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.10 by root, Thu Dec 21 23:37:05 2006 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
18player BIRTH event, nothing much will happen with respect to the built-in 18player BIRTH event, nothing much will happen with respect to the built-in
19processing, but if you override from within a player TELL event, the tell 19processing, but if you override from within a player TELL event, the tell
20will be ignored (presumably your plug-in took care of it). 20will be ignored (presumably your plug-in took care of it).
21 21
22 22
23=head2 OBJECT EVENTS 23=head2 ATTACHABLE EVENTS
24 24
25Object events always relate to a specific object, which is always the 25No time to document this, screw me.
26first argument. Not all events get generated for every object, some are
27specific to an object type.
28 26
29=head3 instantiate (object init-args...) 27=head3 instantiate (object init-args...)
30 28
31An archetype was instantiated into an object. This event occurs when 29An object was instantiated.
32a map is loaded for the first time, or when the object was created 30
31For objects, this event occurs when a map is loaded for the first time
32when it was instantiated from an archetype, or when the object was created
33dynamically. The arguments are as specified in the C<attach> attribute of 33dynamically. The arguments are as specified in the C<attach> attribute of
34the object or archetype. 34the object or archetype.
35 35
36This is useful to initialise any per-object state you might need. 36This is useful to initialise any per-object state you might need.
37 37
42server was reloaded. This event will only be generated if the object has 42server was reloaded. This event will only be generated if the object has
43attachments. 43attachments.
44 44
45=head3 clone (object destination) 45=head3 clone (object destination)
46 46
47An object with _attached extension_ is cloned, that is, a copy was 47An object with _attached plugin_ is cloned, that is, a copy was made. The
48made. The copy automatically has all attachments the original object 48copy automatically has all attachments the original object had. The perl
49had. The perl variables get copied in a shallow way (references are shared 49variables get copied in a shallow way (references are shared between
50between instances). If this is not the behaviour you need, you have to 50instances). If this is not the behaviour you need, you have to adjust the
51adjust the B<destination> object as you see fit. 51B<destination> object as you see fit.
52 52
53=head3 destroy (object -- )
54
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
57called when the in-memory object is destroyed, not when the object itself
58dies.
59
60
61=head2 OBJECT EVENTS
62
63Object events always relate to a specific object, which is always the
64first argument. Not all events get generated for every object, some are
65specific to an object type.
66
53=head3 add_bonus (item creator difficulty max_magic flags) 67=head3 add_bonus (item creator difficulty max_magic flags -- )
54 68
55A 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.)
56that needs bonus values applied. The B<creator> object is a template 70that needs bonus values applied. The B<creator> object is a template
57object 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
58combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP 72combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP
62treasure generation continues as it would without this hook. 76treasure generation continues as it would without this hook.
63 77
64In general, if flags != 0 or creator != 0 you should just return and leave 78In general, if flags != 0 or creator != 0 you should just return and leave
65item generation to the standard code. 79item generation to the standard code.
66 80
67=head3 destroy (object) 81=head3 remove (object -- )
68 82
69Invoked when the crossfire object gets destroyed, and only when the object 83Invoked before the object is removed from its environment.
70has a handler for this event. This event can occur many times, as its
71called when the in-memory object is destroyed, not when the object itself
72dies.
73 84
85=head3 insert (object -- )
86
87Called after the object was inserted into a container or map.
88
74=head3 tick (object) 89=head3 tick (object -- )
75 90
76Invoked 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
77during ticks should an objetc process any movement or other events. 92during ticks should an objetc process any movement or other events.
78 93
79=head3 kill (object hitter -- ) 94=head3 kill (object hitter -- )
80 95
81Invoked 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
82processing will skip removal, but to do this successfully you have to 97about to get removed. Overriding processing will skip removal, but to do
83objetc 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.
84 100
85=head3 apply (object who -- applytype) 101=head3 apply (object who -- applytype)
86 102
87Invoked 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:
88 104
93=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
94 110
95=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
96 112
97=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.
98 119
99=head3 throw (object thrower) 120=head3 throw (object thrower)
100 121
101Invoked when an B<object> is thrown by B<thrower>. 122Invoked when an B<object> is thrown by B<thrower>.
102 123
128Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, 149Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,
129currently 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'
130(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
131object was freed. 152object was freed.
132 153
133=head3 use_skill (skill who part direction strignarg -- ) 154=head3 use_skill (skill who part direction stringarg -- )
134 155
135Invoked whenever a skill is used by somebody or something. 156Invoked whenever a skill is used by somebody or something.
136 157
137=head3 cast_spell (spell casting_object owner direction stringarg -- ) 158=head3 cast_spell (spell owner casting_object direction stringarg -- )
138 159
139Invoked 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
140B<owner>). 161B<owner>).
141 162
142=head3 drop (object who -- ) 163=head3 drop (object who -- )
143 164
144Invoked 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
145drop 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.
146 170
147=head3 drop_on (floor object who -- ) 171=head3 drop_on (floor object who -- )
148 172
149Invoked 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.
150 177
151=head3 say (object player message) 178=head3 say (object player message)
152 179
153Invoked 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
154B<player> in its vicinity. 181B<player> in its vicinity.
188 215
189Invoked whenever a trap-like B<object> has been activated, usually by 216Invoked whenever a trap-like B<object> has been activated, usually by
190moving onto it. This includes not just traps, but also buttons, holes, 217moving onto it. This includes not just traps, but also buttons, holes,
191signs and similar stuff. 218signs and similar stuff.
192 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
193=head3 close (container who -- ) 225=head3 close (container who -- )
194 226
195Invoked 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.
196 231
197 232
198=head2 GLOBAL EVENTS 233=head2 GLOBAL EVENTS
199 234
200Global events have no relation to specific objects. 235Global events have no relation to specific objects.
201 236
202=head3 cleanup () 237=head3 cleanup ()
203 238
204Called when the server is cleaning up, just before it calls exit. 239Called when the server is cleaning up, just before it calls exit.
205 240
206=head3 clock ( ) 241=head3 clock ()
207 242
208Is invoked on every server tick, usually every 0.12 seconds. 243Is invoked on every server tick, usually every 0.12 seconds.
209 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
210 250
211=head2 PLAYER EVENTS 251=head2 PLAYER EVENTS
212 252
213Player events always have a player object as first argument. 253Player events always have a player object as first argument.
214 254
215=head3 reattach (player)
216
217Invoked whenever attachments/plug-ins need to get reattached to the player
218object. This usually happens when the player gets loaded from disk, or
219when the server is reloaded.
220
221=head3 birth (player) 255=head3 birth (player)
222 256
223Invoked as very first thing after creating a player. 257Invoked as very first thing after creating a player.
224 258
225=head3 quit (player) 259=head3 quit (player)
226 260
227Invoked wheneever a player quits, before actually removing him/her. 261Invoked wheneever a player quits, before actually removing him/her.
228 262
229=head3 kick (player params -- ) 263=head3 kick (player params -- )
230 264
231Invoked 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.
232 267
233=head3 load (player) 268=head3 load (player -- )
234 269
235Invoked whenever a player has been loaded from disk, but before 270Invoked whenever a player has been loaded from disk, but before
236actual login. 271actual login.
237 272
238=head3 save (player) 273=head3 save (player -- )
239 274
240Invoked just before a player gets saved. 275Invoked just before a player gets serialised.
276
277=head3 save_done (player -- )
278
279Invoked just after a player was serialised.
280
281=head3 connect (player -- )
282
283Invoked just after the player object was connected to a client.
284
285=head3 disconnect (player -- )
286
287Invoked just before the player gets disconnected from the client.
241 288
242=head3 login (player) 289=head3 login (player)
243 290
244Invoked whenever a player logs in. 291Invoked whenever a player logs in.
245 292
246=head3 logout (player) 293=head3 logout (player cleanly -- )
247 294
248Invoked whenever a player logs out, gets disconnected etc. 295Invoked whenever a player logs out, gets disconnected etc.
249 296
250=head3 death (player) 297=head3 death (player)
251 298
252Invoked whenever a player dies, before the death actually gets processed. 299Invoked whenever a player dies, before the death actually gets processed.
253 300
254=head3 map_change (player newmap x y -- ) 301=head3 map_change (player newmap x y -- )
255 302
256Invoked 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.
257 308
258=head3 command (player command args -- time) 309=head3 command (player command args -- time)
259 310
260Execute a user command send by the client. Programmable plug-ins usually 311Execute a user command send by the client. Programmable plug-ins usually
261handle this event internally. 312handle this event internally.
265Invoked whenever a client issues the C<extcmd> protocol command. 316Invoked whenever a client issues the C<extcmd> protocol command.
266Programmable plug-ins usually handle this event internally. 317Programmable plug-ins usually handle this event internally.
267 318
268=head3 move (player direction -- ) 319=head3 move (player direction -- )
269 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
270=head3 pray_altar (player altar skill -- ) 327=head3 pray_altar (player altar skill -- )
271 328
272Invoked 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>.
273 330
274=head3 tell (player name message -- ) 331=head3 tell (player name message -- )
275 332
276Invoked 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
277it gets processed. 334it gets processed.
278 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>.
340
279=head3 say (player message --) 341=head3 say (player message --)
280 342
281=head3 chat (player message --) 343=head3 chat (player message --)
282 344
283=head3 shout (player message --) 345=head3 shout (player message --)
293 355
294=head3 instantiate (map) 356=head3 instantiate (map)
295 357
296Original B<map> has been loaded (e.g. on first use, or after a map 358Original B<map> has been loaded (e.g. on first use, or after a map
297reset). 359reset).
298
299=head3 reattach (map)
300
301Invoked whenever attachments/plug-ins need to get reattached to the
302B<map>. This usually happens when the map was loaded from disk, or when the
303server was reloaded.
304
305=head3 destroy (map)
306
307Invoked when the map object gets destroyed, and only when the map object
308has a handler for this event. This event can occur many times, as its
309called when the in-memory object is destroyed, not when the object itself
310dies.
311 360
312=head3 swapin (map) 361=head3 swapin (map)
313 362
314Invoked when a previously swapped-out temporary B<map> has been loaded again. 363Invoked when a previously swapped-out temporary B<map> has been loaded again.
315 364
351=head3 connect (client -- ) 400=head3 connect (client -- )
352 401
353Called 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
354not be overriden. 403not be overriden.
355 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
356=head3 addme (client -- ) 410=head3 addme (client -- )
357 411
358The 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
359will not send any response. 413and done by F<login.ext>.
360
361=head3 reattach (client -- )
362
363Invoked whenever attachments/plug-ins need to get reattached to the
364object. This usually happens when server was reloaded. This event will
365only be generated if the object has attachments.
366 414
367=head3 reply (client replystring -- ) 415=head3 reply (client replystring -- )
368 416
369Called 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
370handled internally by language plugins. 418handled internally by language plugins.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines