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

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.7 by root, Mon Dec 11 22:56:57 2006 UTC vs.
Revision 1.26 by elmex, Mon Jul 14 10:26:43 2008 UTC

…		…
1	=head1 CROSSFIRE+ PLUG-IN EVENTS	1	=head1 DELIANTRA PLUG-IN EVENTS
2		2
3	This document briefly describes each plug-in event. It is also used to	3	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	4	generate the event-list itself, so is always complete. Be careful wehn
5	changing it, though.	5	changing it, though.
6		6
18	player BIRTH event, nothing much will happen with respect to the built-in	18	player BIRTH event, nothing much will happen with respect to the built-in
19	processing, but if you override from within a player TELL event, the tell	19	processing, but if you override from within a player TELL event, the tell
20	will be ignored (presumably your plug-in took care of it).	20	will be ignored (presumably your plug-in took care of it).
21		21
22		22
23	=head2 OBJECT EVENTS	23	=head2 ATTACHABLE EVENTS
24		24
25	Object events always relate to a specific object, which is always the	25	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		26
29	=head3 instantiate (object init-args...)	27	=head3 instantiate (object init-args...)
30		28
31	An archetype was instantiated into an object. This event occurs when	29	An object was instantiated.
32	a map is loaded for the first time, or when the object was created	30
		31	For objects, this event occurs when a map is loaded for the first time
		32	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	33	dynamically. The arguments are as specified in the C<attach> attribute of
34	the object or archetype.	34	the object or archetype.
35		35
36	This is useful to initialise any per-object state you might need.	36	This is useful to initialise any per-object state you might need.
37		37
…		…
42	server was reloaded. This event will only be generated if the object has	42	server was reloaded. This event will only be generated if the object has
43	attachments.	43	attachments.
44		44
45	=head3 clone (object destination)	45	=head3 clone (object destination)
46		46
47	An object with _attached extension_ is cloned, that is, a copy was	47	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	48	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	49	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	50	instances). If this is not the behaviour you need, you have to adjust the
51	adjust the B<destination> object as you see fit.	51	B<destination> object as you see fit.
52		52
		53	=head3 destroy (object -- )
		54
		55	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
		57	called when the in-memory object is destroyed, not when the object itself
		58	dies.
		59
		60
		61	=head2 OBJECT EVENTS
		62
		63	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
		65	specific to an object type.
		66
53	=head3 add_bonus (item creator difficulty max_magic flags)	67	=head3 add_bonus (item creator difficulty max_magic flags -- )
54		68
55	A basic item has been created (e.g. for shops, monsters drops etc.)	69	A basic item has been created (e.g. for shops, monsters drops etc.)
56	that needs bonus values applied. The B<creator> object is a template	70	that needs bonus values applied. The B<creator> object is a template
57	object that can be used to inherit stuff (and can be NULL). Flags is a	71	object that can be used to inherit stuff (and can be NULL). Flags is a
58	combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP	72	combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP
…		…
62	treasure generation continues as it would without this hook.	76	treasure generation continues as it would without this hook.
63		77
64	In general, if flags != 0 or creator != 0 you should just return and leave	78	In general, if flags != 0 or creator != 0 you should just return and leave
65	item generation to the standard code.	79	item generation to the standard code.
66		80
67	=head3 destroy (object)	81	=head3 remove (object -- )
68		82
69	Invoked when the crossfire object gets destroyed, and only when the object	83	Invoked before the object is removed from its environment.
70	has a handler for this event. This event can occur many times, as its
71	called when the in-memory object is destroyed, not when the object itself
72	dies.
73		84
		85	=head3 insert (object -- )
		86
		87	Called after the object was inserted into a container or map.
		88
74	=head3 tick (object)	89	=head3 tick (object -- )
75		90
76	Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only	91	Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only
77	during ticks should an objetc process any movement or other events.	92	during ticks should an objetc process any movement or other events.
78		93
79	=head3 kill (object hitter -- )	94	=head3 kill (object hitter -- )
80		95
81	Invoked whenever an object is dead and about to get removed. Overriding	96	Invoked whenever an object was killed (hp < 0 caused by an attack) and is
82	processing will skip removal, but to do this successfully you have to	97	about to get removed. Overriding processing will skip removal, but to do
83	objetc from dieing, otherwise the event gets invoked again and again.	98	this successfully you have to keep the object from dieing, otherwise the
		99	event gets invoked again and again.
84		100
85	=head3 apply (object who -- applytype)	101	=head3 apply (object who -- applytype)
86		102
87	Invoked whenever the object is being applied in some way. The applytype is one of:	103	Invoked whenever the object is being applied in some way. The applytype is one of:
		104
		105	=head3 auto_apply (object)
		106
		107	Invoked whenever the object is automatically applied (as for example shop tiles
		108	are on map instantiation). See also the 'auto_apply' flag to enforce auto apply on
		109	any object.
88		110
89	=over 4	111	=over 4
90		112
91	=item B<0> player or monster can't apply objects of that type	113	=item B<0> player or monster can't apply objects of that type
92		114
…		…
128	Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,	150	Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,
129	currently applied by B<who>. If your override, make sure you give 'who'	151	currently applied by B<who>. If your override, make sure you give 'who'
130	(if it is a player) an indication of whats wrong. Must return true if the	152	(if it is a player) an indication of whats wrong. Must return true if the
131	object was freed.	153	object was freed.
132		154
133	=head3 use_skill (skill who part direction strignarg -- )	155	=head3 use_skill (skill who part direction stringarg -- )
134		156
135	Invoked whenever a skill is used by somebody or something.	157	Invoked whenever a skill is used by somebody or something.
136		158
137	=head3 cast_spell (spell casting_object owner direction stringarg -- )	159	=head3 cast_spell (spell owner casting_object direction stringarg -- )
138		160
139	Invoked whenever a given spell is cast by B<casting_object> (used by	161	Invoked whenever a given spell is cast by B<casting_object> (used by
140	B<owner>).	162	B<owner>).
141		163
142	=head3 drop (object who -- )	164	=head3 drop (object who -- )
…		…
188		210
189	Invoked whenever a trap-like B<object> has been activated, usually by	211	Invoked whenever a trap-like B<object> has been activated, usually by
190	moving onto it. This includes not just traps, but also buttons, holes,	212	moving onto it. This includes not just traps, but also buttons, holes,
191	signs and similar stuff.	213	signs and similar stuff.
192		214
		215	=head3 open (container who -- )
		216
		217	Invoked whenever a container gets opened. When overriden, the container will not
		218	get opened, but you must tell op about the reason.
		219
193	=head3 close (container who -- )	220	=head3 close (container who -- )
194		221
195	Invoked whenever a container gets closed (this event is not yet reliable!).	222	Invoked whenever a container gets closed. When overriden, the container
		223	will not get closed, but you must tell op about the reason. This event
		224	is not crash-safe, i.e. containers might be closed due to a server crash
		225	without this event being invoked.
196		226
197		227
198	=head2 GLOBAL EVENTS	228	=head2 GLOBAL EVENTS
199		229
200	Global events have no relation to specific objects.	230	Global events have no relation to specific objects.
201		231
202	=head3 cleanup ()	232	=head3 cleanup ()
203		233
204	Called when the server is cleaning up, just before it calls exit.	234	Called when the server is cleaning up, just before it calls exit.
205		235
206	=head3 clock ( )	236	=head3 clock ()
207		237
208	Is invoked on every server tick, usually every 0.12 seconds.	238	Is invoked on every server tick, usually every 0.12 seconds.
209		239
		240	=head3 resource_update ()
		241
		242	Is invoked after each time the server reloads its resources, which is
		243	usually one of the earliest things it does when starting up.
		244
210		245
211	=head2 PLAYER EVENTS	246	=head2 PLAYER EVENTS
212		247
213	Player events always have a player object as first argument.	248	Player events always have a player object as first argument.
214		249
215	=head3 reattach (player)
216
217	Invoked whenever attachments/plug-ins need to get reattached to the player
218	object. This usually happens when the player gets loaded from disk, or
219	when the server is reloaded.
220
221	=head3 birth (player)	250	=head3 birth (player)
222		251
223	Invoked as very first thing after creating a player.	252	Invoked as very first thing after creating a player.
224		253
225	=head3 quit (player)	254	=head3 quit (player)
226		255
227	Invoked wheneever a player quits, before actually removing him/her.	256	Invoked wheneever a player quits, before actually removing him/her.
228		257
229	=head3 kick (player params -- )	258	=head3 kick (player params -- )
230		259
231	Invoked when the given plaer is being kicked, before the kick is executed.	260	Invoked when the given player is being kicked, before the kick is
		261	executed.
232		262
233	=head3 load (player)	263	=head3 load (player -- )
234		264
235	Invoked whenever a player has been loaded from disk, but before	265	Invoked whenever a player has been loaded from disk, but before
236	actual login.	266	actual login.
237		267
238	=head3 save (player)	268	=head3 save (player -- )
239		269
240	Invoked just before a player gets saved.	270	Invoked just before a player gets serialised.
		271
		272	=head3 save_done (player -- )
		273
		274	Invoked just after a player was serialised.
		275
		276	=head3 connect (player -- )
		277
		278	Invoked just after the player object was connected to a client.
		279
		280	=head3 disconnect (player -- )
		281
		282	Invoked just before the player gets disconnected from the client.
241		283
242	=head3 login (player)	284	=head3 login (player)
243		285
244	Invoked whenever a player logs in.	286	Invoked whenever a player logs in.
245		287
246	=head3 logout (player)	288	=head3 logout (player cleanly -- )
247		289
248	Invoked whenever a player logs out, gets disconnected etc.	290	Invoked whenever a player logs out, gets disconnected etc.
249		291
250	=head3 death (player)	292	=head3 death (player)
251		293
252	Invoked whenever a player dies, before the death actually gets processed.	294	Invoked whenever a player dies, before the death actually gets processed.
253		295
254	=head3 map_change (player newmap x y -- )	296	=head3 map_change (player newmap x y -- )
255		297
256	Invoked before a player moves from one map to another, can override the movement.	298	Invoked before a player moves from one map to another, can override the movement.
		299
		300	=head3 region_change (player newregion oldregion -- )
		301
		302	Invoked when a player entered a new region. Cannot be overriden.
257		303
258	=head3 command (player command args -- time)	304	=head3 command (player command args -- time)
259		305
260	Execute a user command send by the client. Programmable plug-ins usually	306	Execute a user command send by the client. Programmable plug-ins usually
261	handle this event internally.	307	handle this event internally.
…		…
265	Invoked whenever a client issues the C<extcmd> protocol command.	311	Invoked whenever a client issues the C<extcmd> protocol command.
266	Programmable plug-ins usually handle this event internally.	312	Programmable plug-ins usually handle this event internally.
267		313
268	=head3 move (player direction -- )	314	=head3 move (player direction -- )
269		315
		316	Called whenever the player is supposed to move or attack. The handler
		317	must handle the cases of speed_left or weapon_sp_left being negative,
		318	fire being on, is responsible for decreaseing the speed_left value
		319	on successful moves etc. etc.. When overriden, must return a boolean
		320	indicating wether a move could be effected.
		321
270	=head3 pray_altar (player altar skill -- )	322	=head3 pray_altar (player altar skill -- )
271		323
272	Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.	324	Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.
273		325
274	=head3 tell (player name message -- )	326	=head3 tell (player name message -- )
275		327
276	Invoked whenever the player uses the B<tell> or B<reply> command, before	328	Invoked whenever the player uses the B<tell> or B<reply> command, before
277	it gets processed.	329	it gets processed.
278		330
		331	=head3 told (player player message -- )
		332
		333	Invoked right before a message is being told to a player using B<tell> or
		334	B<reply>.
		335
279	=head3 say (player message --)	336	=head3 say (player message --)
280		337
281	=head3 chat (player message --)	338	=head3 chat (player message --)
282		339
283	=head3 shout (player message --)	340	=head3 shout (player message --)
…		…
293		350
294	=head3 instantiate (map)	351	=head3 instantiate (map)
295		352
296	Original B<map> has been loaded (e.g. on first use, or after a map	353	Original B<map> has been loaded (e.g. on first use, or after a map
297	reset).	354	reset).
298
299	=head3 reattach (map)
300
301	Invoked whenever attachments/plug-ins need to get reattached to the
302	B<map>. This usually happens when the map was loaded from disk, or when the
303	server was reloaded.
304
305	=head3 destroy (map)
306
307	Invoked when the map object gets destroyed, and only when the map object
308	has a handler for this event. This event can occur many times, as its
309	called when the in-memory object is destroyed, not when the object itself
310	dies.
311		355
312	=head3 swapin (map)	356	=head3 swapin (map)
313		357
314	Invoked when a previously swapped-out temporary B<map> has been loaded again.	358	Invoked when a previously swapped-out temporary B<map> has been loaded again.
315		359
…		…
334	=head3 leave (map player -- )	378	=head3 leave (map player -- )
335		379
336	Invoked whenever a player tries to leave the B<map>. Overriding means the	380	Invoked whenever a player tries to leave the B<map>. Overriding means the
337	player won't be able to leave.	381	player won't be able to leave.
338		382
339	=head3 trigger (map connection state)	383	=head3 trigger (map connection state -- )
340		384
341	Invoked whenever something activates a B<connection> on the B<map>. If B<state>	385	Invoked whenever something activates a B<connection> on the B<map>. If B<state>
342	is true the connection was 'state' and if false it is 'released'.	386	is true the connection was 'state' and if false it is 'released'.
343		387
		388
		389	=head2 CLIENT EVENTS
		390
		391	These events are very similar to player events, but they are might be
		392	handled asynchronously as soon as the command reaches the server, even when
		393	the player hasn't logged in yet (meaning there is no player yet).
		394
		395	=head3 connect (client -- )
		396
		397	Called as soon as a new connection to the server is established. Should
		398	not be overriden.
		399
		400	=head3 setup (client string -- )
		401
		402	Client sent the setup command to negotiate parameters. Handling is
		403	mandatory and done by F<login.ext>.
		404
		405	=head3 addme (client -- )
		406
		407	The client sent an addme, thus ending the initial handshaking. Handling is mandatory
		408	and done by F<login.ext>.
		409
		410	=head3 reply (client replystring -- )
		411
		412	Called when the client submits a reply in the ST_CUSTOM state. Usually
		413	handled internally by language plugins.
		414
		415	=head3 exticmd (client string -- )
		416
		417	Like C<extcmd>, but can be called before a player has logged in.
		418
		419	Programmable plug-ins usually handle this event internally.
		420

Diff Legend

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

Comparing deliantra/server/pod/events.pod (file contents): Revision 1.7 by root, Mon Dec 11 22:56:57 2006 UTC vs. Revision 1.26 by elmex, Mon Jul 14 10:26:43 2008 UTC

Diff Legend

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.7 by root, Mon Dec 11 22:56:57 2006 UTC vs.
Revision 1.26 by elmex, Mon Jul 14 10:26:43 2008 UTC