Phantasmal Site > Phantasmal API > API Listing > get_location

API Function: get_location

Summary:

get the object's location

Defined In LPC Object:

/usr/common/lib/object.c

Prototype:

object get_location(void)

Can Be Called By:

System, Common, Game

Description:

Gets the object's location, or nil if the object has no location. Normally only the Void will have no location, though a particular game can change that with effort.

Any object may be located within any other object. Phantasmal doesn't worry about differences between portable objects, containers and rooms, so you're allowed to stand in a tent or a breadbox if you're so inclined (and if you fit).

You should access-protect your version of this and all other inherited functions, including upgraded() and destructed().

Return Value:

The location object.

Errors:

Usually none.

See Also:

get_user