[ViewVC] Diff of: cvs/deliantra/server/pod/events.pod

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.26 by elmex, Mon Jul 14 10:26:43 2008 UTC vs.
Revision 1.36 by root, Mon Apr 5 03:22:25 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
3	This document briefly describes each plug-in event. It is also used to	27	This document briefly describes each plug-in event. It is also used to
4	generate the event-list itself, so is always complete. Be careful wehn	28	generate the event-list itself, so is always complete. Be careful wehn
5	changing it, though.	29	changing it, though.
6		30
7	=head2 NOTATION	31	=head2 NOTATION
8		32
9	the event description below uses a variant of the forth stack notation -	33	The event description below uses a variant of the forth stack notation -
10	an opening parenthesis followed by the type of each parameter, optionally	34	an opening parenthesis followed by the type of each parameter, optionally
11	followed by two dashes and the returning parameters. If the latter is	35	followed by two dashes and the returning parameters. If the latter part is
12	missing, the event will be invoked but cannot change wether the event gets	36	missing, the event will be invoked but cannot change wether the event gets
13	processed.	37	processed.
14		38
15	If it is specified (even if no return values are supported), a plug-in	39	Return values are given by overriding (in Perl by calling C<cf::override>)
16	can override (e.g. using C<cf::override> in Perl) event processing,	40	with the return values, which will both stop further event processing and
17	basically short-circuiting it. For example, if you override from within a	41	tell the caller that it wants to override normal processing.
18	player BIRTH event, nothing much will happen with respect to the built-in	42
		43	Even if no return values are supported, a plug-in can override (e.g. using
		44	C<cf::override> in Perl) event processing, basically short-circuiting
		45	it. For example, if you override from within a player BIRTH event,
		46	nothing much will happen with respect to the built-in processing, but if
19	processing, but if you override from within a player TELL event, the tell	47	you override from within a player TELL event, the tell will be ignored
20	will 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
25	No time to document this, screw me.	53	No time to document this, screw me.
100		128
101	=head3 apply (object who -- applytype)	129	=head3 apply (object who -- applytype)
102		130
103	Invoked whenever the object is being applied in some way. The applytype is one of:	131	Invoked whenever the object is being applied in some way. The applytype is one of:
104		132
105	=head3 auto_apply (object)
106
107	Invoked whenever the object is automatically applied (as for example shop tiles
108	are on map instantiation). See also the 'auto_apply' flag to enforce auto apply on
109	any object.
110
111	=over 4	133	=over 4
112		134
113	=item B<0> player or monster can't apply objects of that type	135	=item B<0> player or monster can't apply objects of that type
114		136
115	=item B<1> has been applied, or there was an error applying the object	137	=item B<1> has been applied, or there was an error applying the object
116		138
117	=item B<2> objects of that type can't be applied if not in inventory	139	=item B<2> objects of that type can't be applied if not in inventory
118		140
119	=back	141	=back
		142
		143	=head3 reset (object)
		144
		145	Invoked whenever the object is initialised on a map after it was
		146	loaded. This can be used to emulate shop-floor behaviour for example.
120		147
121	=head3 throw (object thrower)	148	=head3 throw (object thrower)
122		149
123	Invoked when an B<object> is thrown by B<thrower>.	150	Invoked when an B<object> is thrown by B<thrower>.
124		151
…		…
187	damage that has been dealt.	214	damage that has been dealt.
188		215
189	=head3 skill_attack (attacker victim message skill -- success)	216	=head3 skill_attack (attacker victim message skill -- success)
190		217
191	Invoked whenever an B<attacker> attacks B<victim> using a B<skill> (skill	218	Invoked whenever an B<attacker> attacks B<victim> using a B<skill> (skill
192	cna be C<undef>). B<message> is the message that describes the attack when	219	can be C<undef>). B<message> is the message that describes the attack when
193	damage is done.	220	damage is done.
194		221
195	=head3 weapon_attack (weapon hitter victim)	222	=head3 weapon_attack (weapon hitter victim)
196		223
197	Invoked whenever an object is used as a B<weapon> by B<hitter> to attack	224	Invoked whenever an object is used as a B<weapon> by B<hitter> to attack
…		…
222	Invoked whenever a container gets closed. When overriden, the container	249	Invoked whenever a container gets closed. When overriden, the container
223	will not get closed, but you must tell op about the reason. This event	250	will not get closed, but you must tell op about the reason. This event
224	is not crash-safe, i.e. containers might be closed due to a server crash	251	is not crash-safe, i.e. containers might be closed due to a server crash
225	without this event being invoked.	252	without this event being invoked.
226		253
		254	=head3 blocked_move (self who -- do_blocked)
		255
		256	Invoked when an C<who> tries to move to the same space as C<self>,
		257	C<self>'s C<move_block> causes blocked movement for C<who> and nothing
		258	else explicitly allows movement to this space.
		259
		260	Should return true when C<who> is blocked, i.e., should not be allowed to
		261	move onto C<self>.
		262
		263	When not overriding, normal blocked_move (blocked_link) processing will
		264	happen.
		265
227		266
228	=head2 GLOBAL EVENTS	267	=head2 GLOBAL EVENTS
229		268
230	Global events have no relation to specific objects.	269	Global events have no relation to specific objects.
231		270
…		…
301		340
302	Invoked when a player entered a new region. Cannot be overriden.	341	Invoked when a player entered a new region. Cannot be overriden.
303		342
304	=head3 command (player command args -- time)	343	=head3 command (player command args -- time)
305		344
306	Execute a user command send by the client. Programmable plug-ins usually	345	Execute a user command sent by the client - this is invoked for I<all>
307	handle this event internally.	346	command,s so should not normally be hooked.
		347
		348	=head3 unknown_command (player command args -- time)
		349
		350	Execute a user command sent by the client that isn't known to the
		351	server. Programmable plug-ins usually handle this event internally.
308		352
309	=head3 extcmd (player string)	353	=head3 extcmd (player string)
310		354
311	Invoked whenever a client issues the C<extcmd> protocol command.	355	Invoked whenever a client issues the C<extcmd> protocol command.
312	Programmable plug-ins usually handle this event internally.	356	Programmable plug-ins usually handle this event internally.
…		…
340	=head3 shout (player message --)	384	=head3 shout (player message --)
341		385
342	Invoked whenever the player uses the B<say>, B<chat> or B<shout> command,	386	Invoked whenever the player uses the B<say>, B<chat> or B<shout> command,
343	before it gets processed.	387	before it gets processed.
344		388
		389	=head3 build (player builder map x y --)
		390
		391	Players tries to build using C<builder> at (map+x+y). Is invoked after the
		392	usual sanity checks, so the coordinates are valid.
		393
345		394
346	=head2 MAP EVENTS	395	=head2 MAP EVENTS
347		396
348	These events are generally dependent on a map and thus all have a map	397	These events are generally dependent on a map and thus all have a map
349	as first argument.	398	as first argument.
…		…
378	=head3 leave (map player -- )	427	=head3 leave (map player -- )
379		428
380	Invoked whenever a player tries to leave the B<map>. Overriding means the	429	Invoked whenever a player tries to leave the B<map>. Overriding means the
381	player won't be able to leave.	430	player won't be able to leave.
382		431
383	=head3 trigger (map connection state -- )	432	=head3 trigger (map connection state what? who? -- )
384		433
385	Invoked whenever something activates a B<connection> on the B<map>. If B<state>	434	Invoked whenever something activates a B<connection> on the B<map>. If B<state>
386	is true the connection was 'state' and if false it is 'released'.	435	is true the connection was 'state' and if false it is 'released'.
387		436
388		437
…		…
416		465
417	Like C<extcmd>, but can be called before a player has logged in.	466	Like C<extcmd>, but can be called before a player has logged in.
418		467
419	Programmable plug-ins usually handle this event internally.	468	Programmable plug-ins usually handle this event internally.
420		469
		470	=head3 client_destroy (client -- )
		471
		472	Invoked when the client gets destroyed.
		473
		474

Diff Legend

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

Comparing deliantra/server/pod/events.pod (file contents): Revision 1.26 by elmex, Mon Jul 14 10:26:43 2008 UTC vs. Revision 1.36 by root, Mon Apr 5 03:22:25 2010 UTC

Diff Legend

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.26 by elmex, Mon Jul 14 10:26:43 2008 UTC vs.
Revision 1.36 by root, Mon Apr 5 03:22:25 2010 UTC