[Package Index | Mudlib Index | Effect Index]

File /obj/handlers/refresh.c

This is the Refresh Handler. When a player refreshes, this handler is called so that all the miscellaneous bookkeeping about that player can be reset. This should be used for taking someone out of the playtesters' group, resetting the criminal ledger in KLK, etc. Everything, in short, which is not a property on the player object or otherwise can be handled entirely by the player object without using any other objects. Similarly, whenever a player gets deleted, this handler gets called upon to call a number of deletion callbacks to remove bookeeping about that player. If you have code that stores information about a player outside of the player object, then you should call register_refresh() and possibly register_delete() on this handler. That will then remember the function you give it. Then, whenever a player refreshes or deletes, the function you specified will get called with the player object and a flag to indicate if this is a total refresh or a partial refresh (for refresh callbacks) or a string with the player name (for player deletions). Do the right thing. will get called with the player object and a flag to indicate if this is a total refresh or a partial refresh. Do the right thing. If your object moves to a different file, then you will have to manually unregister the object from the refresh handler. This is very important! To unregister, simply call register_function() again, with the same object, but give 0 for the function. Each object can have only one refresh function registered, and clones can't have any! You can easily use the same function for both a deletion and refresh callback. All you do is declare the function void callback_func(mixed player, int flag) and then test flag to see if it is PARTIAL_REFRESH, TOTAL_REFRESH, or PLAYER_DELETED. In the last case, player will be a string. Otherwise player is an object.

Written by Sin

Includes

This class includes the following files /include/refresh.h and /include/playerinfo.h

Method index

player_deleted(string)
This, like player_refreshed(), goes through and calls all the registered deletion callbacks.
player_refreshed(object, int)
This function gets called by the player object whenever a player refreshes, or by any of the various objects that delete players when they get deleted.
query_funcs()
Return the current list of callback functions.
register_delete(mixed, string)
This function does almost exactly what register_refresh() does, but it is used for registering delete handlers.
register_refresh(mixed, string)
Use this function to tell the refresh handler about functions that you want to have called whenever any player refreshes or gets deleted.

Public Functions

These are functions that everyone can access.

player_deleted varargs void player_deleted(string player): This, like player_refreshed(), goes through and calls all the registered deletion callbacks. In this case, however, the deletion callbacks get called with a _string_ rather than an object. That string is the name of the player who is being deleted.
player_refreshed varargs void player_refreshed(object player, int totally): This function gets called by the player object whenever a player refreshes, or by any of the various objects that delete players when they get deleted. You should never call this function directly.
query_funcs mapping query_funcs(): Return the current list of callback functions.
register_delete string register_delete(mixed ob, string func): This function does almost exactly what register_refresh() does, but it is used for registering delete handlers. Delete callbacks are called with two parameters as well, but the first parameter is a string containing the player's name, while the second parameter is the integer PLAYER_DELETED.
register_refresh string register_refresh(mixed ob, string func): Use this function to tell the refresh handler about functions that you want to have called whenever any player refreshes or gets deleted. Typically, you will call this by hand, with the 'call' command, rather than coding a call to this function into your code. The first parameter is the object that contains the callback to be called. This can be either a pointer to the object, or the filename to the object. The second parameter is the name of the function that should be called. This callback should take two parameters: an object for the player who is affected, and an integer, which will be either PARTIAL_REFRESH or TOTAL_REFRESH. This function will refuse to register a callback if either: the object is a clone, the callback isn't defined in the object, or the callback is a function pointer.