1 | =head1 CROSSFIRE+ PLUG-IN EVENTS |
1 | =begin comment |
|
|
2 | |
|
|
3 | This file is part of Deliantra, the Roguelike Realtime MMORPG. |
|
|
4 | |
|
|
5 | Copyright (©) 2005,2006,2007,2008,2009 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
|
|
6 | |
|
|
7 | Deliantra is free software: you can redistribute it and/or modify it under |
|
|
8 | the terms of the Affero GNU General Public License as published by the |
|
|
9 | Free Software Foundation, either version 3 of the License, or (at your |
|
|
10 | option) any later version. |
|
|
11 | |
|
|
12 | This program is distributed in the hope that it will be useful, |
|
|
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
|
15 | GNU General Public License for more details. |
|
|
16 | |
|
|
17 | You should have received a copy of the Affero GNU General Public License |
|
|
18 | and the GNU General Public License along with this program. If not, see |
|
|
19 | <http://www.gnu.org/licenses/>. |
|
|
20 | |
|
|
21 | The authors can be reached via e-mail to <support@deliantra.net> |
|
|
22 | |
|
|
23 | =end comment |
|
|
24 | |
|
|
25 | =head1 DELIANTRA PLUG-IN EVENTS |
2 | |
26 | |
3 | This document briefly describes each plug-in event. It is also used to |
27 | 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 |
28 | generate the event-list itself, so is always complete. Be careful wehn |
5 | changing it, though. |
29 | changing it, though. |
6 | |
30 | |
7 | =head2 NOTATION |
31 | =head2 NOTATION |
8 | |
32 | |
9 | the event description below uses a variant of the forth stack notation - |
33 | The event description below uses a variant of the forth stack notation - |
10 | an opening parenthesis followed by the type of each parameter, optionally |
34 | an opening parenthesis followed by the type of each parameter, optionally |
11 | followed by two dashes and the returning parameters. If the latter is |
35 | followed by two dashes and the returning parameters. If the latter part is |
12 | missing, the event will be invoked but cannot change wether the event gets |
36 | missing, the event will be invoked but cannot change wether the event gets |
13 | processed. |
37 | processed. |
14 | |
38 | |
15 | If it is specified (even if no return values are supported), a plug-in |
39 | Return values are given by overriding (in Perl by calling C<cf::override>) |
16 | can override (e.g. using C<cf::override> in Perl) event processing, |
40 | with the return values, which will both stop further event processing and |
17 | basically short-circuiting it. For example, if you override from within a |
41 | tell the caller that it wants to override normal processing. |
18 | player BIRTH event, nothing much will happen with respect to the built-in |
42 | |
|
|
43 | Even if no return values are supported, a plug-in can override (e.g. using |
|
|
44 | C<cf::override> in Perl) event processing, basically short-circuiting |
|
|
45 | it. For example, if you override from within a player BIRTH event, |
|
|
46 | nothing much will happen with respect to the built-in processing, but if |
19 | processing, but if you override from within a player TELL event, the tell |
47 | you override from within a player TELL event, the tell will be ignored |
20 | will be ignored (presumably your plug-in took care of it). |
48 | (presumably your plug-in took care of it). |
21 | |
49 | |
22 | |
50 | |
23 | =head2 ATTACHABLE EVENTS |
51 | =head2 ATTACHABLE EVENTS |
24 | |
52 | |
25 | No time to document this, screw me. |
53 | No time to document this, screw me. |
… | |
… | |
50 | instances). If this is not the behaviour you need, you have to adjust the |
78 | instances). If this is not the behaviour you need, you have to adjust the |
51 | B<destination> object as you see fit. |
79 | B<destination> object as you see fit. |
52 | |
80 | |
53 | =head3 destroy (object -- ) |
81 | =head3 destroy (object -- ) |
54 | |
82 | |
55 | Invoked when the crossfire object gets destroyed, and only when the object |
83 | 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 |
84 | 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 |
85 | called when the in-memory object is destroyed, not when the object itself |
58 | dies. |
86 | dies. |
59 | |
87 | |
60 | |
88 | |
… | |
… | |
62 | |
90 | |
63 | Object events always relate to a specific object, which is always the |
91 | 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 |
92 | first argument. Not all events get generated for every object, some are |
65 | specific to an object type. |
93 | specific to an object type. |
66 | |
94 | |
67 | =head3 add_bonus (item creator difficulty max_magic flags) |
95 | =head3 add_bonus (item creator difficulty max_magic flags -- ) |
68 | |
96 | |
69 | A basic item has been created (e.g. for shops, monsters drops etc.) |
97 | 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 |
98 | 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 |
99 | 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 |
100 | combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP |
… | |
… | |
91 | Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only |
119 | 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. |
120 | during ticks should an objetc process any movement or other events. |
93 | |
121 | |
94 | =head3 kill (object hitter -- ) |
122 | =head3 kill (object hitter -- ) |
95 | |
123 | |
96 | Invoked whenever an object is dead and about to get removed. Overriding |
124 | 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 |
125 | about to get removed. Overriding processing will skip removal, but to do |
98 | objetc from dieing, otherwise the event gets invoked again and again. |
126 | this successfully you have to keep the object from dieing, otherwise the |
|
|
127 | event gets invoked again and again. |
99 | |
128 | |
100 | =head3 apply (object who -- applytype) |
129 | =head3 apply (object who -- applytype) |
101 | |
130 | |
102 | Invoked whenever the object is being applied in some way. The applytype is one of: |
131 | Invoked whenever the object is being applied in some way. The applytype is one of: |
103 | |
132 | |
… | |
… | |
108 | =item B<1> has been applied, or there was an error applying the object |
137 | =item B<1> has been applied, or there was an error applying the object |
109 | |
138 | |
110 | =item B<2> objects of that type can't be applied if not in inventory |
139 | =item B<2> objects of that type can't be applied if not in inventory |
111 | |
140 | |
112 | =back |
141 | =back |
|
|
142 | |
|
|
143 | =head3 reset (object) |
|
|
144 | |
|
|
145 | Invoked whenever the object is initialised on a map after it was |
|
|
146 | loaded. This can be used to emulate shop-floor behaviour for example. |
113 | |
147 | |
114 | =head3 throw (object thrower) |
148 | =head3 throw (object thrower) |
115 | |
149 | |
116 | Invoked when an B<object> is thrown by B<thrower>. |
150 | Invoked when an B<object> is thrown by B<thrower>. |
117 | |
151 | |
… | |
… | |
143 | Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, |
177 | 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' |
178 | 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 |
179 | (if it is a player) an indication of whats wrong. Must return true if the |
146 | object was freed. |
180 | object was freed. |
147 | |
181 | |
148 | =head3 use_skill (skill who part direction strignarg -- ) |
182 | =head3 use_skill (skill who part direction stringarg -- ) |
149 | |
183 | |
150 | Invoked whenever a skill is used by somebody or something. |
184 | Invoked whenever a skill is used by somebody or something. |
151 | |
185 | |
152 | =head3 cast_spell (spell casting_object owner direction stringarg -- ) |
186 | =head3 cast_spell (spell owner casting_object direction stringarg -- ) |
153 | |
187 | |
154 | Invoked whenever a given spell is cast by B<casting_object> (used by |
188 | Invoked whenever a given spell is cast by B<casting_object> (used by |
155 | B<owner>). |
189 | B<owner>). |
156 | |
190 | |
157 | =head3 drop (object who -- ) |
191 | =head3 drop (object who -- ) |
… | |
… | |
180 | damage that has been dealt. |
214 | damage that has been dealt. |
181 | |
215 | |
182 | =head3 skill_attack (attacker victim message skill -- success) |
216 | =head3 skill_attack (attacker victim message skill -- success) |
183 | |
217 | |
184 | Invoked whenever an B<attacker> attacks B<victim> using a B<skill> (skill |
218 | Invoked whenever an B<attacker> attacks B<victim> using a B<skill> (skill |
185 | cna be C<undef>). B<message> is the message that describes the attack when |
219 | can be C<undef>). B<message> is the message that describes the attack when |
186 | damage is done. |
220 | damage is done. |
187 | |
221 | |
188 | =head3 weapon_attack (weapon hitter victim) |
222 | =head3 weapon_attack (weapon hitter victim) |
189 | |
223 | |
190 | Invoked whenever an object is used as a B<weapon> by B<hitter> to attack |
224 | Invoked whenever an object is used as a B<weapon> by B<hitter> to attack |
… | |
… | |
203 | |
237 | |
204 | Invoked whenever a trap-like B<object> has been activated, usually by |
238 | 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, |
239 | moving onto it. This includes not just traps, but also buttons, holes, |
206 | signs and similar stuff. |
240 | signs and similar stuff. |
207 | |
241 | |
|
|
242 | =head3 open (container who -- ) |
|
|
243 | |
|
|
244 | Invoked whenever a container gets opened. When overriden, the container will not |
|
|
245 | get opened, but you must tell op about the reason. |
|
|
246 | |
208 | =head3 close (container who -- ) |
247 | =head3 close (container who -- ) |
209 | |
248 | |
210 | Invoked whenever a container gets closed (this event is not yet reliable!). |
249 | Invoked whenever a container gets closed. When overriden, the container |
|
|
250 | will not get closed, but you must tell op about the reason. This event |
|
|
251 | is not crash-safe, i.e. containers might be closed due to a server crash |
|
|
252 | without this event being invoked. |
|
|
253 | |
|
|
254 | =head3 blocked_move (self who -- do_blocked) |
|
|
255 | |
|
|
256 | Invoked when an C<who> tries to move to the same space as C<self>, |
|
|
257 | C<self>'s C<move_block> causes blocked movement for C<who> and nothing |
|
|
258 | else explicitly allows movement to this space. |
|
|
259 | |
|
|
260 | Should return true when C<who> is blocked, i.e., should not be allowed to |
|
|
261 | move onto C<self>. |
|
|
262 | |
|
|
263 | When not overriding, normal blocked_move (blocked_link) processing will |
|
|
264 | happen. |
211 | |
265 | |
212 | |
266 | |
213 | =head2 GLOBAL EVENTS |
267 | =head2 GLOBAL EVENTS |
214 | |
268 | |
215 | Global events have no relation to specific objects. |
269 | Global events have no relation to specific objects. |
216 | |
270 | |
217 | =head3 cleanup () |
271 | =head3 cleanup () |
218 | |
272 | |
219 | Called when the server is cleaning up, just before it calls exit. |
273 | Called when the server is cleaning up, just before it calls exit. |
220 | |
274 | |
221 | =head3 clock ( ) |
275 | =head3 clock () |
222 | |
276 | |
223 | Is invoked on every server tick, usually every 0.12 seconds. |
277 | Is invoked on every server tick, usually every 0.12 seconds. |
224 | |
278 | |
|
|
279 | =head3 resource_update () |
|
|
280 | |
|
|
281 | Is invoked after each time the server reloads its resources, which is |
|
|
282 | usually one of the earliest things it does when starting up. |
|
|
283 | |
225 | |
284 | |
226 | =head2 PLAYER EVENTS |
285 | =head2 PLAYER EVENTS |
227 | |
286 | |
228 | Player events always have a player object as first argument. |
287 | Player events always have a player object as first argument. |
229 | |
288 | |
… | |
… | |
235 | |
294 | |
236 | Invoked wheneever a player quits, before actually removing him/her. |
295 | Invoked wheneever a player quits, before actually removing him/her. |
237 | |
296 | |
238 | =head3 kick (player params -- ) |
297 | =head3 kick (player params -- ) |
239 | |
298 | |
240 | Invoked when the given plaer is being kicked, before the kick is executed. |
299 | Invoked when the given player is being kicked, before the kick is |
|
|
300 | executed. |
241 | |
301 | |
242 | =head3 load (player) |
302 | =head3 load (player -- ) |
243 | |
303 | |
244 | Invoked whenever a player has been loaded from disk, but before |
304 | Invoked whenever a player has been loaded from disk, but before |
245 | actual login. |
305 | actual login. |
246 | |
306 | |
247 | =head3 save (player path -- ) |
307 | =head3 save (player -- ) |
248 | |
308 | |
249 | Invoked just before a player gets saved. |
309 | Invoked just before a player gets serialised. |
250 | |
310 | |
251 | =head3 save_done (player path -- ) |
311 | =head3 save_done (player -- ) |
252 | |
312 | |
253 | Invoked just after a player was saved. |
313 | Invoked just after a player was serialised. |
254 | |
314 | |
255 | =head3 connect (player -- ) |
315 | =head3 connect (player -- ) |
256 | |
316 | |
257 | Invoked just after the player object was connected to a client. |
317 | Invoked just after the player object was connected to a client. |
258 | |
318 | |
… | |
… | |
262 | |
322 | |
263 | =head3 login (player) |
323 | =head3 login (player) |
264 | |
324 | |
265 | Invoked whenever a player logs in. |
325 | Invoked whenever a player logs in. |
266 | |
326 | |
267 | =head3 logout (player) |
327 | =head3 logout (player cleanly -- ) |
268 | |
328 | |
269 | Invoked whenever a player logs out, gets disconnected etc. |
329 | Invoked whenever a player logs out, gets disconnected etc. |
270 | |
330 | |
271 | =head3 death (player) |
331 | =head3 death (player) |
272 | |
332 | |
… | |
… | |
274 | |
334 | |
275 | =head3 map_change (player newmap x y -- ) |
335 | =head3 map_change (player newmap x y -- ) |
276 | |
336 | |
277 | Invoked before a player moves from one map to another, can override the movement. |
337 | Invoked before a player moves from one map to another, can override the movement. |
278 | |
338 | |
|
|
339 | =head3 region_change (player newregion oldregion -- ) |
|
|
340 | |
|
|
341 | Invoked when a player entered a new region. Cannot be overriden. |
|
|
342 | |
279 | =head3 command (player command args -- time) |
343 | =head3 command (player command args -- time) |
280 | |
344 | |
281 | Execute a user command send by the client. Programmable plug-ins usually |
345 | Execute a user command sent by the client - this is invoked for I<all> |
282 | handle this event internally. |
346 | command,s so should not normally be hooked. |
|
|
347 | |
|
|
348 | =head3 unknown_command (player command args -- time) |
|
|
349 | |
|
|
350 | Execute a user command sent by the client that isn't known to the |
|
|
351 | server. Programmable plug-ins usually handle this event internally. |
283 | |
352 | |
284 | =head3 extcmd (player string) |
353 | =head3 extcmd (player string) |
285 | |
354 | |
286 | Invoked whenever a client issues the C<extcmd> protocol command. |
355 | Invoked whenever a client issues the C<extcmd> protocol command. |
287 | Programmable plug-ins usually handle this event internally. |
356 | Programmable plug-ins usually handle this event internally. |
288 | |
357 | |
289 | =head3 move (player direction -- ) |
358 | =head3 move (player direction -- ) |
290 | |
359 | |
|
|
360 | Called whenever the player is supposed to move or attack. The handler |
|
|
361 | must handle the cases of speed_left or weapon_sp_left being negative, |
|
|
362 | fire being on, is responsible for decreaseing the speed_left value |
|
|
363 | on successful moves etc. etc.. When overriden, must return a boolean |
|
|
364 | indicating wether a move could be effected. |
|
|
365 | |
291 | =head3 pray_altar (player altar skill -- ) |
366 | =head3 pray_altar (player altar skill -- ) |
292 | |
367 | |
293 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
368 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
294 | |
369 | |
295 | =head3 tell (player name message -- ) |
370 | =head3 tell (player name message -- ) |
296 | |
371 | |
297 | Invoked whenever the player uses the B<tell> or B<reply> command, before |
372 | Invoked whenever the player uses the B<tell> or B<reply> command, before |
298 | it gets processed. |
373 | it gets processed. |
299 | |
374 | |
|
|
375 | =head3 told (player player message -- ) |
|
|
376 | |
|
|
377 | Invoked right before a message is being told to a player using B<tell> or |
|
|
378 | B<reply>. |
|
|
379 | |
300 | =head3 say (player message --) |
380 | =head3 say (player message --) |
301 | |
381 | |
302 | =head3 chat (player message --) |
382 | =head3 chat (player message --) |
303 | |
383 | |
304 | =head3 shout (player message --) |
384 | =head3 shout (player message --) |
305 | |
385 | |
306 | Invoked whenever the player uses the B<say>, B<chat> or B<shout> command, |
386 | Invoked whenever the player uses the B<say>, B<chat> or B<shout> command, |
307 | before it gets processed. |
387 | before it gets processed. |
|
|
388 | |
|
|
389 | =head3 build (player builder map x y --) |
|
|
390 | |
|
|
391 | Players tries to build using C<builder> at (map+x+y). Is invoked after the |
|
|
392 | usual sanity checks, so the coordinates are valid. |
308 | |
393 | |
309 | |
394 | |
310 | =head2 MAP EVENTS |
395 | =head2 MAP EVENTS |
311 | |
396 | |
312 | These events are generally dependent on a map and thus all have a map |
397 | These events are generally dependent on a map and thus all have a map |
… | |
… | |
342 | =head3 leave (map player -- ) |
427 | =head3 leave (map player -- ) |
343 | |
428 | |
344 | Invoked whenever a player tries to leave the B<map>. Overriding means the |
429 | Invoked whenever a player tries to leave the B<map>. Overriding means the |
345 | player won't be able to leave. |
430 | player won't be able to leave. |
346 | |
431 | |
347 | =head3 trigger (map connection state -- ) |
432 | =head3 trigger (map connection state what? who? -- ) |
348 | |
433 | |
349 | Invoked whenever something activates a B<connection> on the B<map>. If B<state> |
434 | 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'. |
435 | is true the connection was 'state' and if false it is 'released'. |
351 | |
436 | |
352 | |
437 | |
… | |
… | |
359 | =head3 connect (client -- ) |
444 | =head3 connect (client -- ) |
360 | |
445 | |
361 | Called as soon as a new connection to the server is established. Should |
446 | Called as soon as a new connection to the server is established. Should |
362 | not be overriden. |
447 | not be overriden. |
363 | |
448 | |
|
|
449 | =head3 setup (client string -- ) |
|
|
450 | |
|
|
451 | Client sent the setup command to negotiate parameters. Handling is |
|
|
452 | mandatory and done by F<login.ext>. |
|
|
453 | |
364 | =head3 addme (client -- ) |
454 | =head3 addme (client -- ) |
365 | |
455 | |
366 | The client sent an addme, thus ending the initial handshaking. If overriden, the server |
456 | The client sent an addme, thus ending the initial handshaking. Handling is mandatory |
367 | will not send any response. |
457 | and done by F<login.ext>. |
368 | |
458 | |
369 | =head3 reply (client replystring -- ) |
459 | =head3 reply (client replystring -- ) |
370 | |
460 | |
371 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
461 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
372 | handled internally by language plugins. |
462 | handled internally by language plugins. |
… | |
… | |
375 | |
465 | |
376 | Like C<extcmd>, but can be called before a player has logged in. |
466 | Like C<extcmd>, but can be called before a player has logged in. |
377 | |
467 | |
378 | Programmable plug-ins usually handle this event internally. |
468 | Programmable plug-ins usually handle this event internally. |
379 | |
469 | |
|
|
470 | =head3 client_destroy (client -- ) |
|
|
471 | |
|
|
472 | Invoked when the client gets destroyed. |
|
|
473 | |
|
|
474 | |