--- deliantra/server/pod/events.pod 2007/05/18 19:46:22 1.18 +++ deliantra/server/pod/events.pod 2009/01/08 04:35:04 1.31 @@ -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. @@ -64,7 +64,7 @@ first argument. Not all events get generated for every object, some are specific to an object type. -=head3 add_bonus (item creator difficulty max_magic flags) +=head3 add_bonus (item creator difficulty max_magic flags -- ) A basic item has been created (e.g. for shops, monsters drops etc.) that needs bonus values applied. The B object is a template @@ -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. @@ -145,11 +151,11 @@ (if it is a player) an indication of whats wrong. Must return true if the object was freed. -=head3 use_skill (skill who part direction strignarg -- ) +=head3 use_skill (skill who part direction stringarg -- ) Invoked whenever a skill is used by somebody or something. -=head3 cast_spell (spell casting_object owner direction stringarg -- ) +=head3 cast_spell (spell owner casting_object direction stringarg -- ) Invoked whenever a given spell is cast by B (used by B). @@ -226,10 +232,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 @@ -273,7 +284,7 @@ Invoked whenever a player logs in. -=head3 logout (player) +=head3 logout (player cleanly -- ) Invoked whenever a player logs out, gets disconnected etc. @@ -285,6 +296,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 @@ -364,7 +379,7 @@ Invoked whenever a player tries to leave the B. Overriding means the player won't be able to leave. -=head3 trigger (map connection state -- ) +=head3 trigger (map connection state what? who? -- ) Invoked whenever something activates a B on the B. If B is true the connection was 'state' and if false it is 'released'.