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

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

Diff Legend

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.11 by root, Fri Dec 22 06:02:29 2006 UTC vs.
Revision 1.24 by root, Mon Dec 17 08:27:44 2007 UTC