Operations on Player Objects

Function: list players ()

Returns a list of the object numbers of all player objects in the database.

Function: int is_player (obj object)

Returns a true value if the given object is a player object and a false value otherwise. If object is not valid, E_INVARG is raised.

Function: none set_player_flag (obj object, value)

Confers or removes the "player object" status of the given object, depending upon the truth value of value. If object is not valid, E_INVARG is raised. If the programmer is not a wizard, then E_PERM is raised.

If value is true, then object gains (or keeps) "player object" status: it will be an element of the list returned by players(), the expression is_player(object) will return true, and the server will treat a call to $do_login_command() that returns object as logging in the current connection.

If value is false, the object loses (or continues to lack) "player object" status: it will not be an element of the list returned by players(), the expression is_player(object) will return false, and users cannot connect to object by name when they log into the server. In addition, if a user is connected to object at the time that it loses "player object" status, then that connection is immediately broken, just as if boot_player(object) had been called (see the description of boot_player() below).

Go to the first, previous, next, last section, table of contents.