--- deliantra/server/pod/events.pod 2009/01/08 03:03:24 1.30 +++ deliantra/server/pod/events.pod 2009/10/21 00:44:39 1.32 @@ -6,18 +6,22 @@ =head2 NOTATION -the event description below uses a variant of the forth stack notation - +The event description below uses a variant of the forth stack notation - an opening parenthesis followed by the type of each parameter, optionally -followed by two dashes and the returning parameters. If the latter is +followed by two dashes and the returning parameters. If the latter part is missing, the event will be invoked but cannot change wether the event gets processed. -If it is specified (even if no return values are supported), a plug-in -can override (e.g. using C in Perl) event processing, -basically short-circuiting it. For example, if you override from within a -player BIRTH event, nothing much will happen with respect to the built-in -processing, but if you override from within a player TELL event, the tell -will be ignored (presumably your plug-in took care of it). +Return values are given by overriding (in Perl by calling C) +with the return values, which will both stop further event processing and +tell the caller that it wants to override normal processing. + +Even if no return values are supported, a plug-in can override (e.g. using +C in Perl) event processing, basically short-circuiting +it. For example, if you override from within a player BIRTH event, +nothing much will happen with respect to the built-in processing, but if +you override from within a player TELL event, the tell will be ignored +(presumably your plug-in took care of it). =head2 ATTACHABLE EVENTS @@ -188,7 +192,7 @@ =head3 skill_attack (attacker victim message skill -- success) Invoked whenever an B attacks B using a B (skill -cna be C). B is the message that describes the attack when +can be C). B is the message that describes the attack when damage is done. =head3 weapon_attack (weapon hitter victim) @@ -223,6 +227,18 @@ is not crash-safe, i.e. containers might be closed due to a server crash without this event being invoked. +=head3 blocked_move (self who -- do_blocked) + +Invoked when an C tries to move to the same space as C, +C's C causes blocked movement for C and nothing +else explicitly allows movement to this space. + +Should return true when C is blocked, i.e., should not be allowed to +move onto C. + +When not overriding, normal blocked_move (blocked_link) processing will +happen. + =head2 GLOBAL EVENTS @@ -379,7 +395,7 @@ Invoked whenever a player tries to leave the B. Overriding means the player won't be able to leave. -=head3 trigger (map connection state who? -- ) +=head3 trigger (map connection state what? who? -- ) Invoked whenever something activates a B on the B. If B is true the connection was 'state' and if false it is 'released'.