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.16 by pippijn, Fri Mar 2 00:29:08 2007 UTC vs.
Revision 1.24 by root, Mon Dec 17 08:27:44 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 -- )
… …
224 224
225=head3 cleanup () 225=head3 cleanup ()
226 226
227Called when the server is cleaning up, just before it calls exit. 227Called when the server is cleaning up, just before it calls exit.
228 228
229=head3 clock ( ) 229=head3 clock ()
230 230
231Is invoked on every server tick, usually every 0.12 seconds. 231Is invoked on every server tick, usually every 0.12 seconds.
232
233=head3 resource_update ()
234
235Is invoked after each time the server reloads its resources, which is
236usually one of the earliest things it does when starting up.
232 237
233 238
234=head2 PLAYER EVENTS 239=head2 PLAYER EVENTS
235 240
236Player events always have a player object as first argument. 241Player events always have a player object as first argument.
… …
271 276
272=head3 login (player) 277=head3 login (player)
273 278
274Invoked whenever a player logs in. 279Invoked whenever a player logs in.
275 280
276=head3 logout (player) 281=head3 logout (player cleanly -- )
277 282
278Invoked whenever a player logs out, gets disconnected etc. 283Invoked whenever a player logs out, gets disconnected etc.
279 284
280=head3 death (player) 285=head3 death (player)
281 286
282Invoked whenever a player dies, before the death actually gets processed. 287Invoked whenever a player dies, before the death actually gets processed.
283 288
284=head3 map_change (player newmap x y -- ) 289=head3 map_change (player newmap x y -- )
285 290
286Invoked before a player moves from one map to another, can override the movement. 291Invoked before a player moves from one map to another, can override the movement.
292
293=head3 region_change (player newregion oldregion -- )
294
295Invoked when a player entered a new region. Cannot be overriden.
287 296
288=head3 command (player command args -- time) 297=head3 command (player command args -- time)
289 298
290Execute a user command send by the client. Programmable plug-ins usually 299Execute a user command send by the client. Programmable plug-ins usually
291handle this event internally. 300handle this event internally.
… …
294 303
295Invoked whenever a client issues the C<extcmd> protocol command. 304Invoked whenever a client issues the C<extcmd> protocol command.
296Programmable plug-ins usually handle this event internally. 305Programmable plug-ins usually handle this event internally.
297 306
298=head3 move (player direction -- ) 307=head3 move (player direction -- )
308
309Called whenever the player is supposed to move or attack. The handler
310must handle the cases of speed_left or weapon_sp_left being negative,
311fire being on, is responsible for decreaseing the speed_left value
312on successful moves etc. etc.. When overriden, must return a boolean
313indicating wether a move could be effected.
299 314
300=head3 pray_altar (player altar skill -- ) 315=head3 pray_altar (player altar skill -- )
301 316
302Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. 317Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.
303 318
… …
373=head3 connect (client -- ) 388=head3 connect (client -- )
374 389
375Called as soon as a new connection to the server is established. Should 390Called as soon as a new connection to the server is established. Should
376not be overriden. 391not be overriden.
377 392
393=head3 setup (client string -- )
394
395Client sent the setup command to negotiate parameters. Handling is
396mandatory and done by F<login.ext>.
397
378=head3 addme (client -- ) 398=head3 addme (client -- )
379 399
380The client sent an addme, thus ending the initial handshaking. If overriden, the server 400The client sent an addme, thus ending the initial handshaking. Handling is mandatory
381will not send any response. 401and done by F<login.ext>.
382 402
383=head3 reply (client replystring -- ) 403=head3 reply (client replystring -- )
384 404
385Called when the client submits a reply in the ST_CUSTOM state. Usually 405Called when the client submits a reply in the ST_CUSTOM state. Usually
386handled internally by language plugins. 406handled internally by language plugins.

Diff Legend

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