Phantasmal Site > Phantasmal API > API Listing > remove_mobile

API Function: remove_mobile

Summary:

remove a mobile from the mobiled, and from the containing room

Defined In LPC Object:

/usr/common/sys/mobiled.c

Prototype:

void remove_mobile(object mobile)

Can Be Called By:

System, Common, Game

Description:

Removes the mobile from mobiled. Also removes the mobile from the mobile list of the room containing the mobile, and destructs the mobile's object.

Return Value:

None.

Errors:

An already-destructed mobile will give an error, as will inconsistencies in the room bookkeeping.

See Also:

add_mobile_number