World Events
[Furnarchy 2]

Game world events. More...

Enumerations

enum  World_Event {
  WO_EVENT_CONNECTED, WO_EVENT_DISCONNECTED, WO_EVENT_LOGGEDIN, WO_EVENT_PLAYERINFO,
  WO_EVENT_MONSTER
}

Detailed Description

Game world events.

Events concerning the world are recieved through a module's on_world() event handler. The event determines the type and meaning of on_world()'s param parameter and return value.

See also:
on_world

Enumeration Type Documentation

enum World_Event

Enumerator:
WO_EVENT_CONNECTED  The main connection to the server has been established.

Parameters:
param Not used.
Returns:
Return 0 always.
WO_EVENT_DISCONNECTED  The main connection to the server has been terminated or lost.

Parameters:
param Not used.
Returns:
Return 0 always.
WO_EVENT_LOGGEDIN  The player has successfully logged in.

Parameters:
param Not used.
Returns:
Return 0 always.
Remarks:
After this event, you can use f2_myplayerinfo() to retrieve information on the player, although some of it (namely the colors and desc) may still be in a state of flux at this point.
WO_EVENT_PLAYERINFO  Player information has changed.

Parameters:
param Not used.
Returns:
Return 0 always.
Remarks:
You can use f2_myplayerinfo() to retrieve the new information.
WO_EVENT_MONSTER  Monster (avatar) updated.

Parameters:
[in] param GUID of the updated monster.
Returns:
Return 0 always.
Remarks:
You can use f2_monsterinfo() to retrieve information on the updated monster. If f2_monsterinfo() returns NULL, this event occured in response to the monster being cleared.


Generated on Tue Jun 24 12:24:07 2008 for Furnarchy Module by  doxygen 1.5.5