ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/pod/events.pod
(Generate patch)

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.21 by root, Tue Jun 12 10:29:51 2007 UTC vs.
Revision 1.26 by elmex, Mon Jul 14 10:26:43 2008 UTC

1=head1 CROSSFIRE+ PLUG-IN EVENTS 1=head1 DELIANTRA PLUG-IN EVENTS
2 2
3This document briefly describes each plug-in event. It is also used to 3This document briefly describes each plug-in event. It is also used to
4generate the event-list itself, so is always complete. Be careful wehn 4generate the event-list itself, so is always complete. Be careful wehn
5changing it, though. 5changing it, though.
6 6
… …
50instances). If this is not the behaviour you need, you have to adjust the 50instances). If this is not the behaviour you need, you have to adjust the
51B<destination> object as you see fit. 51B<destination> object as you see fit.
52 52
53=head3 destroy (object -- ) 53=head3 destroy (object -- )
54 54
55Invoked when the crossfire object gets destroyed, and only when the object 55Invoked when the deliantra object gets destroyed, and only when the object
56has a handler for this event. This event can occur many times, as its 56has a handler for this event. This event can occur many times, as its
57called when the in-memory object is destroyed, not when the object itself 57called when the in-memory object is destroyed, not when the object itself
58dies. 58dies.
59 59
60 60
… …
91Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only 91Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only
92during ticks should an objetc process any movement or other events. 92during ticks should an objetc process any movement or other events.
93 93
94=head3 kill (object hitter -- ) 94=head3 kill (object hitter -- )
95 95
96Invoked whenever an object is dead and about to get removed. Overriding 96Invoked whenever an object was killed (hp < 0 caused by an attack) and is
97processing will skip removal, but to do this successfully you have to 97about to get removed. Overriding processing will skip removal, but to do
98objetc from dieing, otherwise the event gets invoked again and again. 98this successfully you have to keep the object from dieing, otherwise the
99event gets invoked again and again.
99 100
100=head3 apply (object who -- applytype) 101=head3 apply (object who -- applytype)
101 102
102Invoked whenever the object is being applied in some way. The applytype is one of: 103Invoked whenever the object is being applied in some way. The applytype is one of:
104
105=head3 auto_apply (object)
106
107Invoked whenever the object is automatically applied (as for example shop tiles
108are on map instantiation). See also the 'auto_apply' flag to enforce auto apply on
109any object.
103 110
104=over 4 111=over 4
105 112
106=item B<0> player or monster can't apply objects of that type 113=item B<0> player or monster can't apply objects of that type
107 114
… …
224 231
225=head3 cleanup () 232=head3 cleanup ()
226 233
227Called when the server is cleaning up, just before it calls exit. 234Called when the server is cleaning up, just before it calls exit.
228 235
229=head3 clock ( ) 236=head3 clock ()
230 237
231Is invoked on every server tick, usually every 0.12 seconds. 238Is invoked on every server tick, usually every 0.12 seconds.
239
240=head3 resource_update ()
241
242Is invoked after each time the server reloads its resources, which is
243usually one of the earliest things it does when starting up.
232 244
233 245
234=head2 PLAYER EVENTS 246=head2 PLAYER EVENTS
235 247
236Player events always have a player object as first argument. 248Player events always have a player object as first argument.
… …
282Invoked whenever a player dies, before the death actually gets processed. 294Invoked whenever a player dies, before the death actually gets processed.
283 295
284=head3 map_change (player newmap x y -- ) 296=head3 map_change (player newmap x y -- )
285 297
286Invoked before a player moves from one map to another, can override the movement. 298Invoked before a player moves from one map to another, can override the movement.
299
300=head3 region_change (player newregion oldregion -- )
301
302Invoked when a player entered a new region. Cannot be overriden.
287 303
288=head3 command (player command args -- time) 304=head3 command (player command args -- time)
289 305
290Execute a user command send by the client. Programmable plug-ins usually 306Execute a user command send by the client. Programmable plug-ins usually
291handle this event internally. 307handle this event internally.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines