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.14 by root, Sun Jan 7 02:39:14 2007 UTC vs.
Revision 1.25 by root, Wed Apr 30 05:34:24 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
… …
62 62
63Object events always relate to a specific object, which is always the 63Object events always relate to a specific object, which is always the
64first argument. Not all events get generated for every object, some are 64first argument. Not all events get generated for every object, some are
65specific to an object type. 65specific to an object type.
66 66
67=head3 add_bonus (item creator difficulty max_magic flags) 67=head3 add_bonus (item creator difficulty max_magic flags -- )
68 68
69A basic item has been created (e.g. for shops, monsters drops etc.) 69A basic item has been created (e.g. for shops, monsters drops etc.)
70that needs bonus values applied. The B<creator> object is a template 70that needs bonus values applied. The B<creator> object is a template
71object that can be used to inherit stuff (and can be NULL). Flags is a 71object that can be used to inherit stuff (and can be NULL). Flags is a
72combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP 72combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP
… …
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:
103 104
… …
143Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, 144Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,
144currently applied by B<who>. If your override, make sure you give 'who' 145currently applied by B<who>. If your override, make sure you give 'who'
145(if it is a player) an indication of whats wrong. Must return true if the 146(if it is a player) an indication of whats wrong. Must return true if the
146object was freed. 147object was freed.
147 148
148=head3 use_skill (skill who part direction strignarg -- ) 149=head3 use_skill (skill who part direction stringarg -- )
149 150
150Invoked whenever a skill is used by somebody or something. 151Invoked whenever a skill is used by somebody or something.
151 152
152=head3 cast_spell (spell casting_object owner direction stringarg -- ) 153=head3 cast_spell (spell owner casting_object direction stringarg -- )
153 154
154Invoked whenever a given spell is cast by B<casting_object> (used by 155Invoked whenever a given spell is cast by B<casting_object> (used by
155B<owner>). 156B<owner>).
156 157
157=head3 drop (object who -- ) 158=head3 drop (object who -- )
… …
203 204
204Invoked whenever a trap-like B<object> has been activated, usually by 205Invoked whenever a trap-like B<object> has been activated, usually by
205moving onto it. This includes not just traps, but also buttons, holes, 206moving onto it. This includes not just traps, but also buttons, holes,
206signs and similar stuff. 207signs and similar stuff.
207 208
209=head3 open (container who -- )
210
211Invoked whenever a container gets opened. When overriden, the container will not
212get opened, but you must tell op about the reason.
213
208=head3 close (container who -- ) 214=head3 close (container who -- )
209 215
210Invoked whenever a container gets closed (this event is not yet reliable!). 216Invoked whenever a container gets closed. When overriden, the container
217will not get closed, but you must tell op about the reason. This event
218is not crash-safe, i.e. containers might be closed due to a server crash
219without this event being invoked.
211 220
212 221
213=head2 GLOBAL EVENTS 222=head2 GLOBAL EVENTS
214 223
215Global events have no relation to specific objects. 224Global events have no relation to specific objects.
216 225
217=head3 cleanup () 226=head3 cleanup ()
218 227
219Called when the server is cleaning up, just before it calls exit. 228Called when the server is cleaning up, just before it calls exit.
220 229
221=head3 clock ( ) 230=head3 clock ()
222 231
223Is invoked on every server tick, usually every 0.12 seconds. 232Is invoked on every server tick, usually every 0.12 seconds.
233
234=head3 resource_update ()
235
236Is invoked after each time the server reloads its resources, which is
237usually one of the earliest things it does when starting up.
224 238
225 239
226=head2 PLAYER EVENTS 240=head2 PLAYER EVENTS
227 241
228Player events always have a player object as first argument. 242Player events always have a player object as first argument.
… …
263 277
264=head3 login (player) 278=head3 login (player)
265 279
266Invoked whenever a player logs in. 280Invoked whenever a player logs in.
267 281
268=head3 logout (player) 282=head3 logout (player cleanly -- )
269 283
270Invoked whenever a player logs out, gets disconnected etc. 284Invoked whenever a player logs out, gets disconnected etc.
271 285
272=head3 death (player) 286=head3 death (player)
273 287
274Invoked whenever a player dies, before the death actually gets processed. 288Invoked whenever a player dies, before the death actually gets processed.
275 289
276=head3 map_change (player newmap x y -- ) 290=head3 map_change (player newmap x y -- )
277 291
278Invoked before a player moves from one map to another, can override the movement. 292Invoked before a player moves from one map to another, can override the movement.
293
294=head3 region_change (player newregion oldregion -- )
295
296Invoked when a player entered a new region. Cannot be overriden.
279 297
280=head3 command (player command args -- time) 298=head3 command (player command args -- time)
281 299
282Execute a user command send by the client. Programmable plug-ins usually 300Execute a user command send by the client. Programmable plug-ins usually
283handle this event internally. 301handle this event internally.
… …
287Invoked whenever a client issues the C<extcmd> protocol command. 305Invoked whenever a client issues the C<extcmd> protocol command.
288Programmable plug-ins usually handle this event internally. 306Programmable plug-ins usually handle this event internally.
289 307
290=head3 move (player direction -- ) 308=head3 move (player direction -- )
291 309
310Called whenever the player is supposed to move or attack. The handler
311must handle the cases of speed_left or weapon_sp_left being negative,
312fire being on, is responsible for decreaseing the speed_left value
313on successful moves etc. etc.. When overriden, must return a boolean
314indicating wether a move could be effected.
315
292=head3 pray_altar (player altar skill -- ) 316=head3 pray_altar (player altar skill -- )
293 317
294Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. 318Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.
295 319
296=head3 tell (player name message -- ) 320=head3 tell (player name message -- )
297 321
298Invoked whenever the player uses the B<tell> or B<reply> command, before 322Invoked whenever the player uses the B<tell> or B<reply> command, before
299it gets processed. 323it gets processed.
324
325=head3 told (player player message -- )
326
327Invoked right before a message is being told to a player using B<tell> or
328B<reply>.
300 329
301=head3 say (player message --) 330=head3 say (player message --)
302 331
303=head3 chat (player message --) 332=head3 chat (player message --)
304 333
… …
360=head3 connect (client -- ) 389=head3 connect (client -- )
361 390
362Called as soon as a new connection to the server is established. Should 391Called as soon as a new connection to the server is established. Should
363not be overriden. 392not be overriden.
364 393
394=head3 setup (client string -- )
395
396Client sent the setup command to negotiate parameters. Handling is
397mandatory and done by F<login.ext>.
398
365=head3 addme (client -- ) 399=head3 addme (client -- )
366 400
367The client sent an addme, thus ending the initial handshaking. If overriden, the server 401The client sent an addme, thus ending the initial handshaking. Handling is mandatory
368will not send any response. 402and done by F<login.ext>.
369 403
370=head3 reply (client replystring -- ) 404=head3 reply (client replystring -- )
371 405
372Called when the client submits a reply in the ST_CUSTOM state. Usually 406Called when the client submits a reply in the ST_CUSTOM state. Usually
373handled internally by language plugins. 407handled internally by language plugins.

Diff Legend

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