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

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.1 by elmex, Mon Dec 18 10:57:09 2006 UTC vs.
Revision 1.2 by elmex, Mon Dec 18 12:01:20 2006 UTC

 or shouldn't be set by an archetype. If the internal names differs the
 external name (for the archetypes) for the attribute is written behind it.
 =head2 Description of generic archetype and object attributes
+These are the fields that most of the objects have and/or their
+default behaviour.
 =over 4
+=item name <string>
+The name of the object.
+=item name_pl <string>
+The name of a collection of these objects (the plural of the name).
+=item face <facename>
+The graphical appearance of this object.
+=item invisible <number>
+If the <number> is greater than 0 the object is invisible.
+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 speed <numeric>
+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 the speed field drops below the MIN_ACTIVE_SPEED the object is removed
+from the active object list and it won't experience any processing per tick.
+=item speed_left <number>
+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
+   - and this object is processed and experiences a server tick.
+If the object is on the active list and speed_left is lower or
+equal to 0 the absolute value of the speed field is added to speed_left
+on the end of the tick.
+=item no_drop (0|1)
+Sets the flag FLAG_NO_DROP. See the Flags section below.
+=item applied (0|1)
+Sets the flag FLAG_APPLIED. See the Flags section below.
+=item is_used_up (0|1)
+Sets the flag FLAG_IS_USED_UP. See Flags section below.
+=item 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 attribute being
+set in an archetype ignore it and/or remove it. No code interprets this
+field anymore.
+=back
+=head3 Flags
+Here are the effects of the flags described.
+=over 4
+=item FLAG_NO_DROP
+An object can't be picked up and dropped.
+=item FLAG_APPLIED
+This flag mostly states whether this object has been 'applied' by the player.
+For objects that are applied by the code or have this flag set in the archetype
+it mostly means 'this object is active'.
+For example the player adjustments of the hp/sp/grace fields and inheritance
+of flags from objects in his inventory is toggled by this flag.
+=item FLAG_IS_USED_UP
+This flag controls whether an object is 'used up'. If it is set the 'food' field
+of the object is decreased by 1 each tick, and if it is lower or equal 0 after tha
+it is removed.
+If also the flag FLAG_APPLIED is set, the 'duration' field controls whether
+this object is removed or not, see the Force type below for the meaning
+of the duration field in this context.
 =back
 =head2 Description of type specific attributes
 =item attacktype <bitmask>
 bitfield which decides the attacktype of the damage, see include/attackinc.h
-=item dam <integer>
+=item dam <number>
 amount of damage being done with the attacktype
 =item item_power <level>
 =item last_sp
 the weapon speed (see magic description)
-=item food <integer>
+=item food <number>
 addition to food regeneration of the player
-=item hp <integer>
+=item hp <number>
 addition to health regeneration
-=item sp <integer>
+=item sp <number>
 addition to mana regeneration
-=item grace <integer>
+=item grace <number>
 addititon to grace regeneration
-=item gen_sp_armour <integer>
+=item gen_sp_armour <number>
-the players gen_sp_armour field (which is per default 10) is added the <integer> amount.
+the players gen_sp_armour field (which is per default 10) is added the <number> amount.
 gen_sp_armour seems to be a factor with which gen_sp in do_some_living()
-is multiplied:  gen_sp *= 10/<integer>
+is multiplied:  gen_sp *= 10/<number>
 meaning: values > 10 of gen_sp_armour limits the amout of regenerated
 spellpoints.
 generally this field on weapons is in ranges of 1-30 and decides the slowdown of the
 sp regeneration.
 =item body_<body slot/part>
 the part of the body you need to use this weapon, possible values should be
 looked up in common/item.C at body_locations.
-=item resist_<resistnacy> <integer>
+=item resist_<resistnacy> <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) * (<integer>/100)
+   additional_resistancy = (100 - current_resistanct) * (<number>/100)
-if <integer> is negative it is added to the total vulnerabilities,
+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
 =item patch_(attuned|repelled|denied)
 this field modifies the pathes the player is attuned to, see include/spells.h PATH_*
 for the pathes.
-=item luck <integer>
+=item luck <number>
 this luck is added to the players luck
 =item move_type
 if the weapon has a move_type set the player inherits it's move_type
-=item exp <integer>
+=item exp <number>
-the added_speed and bonus_speed of the player is raised by <integer>/3.
+the added_speed and bonus_speed of the player is raised by <number>/3.
-if <integer> < 0 then the added_speed is decreased by <integer>
+if <number> < 0 then the added_speed is decreased by <number>
 =item weight
 the weight of the weapon
   - dam: the players dam is adjusted by: player->dam += (dam + magic)
   - weapon speed (last_sp): weapon_speed is calculated by: (last_sp * 2 - magic) / 2
                             (minium is 0)
-=item ac <integer>
+=item ac <number>
 the amount of ac points the player's ac is decreased
-=item wc <integer>
+=item wc <number>
 the amount of wc points the player's ac is decreased
 =back
 =head4 Player inherits following flags from weapons:
    FLAG_LIFESAVE, FLAG_REFL_SPELL, FLAG_REFL_MISSILE, FLAG_STEALTH,
    FLAG_XRAYS, FLAG_BLIND, FLAG_SEE_IN_DARK, FLAG_UNDEAD
+=head3 FORCE - type 114 - Forces
+Note: Forces only take effect on the player if they have set FLAG_APPLIED.
+Whether the duration field is processed or not a tick is controlled via the
+speed and speed_left field. Look above at the generic description of these
+fields.
+=over 4
+=item duration
+While this field is greater than 0 the force is not removed.
+It is decreased each tick by 1.
+=back

Diff Legend

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

Comparing deliantra/server/pod/objects.pod (file contents): Revision 1.1 by elmex, Mon Dec 18 10:57:09 2006 UTC vs. Revision 1.2 by elmex, Mon Dec 18 12:01:20 2006 UTC

Diff Legend

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.1 by elmex, Mon Dec 18 10:57:09 2006 UTC vs.
Revision 1.2 by elmex, Mon Dec 18 12:01:20 2006 UTC