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

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.2 by elmex, Fri Sep 8 15:34:56 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 OBJECT EVENTS	51	=head2 ATTACHABLE EVENTS
24		52
25	Object events always relate to a specific object, which is always the	53	No time to document this, screw me.
26	first argument. Not all events get generated for every object, some are
27	specific to an object type.
28		54
29	=head3 instantiate (object init-args...)	55	=head3 instantiate (object init-args...)
30		56
31	An archetype was instantiated into an object. This event occurs when	57	An object was instantiated.
32	a map is loaded for the first time, or when the object was created	58
		59	For objects, this event occurs when a map is loaded for the first time
		60	when it was instantiated from an archetype, or when the object was created
33	dynamically. The arguments are as specified in the C<attach> attribute of	61	dynamically. The arguments are as specified in the C<attach> attribute of
34	the object or archetype.	62	the object or archetype.
35		63
36	This is useful to initialise any per-object state you might need.	64	This is useful to initialise any per-object state you might need.
37		65
42	server was reloaded. This event will only be generated if the object has	70	server was reloaded. This event will only be generated if the object has
43	attachments.	71	attachments.
44		72
45	=head3 clone (object destination)	73	=head3 clone (object destination)
46		74
47	An object with _attached extension_ is cloned, that is, a copy was	75	An object with _attached plugin_ is cloned, that is, a copy was made. The
48	made. The copy automatically has all attachments the original object	76	copy automatically has all attachments the original object had. The perl
49	had. The perl variables get copied in a shallow way (references are shared	77	variables get copied in a shallow way (references are shared between
50	between instances). If this is not the behaviour you need, you have to	78	instances). If this is not the behaviour you need, you have to adjust the
51	adjust the 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
		88
		89	=head2 OBJECT EVENTS
		90
		91	Object events always relate to a specific object, which is always the
		92	first argument. Not all events get generated for every object, some are
		93	specific to an object type.
		94
		95	=head3 add_bonus (item creator difficulty max_magic flags -- )
		96
		97	A basic item has been created (e.g. for shops, monsters drops etc.)
		98	that needs bonus values applied. The B<creator> object is a template
		99	object that can be used to inherit stuff (and can be NULL). Flags is a
		100	combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP
		101	on item or set its value to 0) or GT_MINIMAL (???)
		102
		103	When overriden, built-in bonus generation is skipped, otherwise
		104	treasure generation continues as it would without this hook.
		105
		106	In general, if flags != 0 or creator != 0 you should just return and leave
		107	item generation to the standard code.
		108
		109	=head3 remove (object -- )
		110
		111	Invoked before the object is removed from its environment.
		112
		113	=head3 insert (object -- )
		114
		115	Called after the object was inserted into a container or map.
		116
60	=head3 tick (object)	117	=head3 tick (object -- )
61		118
62	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
63	during ticks should an objetc process any movement or other events.	120	during ticks should an objetc process any movement or other events.
64		121
65	=head3 kill (object hitter -- )	122	=head3 kill (object hitter -- )
66		123
67	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
68	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
69	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.
70		128
71	=head3 apply (object who -- applytype)	129	=head3 apply (object who -- applytype)
72		130
73	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:
74		132
…		…
79	=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
80		138
81	=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
82		140
83	=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.
84		147
85	=head3 throw (object thrower)	148	=head3 throw (object thrower)
86		149
87	Invoked when an B<object> is thrown by B<thrower>.	150	Invoked when an B<object> is thrown by B<thrower>.
88		151
…		…
114	Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,	177	Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,
115	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'
116	(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
117	object was freed.	180	object was freed.
118		181
119	=head3 use_skill (skill who part direction strignarg -- )	182	=head3 use_skill (skill who part direction stringarg -- )
120		183
121	Invoked whenever a skill is used by somebody or something.	184	Invoked whenever a skill is used by somebody or something.
122		185
123	=head3 cast_spell (spell casting_object owner direction stringarg -- )	186	=head3 cast_spell (spell owner casting_object direction stringarg -- )
124		187
125	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
126	B<owner>).	189	B<owner>).
127		190
128	=head3 drop (object who -- )	191	=head3 drop (object who -- )
…		…
151	damage that has been dealt.	214	damage that has been dealt.
152		215
153	=head3 skill_attack (attacker victim message skill -- success)	216	=head3 skill_attack (attacker victim message skill -- success)
154		217
155	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
156	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
157	damage is done.	220	damage is done.
158		221
159	=head3 weapon_attack (weapon hitter victim)	222	=head3 weapon_attack (weapon hitter victim)
160		223
161	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
…		…
174		237
175	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
176	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,
177	signs and similar stuff.	240	signs and similar stuff.
178		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
179	=head3 close (container who -- )	247	=head3 close (container who -- )
180		248
181	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.
182		265
183		266
184	=head2 GLOBAL EVENTS	267	=head2 GLOBAL EVENTS
185		268
186	Global events have no relation to specific objects.	269	Global events have no relation to specific objects.
187		270
		271	=head3 cleanup ()
		272
		273	Called when the server is cleaning up, just before it calls exit.
		274
188	=head3 clock ( )	275	=head3 clock ()
189		276
190	Is invoked on every server tick, usually every 0.12 seconds.	277	Is invoked on every server tick, usually every 0.12 seconds.
191		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
		284
192	=head2 PLAYER EVENTS	285	=head2 PLAYER EVENTS
193		286
194	Player events always have a player object as first argument.	287	Player events always have a player object as first argument.
195		288
196	=head3 reattach (player)
197
198	Invoked whenever attachments/plug-ins need to get reattached to the player
199	object. This usually happens when the player gets loaded from disk, or
200	when the server is reloaded.
201
202	=head3 birth (player)	289	=head3 birth (player)
203		290
204	Invoked as very first thing after creating a player.	291	Invoked as very first thing after creating a player.
205		292
206	=head3 quit (player)	293	=head3 quit (player)
207		294
208	Invoked wheneever a player quits, before actually removing him/her.	295	Invoked wheneever a player quits, before actually removing him/her.
209		296
210	=head3 kick (player params -- )	297	=head3 kick (player params -- )
211		298
212	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.
213		301
214	=head3 load (player)	302	=head3 load (player -- )
215		303
216	Invoked whenever a player has been loaded from disk, but before	304	Invoked whenever a player has been loaded from disk, but before
217	actual login.	305	actual login.
218		306
219	=head3 save (player)	307	=head3 save (player -- )
220		308
221	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.
222		322
223	=head3 login (player)	323	=head3 login (player)
224		324
225	Invoked whenever a player logs in.	325	Invoked whenever a player logs in.
226		326
227	=head3 logout (player)	327	=head3 logout (player cleanly -- )
228		328
229	Invoked whenever a player logs out, gets disconnected etc.	329	Invoked whenever a player logs out, gets disconnected etc.
230		330
231	=head3 death (player)	331	=head3 death (player)
232		332
233	Invoked whenever a player dies, before the death actually gets processed.	333	Invoked whenever a player dies, before the death actually gets processed.
234		334
235	=head3 map_change (player oldmap newmap)	335	=head3 map_change (player newmap x y -- )
236		336
237	Invoked whenever a player moves from one map to another.	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.
		342
		343	=head3 command (player command args -- time)
		344
		345	Execute a user command send by the client. Programmable plug-ins usually
		346	handle this event internally.
238		347
239	=head3 extcmd (player string)	348	=head3 extcmd (player string)
240		349
241	Invoked whenever a client issues the C<extcmd> protocol command. It's	350	Invoked whenever a client issues the C<extcmd> protocol command.
242	argument is passed without any changes.	351	Programmable plug-ins usually handle this event internally.
243		352
244	=head3 move (player direction -- )	353	=head3 move (player direction -- )
		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.
245		360
246	=head3 pray_altar (player altar skill -- )	361	=head3 pray_altar (player altar skill -- )
247		362
248	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>.
249		364
250	=head3 tell (player name message -- )	365	=head3 tell (player name message -- )
251		366
252	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
253	it gets processed.	368	it gets processed.
254		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>.
		374
255	=head3 say (player message --)	375	=head3 say (player message --)
256		376
257	=head3 chat (player message --)	377	=head3 chat (player message --)
258		378
259	=head3 shout (player message --)	379	=head3 shout (player message --)
…		…
270	=head3 instantiate (map)	390	=head3 instantiate (map)
271		391
272	Original B<map> has been loaded (e.g. on first use, or after a map	392	Original B<map> has been loaded (e.g. on first use, or after a map
273	reset).	393	reset).
274		394
275	=head3 reattach (map)
276
277	Invoked whenever attachments/plug-ins need to get reattached to the
278	B<map>. This usually happens when the map was loaded from disk, or when the
279	server was reloaded.
280
281	=head3 destroy (map)
282
283	Invoked when the map object gets destroyed, and only when the map object
284	has a handler for this event. This event can occur many times, as its
285	called when the in-memory object is destroyed, not when the object itself
286	dies.
287
288	=head3 swapin (map)	395	=head3 swapin (map)
289		396
290	Invoked when a previously swapped-out temporary B<map> has been loaded again.	397	Invoked when a previously swapped-out temporary B<map> has been loaded again.
291		398
292	=head3 swapout (map)	399	=head3 swapout (map)
…		…
299		406
300	=head3 clean (map)	407	=head3 clean (map)
301		408
302	Invoked when a temporary B<map> gets deleted on-disk.	409	Invoked when a temporary B<map> gets deleted on-disk.
303		410
304	=head3 enter (map player)	411	=head3 enter (map player x y -- )
305		412
306	Invoked whenever a player enters the B<map>. This event is likely unreliable.	413	Invoked whenever a player tries to enter the B<map>, while he/she is still
		414	on the old map. Overriding means the player won't be able to enter, and,
		415	if newmap/x/y are given, will be redirected to that map instead.
307		416
308	=head3 leave (map player)	417	=head3 leave (map player -- )
309		418
310	Invoked whenever a player leaves the B<map>. This event is likely unreliable.	419	Invoked whenever a player tries to leave the B<map>. Overriding means the
		420	player won't be able to leave.
311		421
312	=head3 upgrade (map)
313
314	(TEMPORARY EVENT) gets invoked whenever a old-style map has been upgraded.
315
316	=head3 trigger (map connection state)	422	=head3 trigger (map connection state what? who? -- )
317		423
318	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>
319	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'.
		426
		427
		428	=head2 CLIENT EVENTS
		429
		430	These events are very similar to player events, but they are might be
		431	handled asynchronously as soon as the command reaches the server, even when
		432	the player hasn't logged in yet (meaning there is no player yet).
		433
		434	=head3 connect (client -- )
		435
		436	Called as soon as a new connection to the server is established. Should
		437	not be overriden.
		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
		444	=head3 addme (client -- )
		445
		446	The client sent an addme, thus ending the initial handshaking. Handling is mandatory
		447	and done by F<login.ext>.
		448
		449	=head3 reply (client replystring -- )
		450
		451	Called when the client submits a reply in the ST_CUSTOM state. Usually
		452	handled internally by language plugins.
		453
		454	=head3 exticmd (client string -- )
		455
		456	Like C<extcmd>, but can be called before a player has logged in.
		457
		458	Programmable plug-ins usually handle this event internally.
		459

Diff Legend

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

Comparing deliantra/server/pod/events.pod (file contents): Revision 1.2 by elmex, Fri Sep 8 15:34:56 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.2 by elmex, Fri Sep 8 15:34:56 2006 UTC vs.
Revision 1.33 by root, Tue Nov 3 23:44:21 2009 UTC