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

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.5 by root, Sun Sep 17 18:19:19 2006 UTC vs.
Revision 1.12 by root, Mon Dec 25 11:25:49 2006 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		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 crossfire 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 -- )
…		…
196		225
197	=head2 PLAYER EVENTS	226	=head2 PLAYER EVENTS
198		227
199	Player events always have a player object as first argument.	228	Player events always have a player object as first argument.
200		229
201	=head3 reattach (player)
202
203	Invoked whenever attachments/plug-ins need to get reattached to the player
204	object. This usually happens when the player gets loaded from disk, or
205	when the server is reloaded.
206
207	=head3 birth (player)	230	=head3 birth (player)
208		231
209	Invoked as very first thing after creating a player.	232	Invoked as very first thing after creating a player.
210		233
211	=head3 quit (player)	234	=head3 quit (player)
…		…
239		262
240	=head3 map_change (player newmap x y -- )	263	=head3 map_change (player newmap x y -- )
241		264
242	Invoked before a player moves from one map to another, can override the movement.	265	Invoked before a player moves from one map to another, can override the movement.
243		266
		267	=head3 command (player command args -- time)
		268
		269	Execute a user command send by the client. Programmable plug-ins usually
		270	handle this event internally.
		271
244	=head3 extcmd (player string)	272	=head3 extcmd (player string)
245		273
246	Invoked whenever a client issues the C<extcmd> protocol command. It's	274	Invoked whenever a client issues the C<extcmd> protocol command.
247	argument is passed without any changes.	275	Programmable plug-ins usually handle this event internally.
248		276
249	=head3 move (player direction -- )	277	=head3 move (player direction -- )
250		278
251	=head3 pray_altar (player altar skill -- )	279	=head3 pray_altar (player altar skill -- )
252		280
…		…
274		302
275	=head3 instantiate (map)	303	=head3 instantiate (map)
276		304
277	Original B<map> has been loaded (e.g. on first use, or after a map	305	Original B<map> has been loaded (e.g. on first use, or after a map
278	reset).	306	reset).
279
280	=head3 reattach (map)
281
282	Invoked whenever attachments/plug-ins need to get reattached to the
283	B<map>. This usually happens when the map was loaded from disk, or when the
284	server was reloaded.
285
286	=head3 destroy (map)
287
288	Invoked when the map object gets destroyed, and only when the map object
289	has a handler for this event. This event can occur many times, as its
290	called when the in-memory object is destroyed, not when the object itself
291	dies.
292		307
293	=head3 swapin (map)	308	=head3 swapin (map)
294		309
295	Invoked when a previously swapped-out temporary B<map> has been loaded again.	310	Invoked when a previously swapped-out temporary B<map> has been loaded again.
296		311
…		…
315	=head3 leave (map player -- )	330	=head3 leave (map player -- )
316		331
317	Invoked whenever a player tries to leave the B<map>. Overriding means the	332	Invoked whenever a player tries to leave the B<map>. Overriding means the
318	player won't be able to leave.	333	player won't be able to leave.
319		334
320	=head3 trigger (map connection state)	335	=head3 trigger (map connection state -- )
321		336
322	Invoked whenever something activates a B<connection> on the B<map>. If B<state>	337	Invoked whenever something activates a B<connection> on the B<map>. If B<state>
323	is true the connection was 'state' and if false it is 'released'.	338	is true the connection was 'state' and if false it is 'released'.
324		339
		340
		341	=head2 CLIENT EVENTS
		342
		343	These events are very similar to player events, but they are might be
		344	handled asynchronously as soon as the command reaches the server, even when
		345	the player hasn't logged in yet (meaning there is no player yet).
		346
		347	=head3 connect (client -- )
		348
		349	Called as soon as a new connection to the server is established. Should
		350	not be overriden.
		351
		352	=head3 addme (client -- )
		353
		354	The client sent an addme, thus ending the initial handshaking. If overriden, the server
		355	will not send any response.
		356
		357	=head3 reply (client replystring -- )
		358
		359	Called when the client submits a reply in the ST_CUSTOM state. Usually
		360	handled internally by language plugins.
		361
		362	=head3 exticmd (client string -- )
		363
		364	Like C<extcmd>, but can be called before a player has logged in.
		365
		366	Programmable plug-ins usually handle this event internally.
		367

Diff Legend

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

Comparing deliantra/server/pod/events.pod (file contents): Revision 1.5 by root, Sun Sep 17 18:19:19 2006 UTC vs. Revision 1.12 by root, Mon Dec 25 11:25:49 2006 UTC

Diff Legend

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.5 by root, Sun Sep 17 18:19:19 2006 UTC vs.
Revision 1.12 by root, Mon Dec 25 11:25:49 2006 UTC