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 |
… | |
… | |
143 | Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, |
143 | 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' |
144 | 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 |
145 | (if it is a player) an indication of whats wrong. Must return true if the |
146 | object was freed. |
146 | object was freed. |
147 | |
147 | |
148 | =head3 use_skill (skill who part direction strignarg -- ) |
148 | =head3 use_skill (skill who part direction stringarg -- ) |
149 | |
149 | |
150 | Invoked whenever a skill is used by somebody or something. |
150 | Invoked whenever a skill is used by somebody or something. |
151 | |
151 | |
152 | =head3 cast_spell (spell casting_object owner direction stringarg -- ) |
152 | =head3 cast_spell (spell owner casting_object direction stringarg -- ) |
153 | |
153 | |
154 | Invoked whenever a given spell is cast by B<casting_object> (used by |
154 | Invoked whenever a given spell is cast by B<casting_object> (used by |
155 | B<owner>). |
155 | B<owner>). |
156 | |
156 | |
157 | =head3 drop (object who -- ) |
157 | =head3 drop (object who -- ) |
… | |
… | |
203 | |
203 | |
204 | Invoked whenever a trap-like B<object> has been activated, usually by |
204 | 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, |
205 | moving onto it. This includes not just traps, but also buttons, holes, |
206 | signs and similar stuff. |
206 | signs and similar stuff. |
207 | |
207 | |
|
|
208 | =head3 open (container who -- ) |
|
|
209 | |
|
|
210 | Invoked whenever a container gets opened. When overriden, the container will not |
|
|
211 | get opened, but you must tell op about the reason. |
|
|
212 | |
208 | =head3 close (container who -- ) |
213 | =head3 close (container who -- ) |
209 | |
214 | |
210 | Invoked whenever a container gets closed (this event is not yet reliable!). |
215 | Invoked whenever a container gets closed. When overriden, the container |
|
|
216 | will not get closed, but you must tell op about the reason. This event |
|
|
217 | is not crash-safe, i.e. containers might be closed due to a server crash |
|
|
218 | without this event being invoked. |
211 | |
219 | |
212 | |
220 | |
213 | =head2 GLOBAL EVENTS |
221 | =head2 GLOBAL EVENTS |
214 | |
222 | |
215 | Global events have no relation to specific objects. |
223 | Global events have no relation to specific objects. |
216 | |
224 | |
217 | =head3 cleanup () |
225 | =head3 cleanup () |
218 | |
226 | |
219 | Called when the server is cleaning up, just before it calls exit. |
227 | Called when the server is cleaning up, just before it calls exit. |
220 | |
228 | |
221 | =head3 clock ( ) |
229 | =head3 clock () |
222 | |
230 | |
223 | Is invoked on every server tick, usually every 0.12 seconds. |
231 | Is invoked on every server tick, usually every 0.12 seconds. |
224 | |
232 | |
|
|
233 | =head3 resource_update () |
|
|
234 | |
|
|
235 | Is invoked after each time the server reloads its resources, which is |
|
|
236 | usually one of the earliest things it does when starting up. |
|
|
237 | |
225 | |
238 | |
226 | =head2 PLAYER EVENTS |
239 | =head2 PLAYER EVENTS |
227 | |
240 | |
228 | Player events always have a player object as first argument. |
241 | Player events always have a player object as first argument. |
229 | |
242 | |
… | |
… | |
235 | |
248 | |
236 | Invoked wheneever a player quits, before actually removing him/her. |
249 | Invoked wheneever a player quits, before actually removing him/her. |
237 | |
250 | |
238 | =head3 kick (player params -- ) |
251 | =head3 kick (player params -- ) |
239 | |
252 | |
240 | Invoked when the given plaer is being kicked, before the kick is executed. |
253 | Invoked when the given player is being kicked, before the kick is |
|
|
254 | executed. |
241 | |
255 | |
242 | =head3 load (player) |
256 | =head3 load (player -- ) |
243 | |
257 | |
244 | Invoked whenever a player has been loaded from disk, but before |
258 | Invoked whenever a player has been loaded from disk, but before |
245 | actual login. |
259 | actual login. |
246 | |
260 | |
247 | =head3 save (player path -- ) |
261 | =head3 save (player -- ) |
248 | |
262 | |
249 | Invoked just before a player gets saved. |
263 | Invoked just before a player gets serialised. |
250 | |
264 | |
251 | =head3 save_done (player path -- ) |
265 | =head3 save_done (player -- ) |
252 | |
266 | |
253 | Invoked just after a player was saved. |
267 | Invoked just after a player was serialised. |
254 | |
268 | |
255 | =head3 connect (player -- ) |
269 | =head3 connect (player -- ) |
256 | |
270 | |
257 | Invoked just after the player object was connected to a client. |
271 | Invoked just after the player object was connected to a client. |
258 | |
272 | |
… | |
… | |
262 | |
276 | |
263 | =head3 login (player) |
277 | =head3 login (player) |
264 | |
278 | |
265 | Invoked whenever a player logs in. |
279 | Invoked whenever a player logs in. |
266 | |
280 | |
267 | =head3 logout (player) |
281 | =head3 logout (player cleanly -- ) |
268 | |
282 | |
269 | Invoked whenever a player logs out, gets disconnected etc. |
283 | Invoked whenever a player logs out, gets disconnected etc. |
270 | |
284 | |
271 | =head3 death (player) |
285 | =head3 death (player) |
272 | |
286 | |
273 | Invoked whenever a player dies, before the death actually gets processed. |
287 | Invoked whenever a player dies, before the death actually gets processed. |
274 | |
288 | |
275 | =head3 map_change (player newmap x y -- ) |
289 | =head3 map_change (player newmap x y -- ) |
276 | |
290 | |
277 | Invoked before a player moves from one map to another, can override the movement. |
291 | Invoked before a player moves from one map to another, can override the movement. |
|
|
292 | |
|
|
293 | =head3 region_change (player newregion oldregion -- ) |
|
|
294 | |
|
|
295 | Invoked when a player entered a new region. Cannot be overriden. |
278 | |
296 | |
279 | =head3 command (player command args -- time) |
297 | =head3 command (player command args -- time) |
280 | |
298 | |
281 | Execute a user command send by the client. Programmable plug-ins usually |
299 | Execute a user command send by the client. Programmable plug-ins usually |
282 | handle this event internally. |
300 | handle this event internally. |
… | |
… | |
286 | Invoked whenever a client issues the C<extcmd> protocol command. |
304 | Invoked whenever a client issues the C<extcmd> protocol command. |
287 | Programmable plug-ins usually handle this event internally. |
305 | Programmable plug-ins usually handle this event internally. |
288 | |
306 | |
289 | =head3 move (player direction -- ) |
307 | =head3 move (player direction -- ) |
290 | |
308 | |
|
|
309 | Called whenever the player is supposed to move or attack. The handler |
|
|
310 | must handle the cases of speed_left or weapon_sp_left being negative, |
|
|
311 | fire being on, is responsible for decreaseing the speed_left value |
|
|
312 | on successful moves etc. etc.. When overriden, must return a boolean |
|
|
313 | indicating wether a move could be effected. |
|
|
314 | |
291 | =head3 pray_altar (player altar skill -- ) |
315 | =head3 pray_altar (player altar skill -- ) |
292 | |
316 | |
293 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
317 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
294 | |
318 | |
295 | =head3 tell (player name message -- ) |
319 | =head3 tell (player name message -- ) |
296 | |
320 | |
297 | Invoked whenever the player uses the B<tell> or B<reply> command, before |
321 | Invoked whenever the player uses the B<tell> or B<reply> command, before |
298 | it gets processed. |
322 | it gets processed. |
|
|
323 | |
|
|
324 | =head3 told (player player message -- ) |
|
|
325 | |
|
|
326 | Invoked right before a message is being told to a player using B<tell> or |
|
|
327 | B<reply>. |
299 | |
328 | |
300 | =head3 say (player message --) |
329 | =head3 say (player message --) |
301 | |
330 | |
302 | =head3 chat (player message --) |
331 | =head3 chat (player message --) |
303 | |
332 | |
… | |
… | |
359 | =head3 connect (client -- ) |
388 | =head3 connect (client -- ) |
360 | |
389 | |
361 | Called as soon as a new connection to the server is established. Should |
390 | Called as soon as a new connection to the server is established. Should |
362 | not be overriden. |
391 | not be overriden. |
363 | |
392 | |
|
|
393 | =head3 setup (client string -- ) |
|
|
394 | |
|
|
395 | Client sent the setup command to negotiate parameters. Handling is |
|
|
396 | mandatory and done by F<login.ext>. |
|
|
397 | |
364 | =head3 addme (client -- ) |
398 | =head3 addme (client -- ) |
365 | |
399 | |
366 | The client sent an addme, thus ending the initial handshaking. If overriden, the server |
400 | The client sent an addme, thus ending the initial handshaking. Handling is mandatory |
367 | will not send any response. |
401 | and done by F<login.ext>. |
368 | |
402 | |
369 | =head3 reply (client replystring -- ) |
403 | =head3 reply (client replystring -- ) |
370 | |
404 | |
371 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
405 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
372 | handled internally by language plugins. |
406 | handled internally by language plugins. |