| … | |
… | |
| 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 | |
| 7 | =head2 NOTATION |
7 | =head2 NOTATION |
| 8 | |
8 | |
| 9 | the event description below uses a variant of the forth stack notation - |
9 | The event description below uses a variant of the forth stack notation - |
| 10 | an opening parenthesis followed by the type of each parameter, optionally |
10 | an opening parenthesis followed by the type of each parameter, optionally |
| 11 | followed by two dashes and the returning parameters. If the latter is |
11 | 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 |
12 | missing, the event will be invoked but cannot change wether the event gets |
| 13 | processed. |
13 | processed. |
| 14 | |
14 | |
| 15 | If it is specified (even if no return values are supported), a plug-in |
15 | 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, |
16 | 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 |
17 | tell the caller that it wants to override normal processing. |
| 18 | player BIRTH event, nothing much will happen with respect to the built-in |
18 | |
|
|
19 | Even if no return values are supported, a plug-in can override (e.g. using |
|
|
20 | C<cf::override> in Perl) event processing, basically short-circuiting |
|
|
21 | it. For example, if you override from within a player BIRTH event, |
|
|
22 | 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 |
23 | 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). |
24 | (presumably your plug-in took care of it). |
| 21 | |
25 | |
| 22 | |
26 | |
| 23 | =head2 ATTACHABLE EVENTS |
27 | =head2 ATTACHABLE EVENTS |
| 24 | |
28 | |
| 25 | No time to document this, screw me. |
29 | No time to document this, screw me. |
| … | |
… | |
| 186 | damage that has been dealt. |
190 | damage that has been dealt. |
| 187 | |
191 | |
| 188 | =head3 skill_attack (attacker victim message skill -- success) |
192 | =head3 skill_attack (attacker victim message skill -- success) |
| 189 | |
193 | |
| 190 | Invoked whenever an B<attacker> attacks B<victim> using a B<skill> (skill |
194 | Invoked whenever an B<attacker> attacks B<victim> using a B<skill> (skill |
| 191 | cna be C<undef>). B<message> is the message that describes the attack when |
195 | can be C<undef>). B<message> is the message that describes the attack when |
| 192 | damage is done. |
196 | damage is done. |
| 193 | |
197 | |
| 194 | =head3 weapon_attack (weapon hitter victim) |
198 | =head3 weapon_attack (weapon hitter victim) |
| 195 | |
199 | |
| 196 | Invoked whenever an object is used as a B<weapon> by B<hitter> to attack |
200 | Invoked whenever an object is used as a B<weapon> by B<hitter> to attack |
| … | |
… | |
| 220 | |
224 | |
| 221 | Invoked whenever a container gets closed. When overriden, the container |
225 | 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 |
226 | 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 |
227 | is not crash-safe, i.e. containers might be closed due to a server crash |
| 224 | without this event being invoked. |
228 | without this event being invoked. |
|
|
229 | |
|
|
230 | =head3 blocked_move (self who -- do_blocked) |
|
|
231 | |
|
|
232 | Invoked when an C<who> tries to move to the same space as C<self>, |
|
|
233 | C<self>'s C<move_block> causes blocked movement for C<who> and nothing |
|
|
234 | else explicitly allows movement to this space. |
|
|
235 | |
|
|
236 | Should return true when C<who> is blocked, i.e., should not be allowed to |
|
|
237 | move onto C<self>. |
|
|
238 | |
|
|
239 | When not overriding, normal blocked_move (blocked_link) processing will |
|
|
240 | happen. |
| 225 | |
241 | |
| 226 | |
242 | |
| 227 | =head2 GLOBAL EVENTS |
243 | =head2 GLOBAL EVENTS |
| 228 | |
244 | |
| 229 | Global events have no relation to specific objects. |
245 | Global events have no relation to specific objects. |
