| … | |
… | |
| 226 | |
226 | |
| 227 | =head3 inscribe_note (book pl message skill -- ) |
227 | =head3 inscribe_note (book pl message skill -- ) |
| 228 | |
228 | |
| 229 | Used whenever a book gets inscribed with a message. |
229 | Used whenever a book gets inscribed with a message. |
| 230 | |
230 | |
|
|
231 | =head3 infect (victim disease_type disease -- ) |
|
|
232 | |
|
|
233 | Invoked whenever an object is diseased. The disease object is already |
|
|
234 | inserted in object (the template disease object is C<disease_type>), |
|
|
235 | but no messages have been generated. If overriden, no messages will be |
|
|
236 | generated. |
|
|
237 | |
| 231 | =head3 trigger (object who -- ) |
238 | =head3 trigger (object who -- ) |
| 232 | |
239 | |
| 233 | Invoked whenever a lever-like B<object> has been activated/triggered in some |
240 | Invoked whenever a lever-like B<object> has been activated/triggered in some |
| 234 | (manual) way. |
241 | (manual) way. |
| 235 | |
242 | |
| … | |
… | |
| 299 | Invoked when the given player is being kicked, before the kick is |
306 | Invoked when the given player is being kicked, before the kick is |
| 300 | executed. |
307 | executed. |
| 301 | |
308 | |
| 302 | =head3 load (player -- ) |
309 | =head3 load (player -- ) |
| 303 | |
310 | |
| 304 | Invoked whenever a player has been loaded from disk, but before |
311 | Invoked whenever after a player has been loaded from disk, but before |
| 305 | actual login. |
312 | actual activation/login. |
| 306 | |
313 | |
| 307 | =head3 save (player -- ) |
314 | =head3 save (player -- ) |
| 308 | |
315 | |
| 309 | Invoked just before a player gets serialised. |
316 | Invoked just before a player gets serialised. |
| 310 | |
317 | |
| … | |
… | |
| 340 | |
347 | |
| 341 | Invoked when a player entered a new region. Cannot be overriden. |
348 | Invoked when a player entered a new region. Cannot be overriden. |
| 342 | |
349 | |
| 343 | =head3 command (player command args -- time) |
350 | =head3 command (player command args -- time) |
| 344 | |
351 | |
| 345 | Execute a user command send by the client. Programmable plug-ins usually |
352 | Execute a user command sent by the client - this is invoked for I<all> |
| 346 | handle this event internally. |
353 | command,s so should not normally be hooked. |
|
|
354 | |
|
|
355 | =head3 unknown_command (player command args -- time) |
|
|
356 | |
|
|
357 | Execute a user command sent by the client that isn't known to the |
|
|
358 | server. Programmable plug-ins usually handle this event internally. |
| 347 | |
359 | |
| 348 | =head3 extcmd (player string) |
360 | =head3 extcmd (player string) |
| 349 | |
361 | |
| 350 | Invoked whenever a client issues the C<extcmd> protocol command. |
362 | Invoked whenever a client issues the C<extcmd> protocol command. |
| 351 | Programmable plug-ins usually handle this event internally. |
363 | Programmable plug-ins usually handle this event internally. |
| … | |
… | |
| 379 | =head3 shout (player message --) |
391 | =head3 shout (player message --) |
| 380 | |
392 | |
| 381 | Invoked whenever the player uses the B<say>, B<chat> or B<shout> command, |
393 | Invoked whenever the player uses the B<say>, B<chat> or B<shout> command, |
| 382 | before it gets processed. |
394 | before it gets processed. |
| 383 | |
395 | |
|
|
396 | =head3 build (player builder map x y checkok --) |
|
|
397 | |
|
|
398 | Players tries to build using C<builder> at (map+x+y). Is invoked after |
|
|
399 | the usual map sanity checks, so the coordinates are valid. The boolean |
|
|
400 | C<checkok> is true only if the build code thinks it is "ok" to build at |
|
|
401 | that space, and normally you should only build when it is true. |
|
|
402 | |
| 384 | |
403 | |
| 385 | =head2 MAP EVENTS |
404 | =head2 MAP EVENTS |
| 386 | |
405 | |
| 387 | These events are generally dependent on a map and thus all have a map |
406 | These events are generally dependent on a map and thus all have a map |
| 388 | as first argument. |
407 | as first argument. |
| … | |
… | |
| 431 | handled asynchronously as soon as the command reaches the server, even when |
450 | handled asynchronously as soon as the command reaches the server, even when |
| 432 | the player hasn't logged in yet (meaning there is no player yet). |
451 | the player hasn't logged in yet (meaning there is no player yet). |
| 433 | |
452 | |
| 434 | =head3 connect (client -- ) |
453 | =head3 connect (client -- ) |
| 435 | |
454 | |
| 436 | Called as soon as a new connection to the server is established. Should |
455 | Called as soon as a new connection to the server is established and the |
| 437 | not be overriden. |
456 | socket has been configured. |
|
|
457 | |
|
|
458 | =head3 version (client string -- ) |
|
|
459 | |
|
|
460 | Called as soon as the version command from the client is received |
|
|
461 | (normally the very first command sent). |
| 438 | |
462 | |
| 439 | =head3 setup (client string -- ) |
463 | =head3 setup (client string -- ) |
| 440 | |
464 | |
| 441 | Client sent the setup command to negotiate parameters. Handling is |
465 | Client sent the setup command to negotiate parameters. Handling is |
| 442 | mandatory and done by F<login.ext>. |
466 | mandatory and done by F<login.ext>. |
| … | |
… | |
| 455 | |
479 | |
| 456 | Like C<extcmd>, but can be called before a player has logged in. |
480 | Like C<extcmd>, but can be called before a player has logged in. |
| 457 | |
481 | |
| 458 | Programmable plug-ins usually handle this event internally. |
482 | Programmable plug-ins usually handle this event internally. |
| 459 | |
483 | |
|
|
484 | =head3 client_destroy (client -- ) |
|
|
485 | |
|
|
486 | Invoked when the client gets destroyed. |
|
|
487 | |
|
|
488 | |
