Phantasmal Site > Phantasmal API > API Listing > move

API Function: move

Summary:

instruct the mobile to move through an exit

Defined In LPC Object:

/usr/common/lib/mobile.c

Prototype:

nomask string move(int direction)

Can Be Called By:

System, Common, Game

Description:

Cause the mobile to attempt to move through an exit in the specified direction. If the mobile cannot, a reason why is returned as a string.

When the mobile changes rooms, the 'hook_leave' hook is invoked in the old location, and the 'hook_enter' hook is invoked in the new location.

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

Return Value:

The reason as a string, or nil for success.

Errors:

Usually none.

See Also:

teleport , hook_enter , hook_leave