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

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.23 by root, Sat Nov 10 22:41:59 2007 UTC vs.
Revision 1.39 by root, Thu Apr 8 19:31:22 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.
91	Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only	119	Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only
92	during ticks should an objetc process any movement or other events.	120	during ticks should an objetc process any movement or other events.
93		121
94	=head3 kill (object hitter -- )	122	=head3 kill (object hitter -- )
95		123
96	Invoked whenever an object is dead and about to get removed. Overriding	124	Invoked whenever an object was killed (hp < 0 caused by an attack) and is
97	processing will skip removal, but to do this successfully you have to	125	about to get removed. Overriding processing will skip removal, but to do
98	objetc from dieing, otherwise the event gets invoked again and again.	126	this successfully you have to keep the object from dieing, otherwise the
		127	event gets invoked again and again.
99		128
100	=head3 apply (object who -- applytype)	129	=head3 apply (object who -- applytype)
101		130
102	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:
103		132
…		…
108	=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
109		138
110	=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
111		140
112	=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.
113		147
114	=head3 throw (object thrower)	148	=head3 throw (object thrower)
115		149
116	Invoked when an B<object> is thrown by B<thrower>.	150	Invoked when an B<object> is thrown by B<thrower>.
117		151
…		…
180	damage that has been dealt.	214	damage that has been dealt.
181		215
182	=head3 skill_attack (attacker victim message skill -- success)	216	=head3 skill_attack (attacker victim message skill -- success)
183		217
184	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
185	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
186	damage is done.	220	damage is done.
187		221
188	=head3 weapon_attack (weapon hitter victim)	222	=head3 weapon_attack (weapon hitter victim)
189		223
190	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
…		…
215	Invoked whenever a container gets closed. When overriden, the container	249	Invoked whenever a container gets closed. When overriden, the container
216	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
217	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
218	without this event being invoked.	252	without this event being invoked.
219		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
220		266
221	=head2 GLOBAL EVENTS	267	=head2 GLOBAL EVENTS
222		268
223	Global events have no relation to specific objects.	269	Global events have no relation to specific objects.
224		270
225	=head3 cleanup ()	271	=head3 cleanup ()
226		272
227	Called when the server is cleaning up, just before it calls exit.	273	Called when the server is cleaning up, just before it calls exit.
228		274
229	=head3 clock ( )	275	=head3 clock ()
230		276
231	Is invoked on every server tick, usually every 0.12 seconds.	277	Is invoked on every server tick, usually every 0.12 seconds.
		278
		279	=head3 resource_update ()
		280
		281	Is invoked after each time the server reloads its resources, which is
		282	usually one of the earliest things it does when starting up.
232		283
233		284
234	=head2 PLAYER EVENTS	285	=head2 PLAYER EVENTS
235		286
236	Player events always have a player object as first argument.	287	Player events always have a player object as first argument.
…		…
248	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
249	executed.	300	executed.
250		301
251	=head3 load (player -- )	302	=head3 load (player -- )
252		303
253	Invoked whenever a player has been loaded from disk, but before	304	Invoked whenever after a player has been loaded from disk, but before
254	actual login.	305	actual activation/login.
255		306
256	=head3 save (player -- )	307	=head3 save (player -- )
257		308
258	Invoked just before a player gets serialised.	309	Invoked just before a player gets serialised.
259		310
…		…
289		340
290	Invoked when a player entered a new region. Cannot be overriden.	341	Invoked when a player entered a new region. Cannot be overriden.
291		342
292	=head3 command (player command args -- time)	343	=head3 command (player command args -- time)
293		344
294	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>
295	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.
296		352
297	=head3 extcmd (player string)	353	=head3 extcmd (player string)
298		354
299	Invoked whenever a client issues the C<extcmd> protocol command.	355	Invoked whenever a client issues the C<extcmd> protocol command.
300	Programmable plug-ins usually handle this event internally.	356	Programmable plug-ins usually handle this event internally.
…		…
328	=head3 shout (player message --)	384	=head3 shout (player message --)
329		385
330	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,
331	before it gets processed.	387	before it gets processed.
332		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
333		394
334	=head2 MAP EVENTS	395	=head2 MAP EVENTS
335		396
336	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
337	as first argument.	398	as first argument.
…		…
366	=head3 leave (map player -- )	427	=head3 leave (map player -- )
367		428
368	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
369	player won't be able to leave.	430	player won't be able to leave.
370		431
371	=head3 trigger (map connection state -- )	432	=head3 trigger (map connection state what? who? -- )
372		433
373	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>
374	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'.
375		436
376		437
…		…
380	handled asynchronously as soon as the command reaches the server, even when	441	handled asynchronously as soon as the command reaches the server, even when
381	the player hasn't logged in yet (meaning there is no player yet).	442	the player hasn't logged in yet (meaning there is no player yet).
382		443
383	=head3 connect (client -- )	444	=head3 connect (client -- )
384		445
385	Called as soon as a new connection to the server is established. Should	446	Called as soon as a new connection to the server is established and the
386	not be overriden.	447	socket has been configured.
		448
		449	=head3 version (client string -- )
		450
		451	Called as soon as the version command from the client is received
		452	(normally the very first command sent).
387		453
388	=head3 setup (client string -- )	454	=head3 setup (client string -- )
389		455
390	Client sent the setup command to negotiate parameters. Handling is	456	Client sent the setup command to negotiate parameters. Handling is
391	mandatory and done by F<login.ext>.	457	mandatory and done by F<login.ext>.
…		…
404		470
405	Like C<extcmd>, but can be called before a player has logged in.	471	Like C<extcmd>, but can be called before a player has logged in.
406		472
407	Programmable plug-ins usually handle this event internally.	473	Programmable plug-ins usually handle this event internally.
408		474
		475	=head3 client_destroy (client -- )
		476
		477	Invoked when the client gets destroyed.
		478
		479

Diff Legend

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

Comparing deliantra/server/pod/events.pod (file contents): Revision 1.23 by root, Sat Nov 10 22:41:59 2007 UTC vs. Revision 1.39 by root, Thu Apr 8 19:31:22 2010 UTC

Diff Legend

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.23 by root, Sat Nov 10 22:41:59 2007 UTC vs.
Revision 1.39 by root, Thu Apr 8 19:31:22 2010 UTC