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

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.3 by elmex, Mon Dec 18 12:11:08 2006 UTC vs.
Revision 1.4 by elmex, Mon Dec 18 16:53:04 2006 UTC

…		…
74	For players this field reflects the duration of the invisibility	74	For players this field reflects the duration of the invisibility
75	and is decreased every tick by 1.	75	and is decreased every tick by 1.
76		76
77	For non-player objects this field is not changed by server ticks.	77	For non-player objects this field is not changed by server ticks.
78		78
79	=item speed <numeric>	79	=item speed <number>
80		80
81	If this field is greater than MIN_ACTIVE_SPEED (~0.0001) the object is placed	81	If this field is greater than MIN_ACTIVE_SPEED (~0.0001) the object is placed
82	on the active object list and will be processed each tick (see also speed_left!).	82	on the active object list and will be processed each tick (see also speed_left!).
83		83
84	If the speed field drops below the MIN_ACTIVE_SPEED the object is removed	84	If the speed field drops below the MIN_ACTIVE_SPEED the object is removed
…		…
96	equal to 0 the absolute value of the speed field is added to speed_left	96	equal to 0 the absolute value of the speed field is added to speed_left
97	on the end of the tick.	97	on the end of the tick.
98		98
99	=item no_drop (0\|1)	99	=item no_drop (0\|1)
100		100
101	Sets the flag FLAG_NO_DROP. See the Flags section below.	101	Sets the flag FLAG_NO_DROP.
		102	See Flags section below.
102		103
103	=item applied (0\|1)	104	=item applied (0\|1)
104		105
105	Sets the flag FLAG_APPLIED. See the Flags section below.	106	Sets the flag FLAG_APPLIED.
		107	See Flags section below.
106		108
107	=item is_used_up (0\|1)	109	=item is_used_up (0\|1)
108		110
109	Sets the flag FLAG_IS_USED_UP. See Flags section below.	111	Sets the flag FLAG_IS_USED_UP.
		112	See Flags section below.
		113
		114	=item auto_apply (0\|1)
		115
		116	Sets the flag FLAG_AUTO_APPLY.
		117	See Flags section below.
110		118
111	=item editable (more than deprecated)	119	=item editable (more than deprecated)
112		120
113	This field had a special meaning for crossedit, which used parts	121	This field had a special meaning for crossedit, which used parts
114	of the server code for editing. Wherever you see this attribute being	122	of the server code for editing. Wherever you see this attribute being
…		…
146	this object is removed or not, see the Force type below for the meaning	154	this object is removed or not, see the Force type below for the meaning
147	of the duration field in this context.	155	of the duration field in this context.
148		156
149	If FLAG_APPLIED is not set the object is destroyed.	157	If FLAG_APPLIED is not set the object is destroyed.
150		158
		159	=item FLAG_IS_A_TEMPLATE (internal use)
		160
		161	This flag is set on the inventory of generators like CREATORs and CONVERTERs,
		162	or other objects that have the flags FLAG_GENERATOR and FLAG_CONTENT_ON_GEN set.
		163
		164	=item FLAG_AUTO_APPLY
		165
		166	This flag has currently only meaning for the TREASURE type, see below.
		167
151	=back	168	=back
152		169
153	=head2 Description of type specific attributes	170	=head2 Description of type specific attributes
154		171
155	The beginning of the headers of the following subsection	172	The beginning of the headers of the following subsection
156	are the server internal names for the objects types, see include/define.h.	173	are the server internal names for the objects types, see include/define.h.
157	The numeric values are maybe not 100% accurate, as the code is a changing
158	target, please consult include/define.h in doubt :-)
159		174
160	=head3 FORCE - type 114 - Forces	175	=head3 TRANSPORT - type 2 - Player transports
161		176
162	Forces are a very 'thin' type. They don't have much behaviour other than	177	This type is implemented by the transport extension and has currently no special
163	disappearing after a time and/or affecting the player if they are in his inventory.	178	attributes that affect it.
164		179
165	Forces only take effect on the player if they have set FLAG_APPLIED.	180	=head3 ROD - type 3 - Rods that fire spells
166		181
167	Whether the duration field is processed or not a tick is controlled via the	182	Rods contain spells and can be fired by a player.
168	speed and speed_left field. Look above at the generic description of these
169	fields.
170		183
171	=over 4	184	=over 4
172		185
173	=item duration	186	=item level <number>
174		187
175	While this field is greater than 0 the force/object is not destroyed.	188	This attribute is used for calculating the spell level that can be fired
176	It is decreased each tick by 1.	189	with this rod, it's also the maximum level of the spell that can be fired.
		190	The level of the spell that is being fired depends mostly on
		191	the 'use magic item' skill level of the player and 1/10 of the level of the
		192	rod is added as bonus.
177		193
178	If it reaches 0 the force/object is destroyed.	194	=item hp <number>
179		195
180	This field can have this meaning for B<any> object if that object has	196	The amount of spellpoints this rod has left.
181	FLAG_IS_USED_UP and FLAG_APPLIED set. See the description of FLAG_IS_USED_UP	197
182	what happens then.	198	=item maxhp <number>
		199
		200	The maximum amount of spellpoints this rod has.
		201
		202	=item skill <skill name>
		203
		204	This field determines which skill you need to apply this object.
		205
		206	=back
		207
		208	=head3 TREASURE - type 4 - Treasures
		209
		210	This type of objects are for random treasure generation in maps.
		211	If this object is applied by a player it will replace itself with it's
		212	inventory. If it is automatically applied
		213	generate a treasure and replace itself with the generated treasure.
		214
		215	Chests are also of this type, their treasures are generated by
		216	the auto apply code on map instantiation.
		217
		218	=over 4
		219
		220	=item hp <number>
		221
		222	The number of treasures to generate.
		223
		224	=item exp <level>
		225
		226	If FLAG_AUTO_APPLY is not set the exp field has no further meaning
		227	and the difficulty for the treasurecode only depends on the maps difficulty,
		228	otherwise the exp field has the following meaning:
		229
		230	If this field is not 0 it is passed as the difficulty
		231	to the treasure generation code to determine how good, how much
		232	worth a treasure is or what bonuses it is given by the treasure code.
		233
		234	If this field is not set or 0 the difficulty of the map is passed to the treasure
		235	generation code.
		236
		237	=item randomitems <treasurelist>
		238
		239	The treasurelist to use to generate the treasure which is put in the
		240	treasure objects inventory.
		241
		242	=back
		243
		244	=head3 POTION - type 5 - Potions for drinking and other nastynesses
		245
		246	These objects contain a spell and will emit it on apply, which most
		247	of the time has the meaning of 'drinking'.
		248
		249	If no resistancy field, stat field or attacktype is set and no spell
		250	is put in the potion by the sp field or the randomitems the
		251	potion will become an artifact and the artifact code decides which kind
		252	of potion will be generated.
		253
		254	If the potion has FLAG_CURSED or FLAG_DAMNED set the usage of this potion
		255	will yield an explosion and hurt the player.
		256
		257	=over 4
		258
		259	=item Str, Dex, Con, Int, Wis, Cha, Pow <number>
		260
		261	These stat fields determine how many stat points the player gets
		262	when he applies this potion.
		263
		264	If FLAG_CURSED or FLAG_DAMNED is set the player will loose that many stat points.
		265
		266	=item sp <number>
		267
		268	If this field is set and the randomitems field is not set
		269	the field is interpreted as spell number, please look the right
		270	number up in common/loader.C.
		271
		272	If this field is set the randomitems field will be unset by the
		273	map loading code.
		274
		275	=item attacktype <attacktype>
		276
		277	This field has some special meaning in potions, currently the
		278	bits for AT_DEPLETE and AT_GODPOWER control whethere this is a
		279	restoration potion or improvement potion.
		280	See include/attackinc.h for the bits of these types.
		281
		282	If AT_DEPLETE is set the player will be restored and the ARCH_DEPLETION
		283	will be removed from him. If the potion has FLAG_CURSED or FLAG_DAMNED
		284	set the player will be drained a random stat by inserting an ARCH_DEPLETION
		285	into him.
		286
		287	If AT_GODPOWER is enabled the player will gain +1 maxvalue in his hp, sp or grace stat.
		288	When the potion has FLAG_CURSED or FLAG_DAMNED set he will loose one in one of these stats.
		289
		290	=item resist_<resistancy> <number>
		291
		292	If this stat is set and no spell is in the potion the potion
		293	will create a force that give the player this specific resistancy.
		294	The forces type will be changed to POTION_EFFECT (see POTION_EFFECT type below)
		295	and the potion will last 10 times longer than the default force archetype
		296	FORCE_NAME (at the moment of this writing spell/force.arc).
		297
		298	=item randomitems <treasurelist>
		299
		300	The inventory/spell of the potion will be created by calling the treasure code
		301	with the treasurelist specified here. (I guess it's highly undefined what
		302	happens if there is not a spell in the potions inventory).
		303
		304	=item on_use_yield <archetype>
		305
		306	When this object is applied this object will be created.
		307	This field is also used by FOOD and POISON.
		308
		309	=item subtypes <potion subtype>
		310
		311	see include/spells.h for possible potion subtypes, there are currently 4:
		312
		313	=over 4
		314
		315	=item POT_SPELL
		316
		317	Unused, default behaiour of a potion.
		318
		319	=item POT_DUST
		320
		321	This potion can be thrown to cast the spell that it has in it's inventory,
		322	the behaviour is not defined if there is not a spell in the inventory and the
		323	server will log an error.
		324
		325	=item POT_FIGURINE
		326
		327	Unused, default behaiour of a potion.
		328
		329	=item POT_BALM
		330
		331	Unused, default behaiour of a potion.
		332
		333	=back
183		334
184	=back	335	=back
185		336
186	=head3 WEAPON - type 15 - Weapons	337	=head3 WEAPON - type 15 - Weapons
187		338
…		…
312		463
313	the amount of ac points the player's ac is decreased	464	the amount of ac points the player's ac is decreased
314		465
315	=item wc <number>	466	=item wc <number>
316		467
317	the amount of wc points the player's ac is decreased	468	the amount of wc points the player's wc is decreased
318		469
319	=back	470	=back
320		471
321	=head4 Player inherits following flags from weapons:	472	=head4 Player inherits following flags from weapons:
322		473
323	FLAG_LIFESAVE, FLAG_REFL_SPELL, FLAG_REFL_MISSILE, FLAG_STEALTH,	474	FLAG_LIFESAVE
324	FLAG_XRAYS, FLAG_BLIND, FLAG_SEE_IN_DARK, FLAG_UNDEAD	475	FLAG_REFL_SPELL
		476	FLAG_REFL_MISSILE
		477	FLAG_STEALTH
		478	FLAG_XRAYS
		479	FLAG_BLIND
		480	FLAG_SEE_IN_DARK
		481	FLAG_UNDEAD
		482
		483	=head3 FORCE - type 114 - Forces
		484
		485	Forces are a very 'thin' type. They don't have much behaviour other than
		486	disappearing after a time and/or affecting the player if they are in his inventory.
		487
		488	Forces only take effect on the player if they have set FLAG_APPLIED.
		489
		490	Whether the duration field is processed or not a tick is controlled via the
		491	speed and speed_left field. Look above at the generic description of these
		492	fields.
		493
		494	=over 4
		495
		496	=item duration
		497
		498	While this field is greater than 0 the force/object is not destroyed.
		499	It is decreased each tick by 1.
		500
		501	If it reaches 0 the force/object is destroyed.
		502
		503	This field can have this meaning for B<any> object if that object has
		504	FLAG_IS_USED_UP and FLAG_APPLIED set. See the description of FLAG_IS_USED_UP
		505	what happens then.
		506
		507	=back
		508
		509	=head3 POTION_EFFECT - type 115 - Potion effects (resistancies)
		510
		511	This object is generated by the POTION code when the potion is a
		512	resistance giving potion. It has mainly the same behaviour as a FORCE.
		513
		514	The specialty of the potion effect is that the resistancy it gives is absolute,
		515	so if you drin a resistancy potion of fire+60 you will get 60% resistancy to fire.
		516
		517	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.3 by elmex, Mon Dec 18 12:11:08 2006 UTC vs. Revision 1.4 by elmex, Mon Dec 18 16:53:04 2006 UTC

Diff Legend

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.3 by elmex, Mon Dec 18 12:11:08 2006 UTC vs.
Revision 1.4 by elmex, Mon Dec 18 16:53:04 2006 UTC