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.13 by root, Tue Jan 2 11:08:36 2007 UTC vs.
Revision 1.28 by elmex, Mon Oct 6 18:26:35 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
… …
108=item B<1> has been applied, or there was an error applying the object 109=item B<1> has been applied, or there was an error applying the object
109 110
110=item B<2> objects of that type can't be applied if not in inventory 111=item B<2> objects of that type can't be applied if not in inventory
111 112
112=back 113=back
114
115=head3 reset (object)
116
117Invoked whenever the object is initialised on a map after it was
118loaded. This can be used to emulate shop-floor behaviour for example.
113 119
114=head3 throw (object thrower) 120=head3 throw (object thrower)
115 121
116Invoked when an B<object> is thrown by B<thrower>. 122Invoked when an B<object> is thrown by B<thrower>.
117 123
… …
143Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, 149Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,
144currently applied by B<who>. If your override, make sure you give 'who' 150currently 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 151(if it is a player) an indication of whats wrong. Must return true if the
146object was freed. 152object was freed.
147 153
148=head3 use_skill (skill who part direction strignarg -- ) 154=head3 use_skill (skill who part direction stringarg -- )
149 155
150Invoked whenever a skill is used by somebody or something. 156Invoked whenever a skill is used by somebody or something.
151 157
152=head3 cast_spell (spell casting_object owner direction stringarg -- ) 158=head3 cast_spell (spell owner casting_object direction stringarg -- )
153 159
154Invoked whenever a given spell is cast by B<casting_object> (used by 160Invoked whenever a given spell is cast by B<casting_object> (used by
155B<owner>). 161B<owner>).
156 162
157=head3 drop (object who -- ) 163=head3 drop (object who -- )
158 164
159Invoked whenever an item gets dropped by somebody, e.g. as a result of a 165Invoked whenever an item gets dropped by somebody, e.g. as a result of a
160drop command. 166drop command.
167B<NOTE:> If you put the object somewhere else or destroyed the object
168you have to override! If you do nothing with the object and override it is
169given back to the dropper.
161 170
162=head3 drop_on (floor object who -- ) 171=head3 drop_on (floor object who -- )
163 172
164Invoked whenever some B<object> is being dropped on the B<floor> object. 173Invoked whenever some B<object> is being dropped on the B<floor> object.
174B<NOTE:> If you put the object somewhere else or destroyed the object
175you have to override! If you do nothing with the object and override it is
176given back to the dropper.
165 177
166=head3 say (object player message) 178=head3 say (object player message)
167 179
168Invoked whenever the I<object> can hear a B<message> being said by 180Invoked whenever the I<object> can hear a B<message> being said by
169B<player> in its vicinity. 181B<player> in its vicinity.
… …
203 215
204Invoked whenever a trap-like B<object> has been activated, usually by 216Invoked whenever a trap-like B<object> has been activated, usually by
205moving onto it. This includes not just traps, but also buttons, holes, 217moving onto it. This includes not just traps, but also buttons, holes,
206signs and similar stuff. 218signs and similar stuff.
207 219
220=head3 open (container who -- )
221
222Invoked whenever a container gets opened. When overriden, the container will not
223get opened, but you must tell op about the reason.
224
208=head3 close (container who -- ) 225=head3 close (container who -- )
209 226
210Invoked whenever a container gets closed (this event is not yet reliable!). 227Invoked whenever a container gets closed. When overriden, the container
228will not get closed, but you must tell op about the reason. This event
229is not crash-safe, i.e. containers might be closed due to a server crash
230without this event being invoked.
211 231
212 232
213=head2 GLOBAL EVENTS 233=head2 GLOBAL EVENTS
214 234
215Global events have no relation to specific objects. 235Global events have no relation to specific objects.
216 236
217=head3 cleanup () 237=head3 cleanup ()
218 238
219Called when the server is cleaning up, just before it calls exit. 239Called when the server is cleaning up, just before it calls exit.
220 240
221=head3 clock ( ) 241=head3 clock ()
222 242
223Is invoked on every server tick, usually every 0.12 seconds. 243Is invoked on every server tick, usually every 0.12 seconds.
224 244
245=head3 resource_update ()
246
247Is invoked after each time the server reloads its resources, which is
248usually one of the earliest things it does when starting up.
249
225 250
226=head2 PLAYER EVENTS 251=head2 PLAYER EVENTS
227 252
228Player events always have a player object as first argument. 253Player events always have a player object as first argument.
229 254
… …
235 260
236Invoked wheneever a player quits, before actually removing him/her. 261Invoked wheneever a player quits, before actually removing him/her.
237 262
238=head3 kick (player params -- ) 263=head3 kick (player params -- )
239 264
240Invoked when the given plaer is being kicked, before the kick is executed. 265Invoked when the given player is being kicked, before the kick is
266executed.
241 267
242=head3 load (player) 268=head3 load (player -- )
243 269
244Invoked whenever a player has been loaded from disk, but before 270Invoked whenever a player has been loaded from disk, but before
245actual login. 271actual login.
246 272
247=head3 save (player path -- ) 273=head3 save (player -- )
248 274
249Invoked just before a player gets saved. 275Invoked just before a player gets serialised.
250 276
251=head3 save_done (player path -- ) 277=head3 save_done (player -- )
252 278
253Invoked just after a player was saved. 279Invoked just after a player was serialised.
254 280
255=head3 connect (player -- ) 281=head3 connect (player -- )
256 282
257Invoked just after the player object was connected to a client. 283Invoked just after the player object was connected to a client.
258 284
… …
262 288
263=head3 login (player) 289=head3 login (player)
264 290
265Invoked whenever a player logs in. 291Invoked whenever a player logs in.
266 292
267=head3 logout (player) 293=head3 logout (player cleanly -- )
268 294
269Invoked whenever a player logs out, gets disconnected etc. 295Invoked whenever a player logs out, gets disconnected etc.
270 296
271=head3 death (player) 297=head3 death (player)
272 298
273Invoked whenever a player dies, before the death actually gets processed. 299Invoked whenever a player dies, before the death actually gets processed.
274 300
275=head3 map_change (player newmap x y -- ) 301=head3 map_change (player newmap x y -- )
276 302
277Invoked before a player moves from one map to another, can override the movement. 303Invoked before a player moves from one map to another, can override the movement.
304
305=head3 region_change (player newregion oldregion -- )
306
307Invoked when a player entered a new region. Cannot be overriden.
278 308
279=head3 command (player command args -- time) 309=head3 command (player command args -- time)
280 310
281Execute a user command send by the client. Programmable plug-ins usually 311Execute a user command send by the client. Programmable plug-ins usually
282handle this event internally. 312handle this event internally.
… …
286Invoked whenever a client issues the C<extcmd> protocol command. 316Invoked whenever a client issues the C<extcmd> protocol command.
287Programmable plug-ins usually handle this event internally. 317Programmable plug-ins usually handle this event internally.
288 318
289=head3 move (player direction -- ) 319=head3 move (player direction -- )
290 320
321Called whenever the player is supposed to move or attack. The handler
322must handle the cases of speed_left or weapon_sp_left being negative,
323fire being on, is responsible for decreaseing the speed_left value
324on successful moves etc. etc.. When overriden, must return a boolean
325indicating wether a move could be effected.
326
291=head3 pray_altar (player altar skill -- ) 327=head3 pray_altar (player altar skill -- )
292 328
293Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. 329Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.
294 330
295=head3 tell (player name message -- ) 331=head3 tell (player name message -- )
296 332
297Invoked whenever the player uses the B<tell> or B<reply> command, before 333Invoked whenever the player uses the B<tell> or B<reply> command, before
298it gets processed. 334it gets processed.
335
336=head3 told (player player message -- )
337
338Invoked right before a message is being told to a player using B<tell> or
339B<reply>.
299 340
300=head3 say (player message --) 341=head3 say (player message --)
301 342
302=head3 chat (player message --) 343=head3 chat (player message --)
303 344
… …
359=head3 connect (client -- ) 400=head3 connect (client -- )
360 401
361Called as soon as a new connection to the server is established. Should 402Called as soon as a new connection to the server is established. Should
362not be overriden. 403not be overriden.
363 404
405=head3 setup (client string -- )
406
407Client sent the setup command to negotiate parameters. Handling is
408mandatory and done by F<login.ext>.
409
364=head3 addme (client -- ) 410=head3 addme (client -- )
365 411
366The client sent an addme, thus ending the initial handshaking. If overriden, the server 412The client sent an addme, thus ending the initial handshaking. Handling is mandatory
367will not send any response. 413and done by F<login.ext>.
368 414
369=head3 reply (client replystring -- ) 415=head3 reply (client replystring -- )
370 416
371Called when the client submits a reply in the ST_CUSTOM state. Usually 417Called when the client submits a reply in the ST_CUSTOM state. Usually
372handled internally by language plugins. 418handled internally by language plugins.

Diff Legend

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