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.12 by root, Mon Dec 25 11:25:49 2006 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
… …
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:
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
… …
143Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, 150Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,
144currently applied by B<who>. If your override, make sure you give 'who' 151currently 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 152(if it is a player) an indication of whats wrong. Must return true if the
146object was freed. 153object was freed.
147 154
148=head3 use_skill (skill who part direction strignarg -- ) 155=head3 use_skill (skill who part direction stringarg -- )
149 156
150Invoked whenever a skill is used by somebody or something. 157Invoked whenever a skill is used by somebody or something.
151 158
152=head3 cast_spell (spell casting_object owner direction stringarg -- ) 159=head3 cast_spell (spell owner casting_object direction stringarg -- )
153 160
154Invoked whenever a given spell is cast by B<casting_object> (used by 161Invoked whenever a given spell is cast by B<casting_object> (used by
155B<owner>). 162B<owner>).
156 163
157=head3 drop (object who -- ) 164=head3 drop (object who -- )
… …
203 210
204Invoked whenever a trap-like B<object> has been activated, usually by 211Invoked whenever a trap-like B<object> has been activated, usually by
205moving onto it. This includes not just traps, but also buttons, holes, 212moving onto it. This includes not just traps, but also buttons, holes,
206signs and similar stuff. 213signs and similar stuff.
207 214
215=head3 open (container who -- )
216
217Invoked whenever a container gets opened. When overriden, the container will not
218get opened, but you must tell op about the reason.
219
208=head3 close (container who -- ) 220=head3 close (container who -- )
209 221
210Invoked whenever a container gets closed (this event is not yet reliable!). 222Invoked whenever a container gets closed. When overriden, the container
223will not get closed, but you must tell op about the reason. This event
224is not crash-safe, i.e. containers might be closed due to a server crash
225without this event being invoked.
211 226
212 227
213=head2 GLOBAL EVENTS 228=head2 GLOBAL EVENTS
214 229
215Global events have no relation to specific objects. 230Global events have no relation to specific objects.
216 231
217=head3 cleanup () 232=head3 cleanup ()
218 233
219Called when the server is cleaning up, just before it calls exit. 234Called when the server is cleaning up, just before it calls exit.
220 235
221=head3 clock ( ) 236=head3 clock ()
222 237
223Is invoked on every server tick, usually every 0.12 seconds. 238Is invoked on every server tick, usually every 0.12 seconds.
224 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.
244
225 245
226=head2 PLAYER EVENTS 246=head2 PLAYER EVENTS
227 247
228Player events always have a player object as first argument. 248Player events always have a player object as first argument.
229 249
… …
235 255
236Invoked wheneever a player quits, before actually removing him/her. 256Invoked wheneever a player quits, before actually removing him/her.
237 257
238=head3 kick (player params -- ) 258=head3 kick (player params -- )
239 259
240Invoked when the given plaer is being kicked, before the kick is executed. 260Invoked when the given player is being kicked, before the kick is
261executed.
241 262
242=head3 load (player) 263=head3 load (player -- )
243 264
244Invoked whenever a player has been loaded from disk, but before 265Invoked whenever a player has been loaded from disk, but before
245actual login. 266actual login.
246 267
247=head3 save (player) 268=head3 save (player -- )
248 269
249Invoked just before a player gets saved. 270Invoked just before a player gets serialised.
271
272=head3 save_done (player -- )
273
274Invoked just after a player was serialised.
275
276=head3 connect (player -- )
277
278Invoked just after the player object was connected to a client.
279
280=head3 disconnect (player -- )
281
282Invoked just before the player gets disconnected from the client.
250 283
251=head3 login (player) 284=head3 login (player)
252 285
253Invoked whenever a player logs in. 286Invoked whenever a player logs in.
254 287
255=head3 logout (player) 288=head3 logout (player cleanly -- )
256 289
257Invoked whenever a player logs out, gets disconnected etc. 290Invoked whenever a player logs out, gets disconnected etc.
258 291
259=head3 death (player) 292=head3 death (player)
260 293
261Invoked whenever a player dies, before the death actually gets processed. 294Invoked whenever a player dies, before the death actually gets processed.
262 295
263=head3 map_change (player newmap x y -- ) 296=head3 map_change (player newmap x y -- )
264 297
265Invoked 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.
266 303
267=head3 command (player command args -- time) 304=head3 command (player command args -- time)
268 305
269Execute a user command send by the client. Programmable plug-ins usually 306Execute a user command send by the client. Programmable plug-ins usually
270handle this event internally. 307handle this event internally.
… …
274Invoked whenever a client issues the C<extcmd> protocol command. 311Invoked whenever a client issues the C<extcmd> protocol command.
275Programmable plug-ins usually handle this event internally. 312Programmable plug-ins usually handle this event internally.
276 313
277=head3 move (player direction -- ) 314=head3 move (player direction -- )
278 315
316Called whenever the player is supposed to move or attack. The handler
317must handle the cases of speed_left or weapon_sp_left being negative,
318fire being on, is responsible for decreaseing the speed_left value
319on successful moves etc. etc.. When overriden, must return a boolean
320indicating wether a move could be effected.
321
279=head3 pray_altar (player altar skill -- ) 322=head3 pray_altar (player altar skill -- )
280 323
281Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. 324Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.
282 325
283=head3 tell (player name message -- ) 326=head3 tell (player name message -- )
284 327
285Invoked whenever the player uses the B<tell> or B<reply> command, before 328Invoked whenever the player uses the B<tell> or B<reply> command, before
286it gets processed. 329it gets processed.
330
331=head3 told (player player message -- )
332
333Invoked right before a message is being told to a player using B<tell> or
334B<reply>.
287 335
288=head3 say (player message --) 336=head3 say (player message --)
289 337
290=head3 chat (player message --) 338=head3 chat (player message --)
291 339
… …
347=head3 connect (client -- ) 395=head3 connect (client -- )
348 396
349Called as soon as a new connection to the server is established. Should 397Called as soon as a new connection to the server is established. Should
350not be overriden. 398not be overriden.
351 399
400=head3 setup (client string -- )
401
402Client sent the setup command to negotiate parameters. Handling is
403mandatory and done by F<login.ext>.
404
352=head3 addme (client -- ) 405=head3 addme (client -- )
353 406
354The client sent an addme, thus ending the initial handshaking. If overriden, the server 407The client sent an addme, thus ending the initial handshaking. Handling is mandatory
355will not send any response. 408and done by F<login.ext>.
356 409
357=head3 reply (client replystring -- ) 410=head3 reply (client replystring -- )
358 411
359Called when the client submits a reply in the ST_CUSTOM state. Usually 412Called when the client submits a reply in the ST_CUSTOM state. Usually
360handled internally by language plugins. 413handled internally by language plugins.

Diff Legend

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