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

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.29 by elmex, Tue Oct 7 11:10:31 2008 UTC vs.
Revision 1.40 by root, Tue Apr 13 18:57:06 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.
186	damage that has been dealt.	214	damage 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
190	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
191	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
192	damage is done.	220	damage is done.
193		221
194	=head3 weapon_attack (weapon hitter victim)	222	=head3 weapon_attack (weapon hitter victim)
195		223
196	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
…		…
221	Invoked whenever a container gets closed. When overriden, the container	249	Invoked whenever a container gets closed. When overriden, the container
222	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
223	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
224	without this event being invoked.	252	without this event being invoked.
225		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
226		266
227	=head2 GLOBAL EVENTS	267	=head2 GLOBAL EVENTS
228		268
229	Global events have no relation to specific objects.	269	Global events have no relation to specific objects.
230		270
…		…
259	Invoked when the given player is being kicked, before the kick is	299	Invoked when the given player is being kicked, before the kick is
260	executed.	300	executed.
261		301
262	=head3 load (player -- )	302	=head3 load (player -- )
263		303
264	Invoked whenever a player has been loaded from disk, but before	304	Invoked whenever after a player has been loaded from disk, but before
265	actual login.	305	actual activation/login.
266		306
267	=head3 save (player -- )	307	=head3 save (player -- )
268		308
269	Invoked just before a player gets serialised.	309	Invoked just before a player gets serialised.
270		310
…		…
300		340
301	Invoked when a player entered a new region. Cannot be overriden.	341	Invoked when a player entered a new region. Cannot be overriden.
302		342
303	=head3 command (player command args -- time)	343	=head3 command (player command args -- time)
304		344
305	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>
306	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.
307		352
308	=head3 extcmd (player string)	353	=head3 extcmd (player string)
309		354
310	Invoked whenever a client issues the C<extcmd> protocol command.	355	Invoked whenever a client issues the C<extcmd> protocol command.
311	Programmable plug-ins usually handle this event internally.	356	Programmable plug-ins usually handle this event internally.
…		…
339	=head3 shout (player message --)	384	=head3 shout (player message --)
340		385
341	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,
342	before it gets processed.	387	before it gets processed.
343		388
		389	=head3 build (player builder map x y checkok --)
		390
		391	Players tries to build using C<builder> at (map+x+y). Is invoked after
		392	the usual map sanity checks, so the coordinates are valid. The boolean
		393	C<checkok> is true only if the build code thinks it is "ok" to build at
		394	that space, and normally you should only build when it is true.
		395
344		396
345	=head2 MAP EVENTS	397	=head2 MAP EVENTS
346		398
347	These events are generally dependent on a map and thus all have a map	399	These events are generally dependent on a map and thus all have a map
348	as first argument.	400	as first argument.
…		…
377	=head3 leave (map player -- )	429	=head3 leave (map player -- )
378		430
379	Invoked whenever a player tries to leave the B<map>. Overriding means the	431	Invoked whenever a player tries to leave the B<map>. Overriding means the
380	player won't be able to leave.	432	player won't be able to leave.
381		433
382	=head3 trigger (map connection state -- )	434	=head3 trigger (map connection state what? who? -- )
383		435
384	Invoked whenever something activates a B<connection> on the B<map>. If B<state>	436	Invoked whenever something activates a B<connection> on the B<map>. If B<state>
385	is true the connection was 'state' and if false it is 'released'.	437	is true the connection was 'state' and if false it is 'released'.
386		438
387		439
…		…
391	handled asynchronously as soon as the command reaches the server, even when	443	handled asynchronously as soon as the command reaches the server, even when
392	the player hasn't logged in yet (meaning there is no player yet).	444	the player hasn't logged in yet (meaning there is no player yet).
393		445
394	=head3 connect (client -- )	446	=head3 connect (client -- )
395		447
396	Called as soon as a new connection to the server is established. Should	448	Called as soon as a new connection to the server is established and the
397	not be overriden.	449	socket has been configured.
		450
		451	=head3 version (client string -- )
		452
		453	Called as soon as the version command from the client is received
		454	(normally the very first command sent).
398		455
399	=head3 setup (client string -- )	456	=head3 setup (client string -- )
400		457
401	Client sent the setup command to negotiate parameters. Handling is	458	Client sent the setup command to negotiate parameters. Handling is
402	mandatory and done by F<login.ext>.	459	mandatory and done by F<login.ext>.
…		…
415		472
416	Like C<extcmd>, but can be called before a player has logged in.	473	Like C<extcmd>, but can be called before a player has logged in.
417		474
418	Programmable plug-ins usually handle this event internally.	475	Programmable plug-ins usually handle this event internally.
419		476
		477	=head3 client_destroy (client -- )
		478
		479	Invoked when the client gets destroyed.
		480
		481

Diff Legend

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

Comparing deliantra/server/pod/events.pod (file contents): Revision 1.29 by elmex, Tue Oct 7 11:10:31 2008 UTC vs. Revision 1.40 by root, Tue Apr 13 18:57:06 2010 UTC

Diff Legend

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.29 by elmex, Tue Oct 7 11:10:31 2008 UTC vs.
Revision 1.40 by root, Tue Apr 13 18:57:06 2010 UTC