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

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.13 by root, Tue Jan 2 11:08:36 2007 UTC vs.
Revision 1.32 by root, Wed Oct 21 00:44:39 2009 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
7	=head2 NOTATION	7	=head2 NOTATION
8		8
9	the event description below uses a variant of the forth stack notation -	9	The event description below uses a variant of the forth stack notation -
10	an opening parenthesis followed by the type of each parameter, optionally	10	an opening parenthesis followed by the type of each parameter, optionally
11	followed by two dashes and the returning parameters. If the latter is	11	followed by two dashes and the returning parameters. If the latter part is
12	missing, the event will be invoked but cannot change wether the event gets	12	missing, the event will be invoked but cannot change wether the event gets
13	processed.	13	processed.
14		14
15	If it is specified (even if no return values are supported), a plug-in	15	Return values are given by overriding (in Perl by calling C<cf::override>)
16	can override (e.g. using C<cf::override> in Perl) event processing,	16	with the return values, which will both stop further event processing and
17	basically short-circuiting it. For example, if you override from within a	17	tell the caller that it wants to override normal processing.
18	player BIRTH event, nothing much will happen with respect to the built-in	18
		19	Even if no return values are supported, a plug-in can override (e.g. using
		20	C<cf::override> in Perl) event processing, basically short-circuiting
		21	it. For example, if you override from within a player BIRTH event,
		22	nothing much will happen with respect to the built-in processing, but if
19	processing, but if you override from within a player TELL event, the tell	23	you override from within a player TELL event, the tell will be ignored
20	will be ignored (presumably your plug-in took care of it).	24	(presumably your plug-in took care of it).
21		25
22		26
23	=head2 ATTACHABLE EVENTS	27	=head2 ATTACHABLE EVENTS
24		28
25	No time to document this, screw me.	29	No time to document this, screw me.
50	instances). If this is not the behaviour you need, you have to adjust the	54	instances). If this is not the behaviour you need, you have to adjust the
51	B<destination> object as you see fit.	55	B<destination> object as you see fit.
52		56
53	=head3 destroy (object -- )	57	=head3 destroy (object -- )
54		58
55	Invoked when the crossfire object gets destroyed, and only when the object	59	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	60	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	61	called when the in-memory object is destroyed, not when the object itself
58	dies.	62	dies.
59		63
60		64
…		…
62		66
63	Object events always relate to a specific object, which is always the	67	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	68	first argument. Not all events get generated for every object, some are
65	specific to an object type.	69	specific to an object type.
66		70
67	=head3 add_bonus (item creator difficulty max_magic flags)	71	=head3 add_bonus (item creator difficulty max_magic flags -- )
68		72
69	A basic item has been created (e.g. for shops, monsters drops etc.)	73	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	74	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	75	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	76	combination of GT_ENVIRONMENT (???) or GT_STARTEQUIP (set FLAG_STARTEQUIP
…		…
91	Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only	95	Invoked whenever the object "ticks", i.e. has positive B<speed_left>. Only
92	during ticks should an objetc process any movement or other events.	96	during ticks should an objetc process any movement or other events.
93		97
94	=head3 kill (object hitter -- )	98	=head3 kill (object hitter -- )
95		99
96	Invoked whenever an object is dead and about to get removed. Overriding	100	Invoked whenever an object was killed (hp < 0 caused by an attack) and is
97	processing will skip removal, but to do this successfully you have to	101	about to get removed. Overriding processing will skip removal, but to do
98	objetc from dieing, otherwise the event gets invoked again and again.	102	this successfully you have to keep the object from dieing, otherwise the
		103	event gets invoked again and again.
99		104
100	=head3 apply (object who -- applytype)	105	=head3 apply (object who -- applytype)
101		106
102	Invoked whenever the object is being applied in some way. The applytype is one of:	107	Invoked whenever the object is being applied in some way. The applytype is one of:
103		108
…		…
108	=item B<1> has been applied, or there was an error applying the object	113	=item B<1> has been applied, or there was an error applying the object
109		114
110	=item B<2> objects of that type can't be applied if not in inventory	115	=item B<2> objects of that type can't be applied if not in inventory
111		116
112	=back	117	=back
		118
		119	=head3 reset (object)
		120
		121	Invoked whenever the object is initialised on a map after it was
		122	loaded. This can be used to emulate shop-floor behaviour for example.
113		123
114	=head3 throw (object thrower)	124	=head3 throw (object thrower)
115		125
116	Invoked when an B<object> is thrown by B<thrower>.	126	Invoked when an B<object> is thrown by B<thrower>.
117		127
…		…
143	Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,	153	Unwield/unapply/unready the given spell/weapon/skill/etc. B<object>,
144	currently applied by B<who>. If your override, make sure you give 'who'	154	currently applied by B<who>. If your override, make sure you give 'who'
145	(if it is a player) an indication of whats wrong. Must return true if the	155	(if it is a player) an indication of whats wrong. Must return true if the
146	object was freed.	156	object was freed.
147		157
148	=head3 use_skill (skill who part direction strignarg -- )	158	=head3 use_skill (skill who part direction stringarg -- )
149		159
150	Invoked whenever a skill is used by somebody or something.	160	Invoked whenever a skill is used by somebody or something.
151		161
152	=head3 cast_spell (spell casting_object owner direction stringarg -- )	162	=head3 cast_spell (spell owner casting_object direction stringarg -- )
153		163
154	Invoked whenever a given spell is cast by B<casting_object> (used by	164	Invoked whenever a given spell is cast by B<casting_object> (used by
155	B<owner>).	165	B<owner>).
156		166
157	=head3 drop (object who -- )	167	=head3 drop (object who -- )
…		…
180	damage that has been dealt.	190	damage that has been dealt.
181		191
182	=head3 skill_attack (attacker victim message skill -- success)	192	=head3 skill_attack (attacker victim message skill -- success)
183		193
184	Invoked whenever an B<attacker> attacks B<victim> using a B<skill> (skill	194	Invoked whenever an B<attacker> attacks B<victim> using a B<skill> (skill
185	cna be C<undef>). B<message> is the message that describes the attack when	195	can be C<undef>). B<message> is the message that describes the attack when
186	damage is done.	196	damage is done.
187		197
188	=head3 weapon_attack (weapon hitter victim)	198	=head3 weapon_attack (weapon hitter victim)
189		199
190	Invoked whenever an object is used as a B<weapon> by B<hitter> to attack	200	Invoked whenever an object is used as a B<weapon> by B<hitter> to attack
…		…
203		213
204	Invoked whenever a trap-like B<object> has been activated, usually by	214	Invoked whenever a trap-like B<object> has been activated, usually by
205	moving onto it. This includes not just traps, but also buttons, holes,	215	moving onto it. This includes not just traps, but also buttons, holes,
206	signs and similar stuff.	216	signs and similar stuff.
207		217
		218	=head3 open (container who -- )
		219
		220	Invoked whenever a container gets opened. When overriden, the container will not
		221	get opened, but you must tell op about the reason.
		222
208	=head3 close (container who -- )	223	=head3 close (container who -- )
209		224
210	Invoked whenever a container gets closed (this event is not yet reliable!).	225	Invoked whenever a container gets closed. When overriden, the container
		226	will not get closed, but you must tell op about the reason. This event
		227	is not crash-safe, i.e. containers might be closed due to a server crash
		228	without this event being invoked.
		229
		230	=head3 blocked_move (self who -- do_blocked)
		231
		232	Invoked when an C<who> tries to move to the same space as C<self>,
		233	C<self>'s C<move_block> causes blocked movement for C<who> and nothing
		234	else explicitly allows movement to this space.
		235
		236	Should return true when C<who> is blocked, i.e., should not be allowed to
		237	move onto C<self>.
		238
		239	When not overriding, normal blocked_move (blocked_link) processing will
		240	happen.
211		241
212		242
213	=head2 GLOBAL EVENTS	243	=head2 GLOBAL EVENTS
214		244
215	Global events have no relation to specific objects.	245	Global events have no relation to specific objects.
216		246
217	=head3 cleanup ()	247	=head3 cleanup ()
218		248
219	Called when the server is cleaning up, just before it calls exit.	249	Called when the server is cleaning up, just before it calls exit.
220		250
221	=head3 clock ( )	251	=head3 clock ()
222		252
223	Is invoked on every server tick, usually every 0.12 seconds.	253	Is invoked on every server tick, usually every 0.12 seconds.
224		254
		255	=head3 resource_update ()
		256
		257	Is invoked after each time the server reloads its resources, which is
		258	usually one of the earliest things it does when starting up.
		259
225		260
226	=head2 PLAYER EVENTS	261	=head2 PLAYER EVENTS
227		262
228	Player events always have a player object as first argument.	263	Player events always have a player object as first argument.
229		264
…		…
235		270
236	Invoked wheneever a player quits, before actually removing him/her.	271	Invoked wheneever a player quits, before actually removing him/her.
237		272
238	=head3 kick (player params -- )	273	=head3 kick (player params -- )
239		274
240	Invoked when the given plaer is being kicked, before the kick is executed.	275	Invoked when the given player is being kicked, before the kick is
		276	executed.
241		277
242	=head3 load (player)	278	=head3 load (player -- )
243		279
244	Invoked whenever a player has been loaded from disk, but before	280	Invoked whenever a player has been loaded from disk, but before
245	actual login.	281	actual login.
246		282
247	=head3 save (player path -- )	283	=head3 save (player -- )
248		284
249	Invoked just before a player gets saved.	285	Invoked just before a player gets serialised.
250		286
251	=head3 save_done (player path -- )	287	=head3 save_done (player -- )
252		288
253	Invoked just after a player was saved.	289	Invoked just after a player was serialised.
254		290
255	=head3 connect (player -- )	291	=head3 connect (player -- )
256		292
257	Invoked just after the player object was connected to a client.	293	Invoked just after the player object was connected to a client.
258		294
…		…
262		298
263	=head3 login (player)	299	=head3 login (player)
264		300
265	Invoked whenever a player logs in.	301	Invoked whenever a player logs in.
266		302
267	=head3 logout (player)	303	=head3 logout (player cleanly -- )
268		304
269	Invoked whenever a player logs out, gets disconnected etc.	305	Invoked whenever a player logs out, gets disconnected etc.
270		306
271	=head3 death (player)	307	=head3 death (player)
272		308
273	Invoked whenever a player dies, before the death actually gets processed.	309	Invoked whenever a player dies, before the death actually gets processed.
274		310
275	=head3 map_change (player newmap x y -- )	311	=head3 map_change (player newmap x y -- )
276		312
277	Invoked before a player moves from one map to another, can override the movement.	313	Invoked before a player moves from one map to another, can override the movement.
		314
		315	=head3 region_change (player newregion oldregion -- )
		316
		317	Invoked when a player entered a new region. Cannot be overriden.
278		318
279	=head3 command (player command args -- time)	319	=head3 command (player command args -- time)
280		320
281	Execute a user command send by the client. Programmable plug-ins usually	321	Execute a user command send by the client. Programmable plug-ins usually
282	handle this event internally.	322	handle this event internally.
…		…
286	Invoked whenever a client issues the C<extcmd> protocol command.	326	Invoked whenever a client issues the C<extcmd> protocol command.
287	Programmable plug-ins usually handle this event internally.	327	Programmable plug-ins usually handle this event internally.
288		328
289	=head3 move (player direction -- )	329	=head3 move (player direction -- )
290		330
		331	Called whenever the player is supposed to move or attack. The handler
		332	must handle the cases of speed_left or weapon_sp_left being negative,
		333	fire being on, is responsible for decreaseing the speed_left value
		334	on successful moves etc. etc.. When overriden, must return a boolean
		335	indicating wether a move could be effected.
		336
291	=head3 pray_altar (player altar skill -- )	337	=head3 pray_altar (player altar skill -- )
292		338
293	Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.	339	Invoked whenever the B<player> prays over an B<altar>, using the given B<skill>.
294		340
295	=head3 tell (player name message -- )	341	=head3 tell (player name message -- )
296		342
297	Invoked whenever the player uses the B<tell> or B<reply> command, before	343	Invoked whenever the player uses the B<tell> or B<reply> command, before
298	it gets processed.	344	it gets processed.
		345
		346	=head3 told (player player message -- )
		347
		348	Invoked right before a message is being told to a player using B<tell> or
		349	B<reply>.
299		350
300	=head3 say (player message --)	351	=head3 say (player message --)
301		352
302	=head3 chat (player message --)	353	=head3 chat (player message --)
303		354
…		…
342	=head3 leave (map player -- )	393	=head3 leave (map player -- )
343		394
344	Invoked whenever a player tries to leave the B<map>. Overriding means the	395	Invoked whenever a player tries to leave the B<map>. Overriding means the
345	player won't be able to leave.	396	player won't be able to leave.
346		397
347	=head3 trigger (map connection state -- )	398	=head3 trigger (map connection state what? who? -- )
348		399
349	Invoked whenever something activates a B<connection> on the B<map>. If B<state>	400	Invoked whenever something activates a B<connection> on the B<map>. If B<state>
350	is true the connection was 'state' and if false it is 'released'.	401	is true the connection was 'state' and if false it is 'released'.
351		402
352		403
…		…
359	=head3 connect (client -- )	410	=head3 connect (client -- )
360		411
361	Called as soon as a new connection to the server is established. Should	412	Called as soon as a new connection to the server is established. Should
362	not be overriden.	413	not be overriden.
363		414
		415	=head3 setup (client string -- )
		416
		417	Client sent the setup command to negotiate parameters. Handling is
		418	mandatory and done by F<login.ext>.
		419
364	=head3 addme (client -- )	420	=head3 addme (client -- )
365		421
366	The client sent an addme, thus ending the initial handshaking. If overriden, the server	422	The client sent an addme, thus ending the initial handshaking. Handling is mandatory
367	will not send any response.	423	and done by F<login.ext>.
368		424
369	=head3 reply (client replystring -- )	425	=head3 reply (client replystring -- )
370		426
371	Called when the client submits a reply in the ST_CUSTOM state. Usually	427	Called when the client submits a reply in the ST_CUSTOM state. Usually
372	handled internally by language plugins.	428	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.13 by root, Tue Jan 2 11:08:36 2007 UTC vs. Revision 1.32 by root, Wed Oct 21 00:44:39 2009 UTC

Diff Legend

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.13 by root, Tue Jan 2 11:08:36 2007 UTC vs.
Revision 1.32 by root, Wed Oct 21 00:44:39 2009 UTC