… | |
… | |
18 | player BIRTH event, nothing much will happen with respect to the built-in |
18 | player BIRTH event, nothing much will happen with respect to the built-in |
19 | processing, but if you override from within a player TELL event, the tell |
19 | processing, but if you override from within a player TELL event, the tell |
20 | will be ignored (presumably your plug-in took care of it). |
20 | will be ignored (presumably your plug-in took care of it). |
21 | |
21 | |
22 | |
22 | |
23 | =head2 OBJECT EVENTS |
23 | =head2 ATTACHABLE EVENTS |
24 | |
24 | |
25 | Object events always relate to a specific object, which is always the |
25 | No time to document this, screw me. |
26 | first argument. Not all events get generated for every object, some are |
|
|
27 | specific to an object type. |
|
|
28 | |
26 | |
29 | =head3 instantiate (object init-args...) |
27 | =head3 instantiate (object init-args...) |
30 | |
28 | |
31 | An archetype was instantiated into an object. This event occurs when |
29 | An object was instantiated. |
32 | a map is loaded for the first time, or when the object was created |
30 | |
|
|
31 | For objects, this event occurs when a map is loaded for the first time |
|
|
32 | when it was instantiated from an archetype, or when the object was created |
33 | dynamically. The arguments are as specified in the C<attach> attribute of |
33 | dynamically. The arguments are as specified in the C<attach> attribute of |
34 | the object or archetype. |
34 | the object or archetype. |
35 | |
35 | |
36 | This is useful to initialise any per-object state you might need. |
36 | This is useful to initialise any per-object state you might need. |
37 | |
37 | |
… | |
… | |
42 | server was reloaded. This event will only be generated if the object has |
42 | server was reloaded. This event will only be generated if the object has |
43 | attachments. |
43 | attachments. |
44 | |
44 | |
45 | =head3 clone (object destination) |
45 | =head3 clone (object destination) |
46 | |
46 | |
47 | An object with _attached extension_ is cloned, that is, a copy was |
47 | An object with _attached plugin_ is cloned, that is, a copy was made. The |
48 | made. The copy automatically has all attachments the original object |
48 | copy automatically has all attachments the original object had. The perl |
49 | had. The perl variables get copied in a shallow way (references are shared |
49 | variables get copied in a shallow way (references are shared between |
50 | between instances). If this is not the behaviour you need, you have to |
50 | instances). If this is not the behaviour you need, you have to adjust the |
51 | adjust the B<destination> object as you see fit. |
51 | B<destination> object as you see fit. |
|
|
52 | |
|
|
53 | =head3 destroy (object -- ) |
|
|
54 | |
|
|
55 | Invoked when the crossfire object gets destroyed, and only when the object |
|
|
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 |
|
|
58 | dies. |
|
|
59 | |
|
|
60 | |
|
|
61 | =head2 OBJECT EVENTS |
|
|
62 | |
|
|
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 |
|
|
65 | specific to an object type. |
52 | |
66 | |
53 | =head3 add_bonus (item creator difficulty max_magic flags) |
67 | =head3 add_bonus (item creator difficulty max_magic flags) |
54 | |
68 | |
55 | 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.) |
56 | 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 |
… | |
… | |
62 | treasure generation continues as it would without this hook. |
76 | treasure generation continues as it would without this hook. |
63 | |
77 | |
64 | In general, if flags != 0 or creator != 0 you should just return and leave |
78 | In general, if flags != 0 or creator != 0 you should just return and leave |
65 | item generation to the standard code. |
79 | item generation to the standard code. |
66 | |
80 | |
67 | =head3 destroy (object) |
81 | =head3 remove (object -- ) |
68 | |
82 | |
69 | Invoked when the crossfire object gets destroyed, and only when the object |
83 | Invoked before the object is removed from its environment. |
70 | has a handler for this event. This event can occur many times, as its |
|
|
71 | called when the in-memory object is destroyed, not when the object itself |
|
|
72 | dies. |
|
|
73 | |
84 | |
|
|
85 | =head3 insert (object -- ) |
|
|
86 | |
|
|
87 | Called after the object was inserted into a container or map. |
|
|
88 | |
74 | =head3 tick (object) |
89 | =head3 tick (object -- ) |
75 | |
90 | |
76 | Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only |
91 | Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only |
77 | during ticks should an objetc process any movement or other events. |
92 | during ticks should an objetc process any movement or other events. |
78 | |
93 | |
79 | =head3 kill (object hitter -- ) |
94 | =head3 kill (object hitter -- ) |
… | |
… | |
188 | |
203 | |
189 | 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 |
190 | 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, |
191 | signs and similar stuff. |
206 | signs and similar stuff. |
192 | |
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 | |
193 | =head3 close (container who -- ) |
213 | =head3 close (container who -- ) |
194 | |
214 | |
195 | 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. |
196 | |
219 | |
197 | |
220 | |
198 | =head2 GLOBAL EVENTS |
221 | =head2 GLOBAL EVENTS |
199 | |
222 | |
200 | Global events have no relation to specific objects. |
223 | Global events have no relation to specific objects. |
… | |
… | |
210 | |
233 | |
211 | =head2 PLAYER EVENTS |
234 | =head2 PLAYER EVENTS |
212 | |
235 | |
213 | Player events always have a player object as first argument. |
236 | Player events always have a player object as first argument. |
214 | |
237 | |
215 | =head3 reattach (player) |
|
|
216 | |
|
|
217 | Invoked whenever attachments/plug-ins need to get reattached to the player |
|
|
218 | object. This usually happens when the player gets loaded from disk, or |
|
|
219 | when the server is reloaded. |
|
|
220 | |
|
|
221 | =head3 birth (player) |
238 | =head3 birth (player) |
222 | |
239 | |
223 | Invoked as very first thing after creating a player. |
240 | Invoked as very first thing after creating a player. |
224 | |
241 | |
225 | =head3 quit (player) |
242 | =head3 quit (player) |
226 | |
243 | |
227 | Invoked wheneever a player quits, before actually removing him/her. |
244 | Invoked wheneever a player quits, before actually removing him/her. |
228 | |
245 | |
229 | =head3 kick (player params -- ) |
246 | =head3 kick (player params -- ) |
230 | |
247 | |
231 | Invoked when the given plaer is being kicked, before the kick is executed. |
248 | Invoked when the given player is being kicked, before the kick is |
|
|
249 | executed. |
232 | |
250 | |
233 | =head3 load (player) |
251 | =head3 load (player -- ) |
234 | |
252 | |
235 | Invoked whenever a player has been loaded from disk, but before |
253 | Invoked whenever a player has been loaded from disk, but before |
236 | actual login. |
254 | actual login. |
237 | |
255 | |
238 | =head3 save (player) |
256 | =head3 save (player -- ) |
239 | |
257 | |
240 | Invoked just before a player gets saved. |
258 | Invoked just before a player gets serialised. |
|
|
259 | |
|
|
260 | =head3 save_done (player -- ) |
|
|
261 | |
|
|
262 | Invoked just after a player was serialised. |
|
|
263 | |
|
|
264 | =head3 connect (player -- ) |
|
|
265 | |
|
|
266 | Invoked just after the player object was connected to a client. |
|
|
267 | |
|
|
268 | =head3 disconnect (player -- ) |
|
|
269 | |
|
|
270 | Invoked just before the player gets disconnected from the client. |
241 | |
271 | |
242 | =head3 login (player) |
272 | =head3 login (player) |
243 | |
273 | |
244 | Invoked whenever a player logs in. |
274 | Invoked whenever a player logs in. |
245 | |
275 | |
… | |
… | |
274 | =head3 tell (player name message -- ) |
304 | =head3 tell (player name message -- ) |
275 | |
305 | |
276 | Invoked whenever the player uses the B<tell> or B<reply> command, before |
306 | Invoked whenever the player uses the B<tell> or B<reply> command, before |
277 | it gets processed. |
307 | it gets processed. |
278 | |
308 | |
|
|
309 | =head3 told (player player message -- ) |
|
|
310 | |
|
|
311 | Invoked right before a message is being told to a player using B<tell> or |
|
|
312 | B<reply>. |
|
|
313 | |
279 | =head3 say (player message --) |
314 | =head3 say (player message --) |
280 | |
315 | |
281 | =head3 chat (player message --) |
316 | =head3 chat (player message --) |
282 | |
317 | |
283 | =head3 shout (player message --) |
318 | =head3 shout (player message --) |
… | |
… | |
293 | |
328 | |
294 | =head3 instantiate (map) |
329 | =head3 instantiate (map) |
295 | |
330 | |
296 | Original B<map> has been loaded (e.g. on first use, or after a map |
331 | Original B<map> has been loaded (e.g. on first use, or after a map |
297 | reset). |
332 | reset). |
298 | |
|
|
299 | =head3 reattach (map) |
|
|
300 | |
|
|
301 | Invoked whenever attachments/plug-ins need to get reattached to the |
|
|
302 | B<map>. This usually happens when the map was loaded from disk, or when the |
|
|
303 | server was reloaded. |
|
|
304 | |
|
|
305 | =head3 destroy (map) |
|
|
306 | |
|
|
307 | Invoked when the map object gets destroyed, and only when the map object |
|
|
308 | has a handler for this event. This event can occur many times, as its |
|
|
309 | called when the in-memory object is destroyed, not when the object itself |
|
|
310 | dies. |
|
|
311 | |
333 | |
312 | =head3 swapin (map) |
334 | =head3 swapin (map) |
313 | |
335 | |
314 | Invoked when a previously swapped-out temporary B<map> has been loaded again. |
336 | Invoked when a previously swapped-out temporary B<map> has been loaded again. |
315 | |
337 | |
… | |
… | |
351 | =head3 connect (client -- ) |
373 | =head3 connect (client -- ) |
352 | |
374 | |
353 | Called as soon as a new connection to the server is established. Should |
375 | Called as soon as a new connection to the server is established. Should |
354 | not be overriden. |
376 | not be overriden. |
355 | |
377 | |
|
|
378 | =head3 setup (client string -- ) |
|
|
379 | |
|
|
380 | Client sent the setup command to negotiate parameters. Handling is |
|
|
381 | mandatory and done by F<login.ext>. |
|
|
382 | |
356 | =head3 addme (client -- ) |
383 | =head3 addme (client -- ) |
357 | |
384 | |
358 | The client sent an addme, thus ending the initial handshaking. If overriden, the server |
385 | The client sent an addme, thus ending the initial handshaking. Handling is mandatory |
359 | will not send any response. |
386 | and done by F<login.ext>. |
360 | |
|
|
361 | =head3 reattach (client -- ) |
|
|
362 | |
|
|
363 | Invoked whenever attachments/plug-ins need to get reattached to the |
|
|
364 | object. This usually happens when server was reloaded. This event will |
|
|
365 | only be generated if the object has attachments. |
|
|
366 | |
|
|
367 | =head3 destroy (client -- ) |
|
|
368 | |
|
|
369 | Called when the runtime wants to destroy the client structure. |
|
|
370 | |
387 | |
371 | =head3 reply (client replystring -- ) |
388 | =head3 reply (client replystring -- ) |
372 | |
389 | |
373 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
390 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
374 | handled internally by language plugins. |
391 | handled internally by language plugins. |