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 | |
… | |
… | |
50 | instances). If this is not the behaviour you need, you have to adjust the |
50 | instances). If this is not the behaviour you need, you have to adjust the |
51 | 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 | |
60 | |
… | |
… | |
62 | |
62 | |
63 | Object events always relate to a specific object, which is always the |
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 |
64 | first argument. Not all events get generated for every object, some are |
65 | specific to an object type. |
65 | specific 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 | |
69 | 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.) |
70 | 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 |
71 | 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 |
72 | combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP |
72 | combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP |
… | |
… | |
91 | 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 |
92 | during ticks should an objetc process any movement or other events. |
92 | during ticks should an objetc process any movement or other events. |
93 | |
93 | |
94 | =head3 kill (object hitter -- ) |
94 | =head3 kill (object hitter -- ) |
95 | |
95 | |
96 | 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 |
97 | 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 |
98 | 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. |
99 | |
100 | |
100 | =head3 apply (object who -- applytype) |
101 | =head3 apply (object who -- applytype) |
101 | |
102 | |
102 | 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: |
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 | |
|
|
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. |
113 | |
119 | |
114 | =head3 throw (object thrower) |
120 | =head3 throw (object thrower) |
115 | |
121 | |
116 | Invoked when an B<object> is thrown by B<thrower>. |
122 | Invoked when an B<object> is thrown by B<thrower>. |
117 | |
123 | |
… | |
… | |
143 | Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, |
149 | Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, |
144 | 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' |
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 |
146 | object was freed. |
152 | object was freed. |
147 | |
153 | |
148 | =head3 use_skill (skill who part direction strignarg -- ) |
154 | =head3 use_skill (skill who part direction stringarg -- ) |
149 | |
155 | |
150 | Invoked whenever a skill is used by somebody or something. |
156 | Invoked 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 | |
154 | 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 |
155 | B<owner>). |
161 | B<owner>). |
156 | |
162 | |
157 | =head3 drop (object who -- ) |
163 | =head3 drop (object who -- ) |
… | |
… | |
203 | |
209 | |
204 | 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 |
205 | 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, |
206 | signs and similar stuff. |
212 | signs and similar stuff. |
207 | |
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 | |
208 | =head3 close (container who -- ) |
219 | =head3 close (container who -- ) |
209 | |
220 | |
210 | 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. |
211 | |
225 | |
212 | |
226 | |
213 | =head2 GLOBAL EVENTS |
227 | =head2 GLOBAL EVENTS |
214 | |
228 | |
215 | Global events have no relation to specific objects. |
229 | Global events have no relation to specific objects. |
216 | |
230 | |
217 | =head3 cleanup () |
231 | =head3 cleanup () |
218 | |
232 | |
219 | 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. |
220 | |
234 | |
221 | =head3 clock ( ) |
235 | =head3 clock () |
222 | |
236 | |
223 | Is invoked on every server tick, usually every 0.12 seconds. |
237 | Is invoked on every server tick, usually every 0.12 seconds. |
224 | |
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 | |
225 | |
244 | |
226 | =head2 PLAYER EVENTS |
245 | =head2 PLAYER EVENTS |
227 | |
246 | |
228 | Player events always have a player object as first argument. |
247 | Player events always have a player object as first argument. |
229 | |
248 | |
… | |
… | |
235 | |
254 | |
236 | Invoked wheneever a player quits, before actually removing him/her. |
255 | Invoked wheneever a player quits, before actually removing him/her. |
237 | |
256 | |
238 | =head3 kick (player params -- ) |
257 | =head3 kick (player params -- ) |
239 | |
258 | |
240 | 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. |
241 | |
261 | |
242 | =head3 load (player) |
262 | =head3 load (player -- ) |
243 | |
263 | |
244 | Invoked whenever a player has been loaded from disk, but before |
264 | Invoked whenever a player has been loaded from disk, but before |
245 | actual login. |
265 | actual login. |
246 | |
266 | |
247 | =head3 save (player path -- ) |
267 | =head3 save (player -- ) |
248 | |
268 | |
249 | Invoked just before a player gets saved. |
269 | Invoked just before a player gets serialised. |
250 | |
270 | |
251 | =head3 save_done (player path -- ) |
271 | =head3 save_done (player -- ) |
252 | |
272 | |
253 | Invoked just after a player was saved. |
273 | Invoked just after a player was serialised. |
254 | |
274 | |
255 | =head3 connect (player -- ) |
275 | =head3 connect (player -- ) |
256 | |
276 | |
257 | Invoked just after the player object was connected to a client. |
277 | Invoked just after the player object was connected to a client. |
258 | |
278 | |
… | |
… | |
262 | |
282 | |
263 | =head3 login (player) |
283 | =head3 login (player) |
264 | |
284 | |
265 | Invoked whenever a player logs in. |
285 | Invoked whenever a player logs in. |
266 | |
286 | |
267 | =head3 logout (player) |
287 | =head3 logout (player cleanly -- ) |
268 | |
288 | |
269 | Invoked whenever a player logs out, gets disconnected etc. |
289 | Invoked whenever a player logs out, gets disconnected etc. |
270 | |
290 | |
271 | =head3 death (player) |
291 | =head3 death (player) |
272 | |
292 | |
273 | Invoked whenever a player dies, before the death actually gets processed. |
293 | Invoked whenever a player dies, before the death actually gets processed. |
274 | |
294 | |
275 | =head3 map_change (player newmap x y -- ) |
295 | =head3 map_change (player newmap x y -- ) |
276 | |
296 | |
277 | 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. |
278 | |
302 | |
279 | =head3 command (player command args -- time) |
303 | =head3 command (player command args -- time) |
280 | |
304 | |
281 | 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 |
282 | handle this event internally. |
306 | handle this event internally. |
… | |
… | |
286 | Invoked whenever a client issues the C<extcmd> protocol command. |
310 | Invoked whenever a client issues the C<extcmd> protocol command. |
287 | Programmable plug-ins usually handle this event internally. |
311 | Programmable plug-ins usually handle this event internally. |
288 | |
312 | |
289 | =head3 move (player direction -- ) |
313 | =head3 move (player direction -- ) |
290 | |
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 | |
291 | =head3 pray_altar (player altar skill -- ) |
321 | =head3 pray_altar (player altar skill -- ) |
292 | |
322 | |
293 | 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>. |
294 | |
324 | |
295 | =head3 tell (player name message -- ) |
325 | =head3 tell (player name message -- ) |
296 | |
326 | |
297 | 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 |
298 | it gets processed. |
328 | it gets processed. |
|
|
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>. |
299 | |
334 | |
300 | =head3 say (player message --) |
335 | =head3 say (player message --) |
301 | |
336 | |
302 | =head3 chat (player message --) |
337 | =head3 chat (player message --) |
303 | |
338 | |
… | |
… | |
342 | =head3 leave (map player -- ) |
377 | =head3 leave (map player -- ) |
343 | |
378 | |
344 | 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 |
345 | player won't be able to leave. |
380 | player won't be able to leave. |
346 | |
381 | |
347 | =head3 trigger (map connection state -- ) |
382 | =head3 trigger (map connection state what? who? -- ) |
348 | |
383 | |
349 | 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> |
350 | 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'. |
351 | |
386 | |
352 | |
387 | |
… | |
… | |
359 | =head3 connect (client -- ) |
394 | =head3 connect (client -- ) |
360 | |
395 | |
361 | 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 |
362 | not be overriden. |
397 | not be overriden. |
363 | |
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 | |
364 | =head3 addme (client -- ) |
404 | =head3 addme (client -- ) |
365 | |
405 | |
366 | 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 |
367 | will not send any response. |
407 | and done by F<login.ext>. |
368 | |
408 | |
369 | =head3 reply (client replystring -- ) |
409 | =head3 reply (client replystring -- ) |
370 | |
410 | |
371 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
411 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
372 | handled internally by language plugins. |
412 | handled internally by language plugins. |