ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/pod/events.pod
(Generate patch)

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.31 by root, Thu Jan 8 04:35:04 2009 UTC vs.
Revision 1.34 by root, Fri Mar 19 17:48:47 2010 UTC

1=begin comment
2
3 This file is part of Deliantra, the Roguelike Realtime MMORPG.
4
5 Copyright (©) 2005,2006,2007,2008,2009 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
6
7 Deliantra is free software: you can redistribute it and/or modify it under
8 the terms of the Affero GNU General Public License as published by the
9 Free Software Foundation, either version 3 of the License, or (at your
10 option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the Affero GNU General Public License
18 and the GNU General Public License along with this program. If not, see
19 <http://www.gnu.org/licenses/>.
20
21 The authors can be reached via e-mail to <support@deliantra.net>
22
23=end comment
24
1=head1 DELIANTRA PLUG-IN EVENTS 25=head1 DELIANTRA PLUG-IN EVENTS
2 26
3This document briefly describes each plug-in event. It is also used to 27This document briefly describes each plug-in event. It is also used to
4generate the event-list itself, so is always complete. Be careful wehn 28generate the event-list itself, so is always complete. Be careful wehn
5changing it, though. 29changing it, though.
6 30
7=head2 NOTATION 31=head2 NOTATION
8 32
9the event description below uses a variant of the forth stack notation - 33The event description below uses a variant of the forth stack notation -
10an opening parenthesis followed by the type of each parameter, optionally 34an opening parenthesis followed by the type of each parameter, optionally
11followed by two dashes and the returning parameters. If the latter is 35followed by two dashes and the returning parameters. If the latter part is
12missing, the event will be invoked but cannot change wether the event gets 36missing, the event will be invoked but cannot change wether the event gets
13processed. 37processed.
14 38
15If it is specified (even if no return values are supported), a plug-in 39Return values are given by overriding (in Perl by calling C<cf::override>)
16can override (e.g. using C<cf::override> in Perl) event processing, 40with the return values, which will both stop further event processing and
17basically short-circuiting it. For example, if you override from within a 41tell the caller that it wants to override normal processing.
18player BIRTH event, nothing much will happen with respect to the built-in 42
43Even if no return values are supported, a plug-in can override (e.g. using
44C<cf::override> in Perl) event processing, basically short-circuiting
45it. For example, if you override from within a player BIRTH event,
46nothing much will happen with respect to the built-in processing, but if
19processing, but if you override from within a player TELL event, the tell 47you override from within a player TELL event, the tell will be ignored
20will be ignored (presumably your plug-in took care of it). 48(presumably your plug-in took care of it).
21 49
22 50
23=head2 ATTACHABLE EVENTS 51=head2 ATTACHABLE EVENTS
24 52
25No time to document this, screw me. 53No time to document this, screw me.
… …
186damage that has been dealt. 214damage that has been dealt.
187 215
188=head3 skill_attack (attacker victim message skill -- success) 216=head3 skill_attack (attacker victim message skill -- success)
189 217
190Invoked whenever an B<attacker> attacks B<victim> using a B<skill> (skill 218Invoked whenever an B<attacker> attacks B<victim> using a B<skill> (skill
191cna be C<undef>). B<message> is the message that describes the attack when 219can be C<undef>). B<message> is the message that describes the attack when
192damage is done. 220damage is done.
193 221
194=head3 weapon_attack (weapon hitter victim) 222=head3 weapon_attack (weapon hitter victim)
195 223
196Invoked whenever an object is used as a B<weapon> by B<hitter> to attack 224Invoked whenever an object is used as a B<weapon> by B<hitter> to attack
… …
220 248
221Invoked whenever a container gets closed. When overriden, the container 249Invoked whenever a container gets closed. When overriden, the container
222will not get closed, but you must tell op about the reason. This event 250will not get closed, but you must tell op about the reason. This event
223is not crash-safe, i.e. containers might be closed due to a server crash 251is not crash-safe, i.e. containers might be closed due to a server crash
224without this event being invoked. 252without this event being invoked.
253
254=head3 blocked_move (self who -- do_blocked)
255
256Invoked when an C<who> tries to move to the same space as C<self>,
257C<self>'s C<move_block> causes blocked movement for C<who> and nothing
258else explicitly allows movement to this space.
259
260Should return true when C<who> is blocked, i.e., should not be allowed to
261move onto C<self>.
262
263When not overriding, normal blocked_move (blocked_link) processing will
264happen.
225 265
226 266
227=head2 GLOBAL EVENTS 267=head2 GLOBAL EVENTS
228 268
229Global events have no relation to specific objects. 269Global events have no relation to specific objects.
… …
339=head3 shout (player message --) 379=head3 shout (player message --)
340 380
341Invoked whenever the player uses the B<say>, B<chat> or B<shout> command, 381Invoked whenever the player uses the B<say>, B<chat> or B<shout> command,
342before it gets processed. 382before it gets processed.
343 383
384=head3 build (player x y builder --)
385
386Players tries to build at (x|y), using C<builder>.
387
344 388
345=head2 MAP EVENTS 389=head2 MAP EVENTS
346 390
347These events are generally dependent on a map and thus all have a map 391These events are generally dependent on a map and thus all have a map
348as first argument. 392as first argument.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines