1 | =head1 CROSSFIRE+ PLUG-IN EVENTS |
1 | =head1 DELIANTRA PLUG-IN EVENTS |
2 | |
2 | |
3 | This document briefly describes each plug-in event. It is also used to |
3 | 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 |
4 | generate the event-list itself, so is always complete. Be careful wehn |
5 | changing it, though. |
5 | changing it, though. |
6 | |
6 | |
… | |
… | |
50 | instances). If this is not the behaviour you need, you have to adjust the |
50 | instances). If this is not the behaviour you need, you have to adjust the |
51 | 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 deliantra 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 | |
60 | |
… | |
… | |
91 | 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 |
92 | during ticks should an objetc process any movement or other events. |
92 | during ticks should an objetc process any movement or other events. |
93 | |
93 | |
94 | =head3 kill (object hitter -- ) |
94 | =head3 kill (object hitter -- ) |
95 | |
95 | |
96 | Invoked whenever an object is dead and about to get removed. Overriding |
96 | 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 |
97 | about to get removed. Overriding processing will skip removal, but to do |
98 | objetc from dieing, otherwise the event gets invoked again and again. |
98 | this successfully you have to keep the object from dieing, otherwise the |
|
|
99 | event gets invoked again and again. |
99 | |
100 | |
100 | =head3 apply (object who -- applytype) |
101 | =head3 apply (object who -- applytype) |
101 | |
102 | |
102 | Invoked whenever the object is being applied in some way. The applytype is one of: |
103 | Invoked whenever the object is being applied in some way. The applytype is one of: |
103 | |
104 | |
… | |
… | |
108 | =item B<1> has been applied, or there was an error applying the object |
109 | =item B<1> has been applied, or there was an error applying the object |
109 | |
110 | |
110 | =item B<2> objects of that type can't be applied if not in inventory |
111 | =item B<2> objects of that type can't be applied if not in inventory |
111 | |
112 | |
112 | =back |
113 | =back |
|
|
114 | |
|
|
115 | =head3 reset (object) |
|
|
116 | |
|
|
117 | Invoked whenever the object is initialised on a map after it was |
|
|
118 | loaded. This can be used to emulate shop-floor behaviour for example. |
113 | |
119 | |
114 | =head3 throw (object thrower) |
120 | =head3 throw (object thrower) |
115 | |
121 | |
116 | Invoked when an B<object> is thrown by B<thrower>. |
122 | Invoked when an B<object> is thrown by B<thrower>. |
117 | |
123 | |
… | |
… | |
156 | |
162 | |
157 | =head3 drop (object who -- ) |
163 | =head3 drop (object who -- ) |
158 | |
164 | |
159 | Invoked whenever an item gets dropped by somebody, e.g. as a result of a |
165 | Invoked whenever an item gets dropped by somebody, e.g. as a result of a |
160 | drop command. |
166 | drop command. |
|
|
167 | B<NOTE:> If you put the object somewhere else or destroyed the object |
|
|
168 | you have to override! If you do nothing with the object and override it is |
|
|
169 | given back to the dropper. |
161 | |
170 | |
162 | =head3 drop_on (floor object who -- ) |
171 | =head3 drop_on (floor object who -- ) |
163 | |
172 | |
164 | Invoked whenever some B<object> is being dropped on the B<floor> object. |
173 | Invoked whenever some B<object> is being dropped on the B<floor> object. |
|
|
174 | B<NOTE:> If you put the object somewhere else or destroyed the object |
|
|
175 | you have to override! If you do nothing with the object and override it is |
|
|
176 | given back to the dropper. |
165 | |
177 | |
166 | =head3 say (object player message) |
178 | =head3 say (object player message) |
167 | |
179 | |
168 | Invoked whenever the I<object> can hear a B<message> being said by |
180 | Invoked whenever the I<object> can hear a B<message> being said by |
169 | B<player> in its vicinity. |
181 | B<player> in its vicinity. |
… | |
… | |
224 | |
236 | |
225 | =head3 cleanup () |
237 | =head3 cleanup () |
226 | |
238 | |
227 | Called when the server is cleaning up, just before it calls exit. |
239 | Called when the server is cleaning up, just before it calls exit. |
228 | |
240 | |
229 | =head3 clock ( ) |
241 | =head3 clock () |
230 | |
242 | |
231 | Is invoked on every server tick, usually every 0.12 seconds. |
243 | Is invoked on every server tick, usually every 0.12 seconds. |
|
|
244 | |
|
|
245 | =head3 resource_update () |
|
|
246 | |
|
|
247 | Is invoked after each time the server reloads its resources, which is |
|
|
248 | usually one of the earliest things it does when starting up. |
232 | |
249 | |
233 | |
250 | |
234 | =head2 PLAYER EVENTS |
251 | =head2 PLAYER EVENTS |
235 | |
252 | |
236 | Player events always have a player object as first argument. |
253 | Player events always have a player object as first argument. |
… | |
… | |
282 | Invoked whenever a player dies, before the death actually gets processed. |
299 | Invoked whenever a player dies, before the death actually gets processed. |
283 | |
300 | |
284 | =head3 map_change (player newmap x y -- ) |
301 | =head3 map_change (player newmap x y -- ) |
285 | |
302 | |
286 | Invoked before a player moves from one map to another, can override the movement. |
303 | Invoked before a player moves from one map to another, can override the movement. |
|
|
304 | |
|
|
305 | =head3 region_change (player newregion oldregion -- ) |
|
|
306 | |
|
|
307 | Invoked when a player entered a new region. Cannot be overriden. |
287 | |
308 | |
288 | =head3 command (player command args -- time) |
309 | =head3 command (player command args -- time) |
289 | |
310 | |
290 | Execute a user command send by the client. Programmable plug-ins usually |
311 | Execute a user command send by the client. Programmable plug-ins usually |
291 | handle this event internally. |
312 | handle this event internally. |