… | |
… | |
62 | |
62 | |
63 | Object events always relate to a specific object, which is always the |
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 |
64 | first argument. Not all events get generated for every object, some are |
65 | specific to an object type. |
65 | specific to an object type. |
66 | |
66 | |
67 | =head3 add_bonus (item creator difficulty max_magic flags) |
67 | =head3 add_bonus (item creator difficulty max_magic flags -- ) |
68 | |
68 | |
69 | 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.) |
70 | 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 |
71 | object that can be used to inherit stuff (and can be NULL). Flags is a |
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 |
72 | combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP |
… | |
… | |
143 | Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, |
143 | Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>, |
144 | currently applied by B<who>. If your override, make sure you give 'who' |
144 | currently applied by B<who>. If your override, make sure you give 'who' |
145 | (if it is a player) an indication of whats wrong. Must return true if the |
145 | (if it is a player) an indication of whats wrong. Must return true if the |
146 | object was freed. |
146 | object was freed. |
147 | |
147 | |
148 | =head3 use_skill (skill who part direction strignarg -- ) |
148 | =head3 use_skill (skill who part direction stringarg -- ) |
149 | |
149 | |
150 | Invoked whenever a skill is used by somebody or something. |
150 | Invoked whenever a skill is used by somebody or something. |
151 | |
151 | |
152 | =head3 cast_spell (spell casting_object owner direction stringarg -- ) |
152 | =head3 cast_spell (spell owner casting_object direction stringarg -- ) |
153 | |
153 | |
154 | Invoked whenever a given spell is cast by B<casting_object> (used by |
154 | Invoked whenever a given spell is cast by B<casting_object> (used by |
155 | B<owner>). |
155 | B<owner>). |
156 | |
156 | |
157 | =head3 drop (object who -- ) |
157 | =head3 drop (object who -- ) |
… | |
… | |
271 | |
271 | |
272 | =head3 login (player) |
272 | =head3 login (player) |
273 | |
273 | |
274 | Invoked whenever a player logs in. |
274 | Invoked whenever a player logs in. |
275 | |
275 | |
276 | =head3 logout (player) |
276 | =head3 logout (player cleanly -- ) |
277 | |
277 | |
278 | Invoked whenever a player logs out, gets disconnected etc. |
278 | Invoked whenever a player logs out, gets disconnected etc. |
279 | |
279 | |
280 | =head3 death (player) |
280 | =head3 death (player) |
281 | |
281 | |
… | |
… | |
294 | |
294 | |
295 | Invoked whenever a client issues the C<extcmd> protocol command. |
295 | Invoked whenever a client issues the C<extcmd> protocol command. |
296 | Programmable plug-ins usually handle this event internally. |
296 | Programmable plug-ins usually handle this event internally. |
297 | |
297 | |
298 | =head3 move (player direction -- ) |
298 | =head3 move (player direction -- ) |
|
|
299 | |
|
|
300 | Called whenever the player is supposed to move or attack. The handler |
|
|
301 | must handle the cases of speed_left or weapon_sp_left being negative, |
|
|
302 | fire being on, is responsible for decreaseing the speed_left value |
|
|
303 | on successful moves etc. etc.. When overriden, must return a boolean |
|
|
304 | indicating wether a move could be effected. |
299 | |
305 | |
300 | =head3 pray_altar (player altar skill -- ) |
306 | =head3 pray_altar (player altar skill -- ) |
301 | |
307 | |
302 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
308 | Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>. |
303 | |
309 | |
… | |
… | |
373 | =head3 connect (client -- ) |
379 | =head3 connect (client -- ) |
374 | |
380 | |
375 | Called as soon as a new connection to the server is established. Should |
381 | Called as soon as a new connection to the server is established. Should |
376 | not be overriden. |
382 | not be overriden. |
377 | |
383 | |
|
|
384 | =head3 setup (client string -- ) |
|
|
385 | |
|
|
386 | Client sent the setup command to negotiate parameters. Handling is |
|
|
387 | mandatory and done by F<login.ext>. |
|
|
388 | |
378 | =head3 addme (client -- ) |
389 | =head3 addme (client -- ) |
379 | |
390 | |
380 | The client sent an addme, thus ending the initial handshaking. If overriden, the server |
391 | The client sent an addme, thus ending the initial handshaking. Handling is mandatory |
381 | will not send any response. |
392 | and done by F<login.ext>. |
382 | |
393 | |
383 | =head3 reply (client replystring -- ) |
394 | =head3 reply (client replystring -- ) |
384 | |
395 | |
385 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
396 | Called when the client submits a reply in the ST_CUSTOM state. Usually |
386 | handled internally by language plugins. |
397 | handled internally by language plugins. |