1 | =head1 CROSSFIRE+ PLUG-IN EVENTS |
1 | =head1 DELIANTRA PLUG-IN EVENTS |
2 | |
2 | |
3 | This document briefly describes each plug-in event. It is also used to |
3 | This document briefly describes each plug-in event. It is also used to |
4 | generate the event-list itself, so is always complete. Be careful wehn |
4 | generate the event-list itself, so is always complete. Be careful wehn |
5 | changing it, though. |
5 | changing it, though. |
6 | |
6 | |
… | |
… | |
18 | player BIRTH event, nothing much will happen with respect to the built-in |
18 | player BIRTH event, nothing much will happen with respect to the built-in |
19 | processing, but if you override from within a player TELL event, the tell |
19 | processing, but if you override from within a player TELL event, the tell |
20 | will be ignored (presumably your plug-in took care of it). |
20 | will be ignored (presumably your plug-in took care of it). |
21 | |
21 | |
22 | |
22 | |
23 | =head2 OBJECT EVENTS |
23 | =head2 ATTACHABLE EVENTS |
24 | |
24 | |
25 | Object events always relate to a specific object, which is always the |
25 | No time to document this, screw me. |
26 | first argument. Not all events get generated for every object, some are |
|
|
27 | specific to an object type. |
|
|
28 | |
26 | |
29 | =head3 instantiate (object init-args...) |
27 | =head3 instantiate (object init-args...) |
30 | |
28 | |
31 | An archetype was instantiated into an object. This event occurs when |
29 | An object was instantiated. |
32 | a map is loaded for the first time, or when the object was created |
30 | |
|
|
31 | For objects, this event occurs when a map is loaded for the first time |
|
|
32 | when it was instantiated from an archetype, or when the object was created |
33 | dynamically. The arguments are as specified in the C<attach> attribute of |
33 | dynamically. The arguments are as specified in the C<attach> attribute of |
34 | the object or archetype. |
34 | the object or archetype. |
35 | |
35 | |
36 | This is useful to initialise any per-object state you might need. |
36 | This is useful to initialise any per-object state you might need. |
37 | |
37 | |
… | |
… | |
42 | server was reloaded. This event will only be generated if the object has |
42 | server was reloaded. This event will only be generated if the object has |
43 | attachments. |
43 | attachments. |
44 | |
44 | |
45 | =head3 clone (object destination) |
45 | =head3 clone (object destination) |
46 | |
46 | |
47 | An object with _attached extension_ is cloned, that is, a copy was |
47 | An object with _attached plugin_ is cloned, that is, a copy was made. The |
48 | made. The copy automatically has all attachments the original object |
48 | copy automatically has all attachments the original object had. The perl |
49 | had. The perl variables get copied in a shallow way (references are shared |
49 | variables get copied in a shallow way (references are shared between |
50 | between instances). If this is not the behaviour you need, you have to |
50 | instances). If this is not the behaviour you need, you have to adjust the |
51 | adjust the B<destination> object as you see fit. |
51 | B<destination> object as you see fit. |
52 | |
52 | |
|
|
53 | =head3 destroy (object -- ) |
|
|
54 | |
|
|
55 | Invoked when the deliantra object gets destroyed, and only when the object |
|
|
56 | has a handler for this event. This event can occur many times, as its |
|
|
57 | called when the in-memory object is destroyed, not when the object itself |
|
|
58 | dies. |
|
|
59 | |
|
|
60 | |
|
|
61 | =head2 OBJECT EVENTS |
|
|
62 | |
|
|
63 | Object events always relate to a specific object, which is always the |
|
|
64 | first argument. Not all events get generated for every object, some are |
|
|
65 | specific 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 | |
55 | A basic item has been created (e.g. for shops, monsters drops etc.) |
69 | A basic item has been created (e.g. for shops, monsters drops etc.) |
56 | that needs bonus values applied. The B<creator> object is a template |
70 | that needs bonus values applied. The B<creator> object is a template |
57 | object that can be used to inherit stuff (and can be NULL). Flags is a |
71 | object that can be used to inherit stuff (and can be NULL). Flags is a |
58 | combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP |
72 | combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP |
… | |
… | |
62 | treasure generation continues as it would without this hook. |
76 | treasure generation continues as it would without this hook. |
63 | |
77 | |
64 | In general, if flags != 0 or creator != 0 you should just return and leave |
78 | In general, if flags != 0 or creator != 0 you should just return and leave |
65 | item generation to the standard code. |
79 | item generation to the standard code. |
66 | |
80 | |
67 | =head3 destroy (object) |
81 | =head3 remove (object -- ) |
68 | |
82 | |
69 | Invoked when the crossfire object gets destroyed, and only when the object |
83 | Invoked before the object is removed from its environment. |
70 | has a handler for this event. This event can occur many times, as its |
|
|
71 | called when the in-memory object is destroyed, not when the object itself |
|
|
72 | dies. |
|
|
73 | |
84 | |
|
|
85 | =head3 insert (object -- ) |
|
|
86 | |
|
|
87 | Called after the object was inserted into a container or map. |
|
|
88 | |
74 | =head3 tick (object) |
89 | =head3 tick (object -- ) |
75 | |
90 | |
76 | Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only |
91 | Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only |
77 | during ticks should an objetc process any movement or other events. |
92 | during ticks should an objetc process any movement or other events. |
78 | |
93 | |
79 | =head3 kill (object hitter -- ) |
94 | =head3 kill (object hitter -- ) |
80 | |
95 | |
81 | Invoked whenever an object is dead and about to get removed. Overriding |
96 | Invoked whenever an object was killed (hp < 0 caused by an attack) and is |
82 | processing will skip removal, but to do this successfully you have to |
97 | about to get removed. Overriding processing will skip removal, but to do |
83 | objetc from dieing, otherwise the event gets invoked again and again. |
98 | this successfully you have to keep the object from dieing, otherwise the |
|
|
99 | event gets invoked again and again. |
84 | |
100 | |
85 | =head3 apply (object who -- applytype) |
101 | =head3 apply (object who -- applytype) |
86 | |
102 | |
87 | Invoked whenever the object is being applied in some way. The applytype is one of: |
103 | Invoked 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 | |
|
|
117 | Invoked whenever the object is initialised on a map after it was |
|
|
118 | loaded. 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 | |
101 | Invoked when an B<object> is thrown by B<thrower>. |
122 | Invoked when an B<object> is thrown by B<thrower>. |
102 | |
123 | |
… | |
… | |
128 | Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, |
149 | Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, |
129 | currently applied by B<who>. If your override, make sure you give 'who' |
150 | currently 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 |
131 | object was freed. |
152 | object was freed. |
132 | |
153 | |
133 | =head3 use_skill (skill who part direction strignarg -- ) |
154 | =head3 use_skill (skill who part direction stringarg -- ) |
134 | |
155 | |
135 | Invoked whenever a skill is used by somebody or something. |
156 | Invoked 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 | |
139 | Invoked whenever a given spell is cast by B<casting_object> (used by |
160 | Invoked whenever a given spell is cast by B<casting_object> (used by |
140 | B<owner>). |
161 | B<owner>). |
141 | |
162 | |
142 | =head3 drop (object who -- ) |
163 | =head3 drop (object who -- ) |
… | |
… | |
188 | |
209 | |
189 | Invoked whenever a trap-like B<object> has been activated, usually by |
210 | Invoked whenever a trap-like B<object> has been activated, usually by |
190 | moving onto it. This includes not just traps, but also buttons, holes, |
211 | moving onto it. This includes not just traps, but also buttons, holes, |
191 | signs and similar stuff. |
212 | signs and similar stuff. |
192 | |
213 | |
|
|
214 | =head3 open (container who -- ) |
|
|
215 | |
|
|
216 | Invoked whenever a container gets opened. When overriden, the container will not |
|
|
217 | get opened, but you must tell op about the reason. |
|
|
218 | |
193 | =head3 close (container who -- ) |
219 | =head3 close (container who -- ) |
194 | |
220 | |
195 | Invoked whenever a container gets closed (this event is not yet reliable!). |
221 | Invoked whenever a container gets closed. When overriden, the container |
|
|
222 | will not get closed, but you must tell op about the reason. This event |
|
|
223 | is not crash-safe, i.e. containers might be closed due to a server crash |
|
|
224 | without this event being invoked. |
196 | |
225 | |
197 | |
226 | |
198 | =head2 GLOBAL EVENTS |
227 | =head2 GLOBAL EVENTS |
199 | |
228 | |
200 | Global events have no relation to specific objects. |
229 | Global events have no relation to specific objects. |
201 | |
230 | |
202 | =head3 cleanup () |
231 | =head3 cleanup () |
203 | |
232 | |
204 | Called when the server is cleaning up, just before it calls exit. |
233 | Called when the server is cleaning up, just before it calls exit. |
205 | |
234 | |
206 | =head3 clock ( ) |
235 | =head3 clock () |
207 | |
236 | |
208 | Is invoked on every server tick, usually every 0.12 seconds. |
237 | Is invoked on every server tick, usually every 0.12 seconds. |
209 | |
238 | |
|
|
239 | =head3 resource_update () |
|
|
240 | |
|
|
241 | Is invoked after each time the server reloads its resources, which is |
|
|
242 | usually one of the earliest things it does when starting up. |
|
|
243 | |
210 | |
244 | |
211 | =head2 PLAYER EVENTS |
245 | =head2 PLAYER EVENTS |
212 | |
246 | |
213 | Player events always have a player object as first argument. |
247 | Player events always have a player object as first argument. |
214 | |
248 | |
215 | =head3 reattach (player) |
|
|
216 | |
|
|
217 | Invoked whenever attachments/plug-ins need to get reattached to the player |
|
|
218 | object. This usually happens when the player gets loaded from disk, or |
|
|
219 | when the server is reloaded. |
|
|
220 | |
|
|
221 | =head3 birth (player) |
249 | =head3 birth (player) |
222 | |
250 | |
223 | Invoked as very first thing after creating a player. |
251 | Invoked as very first thing after creating a player. |
224 | |
252 | |
225 | =head3 quit (player) |
253 | =head3 quit (player) |
226 | |
254 | |
227 | Invoked wheneever a player quits, before actually removing him/her. |
255 | Invoked wheneever a player quits, before actually removing him/her. |
228 | |
256 | |
229 | =head3 kick (player params -- ) |
257 | =head3 kick (player params -- ) |
230 | |
258 | |
231 | Invoked when the given plaer is being kicked, before the kick is executed. |
259 | Invoked when the given player is being kicked, before the kick is |
|
|
260 | executed. |
232 | |
261 | |
233 | =head3 load (player) |
262 | =head3 load (player -- ) |
234 | |
263 | |
235 | Invoked whenever a player has been loaded from disk, but before |
264 | Invoked whenever a player has been loaded from disk, but before |
236 | actual login. |
265 | actual login. |
237 | |
266 | |
238 | =head3 save (player) |
267 | =head3 save (player -- ) |
239 | |
268 | |
240 | Invoked just before a player gets saved. |
269 | Invoked just before a player gets serialised. |
|
|
270 | |
|
|
271 | =head3 save_done (player -- ) |
|
|
272 | |
|
|
273 | Invoked just after a player was serialised. |
|
|
274 | |
|
|
275 | =head3 connect (player -- ) |
|
|
276 | |
|
|
277 | Invoked just after the player object was connected to a client. |
|
|
278 | |
|
|
279 | =head3 disconnect (player -- ) |
|
|
280 | |
|
|
281 | Invoked just before the player gets disconnected from the client. |
241 | |
282 | |
242 | =head3 login (player) |
283 | =head3 login (player) |
243 | |
284 | |
244 | Invoked whenever a player logs in. |
285 | Invoked whenever a player logs in. |
245 | |
286 | |
246 | =head3 logout (player) |
287 | =head3 logout (player cleanly -- ) |
247 | |
288 | |
248 | Invoked whenever a player logs out, gets disconnected etc. |
289 | Invoked whenever a player logs out, gets disconnected etc. |
249 | |
290 | |
250 | =head3 death (player) |
291 | =head3 death (player) |
251 | |
292 | |
252 | Invoked whenever a player dies, before the death actually gets processed. |
293 | Invoked whenever a player dies, before the death actually gets processed. |
253 | |
294 | |
254 | =head3 map_change (player newmap x y -- ) |
295 | =head3 map_change (player newmap x y -- ) |
255 | |
296 | |
256 | Invoked before a player moves from one map to another, can override the movement. |
297 | Invoked before a player moves from one map to another, can override the movement. |
|
|
298 | |
|
|
299 | =head3 region_change (player newregion oldregion -- ) |
|
|
300 | |
|
|
301 | Invoked when a player entered a new region. Cannot be overriden. |
257 | |
302 | |
258 | =head3 command (player command args -- time) |
303 | =head3 command (player command args -- time) |
259 | |
304 | |
260 | Execute a user command send by the client. Programmable plug-ins usually |
305 | Execute a user command send by the client. Programmable plug-ins usually |
261 | handle this event internally. |
306 | handle this event internally. |
… | |
… | |
265 | Invoked whenever a client issues the C<extcmd> protocol command. |
310 | Invoked whenever a client issues the C<extcmd> protocol command. |
266 | Programmable plug-ins usually handle this event internally. |
311 | Programmable plug-ins usually handle this event internally. |
267 | |
312 | |
268 | =head3 move (player direction -- ) |
313 | =head3 move (player direction -- ) |
269 | |
314 | |
|
|
315 | Called whenever the player is supposed to move or attack. The handler |
|
|
316 | must handle the cases of speed_left or weapon_sp_left being negative, |
|
|
317 | fire being on, is responsible for decreaseing the speed_left value |
|
|
318 | on successful moves etc. etc.. When overriden, must return a boolean |
|
|
319 | indicating wether a move could be effected. |
|
|
320 | |
270 | =head3 pray_altar (player altar skill -- ) |
321 | =head3 pray_altar (player altar skill -- ) |
271 | |
322 | |
272 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
323 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
273 | |
324 | |
274 | =head3 tell (player name message -- ) |
325 | =head3 tell (player name message -- ) |
275 | |
326 | |
276 | Invoked whenever the player uses the B<tell> or B<reply> command, before |
327 | Invoked whenever the player uses the B<tell> or B<reply> command, before |
277 | it gets processed. |
328 | it gets processed. |
278 | |
329 | |
|
|
330 | =head3 told (player player message -- ) |
|
|
331 | |
|
|
332 | Invoked right before a message is being told to a player using B<tell> or |
|
|
333 | B<reply>. |
|
|
334 | |
279 | =head3 say (player message --) |
335 | =head3 say (player message --) |
280 | |
336 | |
281 | =head3 chat (player message --) |
337 | =head3 chat (player message --) |
282 | |
338 | |
283 | =head3 shout (player message --) |
339 | =head3 shout (player message --) |
… | |
… | |
293 | |
349 | |
294 | =head3 instantiate (map) |
350 | =head3 instantiate (map) |
295 | |
351 | |
296 | Original B<map> has been loaded (e.g. on first use, or after a map |
352 | Original B<map> has been loaded (e.g. on first use, or after a map |
297 | reset). |
353 | reset). |
298 | |
|
|
299 | =head3 reattach (map) |
|
|
300 | |
|
|
301 | Invoked whenever attachments/plug-ins need to get reattached to the |
|
|
302 | B<map>. This usually happens when the map was loaded from disk, or when the |
|
|
303 | server was reloaded. |
|
|
304 | |
|
|
305 | =head3 destroy (map) |
|
|
306 | |
|
|
307 | Invoked when the map object gets destroyed, and only when the map object |
|
|
308 | has a handler for this event. This event can occur many times, as its |
|
|
309 | called when the in-memory object is destroyed, not when the object itself |
|
|
310 | dies. |
|
|
311 | |
354 | |
312 | =head3 swapin (map) |
355 | =head3 swapin (map) |
313 | |
356 | |
314 | Invoked when a previously swapped-out temporary B<map> has been loaded again. |
357 | Invoked when a previously swapped-out temporary B<map> has been loaded again. |
315 | |
358 | |
… | |
… | |
334 | =head3 leave (map player -- ) |
377 | =head3 leave (map player -- ) |
335 | |
378 | |
336 | Invoked whenever a player tries to leave the B<map>. Overriding means the |
379 | Invoked whenever a player tries to leave the B<map>. Overriding means the |
337 | player won't be able to leave. |
380 | player won't be able to leave. |
338 | |
381 | |
339 | =head3 trigger (map connection state -- ) |
382 | =head3 trigger (map connection state who? -- ) |
340 | |
383 | |
341 | Invoked whenever something activates a B<connection> on the B<map>. If B<state> |
384 | Invoked whenever something activates a B<connection> on the B<map>. If B<state> |
342 | is true the connection was 'state' and if false it is 'released'. |
385 | is true the connection was 'state' and if false it is 'released'. |
343 | |
386 | |
344 | |
387 | |
… | |
… | |
351 | =head3 connect (client -- ) |
394 | =head3 connect (client -- ) |
352 | |
395 | |
353 | Called as soon as a new connection to the server is established. Should |
396 | Called as soon as a new connection to the server is established. Should |
354 | not be overriden. |
397 | not be overriden. |
355 | |
398 | |
|
|
399 | =head3 setup (client string -- ) |
|
|
400 | |
|
|
401 | Client sent the setup command to negotiate parameters. Handling is |
|
|
402 | mandatory and done by F<login.ext>. |
|
|
403 | |
356 | =head3 addme (client -- ) |
404 | =head3 addme (client -- ) |
357 | |
405 | |
358 | The client sent an addme, thus ending the initial handshaking. If overriden, the server |
406 | The client sent an addme, thus ending the initial handshaking. Handling is mandatory |
359 | will not send any response. |
407 | and done by F<login.ext>. |
360 | |
408 | |
361 | =head3 reattach (client -- ) |
409 | =head3 reply (client replystring -- ) |
362 | |
410 | |
363 | Invoked whenever attachments/plug-ins need to get reattached to the |
411 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
364 | object. This usually happens when server was reloaded. This event will |
412 | handled internally by language plugins. |
365 | only be generated if the object has attachments. |
|
|
366 | |
413 | |
367 | =head3 exticmd (client string -- ) |
414 | =head3 exticmd (client string -- ) |
368 | |
415 | |
369 | Like C<extcmd>, but can be called before a player has logged in. |
416 | Like C<extcmd>, but can be called before a player has logged in. |
370 | |
417 | |