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

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.6 by root, Sun Dec 10 20:15:58 2006 UTC vs.
Revision 1.25 by root, Wed Apr 30 05:34:24 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:
88		104
…		…
128	Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,	144	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'	145	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	146	(if it is a player) an indication of whats wrong. Must return true if the
131	object was freed.	147	object was freed.
132		148
133	=head3 use_skill (skill who part direction strignarg -- )	149	=head3 use_skill (skill who part direction stringarg -- )
134		150
135	Invoked whenever a skill is used by somebody or something.	151	Invoked whenever a skill is used by somebody or something.
136		152
137	=head3 cast_spell (spell casting_object owner direction stringarg -- )	153	=head3 cast_spell (spell owner casting_object direction stringarg -- )
138		154
139	Invoked whenever a given spell is cast by B<casting_object> (used by	155	Invoked whenever a given spell is cast by B<casting_object> (used by
140	B<owner>).	156	B<owner>).
141		157
142	=head3 drop (object who -- )	158	=head3 drop (object who -- )
…		…
188		204
189	Invoked whenever a trap-like B<object> has been activated, usually by	205	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,	206	moving onto it. This includes not just traps, but also buttons, holes,
191	signs and similar stuff.	207	signs and similar stuff.
192		208
		209	=head3 open (container who -- )
		210
		211	Invoked whenever a container gets opened. When overriden, the container will not
		212	get opened, but you must tell op about the reason.
		213
193	=head3 close (container who -- )	214	=head3 close (container who -- )
194		215
195	Invoked whenever a container gets closed (this event is not yet reliable!).	216	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
		218	is not crash-safe, i.e. containers might be closed due to a server crash
		219	without this event being invoked.
196		220
197		221
198	=head2 GLOBAL EVENTS	222	=head2 GLOBAL EVENTS
199		223
200	Global events have no relation to specific objects.	224	Global events have no relation to specific objects.
201		225
202	=head3 cleanup ()	226	=head3 cleanup ()
203		227
204	Called when the server is cleaning up, just before it calls exit.	228	Called when the server is cleaning up, just before it calls exit.
205		229
206	=head3 clock ( )	230	=head3 clock ()
207		231
208	Is invoked on every server tick, usually every 0.12 seconds.	232	Is invoked on every server tick, usually every 0.12 seconds.
209		233
		234	=head3 resource_update ()
		235
		236	Is invoked after each time the server reloads its resources, which is
		237	usually one of the earliest things it does when starting up.
		238
210		239
211	=head2 PLAYER EVENTS	240	=head2 PLAYER EVENTS
212		241
213	Player events always have a player object as first argument.	242	Player events always have a player object as first argument.
214		243
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)	244	=head3 birth (player)
222		245
223	Invoked as very first thing after creating a player.	246	Invoked as very first thing after creating a player.
224		247
225	=head3 quit (player)	248	=head3 quit (player)
226		249
227	Invoked wheneever a player quits, before actually removing him/her.	250	Invoked wheneever a player quits, before actually removing him/her.
228		251
229	=head3 kick (player params -- )	252	=head3 kick (player params -- )
230		253
231	Invoked when the given plaer is being kicked, before the kick is executed.	254	Invoked when the given player is being kicked, before the kick is
		255	executed.
232		256
233	=head3 load (player)	257	=head3 load (player -- )
234		258
235	Invoked whenever a player has been loaded from disk, but before	259	Invoked whenever a player has been loaded from disk, but before
236	actual login.	260	actual login.
237		261
238	=head3 save (player)	262	=head3 save (player -- )
239		263
240	Invoked just before a player gets saved.	264	Invoked just before a player gets serialised.
		265
		266	=head3 save_done (player -- )
		267
		268	Invoked just after a player was serialised.
		269
		270	=head3 connect (player -- )
		271
		272	Invoked just after the player object was connected to a client.
		273
		274	=head3 disconnect (player -- )
		275
		276	Invoked just before the player gets disconnected from the client.
241		277
242	=head3 login (player)	278	=head3 login (player)
243		279
244	Invoked whenever a player logs in.	280	Invoked whenever a player logs in.
245		281
246	=head3 logout (player)	282	=head3 logout (player cleanly -- )
247		283
248	Invoked whenever a player logs out, gets disconnected etc.	284	Invoked whenever a player logs out, gets disconnected etc.
249		285
250	=head3 death (player)	286	=head3 death (player)
251		287
…		…
253		289
254	=head3 map_change (player newmap x y -- )	290	=head3 map_change (player newmap x y -- )
255		291
256	Invoked before a player moves from one map to another, can override the movement.	292	Invoked before a player moves from one map to another, can override the movement.
257		293
		294	=head3 region_change (player newregion oldregion -- )
		295
		296	Invoked when a player entered a new region. Cannot be overriden.
		297
		298	=head3 command (player command args -- time)
		299
		300	Execute a user command send by the client. Programmable plug-ins usually
		301	handle this event internally.
		302
258	=head3 extcmd (player string)	303	=head3 extcmd (player string)
259		304
260	Invoked whenever a client issues the C<extcmd> protocol command. It's	305	Invoked whenever a client issues the C<extcmd> protocol command.
261	argument is passed without any changes.	306	Programmable plug-ins usually handle this event internally.
262		307
263	=head3 move (player direction -- )	308	=head3 move (player direction -- )
		309
		310	Called whenever the player is supposed to move or attack. The handler
		311	must handle the cases of speed_left or weapon_sp_left being negative,
		312	fire being on, is responsible for decreaseing the speed_left value
		313	on successful moves etc. etc.. When overriden, must return a boolean
		314	indicating wether a move could be effected.
264		315
265	=head3 pray_altar (player altar skill -- )	316	=head3 pray_altar (player altar skill -- )
266		317
267	Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.	318	Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.
268		319
269	=head3 tell (player name message -- )	320	=head3 tell (player name message -- )
270		321
271	Invoked whenever the player uses the B<tell> or B<reply> command, before	322	Invoked whenever the player uses the B<tell> or B<reply> command, before
272	it gets processed.	323	it gets processed.
273		324
		325	=head3 told (player player message -- )
		326
		327	Invoked right before a message is being told to a player using B<tell> or
		328	B<reply>.
		329
274	=head3 say (player message --)	330	=head3 say (player message --)
275		331
276	=head3 chat (player message --)	332	=head3 chat (player message --)
277		333
278	=head3 shout (player message --)	334	=head3 shout (player message --)
…		…
288		344
289	=head3 instantiate (map)	345	=head3 instantiate (map)
290		346
291	Original B<map> has been loaded (e.g. on first use, or after a map	347	Original B<map> has been loaded (e.g. on first use, or after a map
292	reset).	348	reset).
293
294	=head3 reattach (map)
295
296	Invoked whenever attachments/plug-ins need to get reattached to the
297	B<map>. This usually happens when the map was loaded from disk, or when the
298	server was reloaded.
299
300	=head3 destroy (map)
301
302	Invoked when the map object gets destroyed, and only when the map object
303	has a handler for this event. This event can occur many times, as its
304	called when the in-memory object is destroyed, not when the object itself
305	dies.
306		349
307	=head3 swapin (map)	350	=head3 swapin (map)
308		351
309	Invoked when a previously swapped-out temporary B<map> has been loaded again.	352	Invoked when a previously swapped-out temporary B<map> has been loaded again.
310		353
…		…
329	=head3 leave (map player -- )	372	=head3 leave (map player -- )
330		373
331	Invoked whenever a player tries to leave the B<map>. Overriding means the	374	Invoked whenever a player tries to leave the B<map>. Overriding means the
332	player won't be able to leave.	375	player won't be able to leave.
333		376
334	=head3 trigger (map connection state)	377	=head3 trigger (map connection state -- )
335		378
336	Invoked whenever something activates a B<connection> on the B<map>. If B<state>	379	Invoked whenever something activates a B<connection> on the B<map>. If B<state>
337	is true the connection was 'state' and if false it is 'released'.	380	is true the connection was 'state' and if false it is 'released'.
338		381
		382
		383	=head2 CLIENT EVENTS
		384
		385	These events are very similar to player events, but they are might be
		386	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).
		388
		389	=head3 connect (client -- )
		390
		391	Called as soon as a new connection to the server is established. Should
		392	not be overriden.
		393
		394	=head3 setup (client string -- )
		395
		396	Client sent the setup command to negotiate parameters. Handling is
		397	mandatory and done by F<login.ext>.
		398
		399	=head3 addme (client -- )
		400
		401	The client sent an addme, thus ending the initial handshaking. Handling is mandatory
		402	and done by F<login.ext>.
		403
		404	=head3 reply (client replystring -- )
		405
		406	Called when the client submits a reply in the ST_CUSTOM state. Usually
		407	handled internally by language plugins.
		408
		409	=head3 exticmd (client string -- )
		410
		411	Like C<extcmd>, but can be called before a player has logged in.
		412
		413	Programmable plug-ins usually handle this event internally.
		414

Diff Legend

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

Comparing deliantra/server/pod/events.pod (file contents): Revision 1.6 by root, Sun Dec 10 20:15:58 2006 UTC vs. Revision 1.25 by root, Wed Apr 30 05:34:24 2008 UTC

Diff Legend

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.6 by root, Sun Dec 10 20:15:58 2006 UTC vs.
Revision 1.25 by root, Wed Apr 30 05:34:24 2008 UTC