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

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.6 by elmex, Tue Dec 19 15:30:01 2006 UTC vs.
Revision 1.40 by root, Thu Apr 15 00:36:51 2010 UTC

…		…
1	=head1 CROSSFIRE+ OBJECT AND INTERNALS DOCUMENTATION	1	=head1 DELIANTRA OBJECT AND INTERNALS DOCUMENTATION
2		2
3	Here is all information about the object types Crossfire+	3	Here is all information about the object types Deliantra
4	supports at the moment. This is not a complete documentation (yet)	4	supports at the moment. This is not a complete documentation (yet)
5	and browsing the source is still recommended to learn about	5	and browsing the source is still recommended to learn about
6	the objects that aren't documented here.	6	the objects that aren't documented here.
7		7
8	This documentation is in a sketchy state. It's mostly	8	This documentation is in a sketchy state. It's mostly
9	used to collect notes about the internal behaviour of the	9	used to collect notes about the internal behaviour of the
10	objects.	10	objects.
11		11
		12	=head2 About the notation and terms
		13
		14	The term 'archetype' stands for a collection of fields.
		15	The term 'object' stands for an archetype instance.
		16	The term 'field' is used for an object fields and archetype fields.
		17
		18	Field names will be displayed like this: I<fieldname>
		19
		20	Type names will be displayed like this: B<TYPENAME>
		21
		22	Flag names will be displayer like this: FLAG_NAME
		23
12	=head2 About archetypes and objects	24	=head2 About archetypes and objects
13		25
14	Field denotes an attribute of an archetype.	26	Archetypes are 'templates' of objects. If an object is derived
		27	from an archetype the object fields will be set to the corresponding
		28	fields in the archetype.
		29
		30	When a map is instanciated (loaded), the 'object' description on the
		31	map are considered patches of the archetype.
		32
		33	This document does explain the behaviour of the objects and the meaning of
		34	their fields in the server engine, which are derived from archetypes.
		35
15	This is an example of an archetype:	36	This is an example of an archetype:
16		37
17	Object button_trigger	38	object button_trigger
18	name button	39	name button
19	type 30	40	type 30
20	face button_sma.111	41	face button_sma.x11
21	anim	42	anim
22	button_sma.111	43	button_sma.x11
23	button_sma.112	44	button_sma.x12
24	mina	45	mina
25	is_animated 0	46	is_animated 0
26	exp 30	47	exp 30
27	no_pick 1	48	no_pick 1
28	walk_on 1	49	walk_on 1
30	editable 48	51	editable 48
31	visibility 50	52	visibility 50
32	weight 1	53	weight 1
33	end	54	end
34		55
35	This archetype has the name 'button_trigger' and the objects that	56	The first B<field> is I<name>: 'button_trigger', which basically means that
36	inherit from this archetype have the name 'button'.	57	instances (objects) that are created/derived from this archetype have the
		58	name 'button' (which means that the field I<name> of the object will be set
		59	to the same value as the archetypes field I<name>).
37		60
38	The next field 'type' decides the main behaviour of this archetype.	61	The next field I<type> decides the behaviour of objects derived from this archetype.
39	For a comprehensive list of types see include/define.h. For this case	62	For a comprehensive list of types see include/define.h. For this case
40	you might find a line like:	63	you might find a line like:
41		64
42	#define TRIGGER_BUTTON 30	65	#define TRIGGER_BUTTON 30
43		66
44	The server internally works with objects that 'inherit' attributes from	67	The behaviour of objects is further determined by B<Flags>, like FLAG_APPLIED.
45	an archetype. They have a similar set of attributes.	68	For more information on this look in the Flags subsection in the next section
46		69
47	The following documentation will also document the meaning of code internal	70	The following documentation will also document the meaning of internal used
48	attributes of objects. These attributes are marked as '(internal)' and can't	71	fields of objects. These fields are marked as (internal) and can't
49	or shouldn't be set by an archetype. If the internal names differs the	72	or shouldn't be set by an archetype.
50	external name (for the archetypes) for the attribute is written behind it.
51		73
52	=head2 Description of generic archetype and object attributes	74	=head2 Description of (mostly) generic object fields
53		75
54	These are the fields that most of the objects have and/or their	76	These are the fields that most of the objects have and/or their
55	default behaviour.	77	default behaviour.
56		78
57	=over 4	79	=over 4
58		80
59	=item name <string>	81	=item I<name> <string>
60		82
61	The name of the object.	83	The name of the object.
62		84
63	=item name_pl <string>	85	=item I<name_pl> <string>
64		86
65	The name of a collection of these objects (the plural of the name).	87	The name of a collection of these objects (the plural of the name).
66		88
67	=item face <facename>	89	=item I<face> <facename>
68		90
69	The graphical appearance of this object.	91	The graphical appearance of this object.
70		92
		93	=item I<x> <number>
		94
		95	The x position of the object when it is on a map.
		96
		97	=item I<y> <number>
		98
		99	The y position of the object when it is on a map.
		100
		101	=item I<map> (internal)
		102
		103	The map the object is on.
		104
71	=item invisible <number>	105	=item I<invisible> <number>
72		106
73	If the <number> is greater than 0 the object is invisible.	107	If the <number> is greater than 0 the object is invisible.
74	For players this field reflects the duration of the invisibility	108	For players this field reflects the duration of the invisibility
75	and is decreased every tick by 1.	109	and is decreased every tick by 1.
76		110
77	For non-player objects this field is not changed by server ticks.	111	For non-player objects this field is not changed by server ticks.
78		112
79	=item speed <number>	113	=item I<glow_radius> <number>
		114
		115	This field indicates how far an object glows. Default is a radius of 0 (no
		116	glowing at all). Negative glow radii darken areas - currently, negative
		117	glow radii are stronger than positive ones.
		118
		119	=item I<speed> <float>
80		120
81	If this field is greater than MIN_ACTIVE_SPEED (~0.0001) the object is placed	121	If this field is greater than MIN_ACTIVE_SPEED (~0.0001) the object is placed
82	on the active object list and will be processed each tick (see also speed_left!).	122	on the active object list and will be processed each tick (see also speed_left!).
83		123
84	If the speed field drops below the MIN_ACTIVE_SPEED the object is removed	124	If I<speed> drops below the MIN_ACTIVE_SPEED the object is removed
85	from the active object list and it won't experience any processing per tick.	125	from the active object list and it won't experience any processing per tick.
86		126
87	=item speed_left <number>	127	Negative speed settings in archetypes and files cause a speed_left
		128	randomisation on load or instantiatian, but for calculations, the absolute
		129	value is used always.
		130
		131	=item I<speed_left> <float>
88		132
89	If this field is greater than 0 and the object is on the	133	If this field is greater than 0 and the object is on the
90	active list (mostly means it's speed is also greater than 0):	134	active list (mostly means it's speed is also greater than 0):
91		135
92	- speed_left is decreased by 1	136	- speed_left is decreased by 1
93	- and this object is processed and experiences a server tick.	137	- and this object is processed and experiences a server tick.
94		138
95	If the object is on the active list and speed_left is lower or	139	If the object is on the active list and I<speed_left> is lower or
96	equal to 0 the absolute value of the speed field is added to speed_left	140	equal to 0 the absolute value of the I<speed> is added to I<speed_left>
97	on the end of the tick.	141	on the end of the tick.
98		142
		143	This means: the lower I<speed> is (but still above MIN_ACTIVE_SPEED)
		144	the more seldom the object is processed. And the higher I<speed> is
		145	the more often the object is processed.
		146
		147	=item I<connected> <identifier>
		148
		149	When this field is set the object will be linked to a connection with the
		150	same <identifier>. What happens when the connection is 'activated' depends on the
		151	type of the object.
		152
		153	FLAG_ACTIVATE_ON_PUSH and FLAG_ACTIVATE_ON_RELEASE they will control
		154	when to activate the object, see description of these below for further details.
		155
99	=item no_drop (0\|1)	156	=item I<no_drop> (0\|1)
100		157
101	Sets the flag FLAG_NO_DROP.	158	Sets the flag FLAG_NO_DROP.
102	See Flags section below.	159	See Flags section below.
103		160
104	=item applied (0\|1)	161	=item I<applied> (0\|1)
105		162
106	Sets the flag FLAG_APPLIED.	163	Sets the flag FLAG_APPLIED.
107	See Flags section below.	164	See Flags section below.
108		165
109	=item is_used_up (0\|1)	166	=item I<is_used_up> (0\|1)
110		167
111	Sets the flag FLAG_IS_USED_UP.	168	Sets the flag FLAG_IS_USED_UP.
112	See Flags section below.	169	See Flags section below.
113		170
		171	=item I<changing> (0\|1)
		172
		173	Sets the flag FLAG_CHANGING.
		174	See Flags section below.
		175
114	=item auto_apply (0\|1)	176	=item I<auto_apply> (0\|1)
115		177
116	Sets the flag FLAG_AUTO_APPLY.	178	Sets the flag FLAG_AUTO_APPLY.
117	See Flags section below.	179	See Flags section below.
118		180
		181	=item I<no_steal> (0\|1)
		182
		183	Sets the flag FLAG_NO_STEAL.
		184	See Flags section below.
		185
		186	=item I<reflecting> (0\|1)
		187
		188	Sets the flag FLAG_REFLECTING.
		189	See Flags section below.
		190
		191	=item I<reflect_spell> (0\|1)
		192
		193	Sets the flag FLAG_REFL_SPELL.
		194	See Flags section below.
		195
		196	=item I<no_skill_ident> (0\|1)
		197
		198	Sets the flag FLAG_NO_SKILL_IDENT.
		199	See Flags section below.
		200
119	=item activate_on_push (0\|1) (default: 1)	201	=item I<activate_on_push> (0\|1) (default: 1)
120		202
121	Sets the flag FLAG_ACTIVATE_ON_PUSH.	203	Sets the flag FLAG_ACTIVATE_ON_PUSH.
122	See Flags section below.	204	See Flags section below.
123		205
124	=item activate_on_release (0\|1) (default: 1)	206	=item I<activate_on_release> (0\|1) (default: 1)
125		207
126	Sets the flag FLAG_ACTIVATE_ON_RELEASE.	208	Sets the flag FLAG_ACTIVATE_ON_RELEASE.
127	See Flags section below.	209	See Flags section below.
128		210
		211	=item I<is_lightable> (0\|1)
		212
		213	Sets the flag FLAG_IS_LIGHTABLE.
		214	See Flags section below.
		215
129	=item editable (more than deprecated)	216	=item I<editable> (more than deprecated)
130		217
131	This field had a special meaning for crossedit, which used parts	218	This field had a special meaning for crossedit, which used parts
132	of the server code for editing. Wherever you see this attribute being	219	of the server code for editing. Wherever you see this field being
133	set in an archetype ignore it and/or remove it. No code interprets this	220	set in an archetype ignore it and/or remove it. No code interprets this
134	field anymore.	221	field anymore.
		222
		223	=item I<last_heal>, I<last_sp>
		224
		225	For monsters and other living stuff that heals or regenarates hp or sp,
		226	these contain the fractional part of any healing that couldn't be applied
		227	to hp and sp yet.
135		228
136	=back	229	=back
137		230
138	=head3 Flags	231	=head3 Flags
139		232
…		…
149		242
150	This flag mostly states whether this object has been 'applied' by the player.	243	This flag mostly states whether this object has been 'applied' by the player.
151	For objects that are applied by the code or have this flag set in the archetype	244	For objects that are applied by the code or have this flag set in the archetype
152	it mostly means 'this object is active'.	245	it mostly means 'this object is active'.
153		246
154	For example the player adjustments of the hp/sp/grace fields and inheritance	247	For example the player adjustments of the I<hp>/I<sp>/I<grace> fields and inheritance
155	of flags from objects in his inventory is toggled by this flag.	248	of flags from objects in his inventory is toggled by this flag.
156		249
157	=item FLAG_IS_USED_UP	250	=item FLAG_IS_USED_UP
158		251
159	This flag controls whether an object is 'used up'. If it is set the 'food' field	252	This flag controls whether an object is 'used up'. If it is set I<food>
160	of the object is decreased by 1 each tick, and if it is lower or equal 0 after tha	253	is decreased by 1 each tick, and will be removed when I<food> is lower or equal 0.
161	it is removed.
162		254
163	If also the flag FLAG_APPLIED is set, the 'duration' field controls whether	255	If also the flag FLAG_APPLIED is set, the I<duration> field controls whether
164	this object is removed or not, see the Force type below for the meaning	256	this object is removed or not, see the B<FORCE> type below for the meaning
165	of the duration field in this context.	257	of the duration field in this context.
166		258
167	If FLAG_APPLIED is not set the object is destroyed.	259	If FLAG_APPLIED is not set the object is destroyed.
168		260
		261	=item FLAG_CHANGING
		262
		263	If the I<state> field of the object is 0 the object will be processed periodically
		264	(if I<speed> is set). If the I<state> field is 1 it won't be processed.
		265
		266	This flag indicates that the object is changing into a different object.
		267	The object has to have the I<other_arch> field set. The object the changing object
		268	changes into is derived from the archetype in I<other_arch>.
		269
		270	When the object does not have FLAG_ALIVE set the I<food> field will be decremented
		271	each time the object is processed, and if I<food> reaches 0 one new object will be generated.
		272
		273	When the object has FLAG_ALIVE set the I<food> field is the number of objects that
		274	will be generated.
		275
		276	After the new object is created the I<hp> field from the old object is copied into
		277	the new one.
		278
169	=item FLAG_IS_A_TEMPLATE (internal use)	279	=item FLAG_IS_A_TEMPLATE (internal use)
170		280
171	This flag is set on the inventory of generators like CREATORs and CONVERTERs,	281	This flag is set on the inventory of generators like B<CREATOR>s and B<CONVERTER>s,
172	or other objects that have the flags FLAG_GENERATOR and FLAG_CONTENT_ON_GEN set.	282	or other objects that have the flags FLAG_GENERATOR and FLAG_CONTENT_ON_GEN set.
173		283
174	=item FLAG_AUTO_APPLY	284	=item FLAG_AUTO_APPLY
175		285
176	This flag has currently only meaning for the TREASURE type, see below.	286	This flag has currently only meaning for the B<TREASURE> type, see below.
177		287
178	=item FLAG_ACTIVATE_ON_PUSH	288	=item FLAG_ACTIVATE_ON_PUSH
179		289
180	This flag has only meaning for objects that can be linked together	290	This flag has only meaning for objects that can be linked together
181	with the 'connected' field and controls wether the object should	291	by the I<connected> field and controls wether the object should
182	be activated when the connection is 'pushed' or it is 'released'.	292	be activated when the connection is 'pushed' or it is 'released'.
183		293
		294	What 'pushed' and 'released' means depends on the object that
		295	activates the connection.
		296
184	This flag is by default on.	297	This flag is by default on.
185		298
186	=item FLAG_ACTIVATE_ON_RELEASE	299	=item FLAG_ACTIVATE_ON_RELEASE
187		300
188	This flag has only meaning for objects that can be linked together	301	This flag has only meaning for objects that can be linked together
189	with the 'connected' field and controls wether the object should	302	by the I<connected> field and controls wether the object should
190	be activated when the connection is 'pushed' or it is 'released'.	303	be activated when the connection is 'pushed' or it is 'released'.
191		304
		305	What 'pushed' and 'released' means depends on the object that
		306	activates the connection.
		307
192	This flag is by default on.	308	This flag is by default on.
193		309
194	=back	310	=item FLAG_NO_STEAL
195		311
196	=head2 Description of type specific attributes	312	When this flag is set this object can't be stolen. The flag will be
		313	reset once the object is placed on a map.
		314
		315	When this flag is set on a monster it can defend attempts at stealing
		316	(but in this context the flag is only used internally).
		317
		318	=item FLAG_NO_SKILL_IDENT
		319
		320	This flag is mostly used internal and prevents unidentified objects
		321	(objects which don't have FLAG_IDENTIFIED set) being identified
		322	multiple times by skills.
		323
		324	This flag is used to mark objects which were unsuccessfully identified by a
		325	players skill. So that multiple tries of identifying aren't more effective than
		326	one.
		327
		328	=item FLAG_REFLECTING
		329
		330	This flag is used by spell effects (eg. SP_BOLT), B<THROWN_OBJ> and B<ARROW>
		331	to indicate whether this object reflects off walls.
		332
		333	=item FLAG_REFL_SPELL
		334
		335	This flag indicates whether something reflects spells, like spell reflecting
		336	amuletts.
		337
		338	=item FLAG_IS_LIGHTABLE
		339
		340	This flag indicates whether a B<LIGHTER> can light this object. See also the
		341	description of the B<LIGHTER> type. How easy you can light an item depends
		342	partially on the material of the object.
		343
		344	=item FLAG_MONSTER
		345
		346	Enables NPC behaviour in general (both monster AI and friendly AI). Numerous fields
		347	change their meaning, including:
		348
		349	=over 4
		350
		351	=item I<wis>
		352
		353	Governs the "wake-up radius" - the radius within a monster detects an enemy.
		354
		355	Also, I<wis> governs pathfinding intelligence: 8 and up means the monster
		356	will partake in basic smell finding. 10 and up additionally spreads smell
		357	knowledge, and 15 and up additionally will try to perturb the path as to
		358	find shortcuts.
		359
		360	=back
		361
		362	=back
		363
		364	=head2 Description of type specific fields and behaviour
197		365
198	The beginning of the headers of the following subsection	366	The beginning of the headers of the following subsection
199	are the server internal names for the objects types, see include/define.h.	367	are the server internal names for the objects types, see include/define.h.
200		368
201	=head3 TRANSPORT - type 2 - Player transports	369	=head3 B<TRANSPORT> - type 2 - Player transports
202		370
203	This type is implemented by the transport extension and has currently no special	371	This type is implemented by the transport extension and has currently no special
204	attributes that affect it.	372	fields that affect it.
205		373
206	=head3 ROD - type 3 - Rods that fire spells	374	=head3 B<ROD>, B<HORN> - type 3, 35 - Rods that fire spells
207		375
208	Rods contain spells and can be fired by a player.	376	Rods contain spells and can be fired by a player.
209		377
210	=over 4	378	=over 4
211		379
212	=item level <number>	380	=item I<level> <number>
213		381
214	This attribute is used for calculating the spell level that can be fired	382	This field is used for calculating the spell level that can be fired
215	with this rod, it's also the maximum level of the spell that can be fired.	383	with this rod, it's also the maximum level of the spell that can be fired.
216	The level of the spell that is being fired depends mostly on	384	The level of the spell that is being fired depends mostly on
217	the 'use magic item' skill level of the player and 1/10 of the level of the	385	the 'use magic item' skill level of the player and 1/10 of the level of the
218	rod is added as bonus.	386	rod is added as bonus.
219		387
220	=item hp <number>	388	=item I<hp> <number>
221		389
222	The amount of spellpoints this rod has left.	390	The amount of spellpoints this rod has left. Recharges at a rate of C<1 +
		391	maxhp/10> per tick.
223		392
224	=item maxhp <number>	393	=item I<maxhp> <number>
225		394
226	The maximum amount of spellpoints this rod has.	395	The maximum amount of spellpoints this rod has.
227		396
228	=item skill <skill name>	397	=item I<skill> <skill name>
229		398
230	This field determines which skill you need to apply this object.	399	This field determines which skill you need to apply this object.
231		400
232	=back	401	=back
233		402
234	=head3 TREASURE - type 4 - Treasures	403	=head3 B<TREASURE> - type 4 - Treasures
235		404
236	This type of objects are for random treasure generation in maps.	405	This type of objects are for random treasure generation in maps.
237	If this object is applied by a player it will replace itself with it's	406	If this object is applied by a player it will replace itself with it's
238	inventory. If it is automatically applied	407	inventory. If it is automatically applied
239	generate a treasure and replace itself with the generated treasure.	408	generate a treasure and replace itself with the generated treasure.
…		…
241	Chests are also of this type, their treasures are generated by	410	Chests are also of this type, their treasures are generated by
242	the auto apply code on map instantiation.	411	the auto apply code on map instantiation.
243		412
244	=over 4	413	=over 4
245		414
246	=item hp <number>	415	=item I<hp> <number>
247		416
248	The number of treasures to generate.	417	The number of treasures to generate.
249		418
250	=item exp <level>	419	=item I<exp> <level>
251		420
252	If FLAG_AUTO_APPLY is not set the exp field has no further meaning	421	If FLAG_AUTO_APPLY is not set the exp field has no further meaning
253	and the difficulty for the treasurecode only depends on the maps difficulty,	422	and the difficulty for the treasurecode only depends on the maps difficulty,
254	otherwise the exp field has the following meaning:	423	otherwise the exp field has the following meaning:
255		424
…		…
258	worth a treasure is or what bonuses it is given by the treasure code.	427	worth a treasure is or what bonuses it is given by the treasure code.
259		428
260	If this field is not set or 0 the difficulty of the map is passed to the treasure	429	If this field is not set or 0 the difficulty of the map is passed to the treasure
261	generation code.	430	generation code.
262		431
263	=item randomitems <treasurelist>	432	=item I<randomitems> <treasurelist>
264		433
265	The treasurelist to use to generate the treasure which is put in the	434	The treasurelist to use to generate the treasure which is put in the
266	treasure objects inventory.	435	treasure objects inventory.
267		436
268	=back	437	=back
269		438
270	=head3 POTION - type 5 - Potions for drinking and other nastynesses	439	=head3 B<POTION> - type 5 - Potions for drinking and other nastynesses
271		440
272	These objects contain a spell and will emit it on apply, which most	441	These objects contain a spell and will emit it on apply, which most
273	of the time has the meaning of 'drinking'.	442	of the time has the meaning of 'drinking'.
274		443
275	If no resistancy field, stat field or attacktype is set and no spell	444	If no resistancy field, stat field or attacktype is set and no spell
…		…
280	If the potion has FLAG_CURSED or FLAG_DAMNED set the usage of this potion	449	If the potion has FLAG_CURSED or FLAG_DAMNED set the usage of this potion
281	will yield an explosion and hurt the player.	450	will yield an explosion and hurt the player.
282		451
283	=over 4	452	=over 4
284		453
285	=item Str, Dex, Con, Int, Wis, Cha, Pow <number>	454	=item I<Str>, I<Dex>, I<Con>, I<Int>, I<Wis>, I<Cha>, I<Pow> <number>
286		455
287	These stat fields determine how many stat points the player gets	456	These stat fields determine how many stat points the player gets
288	when he applies this potion.	457	when he applies this potion.
289		458
290	If FLAG_CURSED or FLAG_DAMNED is set the player will loose that many stat points.	459	If FLAG_CURSED or FLAG_DAMNED is set the player will loose that many stat points.
291		460
292	=item sp <number>	461	=item I<sp> <number>
293		462
294	If this field is set and the randomitems field is not set	463	If this field is set and the randomitems field is not set
295	the field is interpreted as spell number, please look the right	464	the field is interpreted as spell number, please look the right
296	number up in common/loader.C.	465	number up in common/loader.C.
297		466
298	If this field is set the randomitems field will be unset by the	467	If this field is set the randomitems field will be unset by the
299	map loading code.	468	map loading code.
300		469
301	=item attacktype <attacktype>	470	=item I<attacktype> <attacktype>
302		471
303	This field has some special meaning in potions, currently the	472	This field has some special meaning in potions, currently the
304	bits for AT_DEPLETE and AT_GODPOWER control whethere this is a	473	bits for AT_DEPLETE and AT_GODPOWER control whethere this is a
305	restoration potion or improvement potion.	474	restoration potion or improvement potion.
306	See include/attackinc.h for the bits of these types.	475	See include/attackinc.h for the bits of these types.
307		476
308	If AT_DEPLETE is set the player will be restored and the ARCH_DEPLETION	477	If AT_DEPLETE is set the player will be restored and the "depletion"
309	will be removed from him. If the potion has FLAG_CURSED or FLAG_DAMNED	478	will be removed from him. If the potion has FLAG_CURSED or FLAG_DAMNED
310	set the player will be drained a random stat by inserting an ARCH_DEPLETION	479	set the player will be drained a random stat by inserting an "depletion"
311	into him.	480	into him.
312		481
313	If AT_GODPOWER is enabled the player will gain +1 maxvalue in his hp, sp or grace stat.	482	If AT_GODPOWER is enabled the player will gain +1 maxvalue in his hp, sp or grace stat.
314	When the potion has FLAG_CURSED or FLAG_DAMNED set he will loose one in one of these stats.	483	When the potion has FLAG_CURSED or FLAG_DAMNED set he will loose one in one of these stats.
315		484
316	=item resist_<resistancy> <number>	485	=item I<resist_RESISTANCY> <number>
317		486
318	If this stat is set and no spell is in the potion the potion	487	If this stat is set and no spell is in the potion the potion
319	will create a force that give the player this specific resistancy.	488	will create a force that give the player this specific resistancy.
320	The forces type will be changed to POTION_EFFECT (see POTION_EFFECT type below)	489	The forces type will be changed to POTION_EFFECT (see POTION_EFFECT type below)
321	and the potion will last 10 times longer than the default force archetype	490	and the potion will last 10 times longer than the default force archetype
322	FORCE_NAME (at the moment of this writing spell/force.arc).	491	FORCE_NAME (at the moment of this writing spell/force.arc).
323		492
324	=item randomitems <treasurelist>	493	=item I<randomitems> <treasurelist>
325		494
326	The inventory/spell of the potion will be created by calling the treasure code	495	The inventory/spell of the potion will be created by calling the treasure code
327	with the treasurelist specified here. (I guess it's highly undefined what	496	with the treasurelist specified here. (I guess it's highly undefined what
328	happens if there is not a spell in the potions inventory).	497	happens if there is not a spell in the potions inventory).
329		498
330	=item on_use_yield <archetype>	499	=item I<on_use_yield> <archetype>
331		500
332	When this object is applied this object will be created.	501	When this object is applied an instance of <archetype> will be created.
333	This field is also used by FOOD and POISON.
334		502
335	=item subtypes <potion subtype>	503	=item I<subtypes> <potion subtype>
336		504
337	see include/spells.h for possible potion subtypes, there are currently 4:	505	see include/spells.h for possible potion subtypes, there are currently 4:
338		506
339	=over 4	507	=over 4
340		508
…		…
343	Unused, default behaiour of a potion.	511	Unused, default behaiour of a potion.
344		512
345	=item POT_DUST	513	=item POT_DUST
346		514
347	This potion can be thrown to cast the spell that it has in it's inventory,	515	This potion can be thrown to cast the spell that it has in it's inventory,
348	the behaviour is not defined if there is not a spell in the inventory and the	516	the behaviour is not defined if there is not a B<SPELL> in the inventory and the
349	server will log an error.	517	server will log an error.
350		518
351	=item POT_FIGURINE	519	=item POT_FIGURINE
352		520
353	Unused, default behaiour of a potion.	521	Unused, default behaiour of a potion.
…		…
358		526
359	=back	527	=back
360		528
361	=back	529	=back
362		530
		531	=head3 B<FOOD> - type 6 - Edible stuff
		532
		533	This is for objects that are representing general eatables like
		534	beef or bread.
		535
		536	The main difference between B<FOOD>, B<FLESH> and B<DRINK> is that they
		537	give different messages.
		538
		539	The specialty of B<FLESH> is that it inherits the resistancies of the
		540	monsters it was generated in and will let dragons raise their resistancies
		541	with that. If the monster has the B<POISON> attacktype the B<FLESH>
		542	will change into B<POISON>.
		543
		544	If a player runs low on food he will grab for B<FOOD>, B<DRINK> and B<POISON>
		545	and if he doesn't find any of that he will start eating B<FLESH>.
		546
		547	=over 4
		548
		549	=item I<title> <string>
		550
		551	If the food has B<title> set or is cursed it is considered 'special', which
		552	means that the fields I<Str>, I<Dex>, I<Con>, I<Int>, I<Wis>, I<Pow>,
		553	I<resist_RESISTANCY>, I<hp> and I<sp> are interpreted and have further effects
		554	on the player.
		555
		556	The higher the I<food> field is the longer the improvement of the player lasts
		557	(except for I<hp> and I<sp>).
		558
		559	=item I<food> <number>
		560
		561	This is the amount of food points the player gets when he eats this.
		562
		563	=item I<on_use_yield> <archetype>
		564
		565	When this object is applied an instance of <archetype> will be created.
		566
		567	=back
		568
		569	=head3 B<POISON> - type 7 - Poisonous stuff
		570
		571	This type is for objects that can poison the player when he drinks/applies it.
		572	When applied it will hit the attacked with AT_POISON and will create
		573	a B<POISONING> object in the one who was hit.
		574
		575	=over 4
		576
		577	=item I<level> <number>
		578
		579	This field affects the probability of poisoning. The higher the level difference
		580	between the one who is hit and the poision the more probable it is the attacked
		581	one will be poisoned.
		582
		583	=item I<slaying> <race>
		584
		585	This field has the usual meaning of 'slaying', when the
		586	poisoned's race matches the I<slaying> field the damage done by the poison
		587	is multiplied by 3.
		588
		589	=item I<hp> <number>
		590
		591	This is the amount of damage the player will receive from applying this. The
		592	attacktype AT_POISON will be used to hit the player and the damage will
		593	determine the strenght, duration and depletion of stats of the poisoning. The
		594	created B<POISONING> object which is being placed in the one who was attacked will
		595	get the damage from this field (which is maybe adjusted by slaying or the
		596	resistancies).
		597
		598	=item I<food> <number>
		599
		600	1/4 of <number> will be drained from the players I<food>.
		601
		602	=item I<on_use_yield> <archetype>
		603
		604	When this object is applied an instance of <archetype> will be created.
		605
		606	=back
		607
		608	=head3 B<BOOK> - type 8 - Readable books
		609
		610	This type is basically for representing text books in the game.
		611
		612	Reading a book also identifys it (if FLAG_NO_SKILL_IDENT is not set).
		613
		614	=over 4
		615
		616	=item I<msg> <text>
		617
		618	This is the contents of the book. When this field is unset
		619	at treasure generation a random text will be inserted.
		620
		621	=item I<skill> <skill name>
		622
		623	The skill required to read this book. (The most resonable
		624	skill would be literacy).
		625
		626	=item I<exp> <number>
		627
		628	The experience points the player get for reading this book.
		629
		630	=item I<subtype> <readable subtype>
		631
		632	This field determines the type of the readable.
		633	Please see common/readable.C in the readable_message_types table.
		634
		635	=back
		636
		637	=head3 B<CLOCK> - type 9 - Clocks
		638
		639	This type of objects just display the time when being applied.
		640
		641	=head3 B<VEIN> - type 10 - item veins for mining
		642
		643	Provides a place to apply to mining skill to.
		644
		645	=item I<other_arch> <archname>
		646
		647	The architecture to create on a successful mine.
		648
		649	=item I<food> <number>
		650
		651	The number of items to produce from this vein.
		652
		653	=item I<ac> <percentage>
		654
		655	The base chance of getting an item.
		656
		657	=item I<race> <identifier>
		658
		659	Race of required extraction tools.
		660
		661	=back
		662
		663	=head3 B<LIGHTNING> - type 12 - Lightnings (DEPRECATED: see B<SPELL_EFFECT> subtype SP_BOLT)
		664
		665	This is a spell effect of a moving bolt. It moves straigt forward
		666	through the map until something blocks it.
		667	If FLAG_REFLECTING is set it even reflects on walls.
		668
		669	FLAG_IS_TURNABLE should be set on these objects.
		670
		671	=over 4
		672
		673	=item I<move_type> <movetype>
		674
		675	This field affects the move type with which the lightning moves through
		676	the map and which map cells will reflect or block it.
		677
		678	=item I<attacktype> <attacktype>
		679
		680	The attacktype with which it hits the objects on the map.
		681
		682	=item I<dam> <number>
		683
		684	The damage this bolt inflicts when it hits objects on the map.
		685
		686	=item I<Dex> <number>
		687
		688	This is the fork percentage, it is reduced by 10 per fork.
		689	And the I<dam> field is halved on each fork.
		690
		691	=item I<Con> (internal)
		692
		693	This value is a percentage of which the forking lightning
		694	is deflected to the left. This value should be mostly used internally.
		695
		696	=item I<duration> <number>
		697
		698	The duration the bolt stays on a map cell. This field is decreased each time
		699	the object is processed (see the meaning of I<speed> and I<speed_left> fields in
		700	the generic object field description).
		701
		702	=item I<range> <number>
		703
		704	This is the range of the bolt, each space it advances this field is decreased.
		705
		706	=back
		707
		708	=head3 B<ARROW> - type 13 - Arrows
		709
		710	This is the type for objects that represent projectiles like arrows.
		711	The movement of B<THROWN_OBJ>s behave similar to this type.
		712
		713	Flying arrows are stopped either when they hit something blocking
		714	(I<move_block>) or something which is alive.
		715	If it hits something that is alive, which doesn't have FLAG_REFL_MISSILE
		716	set, it will inflict damage. If FLAG_REFL_MISSILE is set it will inflict
		717	damage with a small chance which is affected by the I<level> field of the arrow.
		718
		719	If FLAG_REFLECTING is set on the arrow it will bounce off everything
		720	that is not alive and blocks it's movement.
		721
		722	When an arrow is being shot it's I<dam>, I<wc>, I<attacktype>, I<slaying>
		723	fields will be saved in the I<sp>, I<hp>, I<grace> and I<spellarg> fields of
		724	the object, to restore them once the arrow has been stopped.
		725
		726	=over 4
		727
		728	=item I<dam> <number>
		729
		730	The amount of damage that is being done to the victim that gets hit.
		731	This field is recomputed when the arrow is fired and will consist
		732	of the sum of a damage bonus (see description of the B<BOW> type),
		733	the arrows I<dam> field, the bows I<dam> field, the bows I<magic> field
		734	and the arrows I<magic> field.
		735
		736	=item I<wc> <number>
		737
		738	The weapon class of the arrow, which has effect on the probability of hitting.
		739
		740	It is recomputed when the arrow is being fired by this formula:
		741
		742	wc = 20 - bow->magic - arrow->magic - (skill->level or shooter->level)
		743	- dex_bonus - thaco_bonus - arrow->stats.wc - bow->stats.wc + wc_mod
		744
		745	When the arrow is not being shot by an player dex_bonus and thaco_bonus and the
		746	level is not added.
		747
		748	wc_mod is dependend on the fire mode of the bow. For a more detailed
		749	explanation of dex_bonus, thaco_bonus and wc_mod please consult the code.
		750
		751	=item I<magic> <number>
		752
		753	This field is added to the damage of the arrow when it is shot and
		754	will also improve it's I<speed> by 1/5 of it's value.
		755
		756	=item I<attacktype> <attacktype>
		757
		758	Bitfield which decides the attacktype of the damage, see include/attackinc.h
		759	On fireing the I<attacktype> of the bow is added to the arrows I<attacktype>.
		760
		761	=item I<level> <number> (interally used)
		762
		763	The level of the arrow, this affects the probability of piercing FLAG_REFL_MISSILE,
		764	see above in the B<ARROW> description.
		765
		766	The I<level> is set when the arrow is fired to either the skill level or the
		767	shooters level.
		768
		769	=item I<speed> <number> (internal)
		770
		771	This field shouldn't be set directly in the archetype, the arrow will get it's
		772	I<speed> from the bow. This fields value has to be at least 0.5 or otherwise the
		773	arrow will be stopped immediatly.
		774
		775	On fireing the I<speed> of the arrow is computed of 1/5 of the
		776	sum of the damage bonus (see BOW), bow I<magic> and arrow I<magic>. After that 1/7
		777	of the bows I<dam> field is added to the I<speed> of the arrow.
		778
		779	The minimum I<speed> of an arrow is 1.0.
		780
		781	While flying the arrows I<speed> is decreased by 0.05 each time it's moved.
		782
		783	If the I<speed> is above 10.0 it goes straight through the creature it hits and
		784	its I<speed> is reduced by 1. If the I<speed> is lower or equal 10.0 the arrow is
		785	stopped and either stuck into the victim (see I<weight> field description) or
		786	put on its map square (if it didn't break, see description of the I<food> field).
		787
		788	=item I<weight> <number>
		789
		790	This field is the weight of the arrow, if I<weight> is below or equal 5000 (5 kg)
		791	the arrow will stick in the victim it hits. Otherwise it will fall to the ground.
		792
		793	=item I<food> <number>
		794
		795	The breaking percentage. 100 (%) means: breaks on usage for sure.
		796
		797	=item I<inventory> (internal)
		798
		799	If the flying/moving object has something in it's inventory and it stops, it
		800	will be replaced with it's inventory. Otherwise it will be handled as usual,
		801	which means: it will be calculated whether the arrow breaks and it will be
		802	reset for reuse.
		803
		804	=item I<slaying> <string>
		805
		806	When the bow that fires this arrow has it's I<slaying> field set it is copied
		807	to the arrows I<slaying> field. Otherwise the arrows I<slaying> field remains.
		808
		809	=item I<move_type> <movetype> (internally used)
		810
		811	This field is set when the arrow is shot to MOVE_FLY_LOW.
		812
		813	=item I<move_on> <movetype> (internally used)
		814
		815	This field is set when the arrow is shot to MOVE_FLY_LOW and MOVE_WALK.
		816
		817	=item I<race> <string>
		818
		819	The I<race> field is a unique key that assigns arrows, bows and quivers. When
		820	shooting an arrow the bows I<race> is used to search for arrows (which have the
		821	same I<race> as the bow) in the players inventory and will recursively search in
		822	the containers (which are applied and have the same I<race> as the bow and the arrow).
		823
		824	=back
		825
		826	=head3 B<BOW> - type 14 - Bows, those that fire B<ARROW>s
		827
		828	TODO, but take into account B<ARROW> description above!
		829
363	=head3 WEAPON - type 15 - Weapons	830	=head3 B<WEAPON> - type 15 - Weapons
364		831
365	This type is for general hack and slash weapons like swords, maces	832	This type is for general hack and slash weapons like swords, maces
366	and daggers and and ....	833	and daggers and and ....
367		834
368	=over 4	835	=over 4
369		836
370	=item weapontype <type id>	837	=item I<weapontype> <type id>
371		838
372	decides what attackmessages are generated, see include/define.h	839	decides what attackmessages are generated, see include/define.h
373		840
374	=item attacktype <bitmask>	841	=item I<attacktype> <bitmask>
375		842
376	bitfield which decides the attacktype of the damage, see include/attackinc.h	843	bitfield which decides the attacktype of the damage, see include/attackinc.h
377		844
378	=item dam <number>	845	=item I<dam> <number>
379		846
380	amount of damage being done with the attacktype	847	amount of damage being done with the attacktype
381		848
382	=item item_power <level>	849	=item I<item_power> <level>
383		850
384	the itempower of this weapon.	851	the itempower of this weapon.
385		852
386	=item name	853	=item I<name>
387		854
388	the name of the weapon.	855	the name of the weapon.
389		856
390	=item level (internal)	857	=item I<level> (internal)
391		858
392	The improvement state of the weapon.	859	The improvement state of the weapon.
393	If this field is greater than 0 the 'name' field starts with the	860	If this field is greater than 0 the I<name> field starts with the
394	characters name who improved this weapon.	861	characters name who improved this weapon.
395		862
396	=item last_eat (internal)	863	=item I<last_eat> (internal)
397		864
398	seems to be the amount of improvements of a weapon,	865	This seems to be the amount of improvements of a weapon,
399	the formular for equipping a weapon seems to be (server/apply.C:check_weapon_power):	866	the formular for equipping a weapon seems to be (server/apply.C:check_weapon_power):
400		867
401	((who->level / 5) + 5) >= op->last_eat	868	((who->level / 5) + 5) >= op->last_eat
402		869
403	=item last_sp	870	=item I<last_sp>
404		871
405	the weapon speed (see magic description)	872	the weapon speed (see magic description)
406		873
407	=item food <number>	874	=item I<food> <number>
408		875
409	addition to food regeneration of the player	876	addition to food regeneration of the player
410		877
411	=item hp <number>	878	=item I<hp> <number>
412		879
413	addition to health regeneration	880	addition to health regeneration
414		881
415	=item sp <number>	882	=item I<sp> <number>
416		883
417	addition to mana regeneration	884	addition to mana regeneration
418		885
419	=item grace <number>	886	=item I<grace> <number>
420		887
421	addititon to grace regeneration	888	addititon to grace regeneration
422		889
423	=item gen_sp_armour <number>	890	=item I<gen_sp_armour> <number>
424		891
425	the players gen_sp_armour field (which is per default 10) is added the <number> amount.	892	the players I<gen_sp_armour> field (which is per default 10) is being added the
426	gen_sp_armour seems to be a factor with which gen_sp in do_some_living()	893	<number> amount. gen_sp_armour seems to be a factor with which gen_sp in
427	is multiplied: gen_sp *= 10/<number>	894	do_some_living() is multiplied: gen_sp *= 10/<number> meaning: values > 10 of
428	meaning: values > 10 of gen_sp_armour limits the amout of regenerated	895	I<gen_sp_armour> limits the amout of regenerated spellpoints.
429	spellpoints.
430		896
431	generally this field on weapons is in ranges of 1-30 and decides the slowdown of the	897	Generally this field on weapons is in ranges of 1-30 and decides the slowdown of the
432	sp regeneration.	898	I<sp> regeneration.
433		899
434	=item body_<body slot/part>	900	=item I<body_BODYSLOT>
435		901
436	the part of the body you need to use this weapon, possible values should be	902	The part/slot of the body you need to use this weapon, possible values for
437	looked up in common/item.C at body_locations.	903	C<BODYSLOT> should be looked up in common/item.C at body_locations.
438		904
439	=item resist_<resistnacy> <number>	905	The value (in the range C<-7..7>) gives the number of those body slots
		906	used up by the item (if negative) or the number of body slots this object
		907	has (if positive, e.g. for monsters or players). The special value C<0>
		908	indicates that this object cannot equip items requiring these body slots.
		909
		910	=item I<resist_RESISTANCY> <number>
440		911
441	this is the factor with which the difference of the players resistancy and 100%	912	this is the factor with which the difference of the players resistancy and 100%
442	is multiplied, something like this:	913	is multiplied, something like this:
443		914
444	additional_resistancy = (100 - current_resistanct) * (<number>/100)	915	additional_resistancy = (100 - current_resistancy) * (<number>/100)
445		916
446	if <number> is negative it is added to the total vulnerabilities,	917	if <number> is negative it is added to the total vulnerabilities,
447	and later the total resistance is decided by:	918	and later the total resistance is decided by:
448		919
449	'total resistance = total protections - total vulnerabilities'	920	'total resistance = total protections - total vulnerabilities'
450		921
451	see also common/living.C:fix_player	922	see also common/living.C:fix_player.
452		923
453	=item patch_(attuned\|repelled\|denied)	924	=item I<path_(attuned\|repelled\|denied)>
454		925
455	this field modifies the pathes the player is attuned to, see include/spells.h PATH_*	926	this field modifies the pathes the player is attuned to, see include/spells.h PATH_*
456	for the pathes.	927	for the pathes.
457		928
458	=item luck <number>	929	=item I<luck> <number>
459		930
460	this luck is added to the players luck	931	this luck is added to the players I<luck>
461		932
462	=item move_type	933	=item I<move_type>
463		934
464	if the weapon has a move_type set the player inherits it's move_type	935	if the weapon has a I<move_type> set the player inherits it's I<move_type>
465		936
466	=item exp <number>	937	=item I<exp> <number>
467		938
468	the added_speed and bonus_speed of the player is raised by <number>/3.	939	the added_speed and bonus_speed of the player is raised by <number>/3.
469	if <number> < 0 then the added_speed is decreased by <number>	940	if <number> < 0 then the added_speed is decreased by <number>
470		941
471	=item weight	942	=item I<weight>
472		943
473	the weight of the weapon	944	the weight of the weapon
474		945
475	=item magic	946	=item I<magic>
476		947
477	the magic field affects the amounts of the following fields:	948	the I<magic> field affects the amounts of the following fields:
478		949
479	- wc : the players wc is adjusted by: player->wc -= (wc + magic)	950	- wc : the players wc is adjusted by: player->wc -= (wc + magic)
480		951
481	- ac : the players ac is lowered by (ac + magic) if (player->ac + magic) > 0	952	- ac : the players ac is lowered by (ac + magic) if (player->ac + magic) > 0
482		953
483	- dam: the players dam is adjusted by: player->dam += (dam + magic)	954	- dam: the players dam is adjusted by: player->dam += (dam + magic)
484		955
485	- weapon speed (last_sp): weapon_speed is calculated by: (last_sp * 2 - magic) / 2	956	- weapon speed (last_sp): weapon_speed is calculated by: (last_sp * 2 - magic) / 2
486	(minium is 0)	957	(minium is 0)
487		958
488	=item ac <number>	959	=item I<ac> <number>
489		960
490	the amount of ac points the player's ac is decreased	961	the amount of ac points the player's I<ac> is decreased when applying this object.
491		962
492	=item wc <number>	963	=item I<wc> <number>
493		964
494	the amount of wc points the player's wc is decreased	965	the amount of wc points the player's I<wc> is decreased when applying this object.
495		966
496	=back	967	=back
497		968
498	=head4 Player inherits following flags from weapons:	969	=head4 Player inherits following flags from weapons:
499		970
…		…
504	FLAG_XRAYS	975	FLAG_XRAYS
505	FLAG_BLIND	976	FLAG_BLIND
506	FLAG_SEE_IN_DARK	977	FLAG_SEE_IN_DARK
507	FLAG_UNDEAD	978	FLAG_UNDEAD
508		979
		980	=head3 B<GRIMREAPER> - type 28 - Grimreapers
		981
		982	These type are mostly used for monsters, they give the
		983	monster the ability to dissapear after 10 hits with AT_DRAIN.
		984
		985	=over 4
		986
		987	=item I<value> <number>
		988
		989	This field stores the hits the monster did yet.
		990
		991	=back
		992
		993	=head3 B<CREATOR> - type 42 - Object creators
		994
		995	Once a creator is activated by a connection it creates a number of objects
		996	(cloned from it's inventory or a new object derived from the archetype
		997	named in the other_arch slot).
		998
		999	If FLAG_LIVESAFE is set the number of uses is unlimited.
		1000
		1001	=over 4
		1002
		1003	=item I<hp> <number>
		1004
		1005	If FLAG_LIVE_SAVE is not set it is the absolute number of times the creator can
		1006	be used.
		1007
		1008	=item I<speed> <float>
		1009
		1010	If I<speed> is set the creator will create an object periodically,
		1011	see I<speed> and I<speed_left> fields in the general object field description
		1012	for more details.
		1013
		1014	=item I<slaying> <string>
		1015
		1016	If set the generated object's name and title will be set to this.
		1017
		1018	=item I<other_arch> <string>
		1019
		1020	If the inventory of the creator is empty new objects will be derived from the
		1021	archetype named by <string>.
		1022
		1023	=item I<connected> <identifier>
		1024
		1025	See generic object field description.
		1026
		1027	=back
		1028
		1029	=head3 B<SKILL> - type 43 - Skills
		1030
		1031	This type is basically for representing skills in the game.
		1032
		1033	=over 4
		1034
		1035	=item I<subtype> <skill number>
		1036
		1037	=item I<skill> <string>
		1038
		1039	The skill identifier used by other items, usually the skill name
		1040
		1041	=item I<level> <percentage>
		1042
		1043	not used?
		1044
		1045	=item I<exp> <number>
		1046
		1047	Base amount of experience in a skill, for skills not starting at zero.
		1048
		1049	=item I<expmul> <float>
		1050
		1051	Experience is multiplied by this factor.
		1052
		1053	=item I<cached_sp> <integer>
		1054
		1055	Used internally by the server (cannot be used in files).
		1056
		1057	=back
		1058
		1059	=head3 B<DRINK> - type 54 - Drinkable stuff
		1060
		1061	See B<FOOD> description.
		1062
509	=head3 CHECK_INV - type 64 - Inventory checkers	1063	=head3 B<CHECK_INV> - type 64 - Inventory checkers
510		1064
511	This object checks whether the player has a specific item in his	1065	This object checks whether the player has a specific item in his
512	inventory when he moves above the inventory checker. If the player has	1066	inventory when he moves above the inventory checker. If the player has
513	the item (or not, which can be controlled with a flag) a connection will be triggered.	1067	the item (or not, which can be controlled with a flag) a connection will be triggered.
514		1068
515	If you set move_block you can deny players and monsters to reach the space where	1069	If you set I<move_block> you can deny players and monsters to reach the space where
516	the inventory checker is on, see 'move_block' description below.	1070	the inventory checker is on, see I<move_block> description below.
517		1071
518	The conditions specified by hp, slaying and race are concationated with OR.	1072	The conditions specified by I<hp>, I<slaying> and I<race> are OR concationated.
519	So matching one of those conditions is enough.	1073	So matching one of those conditions is enough.
520		1074
521	=over 4	1075	=over 4
522		1076
523	=item move_block <move type bitmask>	1077	=item I<move_block> <move type bitmask>
524		1078
525	If you set this field to block a movetype the move code will block any moves	1079	If you set this field to block a movetype the move code will block any moves
526	onto the space with the inventory checker, IF the moving object doesn't have	1080	onto the space with the inventory checker, IF the moving object doesn't have
527	(or has - if last_sp = 0) the item that the checker is searching for.	1081	(or has - if I<last_sp> = 0) the item that the checker is searching for.
528		1082
529	=item last_sp (0\|1)	1083	=item I<last_sp> (0\|1)
530		1084
531	If last_sp is 1 'having' the item that is being checked for will	1085	If I<last_sp> is 1 'having' the item that is being checked for will
532	activate the connection or make the space with the checker non-blocking.	1086	activate the connection or make the space with the checker non-blocking.
533	If last_sp is 0 'not having' the item will activate the connection	1087	If I<last_sp> is 0 'not having' the item will activate the connection
534	or make the space with the checker non-blocking.	1088	or make the space with the checker non-blocking.
535		1089
536	=item last_heal (0\|1)	1090	=item I<last_heal> (0\|1)
537		1091
538	If last_heal is 1 the matching item will be removed if the inventory checker	1092	If I<last_heal> is 1 the matching item will be removed if the inventory checker
539	activates a connection and finds the item in the inventory.	1093	activates a connection and finds the item in the inventory.
540		1094
541	(A inventory checker that blocks a space won't remove anything from inventories)	1095	(A inventory checker that blocks a space won't remove anything from inventories)
542		1096
543	=item hp <number>	1097	=item I<hp> <number>
544		1098
545	If this field is not 0 the inventory checker will search for an object	1099	If this field is not 0 the inventory checker will search for an object
546	with the type id <number>.	1100	with the type id <number>.
547		1101
548	=item slaying <string>	1102	=item I<slaying> <string>
549		1103
550	If this field is set the inventory checker will search for an object that	1104	If this field is set the inventory checker will search for an object that
551	has the same string in the slaying field (for example a key string of a key).	1105	has the same string in the I<slaying> field (for example a key string of a key).
552		1106
553	=item race <string>	1107	=item I<race> <string>
554		1108
555	If this field is set the inventory checker will search for an object which	1109	If this field is set the inventory checker will search for an object which
556	has the archetype name that matches <string>.	1110	has the archetype name that matches <string>.
557		1111
558	=item connected <connection id>	1112	=item I<connected> <identifier>
559		1113
560	This is the connection that will be activated.	1114	This is the connection that will be activated. The connection is
		1115	'pushed' when someone enters the space with the inventory checker,
		1116	and it is 'released' when he leaves it.
561		1117
562	=back	1118	See also the description of the I<connected> field in the generic object
		1119	field section.
563		1120
		1121	=back
		1122
		1123	=head3 B<MOOD_FLOOR> - type 65 - change mood of monsters
		1124
		1125	speed == 0 for triggered mood changes, speed != 0 for non-triggered mood
		1126	changes.
		1127
		1128	(based on value that last_sp takes):
		1129	0: 'furious' Makes all monsters aggressive
		1130	1: 'angry' As above but pets are unaffected
		1131	2: 'calm' Makes all monsters unaggressive
		1132	3: 'sleep' Puts all monsters to sleep
		1133	4: 'charm' Makes monster into a pet of person
		1134	who triggers the square. This setting
		1135	is not enabled for continous operation
		1136	5: 'destroy mons' destroy any monsters on this space
		1137	6: 'destroy pets' destroy friendly monsters on this space
		1138
		1139	=head3 B<FLESH> - type 72 - Organs and body parts
		1140
		1141	See B<FOOD> description.
		1142
		1143	=head3 B<MISC_OBJECT> - type 79 - Misc. objects
		1144
		1145	A type for any object that has no special behaviour.
		1146
		1147	=head3 B<DUPLICATOR> - type 83 - Duplicators or: Multiplicators
		1148
		1149	This type of objects multiplies objects that are above it when it is activated.
		1150	You can even multiply by 0, which will destroy the object.
		1151
		1152	=over 4
		1153
		1154	=item I<level> <number>
		1155
		1156	The multiplicator, if set to 0 or lower it will destroy the objects above it.
		1157
		1158	=item I<other_arch> <string>
		1159
		1160	The archetype name of the objects that should be multiplied.
		1161
		1162	=item I<connected> <identifier>
		1163
		1164	See generic object field description.
		1165
		1166	=back
		1167
564	=head3 HOLE - type 94 - Holes	1168	=head3 B<HOLE> - type 94 - Holes
565		1169
566	Holes are holes in the ground where objects can fall through. When the hole	1170	B<HOLE>s are holes in the ground where objects can fall through. When the hole
567	opens and/or is completly open all objects above it fall through (more	1171	opens and/or is completly open all objects above it fall through (more
568	precisely: if their head is above the hole).	1172	precisely: if their head is above the hole).
569		1173
		1174	When the B<HOLE> is activated it's speed is set to 0.5.
		1175
570	Trapdoors can only transfer the one who falls through to other coordinates	1176	These holes can only transfer the one who falls through to other coordinates
571	on the B<same> map.	1177	on the same map.
572		1178
573	=over 4	1179	=over 4
574		1180
575	=item maxsp (0\|1)	1181	=item I<maxsp> (0\|1)
576		1182
577	This field negates the state of the connection: When maxsp is 1 the pit will	1183	This field negates the state of the connection: When maxsp is 1 the pit will
578	open/close when the connection is deactivated. Otherwise it will open/close	1184	open/close when the connection is deactivated. Otherwise it will open/close
579	when the connection is activated. This field only has effect when the	1185	when the connection is activated. This field only has effect when the
580	connection is triggered. So if you put a closed hole on a map, and the	1186	connection is triggered. So if you put a closed hole on a map, and the
581	connection is deactivated, and maxsp is 1 the hole will remain closed until the	1187	connection is deactivated, and I<maxsp> is 1 the hole will remain closed until the
582	connection was triggered once.	1188	connection was triggered once.
583		1189
584	=item connected <connection id>	1190	=item I<connected> <identifier>
585		1191
586	This is the connection id, which lets the hole opening or closing when	1192	This is the connection id, which lets the hole opening or closing when
587	activated. The flags FLAG_ACTIVATE_ON_PUSH and FLAG_ACTIVATE_ON_RELEASE control	1193	activated. The flags FLAG_ACTIVATE_ON_PUSH and FLAG_ACTIVATE_ON_RELEASE control
588	at which connection state the object is activated.	1194	at which connection state the object is activated.
589		1195
590	For example: if FLAG_ACTIVATE_ON_RELEASE is set to 0 the hole won't react when	1196	For example: if FLAG_ACTIVATE_ON_RELEASE is set to 0 the hole won't react when
591	the connection is released.	1197	the connection is released.
592		1198
593	=item wc <number> (internal)	1199	=item I<wc> <number> (internal)
594		1200
595	This is an internal flag. If it is greater than 0 it means that the hole is not	1201	This is an internal field. If it is greater than 0 it means that the hole is not
596	yet fully open. More preciesly: this field is the animation-step and if it is	1202	yet fully open. More preciesly: this field is the animation-step and if it is
597	set to the 'closed' step of the animation the hole is closed and if it is on	1203	set to the 'closed' step of the animation the hole is closed and if it is on
598	the 'open' animation step (wc = 0), the hole is open.	1204	the 'open' animation step (I<wc> = 0), the hole is open.
599		1205
600	=item sp <number>	1206	=item I<sp> <number>
601		1207
602	The destination y coordinates on the same map.	1208	The destination y coordinates on the same map.
603		1209
604	=item hp <number>	1210	=item I<hp> <number>
605		1211
606	The destination x coordinates on the same map.	1212	The destination x coordinates on the same map.
607		1213
608	=back	1214	=back
609		1215
		1216	=head3 B<POISONING> - type 105 - The poisoning of players and monsters
		1217
		1218	This type is doing the actual damage to the ones who were attacked
		1219	via AT_POISON (or drank B<POISON>).
		1220
		1221	The duration is handled via the FLAG_IS_USED_UP mechanism (please look
		1222	there for details).
		1223
		1224	=over 4
		1225
		1226	=item I<dam> <number>
		1227
		1228	Each time the poisoning is proccessed (which is determined by the I<speed> and
		1229	I<speed_left> fields, see the general object fields description above) it hits
		1230	the player with <number> damage and the AT_INTERNAL attacktype (means: it will
		1231	simply hit the player with no strings attached).
		1232
		1233	=item I<food> <number>
		1234
		1235	Just a note: The posioning is removed if I<food> == 1 and not if
		1236	the whole I<duration> is up, because the B<POISONING> code has to remove
		1237	the poison-effects from the player before the FLAG_IS_USED_UP mechanism
		1238	deletes the B<POISONING> object.
		1239
		1240	=back
		1241
610	=head3 FORCE - type 114 - Forces	1242	=head3 B<FORCE> - type 114 - Forces
611		1243
612	Forces are a very 'thin' type. They don't have much behaviour other than	1244	Forces are a very 'thin' type. They don't have much behaviour other than
613	disappearing after a time and/or affecting the player if they are in his	1245	disappearing after a time and/or affecting the player if they are in his
614	inventory.	1246	inventory.
615		1247
616	Forces only take effect on the player if they have set FLAG_APPLIED.	1248	Forces only take effect on the player if they have FLAG_APPLIED set.
617		1249
618	Whether the duration field is processed or not a tick is controlled via the	1250	Whether the I<duration> field is processed or not per tick is controlled by the
619	speed and speed_left field. Look above at the generic description of these	1251	I<speed> and I<speed_left> fields. Look above in the generic object field description.
620	fields.
621		1252
622	=over 4	1253	NOTE: If FLAG_IS_USED_UP is set on a B<FORCE> it's I<food> field will also
		1254	interpreter like described in the description of the FLAG_IS_USED_UP flag.
		1255	BUT: If I<food> reaches 0 before I<duration> and FLAG_APPLIED is set, the force
		1256	will still last for I<duration>. If the FLAG_APPLIED is not set the force is
		1257	removed when I<food> reaches 0. Generally this means: FLAG_IS_USED_UP doesn't
		1258	have good semantics on forces, try to avoid it.
623		1259
		1260	=over 4
		1261
624	=item duration	1262	=item I<duration>
625		1263
626	While this field is greater than 0 the force/object is not destroyed. It is	1264	While this field is greater than 0 the force/object is not destroyed. It is
627	decreased each tick by 1.	1265	decreased each tick by 1.
628		1266
629	If it reaches 0 the force/object is destroyed.	1267	If it reaches 0 the force/object is destroyed.
…		…
632	FLAG_IS_USED_UP and FLAG_APPLIED set. See the description of FLAG_IS_USED_UP	1270	FLAG_IS_USED_UP and FLAG_APPLIED set. See the description of FLAG_IS_USED_UP
633	what happens then.	1271	what happens then.
634		1272
635	=back	1273	=back
636		1274
637	=head3 POTION_EFFECT - type 115 - Potion effects (resistancies)	1275	=head3 B<POTION_EFFECT> - type 115 - Potion effects (resistancies)
638		1276
639	This object is generated by the POTION code when the potion is a resistance	1277	This object is generated by the B<POTION> code when the potion is a resistance
640	giving potion. It has mainly the same behaviour as a FORCE.	1278	giving potion. It has mainly the same behaviour as a B<FORCE>.
641		1279
642	The specialty of the potion effect is that the resistancy it gives is absolute,	1280	The specialty of the potion effect is that the resistancy it gives is absolute,
643	so if you drin a resistancy potion of fire+60 you will get 60% resistancy to	1281	so if you drink a resistancy potion of fire+60 you will get 60% absolute resistancy to
644	fire.	1282	fire.
645		1283
646	Multiple potion effects only give you the maximum of their resistancy.	1284	Multiple potion effects only give you the maximum of their resistancy.

Diff Legend

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

Comparing deliantra/server/pod/objects.pod (file contents): Revision 1.6 by elmex, Tue Dec 19 15:30:01 2006 UTC vs. Revision 1.40 by root, Thu Apr 15 00:36:51 2010 UTC

Diff Legend

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.6 by elmex, Tue Dec 19 15:30:01 2006 UTC vs.
Revision 1.40 by root, Thu Apr 15 00:36:51 2010 UTC