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

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.25 by root, Wed Apr 30 05:34:24 2008 UTC vs.
Revision 1.41 by root, Mon Oct 1 01:43:39 2012 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.
110		138
111	=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
112		140
113	=back	141	=back
114		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.
		147
115	=head3 throw (object thrower)	148	=head3 throw (object thrower)
116		149
117	Invoked when an B<object> is thrown by B<thrower>.	150	Invoked when an B<object> is thrown by B<thrower>.
118		151
119	=head3 stop (object -- )	152	=head3 stop (object -- )
…		…
181	damage that has been dealt.	214	damage that has been dealt.
182		215
183	=head3 skill_attack (attacker victim message skill -- success)	216	=head3 skill_attack (attacker victim message skill -- success)
184		217
185	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
186	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
187	damage is done.	220	damage is done.
188		221
189	=head3 weapon_attack (weapon hitter victim)	222	=head3 weapon_attack (weapon hitter victim)
190		223
191	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
192	B<victim>.	225	B<victim>.
193		226
194	=head3 inscribe_note (book pl message skill -- )	227	=head3 inscribe_note (book pl message skill -- )
195		228
196	Used whenever a book gets inscribed with a message.	229	Used whenever a book gets inscribed with a message.
		230
		231	=head3 infect (victim disease_type disease -- )
		232
		233	Invoked whenever an object is diseased. The disease object is already
		234	inserted in object (the template disease object is C<disease_type>),
		235	but no messages have been generated. If overriden, no messages will be
		236	generated.
197		237
198	=head3 trigger (object who -- )	238	=head3 trigger (object who -- )
199		239
200	Invoked whenever a lever-like B<object> has been activated/triggered in some	240	Invoked whenever a lever-like B<object> has been activated/triggered in some
201	(manual) way.	241	(manual) way.
…		…
216	Invoked whenever a container gets closed. When overriden, the container	256	Invoked whenever a container gets closed. When overriden, the container
217	will not get closed, but you must tell op about the reason. This event	257	will not get closed, but you must tell op about the reason. This event
218	is not crash-safe, i.e. containers might be closed due to a server crash	258	is not crash-safe, i.e. containers might be closed due to a server crash
219	without this event being invoked.	259	without this event being invoked.
220		260
		261	=head3 blocked_move (self who -- do_blocked)
		262
		263	Invoked when an C<who> tries to move to the same space as C<self>,
		264	C<self>'s C<move_block> causes blocked movement for C<who> and nothing
		265	else explicitly allows movement to this space.
		266
		267	Should return true when C<who> is blocked, i.e., should not be allowed to
		268	move onto C<self>.
		269
		270	When not overriding, normal blocked_move (blocked_link) processing will
		271	happen.
		272
221		273
222	=head2 GLOBAL EVENTS	274	=head2 GLOBAL EVENTS
223		275
224	Global events have no relation to specific objects.	276	Global events have no relation to specific objects.
225		277
…		…
254	Invoked when the given player is being kicked, before the kick is	306	Invoked when the given player is being kicked, before the kick is
255	executed.	307	executed.
256		308
257	=head3 load (player -- )	309	=head3 load (player -- )
258		310
259	Invoked whenever a player has been loaded from disk, but before	311	Invoked whenever after a player has been loaded from disk, but before
260	actual login.	312	actual activation/login.
261		313
262	=head3 save (player -- )	314	=head3 save (player -- )
263		315
264	Invoked just before a player gets serialised.	316	Invoked just before a player gets serialised.
265		317
…		…
295		347
296	Invoked when a player entered a new region. Cannot be overriden.	348	Invoked when a player entered a new region. Cannot be overriden.
297		349
298	=head3 command (player command args -- time)	350	=head3 command (player command args -- time)
299		351
300	Execute a user command send by the client. Programmable plug-ins usually	352	Execute a user command sent by the client - this is invoked for I<all>
301	handle this event internally.	353	command,s so should not normally be hooked.
		354
		355	=head3 unknown_command (player command args -- time)
		356
		357	Execute a user command sent by the client that isn't known to the
		358	server. Programmable plug-ins usually handle this event internally.
302		359
303	=head3 extcmd (player string)	360	=head3 extcmd (player string)
304		361
305	Invoked whenever a client issues the C<extcmd> protocol command.	362	Invoked whenever a client issues the C<extcmd> protocol command.
306	Programmable plug-ins usually handle this event internally.	363	Programmable plug-ins usually handle this event internally.
…		…
334	=head3 shout (player message --)	391	=head3 shout (player message --)
335		392
336	Invoked whenever the player uses the B<say>, B<chat> or B<shout> command,	393	Invoked whenever the player uses the B<say>, B<chat> or B<shout> command,
337	before it gets processed.	394	before it gets processed.
338		395
		396	=head3 build (player builder map x y checkok --)
		397
		398	Players tries to build using C<builder> at (map+x+y). Is invoked after
		399	the usual map sanity checks, so the coordinates are valid. The boolean
		400	C<checkok> is true only if the build code thinks it is "ok" to build at
		401	that space, and normally you should only build when it is true.
		402
339		403
340	=head2 MAP EVENTS	404	=head2 MAP EVENTS
341		405
342	These events are generally dependent on a map and thus all have a map	406	These events are generally dependent on a map and thus all have a map
343	as first argument.	407	as first argument.
…		…
372	=head3 leave (map player -- )	436	=head3 leave (map player -- )
373		437
374	Invoked whenever a player tries to leave the B<map>. Overriding means the	438	Invoked whenever a player tries to leave the B<map>. Overriding means the
375	player won't be able to leave.	439	player won't be able to leave.
376		440
377	=head3 trigger (map connection state -- )	441	=head3 trigger (map connection state what? who? -- )
378		442
379	Invoked whenever something activates a B<connection> on the B<map>. If B<state>	443	Invoked whenever something activates a B<connection> on the B<map>. If B<state>
380	is true the connection was 'state' and if false it is 'released'.	444	is true the connection was 'state' and if false it is 'released'.
381		445
382		446
…		…
386	handled asynchronously as soon as the command reaches the server, even when	450	handled asynchronously as soon as the command reaches the server, even when
387	the player hasn't logged in yet (meaning there is no player yet).	451	the player hasn't logged in yet (meaning there is no player yet).
388		452
389	=head3 connect (client -- )	453	=head3 connect (client -- )
390		454
391	Called as soon as a new connection to the server is established. Should	455	Called as soon as a new connection to the server is established and the
392	not be overriden.	456	socket has been configured.
		457
		458	=head3 version (client string -- )
		459
		460	Called as soon as the version command from the client is received
		461	(normally the very first command sent).
393		462
394	=head3 setup (client string -- )	463	=head3 setup (client string -- )
395		464
396	Client sent the setup command to negotiate parameters. Handling is	465	Client sent the setup command to negotiate parameters. Handling is
397	mandatory and done by F<login.ext>.	466	mandatory and done by F<login.ext>.
…		…
410		479
411	Like C<extcmd>, but can be called before a player has logged in.	480	Like C<extcmd>, but can be called before a player has logged in.
412		481
413	Programmable plug-ins usually handle this event internally.	482	Programmable plug-ins usually handle this event internally.
414		483
		484	=head3 client_destroy (client -- )
		485
		486	Invoked when the client gets destroyed.
		487
		488

Diff Legend

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

Comparing deliantra/server/pod/events.pod (file contents): Revision 1.25 by root, Wed Apr 30 05:34:24 2008 UTC vs. Revision 1.41 by root, Mon Oct 1 01:43:39 2012 UTC

Diff Legend

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.25 by root, Wed Apr 30 05:34:24 2008 UTC vs.
Revision 1.41 by root, Mon Oct 1 01:43:39 2012 UTC