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 | |
… | |
… | |
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 | |
… | |
… | |
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 |
… | |
… | |
215 | Invoked whenever a container gets closed. When overriden, the container |
249 | 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 |
250 | 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 |
251 | is not crash-safe, i.e. containers might be closed due to a server crash |
218 | without this event being invoked. |
252 | without this event being invoked. |
219 | |
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. |
|
|
265 | |
220 | |
266 | |
221 | =head2 GLOBAL EVENTS |
267 | =head2 GLOBAL EVENTS |
222 | |
268 | |
223 | Global events have no relation to specific objects. |
269 | Global events have no relation to specific objects. |
224 | |
270 | |
225 | =head3 cleanup () |
271 | =head3 cleanup () |
226 | |
272 | |
227 | 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. |
228 | |
274 | |
229 | =head3 clock ( ) |
275 | =head3 clock () |
230 | |
276 | |
231 | Is invoked on every server tick, usually every 0.12 seconds. |
277 | Is invoked on every server tick, usually every 0.12 seconds. |
|
|
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. |
232 | |
283 | |
233 | |
284 | |
234 | =head2 PLAYER EVENTS |
285 | =head2 PLAYER EVENTS |
235 | |
286 | |
236 | Player events always have a player object as first argument. |
287 | Player events always have a player object as first argument. |
… | |
… | |
328 | =head3 shout (player message --) |
379 | =head3 shout (player message --) |
329 | |
380 | |
330 | Invoked whenever the player uses the B<say>, B<chat> or B<shout> command, |
381 | Invoked whenever the player uses the B<say>, B<chat> or B<shout> command, |
331 | before it gets processed. |
382 | before it gets processed. |
332 | |
383 | |
|
|
384 | =head3 build (player x y builder --) |
|
|
385 | |
|
|
386 | Players tries to build at (x|y), using C<builder>. |
|
|
387 | |
333 | |
388 | |
334 | =head2 MAP EVENTS |
389 | =head2 MAP EVENTS |
335 | |
390 | |
336 | These events are generally dependent on a map and thus all have a map |
391 | These events are generally dependent on a map and thus all have a map |
337 | as first argument. |
392 | as first argument. |
… | |
… | |
366 | =head3 leave (map player -- ) |
421 | =head3 leave (map player -- ) |
367 | |
422 | |
368 | Invoked whenever a player tries to leave the B<map>. Overriding means the |
423 | Invoked whenever a player tries to leave the B<map>. Overriding means the |
369 | player won't be able to leave. |
424 | player won't be able to leave. |
370 | |
425 | |
371 | =head3 trigger (map connection state -- ) |
426 | =head3 trigger (map connection state what? who? -- ) |
372 | |
427 | |
373 | Invoked whenever something activates a B<connection> on the B<map>. If B<state> |
428 | Invoked whenever something activates a B<connection> on the B<map>. If B<state> |
374 | is true the connection was 'state' and if false it is 'released'. |
429 | is true the connection was 'state' and if false it is 'released'. |
375 | |
430 | |
376 | |
431 | |