… | |
… | |
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 | |
52 | |
53 | =head3 destroy (object) |
53 | =head3 destroy (object -- ) |
54 | |
54 | |
55 | Invoked when the crossfire object gets destroyed, and only when the object |
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 |
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 |
57 | called when the in-memory object is destroyed, not when the object itself |
58 | dies. |
58 | dies. |
59 | |
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. |
|
|
66 | |
|
|
67 | =head3 add_bonus (item creator difficulty max_magic flags) |
|
|
68 | |
|
|
69 | 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 |
|
|
71 | 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 |
|
|
73 | on item or set its value to 0) or GT_MINIMAL (???) |
|
|
74 | |
|
|
75 | When overriden, built-in bonus generation is skipped, otherwise |
|
|
76 | treasure generation continues as it would without this hook. |
|
|
77 | |
|
|
78 | In general, if flags != 0 or creator != 0 you should just return and leave |
|
|
79 | item generation to the standard code. |
|
|
80 | |
|
|
81 | =head3 remove (object -- ) |
|
|
82 | |
|
|
83 | Invoked before the object is removed from its environment. |
|
|
84 | |
|
|
85 | =head3 insert (object -- ) |
|
|
86 | |
|
|
87 | Called after the object was inserted into a container or map. |
|
|
88 | |
60 | =head3 tick (object) |
89 | =head3 tick (object -- ) |
61 | |
90 | |
62 | 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 |
63 | during ticks should an objetc process any movement or other events. |
92 | during ticks should an objetc process any movement or other events. |
64 | |
93 | |
65 | =head3 kill (object hitter -- ) |
94 | =head3 kill (object hitter -- ) |
… | |
… | |
174 | |
203 | |
175 | 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 |
176 | 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, |
177 | signs and similar stuff. |
206 | signs and similar stuff. |
178 | |
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 | |
179 | =head3 close (container who -- ) |
213 | =head3 close (container who -- ) |
180 | |
214 | |
181 | 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. |
182 | |
219 | |
183 | |
220 | |
184 | =head2 GLOBAL EVENTS |
221 | =head2 GLOBAL EVENTS |
185 | |
222 | |
186 | Global events have no relation to specific objects. |
223 | Global events have no relation to specific objects. |
… | |
… | |
196 | |
233 | |
197 | =head2 PLAYER EVENTS |
234 | =head2 PLAYER EVENTS |
198 | |
235 | |
199 | Player events always have a player object as first argument. |
236 | Player events always have a player object as first argument. |
200 | |
237 | |
201 | =head3 reattach (player) |
|
|
202 | |
|
|
203 | Invoked whenever attachments/plug-ins need to get reattached to the player |
|
|
204 | object. This usually happens when the player gets loaded from disk, or |
|
|
205 | when the server is reloaded. |
|
|
206 | |
|
|
207 | =head3 birth (player) |
238 | =head3 birth (player) |
208 | |
239 | |
209 | Invoked as very first thing after creating a player. |
240 | Invoked as very first thing after creating a player. |
210 | |
241 | |
211 | =head3 quit (player) |
242 | =head3 quit (player) |
212 | |
243 | |
213 | Invoked wheneever a player quits, before actually removing him/her. |
244 | Invoked wheneever a player quits, before actually removing him/her. |
214 | |
245 | |
215 | =head3 kick (player params -- ) |
246 | =head3 kick (player params -- ) |
216 | |
247 | |
217 | 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. |
218 | |
250 | |
219 | =head3 load (player) |
251 | =head3 load (player -- ) |
220 | |
252 | |
221 | Invoked whenever a player has been loaded from disk, but before |
253 | Invoked whenever a player has been loaded from disk, but before |
222 | actual login. |
254 | actual login. |
223 | |
255 | |
224 | =head3 save (player) |
256 | =head3 save (player -- ) |
225 | |
257 | |
226 | 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. |
227 | |
271 | |
228 | =head3 login (player) |
272 | =head3 login (player) |
229 | |
273 | |
230 | Invoked whenever a player logs in. |
274 | Invoked whenever a player logs in. |
231 | |
275 | |
… | |
… | |
235 | |
279 | |
236 | =head3 death (player) |
280 | =head3 death (player) |
237 | |
281 | |
238 | Invoked whenever a player dies, before the death actually gets processed. |
282 | Invoked whenever a player dies, before the death actually gets processed. |
239 | |
283 | |
240 | =head3 map_change (player oldmap newmap) |
284 | =head3 map_change (player newmap x y -- ) |
241 | |
285 | |
242 | Invoked whenever a player moves from one map to another. |
286 | Invoked before a player moves from one map to another, can override the movement. |
|
|
287 | |
|
|
288 | =head3 command (player command args -- time) |
|
|
289 | |
|
|
290 | Execute a user command send by the client. Programmable plug-ins usually |
|
|
291 | handle this event internally. |
243 | |
292 | |
244 | =head3 extcmd (player string) |
293 | =head3 extcmd (player string) |
245 | |
294 | |
246 | Invoked whenever a client issues the C<extcmd> protocol command. It's |
295 | Invoked whenever a client issues the C<extcmd> protocol command. |
247 | argument is passed without any changes. |
296 | Programmable plug-ins usually handle this event internally. |
248 | |
297 | |
249 | =head3 move (player direction -- ) |
298 | =head3 move (player direction -- ) |
250 | |
299 | |
251 | =head3 pray_altar (player altar skill -- ) |
300 | =head3 pray_altar (player altar skill -- ) |
252 | |
301 | |
… | |
… | |
255 | =head3 tell (player name message -- ) |
304 | =head3 tell (player name message -- ) |
256 | |
305 | |
257 | 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 |
258 | it gets processed. |
307 | it gets processed. |
259 | |
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 | |
260 | =head3 say (player message --) |
314 | =head3 say (player message --) |
261 | |
315 | |
262 | =head3 chat (player message --) |
316 | =head3 chat (player message --) |
263 | |
317 | |
264 | =head3 shout (player message --) |
318 | =head3 shout (player message --) |
… | |
… | |
275 | =head3 instantiate (map) |
329 | =head3 instantiate (map) |
276 | |
330 | |
277 | 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 |
278 | reset). |
332 | reset). |
279 | |
333 | |
280 | =head3 reattach (map) |
|
|
281 | |
|
|
282 | Invoked whenever attachments/plug-ins need to get reattached to the |
|
|
283 | B<map>. This usually happens when the map was loaded from disk, or when the |
|
|
284 | server was reloaded. |
|
|
285 | |
|
|
286 | =head3 destroy (map) |
|
|
287 | |
|
|
288 | Invoked when the map object gets destroyed, and only when the map object |
|
|
289 | has a handler for this event. This event can occur many times, as its |
|
|
290 | called when the in-memory object is destroyed, not when the object itself |
|
|
291 | dies. |
|
|
292 | |
|
|
293 | =head3 swapin (map) |
334 | =head3 swapin (map) |
294 | |
335 | |
295 | 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. |
296 | |
337 | |
297 | =head3 swapout (map) |
338 | =head3 swapout (map) |
… | |
… | |
304 | |
345 | |
305 | =head3 clean (map) |
346 | =head3 clean (map) |
306 | |
347 | |
307 | Invoked when a temporary B<map> gets deleted on-disk. |
348 | Invoked when a temporary B<map> gets deleted on-disk. |
308 | |
349 | |
309 | =head3 enter (map player) |
350 | =head3 enter (map player x y -- ) |
310 | |
351 | |
311 | Invoked whenever a player enters the B<map>. This event is likely unreliable. |
352 | Invoked whenever a player tries to enter the B<map>, while he/she is still |
|
|
353 | on the old map. Overriding means the player won't be able to enter, and, |
|
|
354 | if newmap/x/y are given, will be redirected to that map instead. |
312 | |
355 | |
313 | =head3 leave (map player) |
356 | =head3 leave (map player -- ) |
314 | |
357 | |
315 | Invoked whenever a player leaves the B<map>. This event is likely unreliable. |
358 | Invoked whenever a player tries to leave the B<map>. Overriding means the |
|
|
359 | player won't be able to leave. |
316 | |
360 | |
317 | =head3 upgrade (map) |
|
|
318 | |
|
|
319 | (TEMPORARY EVENT) gets invoked whenever a old-style map has been upgraded. |
|
|
320 | |
|
|
321 | =head3 trigger (map connection state) |
361 | =head3 trigger (map connection state -- ) |
322 | |
362 | |
323 | Invoked whenever something activates a B<connection> on the B<map>. If B<state> |
363 | Invoked whenever something activates a B<connection> on the B<map>. If B<state> |
324 | is true the connection was 'state' and if false it is 'released'. |
364 | is true the connection was 'state' and if false it is 'released'. |
|
|
365 | |
|
|
366 | |
|
|
367 | =head2 CLIENT EVENTS |
|
|
368 | |
|
|
369 | These events are very similar to player events, but they are might be |
|
|
370 | 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). |
|
|
372 | |
|
|
373 | =head3 connect (client -- ) |
|
|
374 | |
|
|
375 | Called as soon as a new connection to the server is established. Should |
|
|
376 | not be overriden. |
|
|
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 | |
|
|
383 | =head3 addme (client -- ) |
|
|
384 | |
|
|
385 | The client sent an addme, thus ending the initial handshaking. Handling is mandatory |
|
|
386 | and done by F<login.ext>. |
|
|
387 | |
|
|
388 | =head3 reply (client replystring -- ) |
|
|
389 | |
|
|
390 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
|
|
391 | handled internally by language plugins. |
|
|
392 | |
|
|
393 | =head3 exticmd (client string -- ) |
|
|
394 | |
|
|
395 | Like C<extcmd>, but can be called before a player has logged in. |
|
|
396 | |
|
|
397 | Programmable plug-ins usually handle this event internally. |
|
|
398 | |