[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.14 by root, Sun Jan 7 02:39:14 2007 UTC

…		…
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
		53	=head3 destroy (object -- )
		54
		55	Invoked when the crossfire 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.
52		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
…		…
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 -- )
…		…
210		225
211	=head2 PLAYER EVENTS	226	=head2 PLAYER EVENTS
212		227
213	Player events always have a player object as first argument.	228	Player events always have a player object as first argument.
214		229
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)	230	=head3 birth (player)
222		231
223	Invoked as very first thing after creating a player.	232	Invoked as very first thing after creating a player.
224		233
225	=head3 quit (player)	234	=head3 quit (player)
226		235
227	Invoked wheneever a player quits, before actually removing him/her.	236	Invoked wheneever a player quits, before actually removing him/her.
228		237
229	=head3 kick (player params -- )	238	=head3 kick (player params -- )
230		239
231	Invoked when the given plaer is being kicked, before the kick is executed.	240	Invoked when the given player is being kicked, before the kick is
		241	executed.
232		242
233	=head3 load (player)	243	=head3 load (player -- )
234		244
235	Invoked whenever a player has been loaded from disk, but before	245	Invoked whenever a player has been loaded from disk, but before
236	actual login.	246	actual login.
237		247
238	=head3 save (player)	248	=head3 save (player -- )
239		249
240	Invoked just before a player gets saved.	250	Invoked just before a player gets serialised.
		251
		252	=head3 save_done (player -- )
		253
		254	Invoked just after a player was serialised.
		255
		256	=head3 connect (player -- )
		257
		258	Invoked just after the player object was connected to a client.
		259
		260	=head3 disconnect (player -- )
		261
		262	Invoked just before the player gets disconnected from the client.
241		263
242	=head3 login (player)	264	=head3 login (player)
243		265
244	Invoked whenever a player logs in.	266	Invoked whenever a player logs in.
245		267
…		…
253		275
254	=head3 map_change (player newmap x y -- )	276	=head3 map_change (player newmap x y -- )
255		277
256	Invoked before a player moves from one map to another, can override the movement.	278	Invoked before a player moves from one map to another, can override the movement.
257		279
		280	=head3 command (player command args -- time)
		281
		282	Execute a user command send by the client. Programmable plug-ins usually
		283	handle this event internally.
		284
258	=head3 extcmd (player string)	285	=head3 extcmd (player string)
259		286
260	Invoked whenever a client issues the C<extcmd> protocol command. It's	287	Invoked whenever a client issues the C<extcmd> protocol command.
261	argument is passed without any changes.	288	Programmable plug-ins usually handle this event internally.
262		289
263	=head3 move (player direction -- )	290	=head3 move (player direction -- )
264		291
265	=head3 pray_altar (player altar skill -- )	292	=head3 pray_altar (player altar skill -- )
266		293
…		…
288		315
289	=head3 instantiate (map)	316	=head3 instantiate (map)
290		317
291	Original B<map> has been loaded (e.g. on first use, or after a map	318	Original B<map> has been loaded (e.g. on first use, or after a map
292	reset).	319	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		320
307	=head3 swapin (map)	321	=head3 swapin (map)
308		322
309	Invoked when a previously swapped-out temporary B<map> has been loaded again.	323	Invoked when a previously swapped-out temporary B<map> has been loaded again.
310		324
…		…
329	=head3 leave (map player -- )	343	=head3 leave (map player -- )
330		344
331	Invoked whenever a player tries to leave the B<map>. Overriding means the	345	Invoked whenever a player tries to leave the B<map>. Overriding means the
332	player won't be able to leave.	346	player won't be able to leave.
333		347
334	=head3 trigger (map connection state)	348	=head3 trigger (map connection state -- )
335		349
336	Invoked whenever something activates a B<connection> on the B<map>. If B<state>	350	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'.	351	is true the connection was 'state' and if false it is 'released'.
338		352
		353
		354	=head2 CLIENT EVENTS
		355
		356	These events are very similar to player events, but they are might be
		357	handled asynchronously as soon as the command reaches the server, even when
		358	the player hasn't logged in yet (meaning there is no player yet).
		359
		360	=head3 connect (client -- )
		361
		362	Called as soon as a new connection to the server is established. Should
		363	not be overriden.
		364
		365	=head3 addme (client -- )
		366
		367	The client sent an addme, thus ending the initial handshaking. If overriden, the server
		368	will not send any response.
		369
		370	=head3 reply (client replystring -- )
		371
		372	Called when the client submits a reply in the ST_CUSTOM state. Usually
		373	handled internally by language plugins.
		374
		375	=head3 exticmd (client string -- )
		376
		377	Like C<extcmd>, but can be called before a player has logged in.
		378
		379	Programmable plug-ins usually handle this event internally.
		380

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.14 by root, Sun Jan 7 02:39:14 2007 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.14 by root, Sun Jan 7 02:39:14 2007 UTC