--- deliantra/server/pod/events.pod 2006/09/08 02:45:16 1.1 +++ deliantra/server/pod/events.pod 2006/09/17 18:19:19 1.5 @@ -1,4 +1,4 @@ -=head1 CROSSFIRE PLUG-IN EVENTS +=head1 CROSSFIRE+ PLUG-IN EVENTS This document briefly describes each plug-in event. It is also used to generate the event-list itself, so is always complete. Be careful wehn @@ -185,10 +185,15 @@ Global events have no relation to specific objects. +=head3 cleanup () + +Called when the server is cleaning up, just before it calls exit. + =head3 clock ( ) Is invoked on every server tick, usually every 0.12 seconds. + =head2 PLAYER EVENTS Player events always have a player object as first argument. @@ -232,9 +237,9 @@ Invoked whenever a player dies, before the death actually gets processed. -=head3 map_change (player oldmap newmap) +=head3 map_change (player newmap x y -- ) -Invoked whenever a player moves from one map to another. +Invoked before a player moves from one map to another, can override the movement. =head3 extcmd (player string) @@ -301,19 +306,19 @@ Invoked when a temporary B gets deleted on-disk. -=head3 enter (map player) +=head3 enter (map player x y -- ) -Invoked whenever a player enters the B. This event is likely unreliable. +Invoked whenever a player tries to enter the B, while he/she is still +on the old map. Overriding means the player won't be able to enter, and, +if newmap/x/y are given, will be redirected to that map instead. -=head3 leave (map player) +=head3 leave (map player -- ) -Invoked whenever a player leaves the B. This event is likely unreliable. - -=head3 upgrade (map) - -(TEMPORARY EVENT) gets invoked whenever a old-style map has been upgraded. +Invoked whenever a player tries to leave the B. Overriding means the +player won't be able to leave. =head3 trigger (map connection state) Invoked whenever something activates a B on the B. If B is true the connection was 'state' and if false it is 'released'. +