--- deliantra/server/pod/events.pod 2007/06/12 10:29:51 1.21 +++ deliantra/server/pod/events.pod 2008/07/14 10:26:43 1.26 @@ -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,14 +93,21 @@ =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) Invoked whenever the object is being applied in some way. The applytype is one of: +=head3 auto_apply (object) + +Invoked whenever the object is automatically applied (as for example shop tiles +are on map instantiation). See also the 'auto_apply' flag to enforce auto apply on +any object. + =over 4 =item B<0> player or monster can't apply objects of that type @@ -226,10 +233,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 +297,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