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.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 -- )
… …
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.
216 224
217=head3 cleanup () 225=head3 cleanup ()
218 226
219Called when the server is cleaning up, just before it calls exit. 227Called when the server is cleaning up, just before it calls exit.
220 228
221=head3 clock ( ) 229=head3 clock ()
222 230
223Is invoked on every server tick, usually every 0.12 seconds. 231Is invoked on every server tick, usually every 0.12 seconds.
224 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.
237
225 238
226=head2 PLAYER EVENTS 239=head2 PLAYER EVENTS
227 240
228Player events always have a player object as first argument. 241Player events always have a player object as first argument.
229 242
… …
235 248
236Invoked wheneever a player quits, before actually removing him/her. 249Invoked wheneever a player quits, before actually removing him/her.
237 250
238=head3 kick (player params -- ) 251=head3 kick (player params -- )
239 252
240Invoked when the given plaer is being kicked, before the kick is executed. 253Invoked when the given player is being kicked, before the kick is
254executed.
241 255
242=head3 load (player) 256=head3 load (player -- )
243 257
244Invoked whenever a player has been loaded from disk, but before 258Invoked whenever a player has been loaded from disk, but before
245actual login. 259actual login.
246 260
247=head3 save (player) 261=head3 save (player -- )
248 262
249Invoked just before a player gets saved. 263Invoked just before a player gets serialised.
264
265=head3 save_done (player -- )
266
267Invoked just after a player was serialised.
268
269=head3 connect (player -- )
270
271Invoked just after the player object was connected to a client.
272
273=head3 disconnect (player -- )
274
275Invoked just before the player gets disconnected from the client.
250 276
251=head3 login (player) 277=head3 login (player)
252 278
253Invoked whenever a player logs in. 279Invoked whenever a player logs in.
254 280
255=head3 logout (player) 281=head3 logout (player cleanly -- )
256 282
257Invoked whenever a player logs out, gets disconnected etc. 283Invoked whenever a player logs out, gets disconnected etc.
258 284
259=head3 death (player) 285=head3 death (player)
260 286
261Invoked whenever a player dies, before the death actually gets processed. 287Invoked whenever a player dies, before the death actually gets processed.
262 288
263=head3 map_change (player newmap x y -- ) 289=head3 map_change (player newmap x y -- )
264 290
265Invoked 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.
266 296
267=head3 command (player command args -- time) 297=head3 command (player command args -- time)
268 298
269Execute a user command send by the client. Programmable plug-ins usually 299Execute a user command send by the client. Programmable plug-ins usually
270handle this event internally. 300handle this event internally.
… …
274Invoked whenever a client issues the C<extcmd> protocol command. 304Invoked whenever a client issues the C<extcmd> protocol command.
275Programmable plug-ins usually handle this event internally. 305Programmable plug-ins usually handle this event internally.
276 306
277=head3 move (player direction -- ) 307=head3 move (player direction -- )
278 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.
314
279=head3 pray_altar (player altar skill -- ) 315=head3 pray_altar (player altar skill -- )
280 316
281Invoked 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>.
282 318
283=head3 tell (player name message -- ) 319=head3 tell (player name message -- )
284 320
285Invoked whenever the player uses the B<tell> or B<reply> command, before 321Invoked whenever the player uses the B<tell> or B<reply> command, before
286it gets processed. 322it gets processed.
323
324=head3 told (player player message -- )
325
326Invoked right before a message is being told to a player using B<tell> or
327B<reply>.
287 328
288=head3 say (player message --) 329=head3 say (player message --)
289 330
290=head3 chat (player message --) 331=head3 chat (player message --)
291 332
… …
347=head3 connect (client -- ) 388=head3 connect (client -- )
348 389
349Called 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
350not be overriden. 391not be overriden.
351 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
352=head3 addme (client -- ) 398=head3 addme (client -- )
353 399
354The 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
355will not send any response. 401and done by F<login.ext>.
356 402
357=head3 reply (client replystring -- ) 403=head3 reply (client replystring -- )
358 404
359Called 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
360handled internally by language plugins. 406handled internally by language plugins.

Diff Legend

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