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 |
191 | B<victim>. |
225 | B<victim>. |
192 | |
226 | |
193 | =head3 inscribe_note (book pl message skill -- ) |
227 | =head3 inscribe_note (book pl message skill -- ) |
194 | |
228 | |
195 | Used whenever a book gets inscribed with a message. |
229 | Used whenever a book gets inscribed with a message. |
|
|
230 | |
|
|
231 | =head3 infect (victim disease_type disease -- ) |
|
|
232 | |
|
|
233 | Invoked whenever an object is diseased. The disease object is already |
|
|
234 | inserted in object (the template disease object is C<disease_type>), |
|
|
235 | but no messages have been generated. If overriden, no messages will be |
|
|
236 | generated. |
196 | |
237 | |
197 | =head3 trigger (object who -- ) |
238 | =head3 trigger (object who -- ) |
198 | |
239 | |
199 | Invoked whenever a lever-like B<object> has been activated/triggered in some |
240 | Invoked whenever a lever-like B<object> has been activated/triggered in some |
200 | (manual) way. |
241 | (manual) way. |
… | |
… | |
215 | Invoked whenever a container gets closed. When overriden, the container |
256 | 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 |
257 | 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 |
258 | is not crash-safe, i.e. containers might be closed due to a server crash |
218 | without this event being invoked. |
259 | without this event being invoked. |
219 | |
260 | |
|
|
261 | =head3 blocked_move (self who -- do_blocked) |
|
|
262 | |
|
|
263 | Invoked when an C<who> tries to move to the same space as C<self>, |
|
|
264 | C<self>'s C<move_block> causes blocked movement for C<who> and nothing |
|
|
265 | else explicitly allows movement to this space. |
|
|
266 | |
|
|
267 | Should return true when C<who> is blocked, i.e., should not be allowed to |
|
|
268 | move onto C<self>. |
|
|
269 | |
|
|
270 | When not overriding, normal blocked_move (blocked_link) processing will |
|
|
271 | happen. |
|
|
272 | |
220 | |
273 | |
221 | =head2 GLOBAL EVENTS |
274 | =head2 GLOBAL EVENTS |
222 | |
275 | |
223 | Global events have no relation to specific objects. |
276 | Global events have no relation to specific objects. |
224 | |
277 | |
225 | =head3 cleanup () |
278 | =head3 cleanup () |
226 | |
279 | |
227 | Called when the server is cleaning up, just before it calls exit. |
280 | Called when the server is cleaning up, just before it calls exit. |
228 | |
281 | |
229 | =head3 clock ( ) |
282 | =head3 clock () |
230 | |
283 | |
231 | Is invoked on every server tick, usually every 0.12 seconds. |
284 | Is invoked on every server tick, usually every 0.12 seconds. |
|
|
285 | |
|
|
286 | =head3 resource_update () |
|
|
287 | |
|
|
288 | Is invoked after each time the server reloads its resources, which is |
|
|
289 | usually one of the earliest things it does when starting up. |
232 | |
290 | |
233 | |
291 | |
234 | =head2 PLAYER EVENTS |
292 | =head2 PLAYER EVENTS |
235 | |
293 | |
236 | Player events always have a player object as first argument. |
294 | Player events always have a player object as first argument. |
… | |
… | |
248 | Invoked when the given player is being kicked, before the kick is |
306 | Invoked when the given player is being kicked, before the kick is |
249 | executed. |
307 | executed. |
250 | |
308 | |
251 | =head3 load (player -- ) |
309 | =head3 load (player -- ) |
252 | |
310 | |
253 | Invoked whenever a player has been loaded from disk, but before |
311 | Invoked whenever after a player has been loaded from disk, but before |
254 | actual login. |
312 | actual activation/login. |
255 | |
313 | |
256 | =head3 save (player -- ) |
314 | =head3 save (player -- ) |
257 | |
315 | |
258 | Invoked just before a player gets serialised. |
316 | Invoked just before a player gets serialised. |
259 | |
317 | |
… | |
… | |
271 | |
329 | |
272 | =head3 login (player) |
330 | =head3 login (player) |
273 | |
331 | |
274 | Invoked whenever a player logs in. |
332 | Invoked whenever a player logs in. |
275 | |
333 | |
276 | =head3 logout (player) |
334 | =head3 logout (player cleanly -- ) |
277 | |
335 | |
278 | Invoked whenever a player logs out, gets disconnected etc. |
336 | Invoked whenever a player logs out, gets disconnected etc. |
279 | |
337 | |
280 | =head3 death (player) |
338 | =head3 death (player) |
281 | |
339 | |
… | |
… | |
283 | |
341 | |
284 | =head3 map_change (player newmap x y -- ) |
342 | =head3 map_change (player newmap x y -- ) |
285 | |
343 | |
286 | Invoked before a player moves from one map to another, can override the movement. |
344 | Invoked before a player moves from one map to another, can override the movement. |
287 | |
345 | |
|
|
346 | =head3 region_change (player newregion oldregion -- ) |
|
|
347 | |
|
|
348 | Invoked when a player entered a new region. Cannot be overriden. |
|
|
349 | |
288 | =head3 command (player command args -- time) |
350 | =head3 command (player command args -- time) |
289 | |
351 | |
290 | Execute a user command send by the client. Programmable plug-ins usually |
352 | Execute a user command sent by the client - this is invoked for I<all> |
291 | handle this event internally. |
353 | command,s so should not normally be hooked. |
|
|
354 | |
|
|
355 | =head3 unknown_command (player command args -- time) |
|
|
356 | |
|
|
357 | Execute a user command sent by the client that isn't known to the |
|
|
358 | server. Programmable plug-ins usually handle this event internally. |
292 | |
359 | |
293 | =head3 extcmd (player string) |
360 | =head3 extcmd (player string) |
294 | |
361 | |
295 | Invoked whenever a client issues the C<extcmd> protocol command. |
362 | Invoked whenever a client issues the C<extcmd> protocol command. |
296 | Programmable plug-ins usually handle this event internally. |
363 | Programmable plug-ins usually handle this event internally. |
297 | |
364 | |
298 | =head3 move (player direction -- ) |
365 | =head3 move (player direction -- ) |
299 | |
366 | |
|
|
367 | Called whenever the player is supposed to move or attack. The handler |
|
|
368 | must handle the cases of speed_left or weapon_sp_left being negative, |
|
|
369 | fire being on, is responsible for decreaseing the speed_left value |
|
|
370 | on successful moves etc. etc.. When overriden, must return a boolean |
|
|
371 | indicating wether a move could be effected. |
|
|
372 | |
300 | =head3 pray_altar (player altar skill -- ) |
373 | =head3 pray_altar (player altar skill -- ) |
301 | |
374 | |
302 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
375 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
303 | |
376 | |
304 | =head3 tell (player name message -- ) |
377 | =head3 tell (player name message -- ) |
… | |
… | |
317 | |
390 | |
318 | =head3 shout (player message --) |
391 | =head3 shout (player message --) |
319 | |
392 | |
320 | Invoked whenever the player uses the B<say>, B<chat> or B<shout> command, |
393 | Invoked whenever the player uses the B<say>, B<chat> or B<shout> command, |
321 | before it gets processed. |
394 | before it gets processed. |
|
|
395 | |
|
|
396 | =head3 build (player builder map x y checkok --) |
|
|
397 | |
|
|
398 | Players tries to build using C<builder> at (map+x+y). Is invoked after |
|
|
399 | the usual map sanity checks, so the coordinates are valid. The boolean |
|
|
400 | C<checkok> is true only if the build code thinks it is "ok" to build at |
|
|
401 | that space, and normally you should only build when it is true. |
322 | |
402 | |
323 | |
403 | |
324 | =head2 MAP EVENTS |
404 | =head2 MAP EVENTS |
325 | |
405 | |
326 | These events are generally dependent on a map and thus all have a map |
406 | These events are generally dependent on a map and thus all have a map |
… | |
… | |
356 | =head3 leave (map player -- ) |
436 | =head3 leave (map player -- ) |
357 | |
437 | |
358 | Invoked whenever a player tries to leave the B<map>. Overriding means the |
438 | Invoked whenever a player tries to leave the B<map>. Overriding means the |
359 | player won't be able to leave. |
439 | player won't be able to leave. |
360 | |
440 | |
361 | =head3 trigger (map connection state -- ) |
441 | =head3 trigger (map connection state what? who? -- ) |
362 | |
442 | |
363 | Invoked whenever something activates a B<connection> on the B<map>. If B<state> |
443 | Invoked whenever something activates a B<connection> on the B<map>. If B<state> |
364 | is true the connection was 'state' and if false it is 'released'. |
444 | is true the connection was 'state' and if false it is 'released'. |
365 | |
445 | |
366 | |
446 | |
… | |
… | |
370 | handled asynchronously as soon as the command reaches the server, even when |
450 | handled asynchronously as soon as the command reaches the server, even when |
371 | the player hasn't logged in yet (meaning there is no player yet). |
451 | the player hasn't logged in yet (meaning there is no player yet). |
372 | |
452 | |
373 | =head3 connect (client -- ) |
453 | =head3 connect (client -- ) |
374 | |
454 | |
375 | Called as soon as a new connection to the server is established. Should |
455 | Called as soon as a new connection to the server is established and the |
376 | not be overriden. |
456 | socket has been configured. |
|
|
457 | |
|
|
458 | =head3 version (client string -- ) |
|
|
459 | |
|
|
460 | Called as soon as the version command from the client is received |
|
|
461 | (normally the very first command sent). |
377 | |
462 | |
378 | =head3 setup (client string -- ) |
463 | =head3 setup (client string -- ) |
379 | |
464 | |
380 | Client sent the setup command to negotiate parameters. Handling is |
465 | Client sent the setup command to negotiate parameters. Handling is |
381 | mandatory and done by F<login.ext>. |
466 | mandatory and done by F<login.ext>. |
… | |
… | |
394 | |
479 | |
395 | Like C<extcmd>, but can be called before a player has logged in. |
480 | Like C<extcmd>, but can be called before a player has logged in. |
396 | |
481 | |
397 | Programmable plug-ins usually handle this event internally. |
482 | Programmable plug-ins usually handle this event internally. |
398 | |
483 | |
|
|
484 | =head3 client_destroy (client -- ) |
|
|
485 | |
|
|
486 | Invoked when the client gets destroyed. |
|
|
487 | |
|
|
488 | |