--- deliantra/server/pod/events.pod 2006/09/17 14:22:28 1.4 +++ deliantra/server/pod/events.pod 2006/12/21 23:37:05 1.10 @@ -50,6 +50,20 @@ between instances). If this is not the behaviour you need, you have to adjust the B object as you see fit. +=head3 add_bonus (item creator difficulty max_magic flags) + +A basic item has been created (e.g. for shops, monsters drops etc.) +that needs bonus values applied. The B object is a template +object that can be used to inherit stuff (and can be NULL). Flags is a +combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP +on item or set its value to 0) or GT_MINIMAL (???) + +When overriden, built-in bonus generation is skipped, otherwise +treasure generation continues as it would without this hook. + +In general, if flags != 0 or creator != 0 you should just return and leave +item generation to the standard code. + =head3 destroy (object) Invoked when the crossfire object gets destroyed, and only when the object @@ -241,10 +255,15 @@ Invoked before a player moves from one map to another, can override the movement. +=head3 command (player command args -- time) + +Execute a user command send by the client. Programmable plug-ins usually +handle this event internally. + =head3 extcmd (player string) -Invoked whenever a client issues the C protocol command. It's -argument is passed without any changes. +Invoked whenever a client issues the C protocol command. +Programmable plug-ins usually handle this event internally. =head3 move (player direction -- ) @@ -309,14 +328,50 @@ =head3 enter (map player x y -- ) Invoked whenever a player tries to enter the B, while he/she is still -on the old map. Overriding means the player won't be able to enter. +on the old map. Overriding means the player won't be able to enter, and, +if newmap/x/y are given, will be redirected to that map instead. =head3 leave (map player -- ) Invoked whenever a player tries to leave the B. Overriding means the player won't be able to leave. -=head3 trigger (map connection state) +=head3 trigger (map connection state -- ) Invoked whenever something activates a B on the B. If B is true the connection was 'state' and if false it is 'released'. + + +=head2 CLIENT EVENTS + +These events are very similar to player events, but they are might be +handled asynchronously as soon as the command reaches the server, even when +the player hasn't logged in yet (meaning there is no player yet). + +=head3 connect (client -- ) + +Called as soon as a new connection to the server is established. Should +not be overriden. + +=head3 addme (client -- ) + +The client sent an addme, thus ending the initial handshaking. If overriden, the server +will not send any response. + +=head3 reattach (client -- ) + +Invoked whenever attachments/plug-ins need to get reattached to the +object. This usually happens when server was reloaded. This event will +only be generated if the object has attachments. + +=head3 reply (client replystring -- ) + +Called when the client submits a reply in the ST_CUSTOM state. Usually +handled internally by language plugins. + +=head3 exticmd (client string -- ) + +Like C, but can be called before a player has logged in. + +Programmable plug-ins usually handle this event internally. +