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

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.12 by root, Mon Dec 25 11:25:49 2006 UTC vs.
Revision 1.33 by root, Tue Nov 3 23:44:21 2009 UTC

…		…
1	=head1 CROSSFIRE+ PLUG-IN EVENTS	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
		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.
50	instances). If this is not the behaviour you need, you have to adjust the	78	instances). If this is not the behaviour you need, you have to adjust the
51	B<destination> object as you see fit.	79	B<destination> object as you see fit.
52		80
53	=head3 destroy (object -- )	81	=head3 destroy (object -- )
54		82
55	Invoked when the crossfire object gets destroyed, and only when the object	83	Invoked when the deliantra object gets destroyed, and only when the object
56	has a handler for this event. This event can occur many times, as its	84	has a handler for this event. This event can occur many times, as its
57	called when the in-memory object is destroyed, not when the object itself	85	called when the in-memory object is destroyed, not when the object itself
58	dies.	86	dies.
59		87
60		88
…		…
62		90
63	Object events always relate to a specific object, which is always the	91	Object events always relate to a specific object, which is always the
64	first argument. Not all events get generated for every object, some are	92	first argument. Not all events get generated for every object, some are
65	specific to an object type.	93	specific to an object type.
66		94
67	=head3 add_bonus (item creator difficulty max_magic flags)	95	=head3 add_bonus (item creator difficulty max_magic flags -- )
68		96
69	A basic item has been created (e.g. for shops, monsters drops etc.)	97	A basic item has been created (e.g. for shops, monsters drops etc.)
70	that needs bonus values applied. The B<creator> object is a template	98	that needs bonus values applied. The B<creator> object is a template
71	object that can be used to inherit stuff (and can be NULL). Flags is a	99	object that can be used to inherit stuff (and can be NULL). Flags is a
72	combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP	100	combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP
…		…
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
…		…
143	Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,	177	Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,
144	currently applied by B<who>. If your override, make sure you give 'who'	178	currently applied by B<who>. If your override, make sure you give 'who'
145	(if it is a player) an indication of whats wrong. Must return true if the	179	(if it is a player) an indication of whats wrong. Must return true if the
146	object was freed.	180	object was freed.
147		181
148	=head3 use_skill (skill who part direction strignarg -- )	182	=head3 use_skill (skill who part direction stringarg -- )
149		183
150	Invoked whenever a skill is used by somebody or something.	184	Invoked whenever a skill is used by somebody or something.
151		185
152	=head3 cast_spell (spell casting_object owner direction stringarg -- )	186	=head3 cast_spell (spell owner casting_object direction stringarg -- )
153		187
154	Invoked whenever a given spell is cast by B<casting_object> (used by	188	Invoked whenever a given spell is cast by B<casting_object> (used by
155	B<owner>).	189	B<owner>).
156		190
157	=head3 drop (object who -- )	191	=head3 drop (object who -- )
…		…
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
…		…
203		237
204	Invoked whenever a trap-like B<object> has been activated, usually by	238	Invoked whenever a trap-like B<object> has been activated, usually by
205	moving onto it. This includes not just traps, but also buttons, holes,	239	moving onto it. This includes not just traps, but also buttons, holes,
206	signs and similar stuff.	240	signs and similar stuff.
207		241
		242	=head3 open (container who -- )
		243
		244	Invoked whenever a container gets opened. When overriden, the container will not
		245	get opened, but you must tell op about the reason.
		246
208	=head3 close (container who -- )	247	=head3 close (container who -- )
209		248
210	Invoked whenever a container gets closed (this event is not yet reliable!).	249	Invoked whenever a container gets closed. When overriden, the container
		250	will not get closed, but you must tell op about the reason. This event
		251	is not crash-safe, i.e. containers might be closed due to a server crash
		252	without this event being invoked.
		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.
211		265
212		266
213	=head2 GLOBAL EVENTS	267	=head2 GLOBAL EVENTS
214		268
215	Global events have no relation to specific objects.	269	Global events have no relation to specific objects.
216		270
217	=head3 cleanup ()	271	=head3 cleanup ()
218		272
219	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.
220		274
221	=head3 clock ( )	275	=head3 clock ()
222		276
223	Is invoked on every server tick, usually every 0.12 seconds.	277	Is invoked on every server tick, usually every 0.12 seconds.
224		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.
		283
225		284
226	=head2 PLAYER EVENTS	285	=head2 PLAYER EVENTS
227		286
228	Player events always have a player object as first argument.	287	Player events always have a player object as first argument.
229		288
…		…
235		294
236	Invoked wheneever a player quits, before actually removing him/her.	295	Invoked wheneever a player quits, before actually removing him/her.
237		296
238	=head3 kick (player params -- )	297	=head3 kick (player params -- )
239		298
240	Invoked when the given plaer is being kicked, before the kick is executed.	299	Invoked when the given player is being kicked, before the kick is
		300	executed.
241		301
242	=head3 load (player)	302	=head3 load (player -- )
243		303
244	Invoked whenever a player has been loaded from disk, but before	304	Invoked whenever a player has been loaded from disk, but before
245	actual login.	305	actual login.
246		306
247	=head3 save (player)	307	=head3 save (player -- )
248		308
249	Invoked just before a player gets saved.	309	Invoked just before a player gets serialised.
		310
		311	=head3 save_done (player -- )
		312
		313	Invoked just after a player was serialised.
		314
		315	=head3 connect (player -- )
		316
		317	Invoked just after the player object was connected to a client.
		318
		319	=head3 disconnect (player -- )
		320
		321	Invoked just before the player gets disconnected from the client.
250		322
251	=head3 login (player)	323	=head3 login (player)
252		324
253	Invoked whenever a player logs in.	325	Invoked whenever a player logs in.
254		326
255	=head3 logout (player)	327	=head3 logout (player cleanly -- )
256		328
257	Invoked whenever a player logs out, gets disconnected etc.	329	Invoked whenever a player logs out, gets disconnected etc.
258		330
259	=head3 death (player)	331	=head3 death (player)
260		332
261	Invoked whenever a player dies, before the death actually gets processed.	333	Invoked whenever a player dies, before the death actually gets processed.
262		334
263	=head3 map_change (player newmap x y -- )	335	=head3 map_change (player newmap x y -- )
264		336
265	Invoked before a player moves from one map to another, can override the movement.	337	Invoked before a player moves from one map to another, can override the movement.
		338
		339	=head3 region_change (player newregion oldregion -- )
		340
		341	Invoked when a player entered a new region. Cannot be overriden.
266		342
267	=head3 command (player command args -- time)	343	=head3 command (player command args -- time)
268		344
269	Execute a user command send by the client. Programmable plug-ins usually	345	Execute a user command send by the client. Programmable plug-ins usually
270	handle this event internally.	346	handle this event internally.
…		…
274	Invoked whenever a client issues the C<extcmd> protocol command.	350	Invoked whenever a client issues the C<extcmd> protocol command.
275	Programmable plug-ins usually handle this event internally.	351	Programmable plug-ins usually handle this event internally.
276		352
277	=head3 move (player direction -- )	353	=head3 move (player direction -- )
278		354
		355	Called whenever the player is supposed to move or attack. The handler
		356	must handle the cases of speed_left or weapon_sp_left being negative,
		357	fire being on, is responsible for decreaseing the speed_left value
		358	on successful moves etc. etc.. When overriden, must return a boolean
		359	indicating wether a move could be effected.
		360
279	=head3 pray_altar (player altar skill -- )	361	=head3 pray_altar (player altar skill -- )
280		362
281	Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.	363	Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.
282		364
283	=head3 tell (player name message -- )	365	=head3 tell (player name message -- )
284		366
285	Invoked whenever the player uses the B<tell> or B<reply> command, before	367	Invoked whenever the player uses the B<tell> or B<reply> command, before
286	it gets processed.	368	it gets processed.
		369
		370	=head3 told (player player message -- )
		371
		372	Invoked right before a message is being told to a player using B<tell> or
		373	B<reply>.
287		374
288	=head3 say (player message --)	375	=head3 say (player message --)
289		376
290	=head3 chat (player message --)	377	=head3 chat (player message --)
291		378
…		…
330	=head3 leave (map player -- )	417	=head3 leave (map player -- )
331		418
332	Invoked whenever a player tries to leave the B<map>. Overriding means the	419	Invoked whenever a player tries to leave the B<map>. Overriding means the
333	player won't be able to leave.	420	player won't be able to leave.
334		421
335	=head3 trigger (map connection state -- )	422	=head3 trigger (map connection state what? who? -- )
336		423
337	Invoked whenever something activates a B<connection> on the B<map>. If B<state>	424	Invoked whenever something activates a B<connection> on the B<map>. If B<state>
338	is true the connection was 'state' and if false it is 'released'.	425	is true the connection was 'state' and if false it is 'released'.
339		426
340		427
…		…
347	=head3 connect (client -- )	434	=head3 connect (client -- )
348		435
349	Called as soon as a new connection to the server is established. Should	436	Called as soon as a new connection to the server is established. Should
350	not be overriden.	437	not be overriden.
351		438
		439	=head3 setup (client string -- )
		440
		441	Client sent the setup command to negotiate parameters. Handling is
		442	mandatory and done by F<login.ext>.
		443
352	=head3 addme (client -- )	444	=head3 addme (client -- )
353		445
354	The client sent an addme, thus ending the initial handshaking. If overriden, the server	446	The client sent an addme, thus ending the initial handshaking. Handling is mandatory
355	will not send any response.	447	and done by F<login.ext>.
356		448
357	=head3 reply (client replystring -- )	449	=head3 reply (client replystring -- )
358		450
359	Called when the client submits a reply in the ST_CUSTOM state. Usually	451	Called when the client submits a reply in the ST_CUSTOM state. Usually
360	handled internally by language plugins.	452	handled internally by language plugins.

Diff Legend

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

Comparing deliantra/server/pod/events.pod (file contents): Revision 1.12 by root, Mon Dec 25 11:25:49 2006 UTC vs. Revision 1.33 by root, Tue Nov 3 23:44:21 2009 UTC

Diff Legend

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.12 by root, Mon Dec 25 11:25:49 2006 UTC vs.
Revision 1.33 by root, Tue Nov 3 23:44:21 2009 UTC