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) |
53 | =head3 destroy (object -- ) |
54 | |
54 | |
55 | Invoked when the crossfire object gets destroyed, and only when the object |
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 |
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 |
57 | called when the in-memory object is destroyed, not when the object itself |
58 | dies. |
58 | dies. |
59 | |
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 | |
|
|
67 | =head3 add_bonus (item creator difficulty max_magic flags -- ) |
|
|
68 | |
|
|
69 | A basic item has been created (e.g. for shops, monsters drops etc.) |
|
|
70 | that needs bonus values applied. The B<creator> object is a template |
|
|
71 | object that can be used to inherit stuff (and can be NULL). Flags is a |
|
|
72 | combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP |
|
|
73 | on item or set its value to 0) or GT_MINIMAL (???) |
|
|
74 | |
|
|
75 | When overriden, built-in bonus generation is skipped, otherwise |
|
|
76 | treasure generation continues as it would without this hook. |
|
|
77 | |
|
|
78 | In general, if flags != 0 or creator != 0 you should just return and leave |
|
|
79 | item generation to the standard code. |
|
|
80 | |
|
|
81 | =head3 remove (object -- ) |
|
|
82 | |
|
|
83 | Invoked before the object is removed from its environment. |
|
|
84 | |
|
|
85 | =head3 insert (object -- ) |
|
|
86 | |
|
|
87 | Called after the object was inserted into a container or map. |
|
|
88 | |
60 | =head3 tick (object) |
89 | =head3 tick (object -- ) |
61 | |
90 | |
62 | 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 |
63 | during ticks should an objetc process any movement or other events. |
92 | during ticks should an objetc process any movement or other events. |
64 | |
93 | |
65 | =head3 kill (object hitter -- ) |
94 | =head3 kill (object hitter -- ) |
66 | |
95 | |
67 | 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 |
68 | 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 |
69 | 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. |
70 | |
100 | |
71 | =head3 apply (object who -- applytype) |
101 | =head3 apply (object who -- applytype) |
72 | |
102 | |
73 | 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: |
74 | |
104 | |
… | |
… | |
79 | =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 |
80 | |
110 | |
81 | =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 |
82 | |
112 | |
83 | =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. |
84 | |
119 | |
85 | =head3 throw (object thrower) |
120 | =head3 throw (object thrower) |
86 | |
121 | |
87 | Invoked when an B<object> is thrown by B<thrower>. |
122 | Invoked when an B<object> is thrown by B<thrower>. |
88 | |
123 | |
… | |
… | |
114 | Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, |
149 | Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, |
115 | 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' |
116 | (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 |
117 | object was freed. |
152 | object was freed. |
118 | |
153 | |
119 | =head3 use_skill (skill who part direction strignarg -- ) |
154 | =head3 use_skill (skill who part direction stringarg -- ) |
120 | |
155 | |
121 | Invoked whenever a skill is used by somebody or something. |
156 | Invoked whenever a skill is used by somebody or something. |
122 | |
157 | |
123 | =head3 cast_spell (spell casting_object owner direction stringarg -- ) |
158 | =head3 cast_spell (spell owner casting_object direction stringarg -- ) |
124 | |
159 | |
125 | 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 |
126 | B<owner>). |
161 | B<owner>). |
127 | |
162 | |
128 | =head3 drop (object who -- ) |
163 | =head3 drop (object who -- ) |
129 | |
164 | |
130 | Invoked whenever an item gets dropped by somebody, e.g. as a result of a |
165 | Invoked whenever an item gets dropped by somebody, e.g. as a result of a |
131 | drop command. |
166 | drop command. |
|
|
167 | B<NOTE:> If you put the object somewhere else or destroyed the object |
|
|
168 | you have to override! If you do nothing with the object and override it is |
|
|
169 | given back to the dropper. |
132 | |
170 | |
133 | =head3 drop_on (floor object who -- ) |
171 | =head3 drop_on (floor object who -- ) |
134 | |
172 | |
135 | Invoked whenever some B<object> is being dropped on the B<floor> object. |
173 | Invoked whenever some B<object> is being dropped on the B<floor> object. |
|
|
174 | B<NOTE:> If you put the object somewhere else or destroyed the object |
|
|
175 | you have to override! If you do nothing with the object and override it is |
|
|
176 | given back to the dropper. |
136 | |
177 | |
137 | =head3 say (object player message) |
178 | =head3 say (object player message) |
138 | |
179 | |
139 | Invoked whenever the I<object> can hear a B<message> being said by |
180 | Invoked whenever the I<object> can hear a B<message> being said by |
140 | B<player> in its vicinity. |
181 | B<player> in its vicinity. |
… | |
… | |
174 | |
215 | |
175 | Invoked whenever a trap-like B<object> has been activated, usually by |
216 | Invoked whenever a trap-like B<object> has been activated, usually by |
176 | moving onto it. This includes not just traps, but also buttons, holes, |
217 | moving onto it. This includes not just traps, but also buttons, holes, |
177 | signs and similar stuff. |
218 | signs and similar stuff. |
178 | |
219 | |
|
|
220 | =head3 open (container who -- ) |
|
|
221 | |
|
|
222 | Invoked whenever a container gets opened. When overriden, the container will not |
|
|
223 | get opened, but you must tell op about the reason. |
|
|
224 | |
179 | =head3 close (container who -- ) |
225 | =head3 close (container who -- ) |
180 | |
226 | |
181 | Invoked whenever a container gets closed (this event is not yet reliable!). |
227 | Invoked whenever a container gets closed. When overriden, the container |
|
|
228 | will not get closed, but you must tell op about the reason. This event |
|
|
229 | is not crash-safe, i.e. containers might be closed due to a server crash |
|
|
230 | without this event being invoked. |
182 | |
231 | |
183 | |
232 | |
184 | =head2 GLOBAL EVENTS |
233 | =head2 GLOBAL EVENTS |
185 | |
234 | |
186 | Global events have no relation to specific objects. |
235 | Global events have no relation to specific objects. |
187 | |
236 | |
188 | =head3 cleanup () |
237 | =head3 cleanup () |
189 | |
238 | |
190 | Called when the server is cleaning up, just before it calls exit. |
239 | Called when the server is cleaning up, just before it calls exit. |
191 | |
240 | |
192 | =head3 clock ( ) |
241 | =head3 clock () |
193 | |
242 | |
194 | Is invoked on every server tick, usually every 0.12 seconds. |
243 | Is invoked on every server tick, usually every 0.12 seconds. |
195 | |
244 | |
|
|
245 | =head3 resource_update () |
|
|
246 | |
|
|
247 | Is invoked after each time the server reloads its resources, which is |
|
|
248 | usually one of the earliest things it does when starting up. |
|
|
249 | |
196 | |
250 | |
197 | =head2 PLAYER EVENTS |
251 | =head2 PLAYER EVENTS |
198 | |
252 | |
199 | Player events always have a player object as first argument. |
253 | Player events always have a player object as first argument. |
200 | |
254 | |
201 | =head3 reattach (player) |
|
|
202 | |
|
|
203 | Invoked whenever attachments/plug-ins need to get reattached to the player |
|
|
204 | object. This usually happens when the player gets loaded from disk, or |
|
|
205 | when the server is reloaded. |
|
|
206 | |
|
|
207 | =head3 birth (player) |
255 | =head3 birth (player) |
208 | |
256 | |
209 | Invoked as very first thing after creating a player. |
257 | Invoked as very first thing after creating a player. |
210 | |
258 | |
211 | =head3 quit (player) |
259 | =head3 quit (player) |
212 | |
260 | |
213 | Invoked wheneever a player quits, before actually removing him/her. |
261 | Invoked wheneever a player quits, before actually removing him/her. |
214 | |
262 | |
215 | =head3 kick (player params -- ) |
263 | =head3 kick (player params -- ) |
216 | |
264 | |
217 | Invoked when the given plaer is being kicked, before the kick is executed. |
265 | Invoked when the given player is being kicked, before the kick is |
|
|
266 | executed. |
218 | |
267 | |
219 | =head3 load (player) |
268 | =head3 load (player -- ) |
220 | |
269 | |
221 | Invoked whenever a player has been loaded from disk, but before |
270 | Invoked whenever a player has been loaded from disk, but before |
222 | actual login. |
271 | actual login. |
223 | |
272 | |
224 | =head3 save (player) |
273 | =head3 save (player -- ) |
225 | |
274 | |
226 | Invoked just before a player gets saved. |
275 | Invoked just before a player gets serialised. |
|
|
276 | |
|
|
277 | =head3 save_done (player -- ) |
|
|
278 | |
|
|
279 | Invoked just after a player was serialised. |
|
|
280 | |
|
|
281 | =head3 connect (player -- ) |
|
|
282 | |
|
|
283 | Invoked just after the player object was connected to a client. |
|
|
284 | |
|
|
285 | =head3 disconnect (player -- ) |
|
|
286 | |
|
|
287 | Invoked just before the player gets disconnected from the client. |
227 | |
288 | |
228 | =head3 login (player) |
289 | =head3 login (player) |
229 | |
290 | |
230 | Invoked whenever a player logs in. |
291 | Invoked whenever a player logs in. |
231 | |
292 | |
232 | =head3 logout (player) |
293 | =head3 logout (player cleanly -- ) |
233 | |
294 | |
234 | Invoked whenever a player logs out, gets disconnected etc. |
295 | Invoked whenever a player logs out, gets disconnected etc. |
235 | |
296 | |
236 | =head3 death (player) |
297 | =head3 death (player) |
237 | |
298 | |
… | |
… | |
239 | |
300 | |
240 | =head3 map_change (player newmap x y -- ) |
301 | =head3 map_change (player newmap x y -- ) |
241 | |
302 | |
242 | Invoked before a player moves from one map to another, can override the movement. |
303 | Invoked before a player moves from one map to another, can override the movement. |
243 | |
304 | |
|
|
305 | =head3 region_change (player newregion oldregion -- ) |
|
|
306 | |
|
|
307 | Invoked when a player entered a new region. Cannot be overriden. |
|
|
308 | |
|
|
309 | =head3 command (player command args -- time) |
|
|
310 | |
|
|
311 | Execute a user command send by the client. Programmable plug-ins usually |
|
|
312 | handle this event internally. |
|
|
313 | |
244 | =head3 extcmd (player string) |
314 | =head3 extcmd (player string) |
245 | |
315 | |
246 | Invoked whenever a client issues the C<extcmd> protocol command. It's |
316 | Invoked whenever a client issues the C<extcmd> protocol command. |
247 | argument is passed without any changes. |
317 | Programmable plug-ins usually handle this event internally. |
248 | |
318 | |
249 | =head3 move (player direction -- ) |
319 | =head3 move (player direction -- ) |
|
|
320 | |
|
|
321 | Called whenever the player is supposed to move or attack. The handler |
|
|
322 | must handle the cases of speed_left or weapon_sp_left being negative, |
|
|
323 | fire being on, is responsible for decreaseing the speed_left value |
|
|
324 | on successful moves etc. etc.. When overriden, must return a boolean |
|
|
325 | indicating wether a move could be effected. |
250 | |
326 | |
251 | =head3 pray_altar (player altar skill -- ) |
327 | =head3 pray_altar (player altar skill -- ) |
252 | |
328 | |
253 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
329 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
254 | |
330 | |
255 | =head3 tell (player name message -- ) |
331 | =head3 tell (player name message -- ) |
256 | |
332 | |
257 | Invoked whenever the player uses the B<tell> or B<reply> command, before |
333 | Invoked whenever the player uses the B<tell> or B<reply> command, before |
258 | it gets processed. |
334 | it gets processed. |
259 | |
335 | |
|
|
336 | =head3 told (player player message -- ) |
|
|
337 | |
|
|
338 | Invoked right before a message is being told to a player using B<tell> or |
|
|
339 | B<reply>. |
|
|
340 | |
260 | =head3 say (player message --) |
341 | =head3 say (player message --) |
261 | |
342 | |
262 | =head3 chat (player message --) |
343 | =head3 chat (player message --) |
263 | |
344 | |
264 | =head3 shout (player message --) |
345 | =head3 shout (player message --) |
… | |
… | |
274 | |
355 | |
275 | =head3 instantiate (map) |
356 | =head3 instantiate (map) |
276 | |
357 | |
277 | Original B<map> has been loaded (e.g. on first use, or after a map |
358 | Original B<map> has been loaded (e.g. on first use, or after a map |
278 | reset). |
359 | reset). |
279 | |
|
|
280 | =head3 reattach (map) |
|
|
281 | |
|
|
282 | Invoked whenever attachments/plug-ins need to get reattached to the |
|
|
283 | B<map>. This usually happens when the map was loaded from disk, or when the |
|
|
284 | server was reloaded. |
|
|
285 | |
|
|
286 | =head3 destroy (map) |
|
|
287 | |
|
|
288 | Invoked when the map object gets destroyed, and only when the map object |
|
|
289 | has a handler for this event. This event can occur many times, as its |
|
|
290 | called when the in-memory object is destroyed, not when the object itself |
|
|
291 | dies. |
|
|
292 | |
360 | |
293 | =head3 swapin (map) |
361 | =head3 swapin (map) |
294 | |
362 | |
295 | Invoked when a previously swapped-out temporary B<map> has been loaded again. |
363 | Invoked when a previously swapped-out temporary B<map> has been loaded again. |
296 | |
364 | |
… | |
… | |
315 | =head3 leave (map player -- ) |
383 | =head3 leave (map player -- ) |
316 | |
384 | |
317 | Invoked whenever a player tries to leave the B<map>. Overriding means the |
385 | Invoked whenever a player tries to leave the B<map>. Overriding means the |
318 | player won't be able to leave. |
386 | player won't be able to leave. |
319 | |
387 | |
320 | =head3 trigger (map connection state) |
388 | =head3 trigger (map connection state -- ) |
321 | |
389 | |
322 | Invoked whenever something activates a B<connection> on the B<map>. If B<state> |
390 | Invoked whenever something activates a B<connection> on the B<map>. If B<state> |
323 | is true the connection was 'state' and if false it is 'released'. |
391 | is true the connection was 'state' and if false it is 'released'. |
324 | |
392 | |
|
|
393 | |
|
|
394 | =head2 CLIENT EVENTS |
|
|
395 | |
|
|
396 | These events are very similar to player events, but they are might be |
|
|
397 | handled asynchronously as soon as the command reaches the server, even when |
|
|
398 | the player hasn't logged in yet (meaning there is no player yet). |
|
|
399 | |
|
|
400 | =head3 connect (client -- ) |
|
|
401 | |
|
|
402 | Called as soon as a new connection to the server is established. Should |
|
|
403 | not be overriden. |
|
|
404 | |
|
|
405 | =head3 setup (client string -- ) |
|
|
406 | |
|
|
407 | Client sent the setup command to negotiate parameters. Handling is |
|
|
408 | mandatory and done by F<login.ext>. |
|
|
409 | |
|
|
410 | =head3 addme (client -- ) |
|
|
411 | |
|
|
412 | The client sent an addme, thus ending the initial handshaking. Handling is mandatory |
|
|
413 | and done by F<login.ext>. |
|
|
414 | |
|
|
415 | =head3 reply (client replystring -- ) |
|
|
416 | |
|
|
417 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
|
|
418 | handled internally by language plugins. |
|
|
419 | |
|
|
420 | =head3 exticmd (client string -- ) |
|
|
421 | |
|
|
422 | Like C<extcmd>, but can be called before a player has logged in. |
|
|
423 | |
|
|
424 | Programmable plug-ins usually handle this event internally. |
|
|
425 | |