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

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.16 by elmex, Wed Dec 20 21:30:42 2006 UTC vs.
Revision 1.29 by root, Thu Dec 4 03:48:19 2008 UTC

-=head1 CROSSFIRE+ OBJECT AND INTERNALS DOCUMENTATION
+=head1 DELIANTRA OBJECT AND INTERNALS DOCUMENTATION
-Here is all information about the object types Crossfire+
+Here is all information about the object types Deliantra
 supports at the moment. This is not a complete documentation (yet)
 and browsing the source is still recommended to learn about
 the objects that aren't documented here.
 This documentation is in a sketchy state. It's mostly
 For players this field reflects the duration of the invisibility
 and is decreased every tick by 1.
 For non-player objects this field is not changed by server ticks.
+=item I<glow_radius> <number>
+This field indicates how far an object glows. Default is a radius of 0 (no
+glowing at all). Negative glow radii darken areas - currently, negative
+glow radii are stronger than positive ones.
 =item I<speed> <number>
 If this field is greater than MIN_ACTIVE_SPEED (~0.0001) the object is placed
 on the active object list and will be processed each tick (see also speed_left!).
 See Flags section below.
 =item I<activate_on_release> (0|1) (default: 1)
 Sets the flag FLAG_ACTIVATE_ON_RELEASE.
+See Flags section below.
+=item I<is_lightable> (0|1)
+Sets the flag FLAG_IS_LIGHTABLE.
 See Flags section below.
 =item I<editable> (more than deprecated)
 This field had a special meaning for crossedit, which used parts
 If FLAG_APPLIED is not set the object is destroyed.
 =item FLAG_CHANGING
 If the I<state> field of the object is 0 the object will be processed periodically
-(if speed is set). If the I<state> field is 1 it won't be processed.
+(if I<speed> is set). If the I<state> field is 1 it won't be processed.
+This flag indicates that the object is changing into a different object.
+The object has to have the I<other_arch> field set. The object the changing object
+changes into is derived from the archetype in I<other_arch>.
+When the object does not have FLAG_ALIVE set the I<food> field will be decremented
+each time the object is processed, and if I<food> reaches 0 one new object will be generated.
+When the object has FLAG_ALIVE set the I<food> field is the number of objects that
+will be generated.
+After the new object is created the I<hp> field from the old object is copied into
+the new one.
+When the old object was a B<LAMP> it's I<food> fields value less 1 will be copied
+to the new object.
 =item FLAG_IS_A_TEMPLATE (internal use)
 This flag is set on the inventory of generators like B<CREATOR>s and B<CONVERTER>s,
 or other objects that have the flags FLAG_GENERATOR and FLAG_CONTENT_ON_GEN set.
 This flag is by default on.
 =item FLAG_NO_STEAL
 When this flag is set this object can't be stolen. The flag will be
-resetted once the object is placed on a map.
+reset once the object is placed on a map.
-When this flag is set on a monster it can defent attempts of stealing
+When this flag is set on a monster it can defend attempts at stealing
 (but in this context the flag is only used internally).
 =item FLAG_NO_SKILL_IDENT
 This flag is mostly used internal and prevents unidentified objects
 =item FLAG_REFL_SPELL
 This flag indicates whether something reflects spells, like spell reflecting
 amuletts.
+=item FLAG_IS_LIGHTABLE
+This flag indicates whether a B<LIGHTER> can light this object. See also the
+description of the B<LIGHTER> type. How easy you can light an item depends
+partially on the material of the object.
 =back
 =head2 Description of type specific fields and behaviour
 The beginning of the headers of the following subsection
 =head3 B<TRANSPORT> - type 2 - Player transports
 This type is implemented by the transport extension and has currently no special
 fields that affect it.
-=head3 B<ROD> - type 3 - Rods that fire spells
+=head3 B<ROD>, B<HORN> - type 3, 35 - Rods that fire spells
 Rods contain spells and can be fired by a player.
 =over 4
 the 'use magic item' skill level of the player and 1/10 of the level of the
 rod is added as bonus.
 =item I<hp> <number>
-The amount of spellpoints this rod has left.
+The amount of spellpoints this rod has left. Recharges at a rate of C<1 +
+maxhp/10> per tick.
 =item I<maxhp> <number>
 The maximum amount of spellpoints this rod has.
 =over 4
 =item I<level> <number>
-This field affects the propability of poisoning. The higher the level difference
+This field affects the probability of poisoning. The higher the level difference
-between the one who is hit and the poision the more propable it is the attacked
+between the one who is hit and the poision the more probable it is the attacked
 one will be poisoned.
 =item I<slaying> <race>
 This field has the usual meaning of 'slaying', when the
 the arrows I<dam> field, the bows I<dam> field, the bows I<magic> field
 and the arrows I<magic> field.
 =item I<wc> <number>
-The weapon class of the arrow, which has effect on the propability of hitting.
+The weapon class of the arrow, which has effect on the probability of hitting.
 It is recomputed when the arrow is being fired by this formula:
   wc = 20 - bow->magic - arrow->magic - (skill->level or shooter->level)
           - dex_bonus - thaco_bonus - arrow->stats.wc - bow->stats.wc + wc_mod
 Bitfield which decides the attacktype of the damage, see include/attackinc.h
 On fireing the I<attacktype> of the bow is added to the arrows I<attacktype>.
 =item I<level> <number> (interally used)
-The level of the arrow, this affects the propability of piercing FLAG_REFL_MISSILE,
+The level of the arrow, this affects the probability of piercing FLAG_REFL_MISSILE,
 see above in the B<ARROW> description.
 The I<level> is set when the arrow is fired to either the skill level or the
 shooters level.
 Generally this field on weapons is in ranges of 1-30 and decides the slowdown of the
 I<sp> regeneration.
 =item I<body_BODYSLOT>
-The part of the body you need to use this weapon, possible values should be
+The part/slot of the body you need to use this weapon, possible values for
-looked up in common/item.C at body_locations.
+C<BODYSLOT> should be looked up in common/item.C at body_locations.
+The value (in the range C<-7..7>) gives the number of those body slots
+used up by the item (if negative) or the number of body slots this object
+has (if positive, e.g. for monsters or players). The special value C<0>
+indicates that this object cannot equip items requiring these body slots.
-=item I<resist_RESISTNACY> <number>
+=item I<resist_RESISTANCY> <number>
 this is the factor with which the difference of the players resistancy and 100%
 is multiplied, something like this:
-   additional_resistancy = (100 - current_resistanct) * (<number>/100)
+   additional_resistancy = (100 - current_resistancy) * (<number>/100)
 if <number> is negative it is added to the total vulnerabilities,
 and later the total resistance is decided by:
   'total resistance = total protections - total vulnerabilities'
-see also common/living.C:fix_player
+see also common/living.C:fix_player.
 =item I<path_(attuned|repelled|denied)>
 this field modifies the pathes the player is attuned to, see include/spells.h PATH_*
 for the pathes.
 See also the description of the I<connected> field in the generic object field
 section.
 =back
+=head3 B<MOOD_FLOOR> - type 65 - change mood of monsters
+speed == 0 for triggered mood changes, speed != 0 for non-triggered mood
+changes.
+ (based on value that last_sp takes):
+ 0:  'furious'      Makes all monsters aggressive
+ 1:  'angry'        As above but pets are unaffected
+ 2:  'calm'         Makes all monsters unaggressive
+ 3:  'sleep'        Puts all monsters to sleep
+ 4:  'charm'        Makes monster into a pet of person
+                    who triggers the square. This setting
+                    is not enabled for continous operation
+ 5:  'destroy mons' destroy any monsters on this space
+ 6:  'destroy pets' destroy friendly monsters on this space
 =head3 B<FLESH> - type 72 - Organs and body parts
 See B<FOOD> description.
 =head3 B<MISC_OBJECT> - type 79 - Misc. objects
 A type for any object that has no special behaviour.
 =head3 B<LAMP> - type 82 - A lamp
-This object makes light.
+This object represents a lamp, that can be carried and switched
+on and off and has a certain amount of fuel in it.
+A lamp consists of two archetypes: the 'on' archetype and the 'off' archetype.
+Each of them should point at the other one with it's I<other_arch> field.
+See the I<other_arch> field for the behaviour of a lamp object when it is applied.
+If this object has FLAG_IS_LIGHTABLE set the lamp can be turned on and off
+with a B<LIGHTER>, see also the description of FLAG_IS_LIGHTABLE.
+=over 4
+=item I<glow_radius> <number>
+The radius of the light that the lamp emits, see also I<glow_radius> in the
+generic object flags description.
+=item I<speed> <number>
+If FLAG_CHANGING is set the I<speed> field will indicate how fast the
+lamp burns it's fuel (I<food>).
+Setting FLAG_CHANGING makes only sense on the archetype which represents
+the 'on' state of the lamp.
+See also the description of FLAG_CHANGING.
+Lamps which have no FLAG_CHANGING set would also make sense and represent
+lamps that never burn up.
+=item I<other_arch> <number>
+This is the field that points to the 'other' archetype which represents the
+opposite state of the lamp. The newly from I<other_arch> derived object will
+replace the current object and will get the value of I<food> of the replaced object.
+Rationale:
+When the lamp (on) is applied a new object is derived from the archetype
+in I<other_arch> and the I<food> value is copied to it ('the fuel is
+transferred'). The new lamp (off) object has to have a I<other_arch> field
+which points to the archetype from which a lamp (on) can be derived.
+=item I<food> <number>
+This fields stands for the fuel of the lamp.
+=back
 =head3 B<DUPLICATOR> - type 83 - Duplicators or: Multiplicators
 This type of objects multiplies objects that are above it when it is activated.
 You can even multiply by 0, which will destroy the object.

Diff Legend

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

Comparing deliantra/server/pod/objects.pod (file contents): Revision 1.16 by elmex, Wed Dec 20 21:30:42 2006 UTC vs. Revision 1.29 by root, Thu Dec 4 03:48:19 2008 UTC

Diff Legend

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.16 by elmex, Wed Dec 20 21:30:42 2006 UTC vs.
Revision 1.29 by root, Thu Dec 4 03:48:19 2008 UTC