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