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

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.15 by elmex, Wed Dec 20 20:25:59 2006 UTC vs.
Revision 1.24 by root, Sat May 19 00:11:11 2007 UTC

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

Diff Legend

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.15 by elmex, Wed Dec 20 20:25:59 2006 UTC vs.
Revision 1.24 by root, Sat May 19 00:11:11 2007 UTC