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

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.1 by pippijn, Fri Sep 8 02:45:16 2006 UTC vs.
Revision 1.23 by root, Sat Nov 10 22:41:59 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)	53	=head3 destroy (object -- )
54		54
55	Invoked when the crossfire object gets destroyed, and only when the object	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	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	57	called when the in-memory object is destroyed, not when the object itself
58	dies.	58	dies.
59		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
		67	=head3 add_bonus (item creator difficulty max_magic flags -- )
		68
		69	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
		71	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
		73	on item or set its value to 0) or GT_MINIMAL (???)
		74
		75	When overriden, built-in bonus generation is skipped, otherwise
		76	treasure generation continues as it would without this hook.
		77
		78	In general, if flags != 0 or creator != 0 you should just return and leave
		79	item generation to the standard code.
		80
		81	=head3 remove (object -- )
		82
		83	Invoked before the object is removed from its environment.
		84
		85	=head3 insert (object -- )
		86
		87	Called after the object was inserted into a container or map.
		88
60	=head3 tick (object)	89	=head3 tick (object -- )
61		90
62	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
63	during ticks should an objetc process any movement or other events.	92	during ticks should an objetc process any movement or other events.
64		93
65	=head3 kill (object hitter -- )	94	=head3 kill (object hitter -- )
…		…
114	Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,	143	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'	144	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	145	(if it is a player) an indication of whats wrong. Must return true if the
117	object was freed.	146	object was freed.
118		147
119	=head3 use_skill (skill who part direction strignarg -- )	148	=head3 use_skill (skill who part direction stringarg -- )
120		149
121	Invoked whenever a skill is used by somebody or something.	150	Invoked whenever a skill is used by somebody or something.
122		151
123	=head3 cast_spell (spell casting_object owner direction stringarg -- )	152	=head3 cast_spell (spell owner casting_object direction stringarg -- )
124		153
125	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
126	B<owner>).	155	B<owner>).
127		156
128	=head3 drop (object who -- )	157	=head3 drop (object who -- )
…		…
174		203
175	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
176	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,
177	signs and similar stuff.	206	signs and similar stuff.
178		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
179	=head3 close (container who -- )	213	=head3 close (container who -- )
180		214
181	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.
182		219
183		220
184	=head2 GLOBAL EVENTS	221	=head2 GLOBAL EVENTS
185		222
186	Global events have no relation to specific objects.	223	Global events have no relation to specific objects.
187		224
		225	=head3 cleanup ()
		226
		227	Called when the server is cleaning up, just before it calls exit.
		228
188	=head3 clock ( )	229	=head3 clock ( )
189		230
190	Is invoked on every server tick, usually every 0.12 seconds.	231	Is invoked on every server tick, usually every 0.12 seconds.
191		232
		233
192	=head2 PLAYER EVENTS	234	=head2 PLAYER EVENTS
193		235
194	Player events always have a player object as first argument.	236	Player events always have a player object as first argument.
195		237
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)	238	=head3 birth (player)
203		239
204	Invoked as very first thing after creating a player.	240	Invoked as very first thing after creating a player.
205		241
206	=head3 quit (player)	242	=head3 quit (player)
207		243
208	Invoked wheneever a player quits, before actually removing him/her.	244	Invoked wheneever a player quits, before actually removing him/her.
209		245
210	=head3 kick (player params -- )	246	=head3 kick (player params -- )
211		247
212	Invoked when the given plaer is being kicked, before the kick is executed.	248	Invoked when the given player is being kicked, before the kick is
		249	executed.
213		250
214	=head3 load (player)	251	=head3 load (player -- )
215		252
216	Invoked whenever a player has been loaded from disk, but before	253	Invoked whenever a player has been loaded from disk, but before
217	actual login.	254	actual login.
218		255
219	=head3 save (player)	256	=head3 save (player -- )
220		257
221	Invoked just before a player gets saved.	258	Invoked just before a player gets serialised.
		259
		260	=head3 save_done (player -- )
		261
		262	Invoked just after a player was serialised.
		263
		264	=head3 connect (player -- )
		265
		266	Invoked just after the player object was connected to a client.
		267
		268	=head3 disconnect (player -- )
		269
		270	Invoked just before the player gets disconnected from the client.
222		271
223	=head3 login (player)	272	=head3 login (player)
224		273
225	Invoked whenever a player logs in.	274	Invoked whenever a player logs in.
226		275
227	=head3 logout (player)	276	=head3 logout (player cleanly -- )
228		277
229	Invoked whenever a player logs out, gets disconnected etc.	278	Invoked whenever a player logs out, gets disconnected etc.
230		279
231	=head3 death (player)	280	=head3 death (player)
232		281
233	Invoked whenever a player dies, before the death actually gets processed.	282	Invoked whenever a player dies, before the death actually gets processed.
234		283
235	=head3 map_change (player oldmap newmap)	284	=head3 map_change (player newmap x y -- )
236		285
237	Invoked whenever a player moves from one map to another.	286	Invoked before a player moves from one map to another, can override the movement.
		287
		288	=head3 region_change (player newregion oldregion -- )
		289
		290	Invoked when a player entered a new region. Cannot be overriden.
		291
		292	=head3 command (player command args -- time)
		293
		294	Execute a user command send by the client. Programmable plug-ins usually
		295	handle this event internally.
238		296
239	=head3 extcmd (player string)	297	=head3 extcmd (player string)
240		298
241	Invoked whenever a client issues the C<extcmd> protocol command. It's	299	Invoked whenever a client issues the C<extcmd> protocol command.
242	argument is passed without any changes.	300	Programmable plug-ins usually handle this event internally.
243		301
244	=head3 move (player direction -- )	302	=head3 move (player direction -- )
		303
		304	Called whenever the player is supposed to move or attack. The handler
		305	must handle the cases of speed_left or weapon_sp_left being negative,
		306	fire being on, is responsible for decreaseing the speed_left value
		307	on successful moves etc. etc.. When overriden, must return a boolean
		308	indicating wether a move could be effected.
245		309
246	=head3 pray_altar (player altar skill -- )	310	=head3 pray_altar (player altar skill -- )
247		311
248	Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.	312	Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.
249		313
250	=head3 tell (player name message -- )	314	=head3 tell (player name message -- )
251		315
252	Invoked whenever the player uses the B<tell> or B<reply> command, before	316	Invoked whenever the player uses the B<tell> or B<reply> command, before
253	it gets processed.	317	it gets processed.
254		318
		319	=head3 told (player player message -- )
		320
		321	Invoked right before a message is being told to a player using B<tell> or
		322	B<reply>.
		323
255	=head3 say (player message --)	324	=head3 say (player message --)
256		325
257	=head3 chat (player message --)	326	=head3 chat (player message --)
258		327
259	=head3 shout (player message --)	328	=head3 shout (player message --)
…		…
270	=head3 instantiate (map)	339	=head3 instantiate (map)
271		340
272	Original B<map> has been loaded (e.g. on first use, or after a map	341	Original B<map> has been loaded (e.g. on first use, or after a map
273	reset).	342	reset).
274		343
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)	344	=head3 swapin (map)
289		345
290	Invoked when a previously swapped-out temporary B<map> has been loaded again.	346	Invoked when a previously swapped-out temporary B<map> has been loaded again.
291		347
292	=head3 swapout (map)	348	=head3 swapout (map)
…		…
299		355
300	=head3 clean (map)	356	=head3 clean (map)
301		357
302	Invoked when a temporary B<map> gets deleted on-disk.	358	Invoked when a temporary B<map> gets deleted on-disk.
303		359
304	=head3 enter (map player)	360	=head3 enter (map player x y -- )
305		361
306	Invoked whenever a player enters the B<map>. This event is likely unreliable.	362	Invoked whenever a player tries to enter the B<map>, while he/she is still
		363	on the old map. Overriding means the player won't be able to enter, and,
		364	if newmap/x/y are given, will be redirected to that map instead.
307		365
308	=head3 leave (map player)	366	=head3 leave (map player -- )
309		367
310	Invoked whenever a player leaves the B<map>. This event is likely unreliable.	368	Invoked whenever a player tries to leave the B<map>. Overriding means the
		369	player won't be able to leave.
311		370
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)	371	=head3 trigger (map connection state -- )
317		372
318	Invoked whenever something activates a B<connection> on the B<map>. If B<state>	373	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'.	374	is true the connection was 'state' and if false it is 'released'.
		375
		376
		377	=head2 CLIENT EVENTS
		378
		379	These events are very similar to player events, but they are might be
		380	handled asynchronously as soon as the command reaches the server, even when
		381	the player hasn't logged in yet (meaning there is no player yet).
		382
		383	=head3 connect (client -- )
		384
		385	Called as soon as a new connection to the server is established. Should
		386	not be overriden.
		387
		388	=head3 setup (client string -- )
		389
		390	Client sent the setup command to negotiate parameters. Handling is
		391	mandatory and done by F<login.ext>.
		392
		393	=head3 addme (client -- )
		394
		395	The client sent an addme, thus ending the initial handshaking. Handling is mandatory
		396	and done by F<login.ext>.
		397
		398	=head3 reply (client replystring -- )
		399
		400	Called when the client submits a reply in the ST_CUSTOM state. Usually
		401	handled internally by language plugins.
		402
		403	=head3 exticmd (client string -- )
		404
		405	Like C<extcmd>, but can be called before a player has logged in.
		406
		407	Programmable plug-ins usually handle this event internally.
		408

Diff Legend

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

Comparing deliantra/server/pod/events.pod (file contents): Revision 1.1 by pippijn, Fri Sep 8 02:45:16 2006 UTC vs. Revision 1.23 by root, Sat Nov 10 22:41:59 2007 UTC

Diff Legend

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.1 by pippijn, Fri Sep 8 02:45:16 2006 UTC vs.
Revision 1.23 by root, Sat Nov 10 22:41:59 2007 UTC