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

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.17 by elmex, Wed Dec 20 22:54:59 2006 UTC vs.
Revision 1.41 by root, Sat May 7 17:12:28 2011 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
 This document does explain the behaviour of the objects and the meaning of
 their fields in the server engine, which are derived from archetypes.
 This is an example of an archetype:
-   Object button_trigger
+   object button_trigger
    name button
    type 30
-   face button_sma.111
+   face button_sma.x11
    anim
-   button_sma.111
+   button_sma.x11
-   button_sma.112
+   button_sma.x12
    mina
    is_animated 0
    exp 30
    no_pick 1
-   walk_on 1
-   walk_off 1
    editable 48
    visibility 50
    weight 1
    end
 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>
+=item I<speed> <float>
 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!).
 If I<speed> drops below the MIN_ACTIVE_SPEED the object is removed
 from the active object list and it won't experience any processing per tick.
+Negative speed settings in archetypes and files cause a speed_left
+randomisation on load or instantiatian, but for calculations, the absolute
+value is used always.
-=item I<speed_left> <number>
+=item I<speed_left> <float>
 If this field is greater than 0 and the object is on the
 active list (mostly means it's speed is also greater than 0):
    - speed_left is decreased by 1
 This means: the lower I<speed> is (but still above MIN_ACTIVE_SPEED)
 the more seldom the object is processed. And the higher I<speed> is
 the more often the object is processed.
-=item I<connected> <number>
+=item I<connected> <identifier>
 When this field is set the object will be linked to a connection with the
-id <number>. What happens when the connection is 'activated' depends on the
+same <identifier>. What happens when the connection is 'activated' depends on the
 type of the object.
 FLAG_ACTIVATE_ON_PUSH and FLAG_ACTIVATE_ON_RELEASE they will control
 when to activate the object, see description of these below for further details.
 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
 of the server code for editing. Wherever you see this field being
 set in an archetype ignore it and/or remove it. No code interprets this
 field anymore.
+=item I<last_heal>, I<last_sp>
+For monsters and other living stuff that heals or regenarates hp or sp,
+these contain the fractional part of any healing that couldn't be applied
+to hp and sp yet.
 =back
 =head3 Flags
 Here are the effects of the flags described.
 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.
+=item FLAG_MONSTER
+Enables NPC behaviour in general (both monster AI and friendly AI). Numerous fields
+change their meaning, including:
+=over 4
+=item I<wis>
+Governs the "wake-up radius" - the radius within a monster detects an enemy.
+Also, I<wis> governs pathfinding intelligence: 8 and up means the monster
+will partake in basic smell finding. 10 and up additionally spreads smell
+knowledge, and 15 and up additionally will try to perturb the path as to
+find shortcuts.
+=back
 =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.
 This field has some special meaning in potions, currently the
 bits for AT_DEPLETE and AT_GODPOWER control whethere this is a
 restoration potion or improvement potion.
 See include/attackinc.h for the bits of these types.
-If AT_DEPLETE is set the player will be restored and the ARCH_DEPLETION
+If AT_DEPLETE is set the player will be restored and the "depletion"
 will be removed from him. If the potion has FLAG_CURSED or FLAG_DAMNED
-set the player will be drained a random stat by inserting an ARCH_DEPLETION
+set the player will be drained a random stat by inserting an "depletion"
 into him.
 If AT_GODPOWER is enabled the player will gain +1 maxvalue in his hp, sp or grace stat.
 When the potion has FLAG_CURSED or FLAG_DAMNED set he will loose one in one of these stats.
 =back
 =back
-=head3 B<FOOD> - type 6 - Eatable stuff
+=head3 B<FOOD> - type 6 - Edible stuff
 This is for objects that are representing general eatables like
 beef or bread.
 The main difference between B<FOOD>, B<FLESH> and B<DRINK> is that they
 =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
 =head3 B<CLOCK> - type 9 - Clocks
 This type of objects just display the time when being applied.
+=head3 B<VEIN> - type 10 - item veins for mining
+Provides a place to apply to mining skill to.
+=item I<other_arch> <archname>
+The architecture to create on a successful mine.
+=item I<food> <number>
+The number of items to produce from this vein.
+=item I<ac> <percentage>
+The base chance of getting an item.
+=item I<race> <identifier>
+Race of required extraction tools.
+=back
 =head3 B<LIGHTNING> - type 12 - Lightnings (DEPRECATED: see B<SPELL_EFFECT> subtype SP_BOLT)
 This is a spell effect of a moving bolt. It moves straigt forward
 through the map until something blocks it.
 If FLAG_REFLECTING is set it even reflects on walls.
 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.
 The minimum I<speed> of an arrow is 1.0.
 While flying the arrows I<speed> is decreased by 0.05 each time it's moved.
 If the I<speed> is above 10.0 it goes straight through the creature it hits and
-it's I<speed> is reduced by 1. If the I<speed> is lower or equal 10.0 the arrow is
+its I<speed> is reduced by 1. If the I<speed> is lower or equal 10.0 the arrow is
-stopped and either sticked into the victim (see I<weight> field description) or
+stopped and either stuck into the victim (see I<weight> field description) or
-put on it's map square (if it didn't break, see description of the I<food> field).
+put on its map square (if it didn't break, see description of the I<food> field).
 =item I<weight> <number>
 This field is the weight of the arrow, if I<weight> is below or equal 5000 (5 kg)
 the arrow will stick in the victim it hits. Otherwise it will fall to the ground.
 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.
 =item I<hp> <number>
 If FLAG_LIVE_SAVE is not set it is the absolute number of times the creator can
 be used.
-=item I<speed> <number>
+=item I<speed> <float>
 If I<speed> is set the creator will create an object periodically,
 see I<speed> and I<speed_left> fields in the general object field description
 for more details.
 =item I<other_arch> <string>
 If the inventory of the creator is empty new objects will be derived from the
 archetype named by <string>.
-=item I<connected> <number>
+=item I<connected> <identifier>
 See generic object field description.
+=back
+=head3 B<SKILL> - type 43 - Skills
+This type is basically for representing skills in the game.
+=over 4
+=item I<subtype> <skill number>
+=item I<skill> <string>
+The skill identifier used by other items, usually the skill name
+=item I<level> <percentage>
+not used?
+=item I<exp> <number>
+Base amount of experience in a skill, for skills not starting at zero.
+=item I<expmul> <float>
+Experience is multiplied by this factor.
+=item I<cached_sp> <integer>
+Used internally by the server (cannot be used in files).
 =back
 =head3 B<DRINK> - type 54 - Drinkable stuff
 =item I<race> <string>
 If this field is set the inventory checker will search for an object which
 has the archetype name that matches <string>.
-=item I<connected> <connection id>
+=item I<connected> <identifier>
 This is the connection that will be activated. The connection is
 'pushed' when someone enters the space with the inventory checker,
 and it is 'released' when he leaves it.
-See also the description of the I<connected> field in the generic object field
+See also the description of the I<connected> field in the generic object
-section.
+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 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.
-=over 4
-=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.
 =item I<other_arch> <string>
 The archetype name of the objects that should be multiplied.
-=item I<connected> <number>
+=item I<connected> <identifier>
 See generic object field description.
 =back
 when the connection is activated. This field only has effect when the
 connection is triggered. So if you put a closed hole on a map, and the
 connection is deactivated, and I<maxsp> is 1 the hole will remain closed until the
 connection was triggered once.
-=item I<connected> <connection id>
+=item I<connected> <identifier>
 This is the connection id, which lets the hole opening or closing when
 activated. The flags FLAG_ACTIVATE_ON_PUSH and FLAG_ACTIVATE_ON_RELEASE control
 at which connection state the object is activated.

Diff Legend

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

Comparing deliantra/server/pod/objects.pod (file contents): Revision 1.17 by elmex, Wed Dec 20 22:54:59 2006 UTC vs. Revision 1.41 by root, Sat May 7 17:12:28 2011 UTC

Diff Legend

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.17 by elmex, Wed Dec 20 22:54:59 2006 UTC vs.
Revision 1.41 by root, Sat May 7 17:12:28 2011 UTC