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.23 by root, Sat Nov 10 22:41:59 2007 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
… …
143Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, 143Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,
144currently applied by B<who>. If your override, make sure you give 'who' 144currently 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 145(if it is a player) an indication of whats wrong. Must return true if the
146object was freed. 146object was freed.
147 147
148=head3 use_skill (skill who part direction strignarg -- ) 148=head3 use_skill (skill who part direction stringarg -- )
149 149
150Invoked whenever a skill is used by somebody or something. 150Invoked whenever a skill is used by somebody or something.
151 151
152=head3 cast_spell (spell casting_object owner direction stringarg -- ) 152=head3 cast_spell (spell owner casting_object direction stringarg -- )
153 153
154Invoked whenever a given spell is cast by B<casting_object> (used by 154Invoked whenever a given spell is cast by B<casting_object> (used by
155B<owner>). 155B<owner>).
156 156
157=head3 drop (object who -- ) 157=head3 drop (object who -- )
… …
203 203
204Invoked whenever a trap-like B<object> has been activated, usually by 204Invoked whenever a trap-like B<object> has been activated, usually by
205moving onto it. This includes not just traps, but also buttons, holes, 205moving onto it. This includes not just traps, but also buttons, holes,
206signs and similar stuff. 206signs and similar stuff.
207 207
208=head3 open (container who -- )
209
210Invoked whenever a container gets opened. When overriden, the container will not
211get opened, but you must tell op about the reason.
212
208=head3 close (container who -- ) 213=head3 close (container who -- )
209 214
210Invoked whenever a container gets closed (this event is not yet reliable!). 215Invoked whenever a container gets closed. When overriden, the container
216will not get closed, but you must tell op about the reason. This event
217is not crash-safe, i.e. containers might be closed due to a server crash
218without this event being invoked.
211 219
212 220
213=head2 GLOBAL EVENTS 221=head2 GLOBAL EVENTS
214 222
215Global events have no relation to specific objects. 223Global events have no relation to specific objects.
… …
263 271
264=head3 login (player) 272=head3 login (player)
265 273
266Invoked whenever a player logs in. 274Invoked whenever a player logs in.
267 275
268=head3 logout (player) 276=head3 logout (player cleanly -- )
269 277
270Invoked whenever a player logs out, gets disconnected etc. 278Invoked whenever a player logs out, gets disconnected etc.
271 279
272=head3 death (player) 280=head3 death (player)
273 281
274Invoked whenever a player dies, before the death actually gets processed. 282Invoked whenever a player dies, before the death actually gets processed.
275 283
276=head3 map_change (player newmap x y -- ) 284=head3 map_change (player newmap x y -- )
277 285
278Invoked before a player moves from one map to another, can override the movement. 286Invoked before a player moves from one map to another, can override the movement.
287
288=head3 region_change (player newregion oldregion -- )
289
290Invoked when a player entered a new region. Cannot be overriden.
279 291
280=head3 command (player command args -- time) 292=head3 command (player command args -- time)
281 293
282Execute a user command send by the client. Programmable plug-ins usually 294Execute a user command send by the client. Programmable plug-ins usually
283handle this event internally. 295handle this event internally.
… …
287Invoked whenever a client issues the C<extcmd> protocol command. 299Invoked whenever a client issues the C<extcmd> protocol command.
288Programmable plug-ins usually handle this event internally. 300Programmable plug-ins usually handle this event internally.
289 301
290=head3 move (player direction -- ) 302=head3 move (player direction -- )
291 303
304Called whenever the player is supposed to move or attack. The handler
305must handle the cases of speed_left or weapon_sp_left being negative,
306fire being on, is responsible for decreaseing the speed_left value
307on successful moves etc. etc.. When overriden, must return a boolean
308indicating wether a move could be effected.
309
292=head3 pray_altar (player altar skill -- ) 310=head3 pray_altar (player altar skill -- )
293 311
294Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. 312Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.
295 313
296=head3 tell (player name message -- ) 314=head3 tell (player name message -- )
297 315
298Invoked whenever the player uses the B<tell> or B<reply> command, before 316Invoked whenever the player uses the B<tell> or B<reply> command, before
299it gets processed. 317it gets processed.
318
319=head3 told (player player message -- )
320
321Invoked right before a message is being told to a player using B<tell> or
322B<reply>.
300 323
301=head3 say (player message --) 324=head3 say (player message --)
302 325
303=head3 chat (player message --) 326=head3 chat (player message --)
304 327
… …
360=head3 connect (client -- ) 383=head3 connect (client -- )
361 384
362Called as soon as a new connection to the server is established. Should 385Called as soon as a new connection to the server is established. Should
363not be overriden. 386not be overriden.
364 387
388=head3 setup (client string -- )
389
390Client sent the setup command to negotiate parameters. Handling is
391mandatory and done by F<login.ext>.
392
365=head3 addme (client -- ) 393=head3 addme (client -- )
366 394
367The client sent an addme, thus ending the initial handshaking. If overriden, the server 395The client sent an addme, thus ending the initial handshaking. Handling is mandatory
368will not send any response. 396and done by F<login.ext>.
369 397
370=head3 reply (client replystring -- ) 398=head3 reply (client replystring -- )
371 399
372Called when the client submits a reply in the ST_CUSTOM state. Usually 400Called when the client submits a reply in the ST_CUSTOM state. Usually
373handled internally by language plugins. 401handled internally by language plugins.

Diff Legend

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