… | |
… | |
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 GLOBAL EVENTS |
|
|
24 | |
|
|
25 | Global events have no relation to specific objects. |
|
|
26 | |
|
|
27 | =head3 CLOCK ( ) |
|
|
28 | |
|
|
29 | Is invoked on every server tick, usually every 0.12 seconds. |
|
|
30 | |
|
|
31 | |
|
|
32 | =head2 PLAYER EVENTS |
|
|
33 | |
|
|
34 | Player events always have a player object as first argument. |
|
|
35 | |
|
|
36 | =head3 REATTACH (player) |
|
|
37 | |
|
|
38 | Invoked whenever attachments/plug-ins need to get reattached to the player |
|
|
39 | object. This usually happens when the player gets loaded from disk, or |
|
|
40 | when the server is reloaded. |
|
|
41 | |
|
|
42 | =head3 BIRTH (player) |
|
|
43 | |
|
|
44 | Invoked as very first thing after creating a player. |
|
|
45 | |
|
|
46 | =head3 QUIT (player) |
|
|
47 | |
|
|
48 | Invoked wheneever a player quits, before actually removing him/her. |
|
|
49 | |
|
|
50 | =head3 LOAD (player) |
|
|
51 | |
|
|
52 | Invoked whenever a player has been loaded from disk, but before |
|
|
53 | actual login. |
|
|
54 | |
|
|
55 | =head3 SAVE (player) |
|
|
56 | |
|
|
57 | Invoked just before a player gets saved. |
|
|
58 | |
|
|
59 | =head3 LOGIN (player) |
|
|
60 | |
|
|
61 | Invoked whenever a player logs in. |
|
|
62 | |
|
|
63 | =head3 LOGOUT (player) |
|
|
64 | |
|
|
65 | Invoked whenever a player logs out, gets disconnected etc. |
|
|
66 | |
|
|
67 | =head3 DEATH (player) |
|
|
68 | |
|
|
69 | Invoked whenever a player dies, before the death actually gets processed. |
|
|
70 | |
|
|
71 | =head3 MAP_CHANGE (player oldmap newmap) |
|
|
72 | |
|
|
73 | Invoked whenever a player moves from one map to another. |
|
|
74 | |
|
|
75 | =head3 EXTCMD (player string) |
|
|
76 | |
|
|
77 | Invoked whenever a client issues the C<extcmd> protocol command. It's |
|
|
78 | argument is passed without any changes. |
|
|
79 | |
|
|
80 | =head3 PRAY_ALTAR (player altar skill -- ) |
|
|
81 | |
|
|
82 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
|
|
83 | |
|
|
84 | =head3 TELL (player -- ) |
|
|
85 | |
|
|
86 | Invoked whenever the player uses the B<tell> command, before it gets processed. |
|
|
87 | |
|
|
88 | =head3 SAY (player --) |
|
|
89 | |
|
|
90 | Invoked whenever the player uses the B<say> command, before it gets processed. |
|
|
91 | |
|
|
92 | =head3 SHOUT (player --) |
|
|
93 | |
|
|
94 | Invoked whenever the player uses the B<shout> command, before it gets processed. |
|
|
95 | |
|
|
96 | |
|
|
97 | =head2 OBJECT EVENTS |
23 | =head2 OBJECT EVENTS |
98 | |
24 | |
99 | Object events always relate to a specific object, which is always the |
25 | Object events always relate to a specific object, which is always the |
100 | first argument. Not all events get generated for every object, some are |
26 | first argument. Not all events get generated for every object, some are |
101 | specific to an object type. |
27 | specific to an object type. |
102 | |
28 | |
103 | =head3 INSTANTIATE (object init-args...) |
29 | =head3 instantiate (object init-args...) |
104 | |
30 | |
105 | An archetype was instantiated into an object. This event occurs when |
31 | An archetype was instantiated into an object. This event occurs when |
106 | a map is loaded for the first time, or when the object was created |
32 | a map is loaded for the first time, or when the object was created |
107 | 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 |
108 | the object or archetype. |
34 | the object or archetype. |
109 | |
35 | |
110 | 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. |
111 | |
37 | |
112 | =head3 REATTACH (object) |
38 | =head3 reattach (object) |
113 | |
39 | |
114 | Invoked whenever attachments/plug-ins need to get reattached to the |
40 | Invoked whenever attachments/plug-ins need to get reattached to the |
115 | object. This usually happens when it was loaded from disk, or when the |
41 | object. This usually happens when it was loaded from disk, or when the |
116 | 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 |
117 | attachments. |
43 | attachments. |
118 | |
44 | |
119 | =head3 CLONE (object destination) |
45 | =head3 clone (object destination) |
120 | |
46 | |
121 | An object with _attached extension_ is cloned, that is, a copy was |
47 | An object with _attached extension_ is cloned, that is, a copy was |
122 | made. The copy automatically has all attachments the original object |
48 | made. The copy automatically has all attachments the original object |
123 | had. The perl variables get copied in a shallow way (references are shared |
49 | had. The perl variables get copied in a shallow way (references are shared |
124 | between instances). If this is not the behaviour you need, you have to |
50 | between instances). If this is not the behaviour you need, you have to |
125 | adjust the B<destination> object as you see fit. |
51 | adjust the B<destination> object as you see fit. |
126 | |
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 | |
127 | =head3 TICK (object) |
60 | =head3 tick (object) |
128 | |
61 | |
129 | Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only |
62 | Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only |
130 | during ticks should an objetc process any movement or other events. |
63 | during ticks should an objetc process any movement or other events. |
131 | |
64 | |
132 | =head3 KILL (object hitter -- ) |
65 | =head3 kill (object hitter -- ) |
133 | |
66 | |
134 | Invoked whenever an object is dead and about to get removed. Overriding |
67 | Invoked whenever an object is dead and about to get removed. Overriding |
135 | processing will skip removal, but to do this successfully you have to |
68 | processing will skip removal, but to do this successfully you have to |
136 | objetc from dieing, otherwise the event gets invoked again and again. |
69 | objetc from dieing, otherwise the event gets invoked again and again. |
137 | |
70 | |
138 | =head3 APPLY (object who -- applytype) |
71 | =head3 apply (object who -- applytype) |
139 | |
72 | |
140 | Invoked whenever the object is being applied in some way. The applytype is one of: |
73 | Invoked whenever the object is being applied in some way. The applytype is one of: |
141 | |
74 | |
142 | =over 4 |
75 | =over 4 |
143 | |
76 | |
… | |
… | |
145 | |
78 | |
146 | =item B<1> has been applied, or there was an error applying the object |
79 | =item B<1> has been applied, or there was an error applying the object |
147 | |
80 | |
148 | =item B<2> objects of that type can't be applied if not in inventory |
81 | =item B<2> objects of that type can't be applied if not in inventory |
149 | |
82 | |
150 | =cut |
83 | =back |
151 | |
84 | |
|
|
85 | =head3 throw (object thrower) |
|
|
86 | |
|
|
87 | Invoked when an B<object> is thrown by B<thrower>. |
|
|
88 | |
|
|
89 | =head3 stop (object -- ) |
|
|
90 | |
|
|
91 | Invoked when a thrown B<object> (arrow, other stuff) hits something and is |
|
|
92 | thus being "stopped". |
|
|
93 | |
|
|
94 | =head3 can_apply (who object -- reason) |
|
|
95 | |
|
|
96 | =head3 can_be_applied (object who -- reason) |
|
|
97 | |
|
|
98 | Check wether the B<object> can be applied/readied/etc. by the |
|
|
99 | object B<who> and return reason otherwise. Reason is a bitset composed of |
|
|
100 | C<CAN_APPLY_*>-flags. |
|
|
101 | |
|
|
102 | =head3 be_ready (object who -- success) |
|
|
103 | |
|
|
104 | =head3 ready (who object -- success) |
|
|
105 | |
|
|
106 | Invoked whenever an B<object> is being applied by object B<who>. See |
|
|
107 | I<can_apply> for an alternative if you just want to check wether something |
|
|
108 | can apply an object. |
|
|
109 | |
|
|
110 | =head3 be_unready (object who -- deleted) |
|
|
111 | |
|
|
112 | =head3 unready (who object -- deleted) |
|
|
113 | |
|
|
114 | Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, |
|
|
115 | currently applied by B<who>. If your override, make sure you give 'who' |
|
|
116 | (if it is a player) an indication of whats wrong. Must return true if the |
|
|
117 | object was freed. |
|
|
118 | |
152 | =head3 USE_SKILL (skill who part direction strignarg -- ) |
119 | =head3 use_skill (skill who part direction strignarg -- ) |
153 | |
120 | |
154 | Invoked whenever a skill is used by somebody or something. |
121 | Invoked whenever a skill is used by somebody or something. |
155 | |
122 | |
156 | =head3 CAST_SPELL (spell casting_object owner direction stringarg -- ) |
123 | =head3 cast_spell (spell casting_object owner direction stringarg -- ) |
157 | |
124 | |
158 | Invoked whenever a given spell is cast by B<casting_oject> (used by |
125 | Invoked whenever a given spell is cast by B<casting_object> (used by |
159 | B<owner>). |
126 | B<owner>). |
160 | |
127 | |
161 | =head3 DROP (object who -- ) |
128 | =head3 drop (object who -- ) |
162 | |
129 | |
163 | Invoked whenever an item gets dropped by somebody, e.g. as a result of a |
130 | Invoked whenever an item gets dropped by somebody, e.g. as a result of a |
164 | drop command. |
131 | drop command. |
165 | |
132 | |
166 | =head3 DROP_ON (floor object who -- ) |
133 | =head3 drop_on (floor object who -- ) |
167 | |
134 | |
168 | Invoked whenever some B<object> is being dropped on the B<floor> object. |
135 | Invoked whenever some B<object> is being dropped on the B<floor> object. |
169 | |
136 | |
170 | =head3 LISTEN |
137 | =head3 say (object player message) |
171 | |
138 | |
172 | Invoked whenever the object can hear something beign said in its |
139 | Invoked whenever the I<object> can hear a B<message> being said by |
173 | vicinity. Not yet implemented. |
140 | B<player> in its vicinity. |
174 | |
141 | |
175 | =head3 MOVE (monster enemy -- ) |
142 | =head3 move (monster enemy -- ) |
176 | |
143 | |
177 | Invoked whenever the B<monster> tries to move, just after B<enemy> and |
144 | Invoked whenever the B<monster> tries to move, just after B<enemy> and |
178 | other parameters have been determined, but before movement is actually |
145 | other parameters have been determined, but before movement is actually |
179 | executed. |
146 | executed. |
180 | |
147 | |
181 | =head3 ATTACK (object hitter -- damage) |
148 | =head3 attack (object hitter -- damage) |
182 | |
149 | |
183 | Object gets attacked by somebody - when overriden, should return the |
150 | Object gets attacked by somebody - when overriden, should return the |
184 | damage that has been dealt. |
151 | damage that has been dealt. |
185 | |
152 | |
186 | =head3 ATTACKS (weapon hitter victim) |
153 | =head3 attacks (weapon hitter victim) |
187 | |
154 | |
188 | Invoked whenever an object is used as a B<weapon> by B<hitter> to attack |
155 | Invoked whenever an object is used as a B<weapon> by B<hitter> to attack |
189 | B<victim>. |
156 | B<victim>. |
190 | |
157 | |
191 | =head3 INSCRIBE_NOTE (book pl message skill -- ) |
158 | =head3 inscribe_note (book pl message skill -- ) |
192 | |
159 | |
193 | Used whenever a book gets inscribed with a message. |
160 | Used whenever a book gets inscribed with a message. |
194 | |
161 | |
195 | =head3 TRIGGER (object who -- ) |
162 | =head3 trigger (object who -- ) |
196 | |
163 | |
197 | Invoked whenever a lever-like B<object> has been activated/triggered in some |
164 | Invoked whenever a lever-like B<object> has been activated/triggered in some |
198 | (manual) way. |
165 | (manual) way. |
199 | |
166 | |
200 | =head3 MOVE_TRIGGER (object victim originator -- ) |
167 | =head3 move_trigger (object victim originator -- ) |
201 | |
168 | |
202 | Invoked whenever a trap-like B<object> has been activated, usually by |
169 | Invoked whenever a trap-like B<object> has been activated, usually by |
203 | moving onto it. This includes not just traps, but also buttons, holes, |
170 | moving onto it. This includes not just traps, but also buttons, holes, |
204 | signs and similar stuff. |
171 | signs and similar stuff. |
205 | |
172 | |
206 | =head3 CLOSE (container -- ) |
173 | =head3 close (container -- ) |
207 | |
174 | |
208 | Invoked whenever a container gets closed (this event is not yet reliable!). |
175 | Invoked whenever a container gets closed (this event is not yet reliable!). |
|
|
176 | |
|
|
177 | |
|
|
178 | =head2 GLOBAL EVENTS |
|
|
179 | |
|
|
180 | Global events have no relation to specific objects. |
|
|
181 | |
|
|
182 | =head3 clock ( ) |
|
|
183 | |
|
|
184 | Is invoked on every server tick, usually every 0.12 seconds. |
|
|
185 | |
|
|
186 | =head2 PLAYER EVENTS |
|
|
187 | |
|
|
188 | Player events always have a player object as first argument. |
|
|
189 | |
|
|
190 | =head3 reattach (player) |
|
|
191 | |
|
|
192 | Invoked whenever attachments/plug-ins need to get reattached to the player |
|
|
193 | object. This usually happens when the player gets loaded from disk, or |
|
|
194 | when the server is reloaded. |
|
|
195 | |
|
|
196 | =head3 birth (player) |
|
|
197 | |
|
|
198 | Invoked as very first thing after creating a player. |
|
|
199 | |
|
|
200 | =head3 quit (player) |
|
|
201 | |
|
|
202 | Invoked wheneever a player quits, before actually removing him/her. |
|
|
203 | |
|
|
204 | =head3 kick (player params -- ) |
|
|
205 | |
|
|
206 | Invoked when the given plaer is being kicked, before the kick is executed. |
|
|
207 | |
|
|
208 | =head3 load (player) |
|
|
209 | |
|
|
210 | Invoked whenever a player has been loaded from disk, but before |
|
|
211 | actual login. |
|
|
212 | |
|
|
213 | =head3 save (player) |
|
|
214 | |
|
|
215 | Invoked just before a player gets saved. |
|
|
216 | |
|
|
217 | =head3 login (player) |
|
|
218 | |
|
|
219 | Invoked whenever a player logs in. |
|
|
220 | |
|
|
221 | =head3 logout (player) |
|
|
222 | |
|
|
223 | Invoked whenever a player logs out, gets disconnected etc. |
|
|
224 | |
|
|
225 | =head3 death (player) |
|
|
226 | |
|
|
227 | Invoked whenever a player dies, before the death actually gets processed. |
|
|
228 | |
|
|
229 | =head3 map_change (player oldmap newmap) |
|
|
230 | |
|
|
231 | Invoked whenever a player moves from one map to another. |
|
|
232 | |
|
|
233 | =head3 extcmd (player string) |
|
|
234 | |
|
|
235 | Invoked whenever a client issues the C<extcmd> protocol command. It's |
|
|
236 | argument is passed without any changes. |
|
|
237 | |
|
|
238 | =head3 pray_altar (player altar skill -- ) |
|
|
239 | |
|
|
240 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
|
|
241 | |
|
|
242 | =head3 tell (player -- ) |
|
|
243 | |
|
|
244 | Invoked whenever the player uses the B<tell> command, before it gets processed. |
|
|
245 | |
|
|
246 | =head3 say (player --) |
|
|
247 | |
|
|
248 | Invoked whenever the player uses the B<say> command, before it gets processed. |
|
|
249 | |
|
|
250 | =head3 shout (player --) |
|
|
251 | |
|
|
252 | Invoked whenever the player uses the B<shout> command, before it gets processed. |
209 | |
253 | |
210 | |
254 | |
211 | =head2 MAP EVENTS |
255 | =head2 MAP EVENTS |
212 | |
256 | |
213 | These events are generally dependent on a map and thus all have a map |
257 | These events are generally dependent on a map and thus all have a map |
214 | as first argument. |
258 | as first argument. |
215 | |
259 | |
216 | =head3 REATTACH (map) |
260 | =head3 instantiate (map) |
|
|
261 | |
|
|
262 | Original B<map> has been loaded (e.g. on first use, or after a map |
|
|
263 | reset). |
|
|
264 | |
|
|
265 | =head3 reattach (map) |
217 | |
266 | |
218 | Invoked whenever attachments/plug-ins need to get reattached to the |
267 | Invoked whenever attachments/plug-ins need to get reattached to the |
219 | B<map>. This usually happens when the map was loaded from disk, or when the |
268 | B<map>. This usually happens when the map was loaded from disk, or when the |
220 | server was reloaded. |
269 | server was reloaded. |
221 | |
270 | |
222 | =head3 LOAD (map) |
271 | =head3 destroy (map) |
223 | |
272 | |
224 | Original B<map> has been loaded (e.g. on first use, or after a map |
273 | Invoked when the map object gets destroyed, and only when the map object |
225 | reset). This event might get renamed to instantiate in the future. |
274 | has a handler for this event. This event can occur many times, as its |
|
|
275 | called when the in-memory object is destroyed, not when the object itself |
|
|
276 | dies. |
226 | |
277 | |
227 | =head3 SWAPIN (map) |
278 | =head3 swapin (map) |
228 | |
279 | |
229 | Invoked when a previously swapped-out temporary B<map> has been loaded again. |
280 | Invoked when a previously swapped-out temporary B<map> has been loaded again. |
230 | |
281 | |
231 | =head3 SWAPOUT (map) |
282 | =head3 swapout (map) |
232 | |
283 | |
233 | Invoked after a B<map> has been swapped out to disk. |
284 | Invoked after a B<map> has been swapped out to disk. |
234 | |
285 | |
235 | =head3 RESET (map) |
286 | =head3 reset (map) |
236 | |
287 | |
237 | Invoked when a B<map> gets reset. |
288 | Invoked when a B<map> gets reset. |
238 | |
289 | |
239 | =head3 CLEAN (map) |
290 | =head3 clean (map) |
240 | |
291 | |
241 | Invoked when a temporary B<map> gets deleted on-disk. |
292 | Invoked when a temporary B<map> gets deleted on-disk. |
242 | |
293 | |
243 | =head3 ENTER (map player) |
294 | =head3 enter (map player) |
244 | |
295 | |
245 | Invoked whenever a player enters the B<map>. This event is likely unreliable. |
296 | Invoked whenever a player enters the B<map>. This event is likely unreliable. |
246 | |
297 | |
247 | =head3 LEAVE (map player) |
298 | =head3 leave (map player) |
248 | |
299 | |
249 | Invoked whenever a player leaves the B<map>. This event is likely unreliable. |
300 | Invoked whenever a player leaves the B<map>. This event is likely unreliable. |
250 | |
301 | |
251 | =head3 UPGRADE (map) |
302 | =head3 upgrade (map) |
252 | |
303 | |
253 | (TEMPORARY EVENT) gets invoked whenever a old-style map has been upgraded. |
304 | (TEMPORARY EVENT) gets invoked whenever a old-style map has been upgraded. |
254 | |
305 | |