--- deliantra/server/pod/events.pod 2007/06/12 10:29:51 1.21 +++ deliantra/server/pod/events.pod 2008/10/06 18:26:35 1.28 @@ -1,4 +1,4 @@ -=head1 CROSSFIRE+ PLUG-IN EVENTS +=head1 DELIANTRA 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 @@ -52,7 +52,7 @@ =head3 destroy (object -- ) -Invoked when the crossfire object gets destroyed, and only when the object +Invoked when the deliantra object gets destroyed, and only when the object has a handler for this event. This event can occur many times, as its called when the in-memory object is destroyed, not when the object itself dies. @@ -93,9 +93,10 @@ =head3 kill (object hitter -- ) -Invoked whenever an object is dead and about to get removed. Overriding -processing will skip removal, but to do this successfully you have to -objetc from dieing, otherwise the event gets invoked again and again. +Invoked whenever an object was killed (hp < 0 caused by an attack) and is +about to get removed. Overriding processing will skip removal, but to do +this successfully you have to keep the object from dieing, otherwise the +event gets invoked again and again. =head3 apply (object who -- applytype) @@ -111,6 +112,11 @@ =back +=head3 reset (object) + +Invoked whenever the object is initialised on a map after it was +loaded. This can be used to emulate shop-floor behaviour for example. + =head3 throw (object thrower) Invoked when an B is thrown by B. @@ -158,10 +164,16 @@ Invoked whenever an item gets dropped by somebody, e.g. as a result of a drop command. +B If you put the object somewhere else or destroyed the object +you have to override! If you do nothing with the object and override it is +given back to the dropper. =head3 drop_on (floor object who -- ) Invoked whenever some B is being dropped on the B object. +B If you put the object somewhere else or destroyed the object +you have to override! If you do nothing with the object and override it is +given back to the dropper. =head3 say (object player message) @@ -226,10 +238,15 @@ Called when the server is cleaning up, just before it calls exit. -=head3 clock ( ) +=head3 clock () Is invoked on every server tick, usually every 0.12 seconds. +=head3 resource_update () + +Is invoked after each time the server reloads its resources, which is +usually one of the earliest things it does when starting up. + =head2 PLAYER EVENTS @@ -285,6 +302,10 @@ Invoked before a player moves from one map to another, can override the movement. +=head3 region_change (player newregion oldregion -- ) + +Invoked when a player entered a new region. Cannot be overriden. + =head3 command (player command args -- time) Execute a user command send by the client. Programmable plug-ins usually