Phantasmal MUD Lib for DGD

Phantasmal Site > Phantasmal API > API Listing > get_user

API Function: get_user

Summary:
get the mobile's user object

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

Prototype:
object get_user(void)

Can Be Called By:
Anybody

Description:

Gets the mobile's user object. If the mobile doesn't represent a user, nil is returned.

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 user object or nil.

Errors:
Usually none.

See Also:
set_user , get_body