--- deliantra/server/pod/events.pod	2009/01/08 04:35:04	1.31
+++ deliantra/server/pod/events.pod	2009/11/03 23:44:21	1.33
@@ -1,3 +1,27 @@
+=begin comment
+
+ This file is part of Deliantra, the Roguelike Realtime MMORPG.
+  
+ Copyright (©) 2005,2006,2007,2008,2009 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
+  
+ Deliantra is free software: you can redistribute it and/or modify it under
+ the terms of the Affero GNU General Public License as published by the
+ Free Software Foundation, either version 3 of the License, or (at your
+ option) any later version.
+  
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+  
+ You should have received a copy of the Affero GNU General Public License
+ and the GNU General Public License along with this program. If not, see
+ <http://www.gnu.org/licenses/>.
+  
+ The authors can be reached via e-mail to <support@deliantra.net>
+
+=end comment
+
 =head1 DELIANTRA PLUG-IN EVENTS
 
 This document briefly describes each plug-in event. It is also used to
@@ -6,18 +30,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<cf::override> 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<cf::override>)
+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<cf::override> 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 +216,7 @@
 =head3 skill_attack (attacker victim message skill -- success)
 
 Invoked whenever an B<attacker> attacks B<victim> using a B<skill> (skill
-cna be C<undef>). B<message> is the message that describes the attack when
+can be C<undef>). B<message> is the message that describes the attack when
 damage is done.
 
 =head3 weapon_attack (weapon hitter victim)
@@ -223,6 +251,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<who> tries to move to the same space as C<self>,
+C<self>'s C<move_block> causes blocked movement for C<who> and nothing
+else explicitly allows movement to this space.
+
+Should return true when C<who> is blocked, i.e., should not be allowed to
+move onto C<self>.
+
+When not overriding, normal blocked_move (blocked_link) processing will
+happen.
+
 
 =head2 GLOBAL EVENTS