Phantasmal Site > Phantasmal API > API Listing > get_link

API Function: get_link

Summary:

get the linked object number of the exit

Defined In LPC Object:

/usr/common/lib/exit.c

Prototype:

int get_link(void)

Can Be Called By:

Anybody

Description:

Gets the linked object number of the exit. Certain exit types like ET_TWOWAY have an additional object linked to them, which is destroyed when they are. This function gives the object number of that linked object.

The function returns the number and not the object itself because the querier may not have access to the linked object, depending on the game's security scheme.

This function isn't access-protected. You should access-protect your version of this and all other inherited functions, including upgraded() and destructed().

Return Value:

The integer object number of the linked object.

Errors:

Usually none.

See Also:

get_destination , get_exit_type