Phantasmal MUD Lib for DGD

Phantasmal Site > Phantasmal API > API Listing > close

API Function: close

Summary:
instruct the mobile to close an object

Defined In LPC Object:
/usr/common/lib/mobile.c

Prototype:
nomask string close(object obj_to_close)

Can Be Called By:
System, Common, Game

Description:

Cause the mobile to attempt to close the given object. If the mobile cannot, a reason why is returned as a string.

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:
place , open