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

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.9 by elmex, Tue Dec 19 23:41:56 2006 UTC vs.
Revision 1.17 by elmex, Wed Dec 20 22:54:59 2006 UTC

 This documentation is in a sketchy state. It's mostly
 used to collect notes about the internal behaviour of the
 objects.
+=head2 About the notation and terms
+The term 'archetype' stands for a collection of fields.
+The term 'object' stands for an archetype instance.
+The term 'field' is used for an object fields and archetype fields.
+Field names will be displayed like this: I<fieldname>
+Type names will be displayed like this: B<TYPENAME>
+Flag names will be displayer like this: FLAG_NAME
 =head2 About archetypes and objects
-Field denotes an attribute of an archetype.
+Archetypes are 'templates' of objects. If an object is derived
+from an archetype the object fields will be set to the corresponding
+fields in the archetype.
+When a map is instanciated (loaded), the 'object' description on the
+map are considered patches of the archetype.
+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
    name button
    type 30
    editable 48
    visibility 50
    weight 1
    end
-This archetype has the name 'button_trigger' and the objects that
+The first B<field> is I<name>: 'button_trigger', which basically means that
-inherit from this archetype have the name 'button'.
+instances (objects) that are created/derived from this archetype have the
+name 'button' (which means that the field I<name> of the object will be set
+to the same value as the archetypes field I<name>).
-The next field 'type' decides the main behaviour of this archetype.
+The next field I<type> decides the behaviour of objects derived from this archetype.
 For a comprehensive list of types see include/define.h. For this case
 you might find a line like:
    #define TRIGGER_BUTTON           30
-The server internally works with objects that 'inherit' attributes from
+The behaviour of objects is further determined by B<Flags>, like FLAG_APPLIED.
-an archetype. They have a similar set of attributes.
+For more information on this look in the Flags subsection in the next section
-The following documentation will also document the meaning of code internal
+The following documentation will also document the meaning of internal used
-attributes of objects. These attributes are marked as '(internal)' and can't
+fields of objects. These fields are marked as (internal) and can't
-or shouldn't be set by an archetype. If the internal names differs the
+or shouldn't be set by an archetype.
-external name (for the archetypes) for the attribute is written behind it.
-=head2 Description of generic archetype and object attributes
+=head2 Description of (mostly) generic object fields
 These are the fields that most of the objects have and/or their
 default behaviour.
 =over 4
-=item name <string>
+=item I<name> <string>
 The name of the object.
-=item name_pl <string>
+=item I<name_pl> <string>
 The name of a collection of these objects (the plural of the name).
-=item face <facename>
+=item I<face> <facename>
 The graphical appearance of this object.
+=item I<x> <number>
+The x position of the object when it is on a map.
+=item I<y> <number>
+The y position of the object when it is on a map.
+=item I<map> (internal)
+The map the object is on.
-=item invisible <number>
+=item I<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 <number>
+=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!).
-If the speed field drops below the MIN_ACTIVE_SPEED the object is removed
+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.
-=item speed_left <number>
+=item I<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
+If the object is on the active list and I<speed_left> is lower or
-equal to 0 the absolute value of the speed field is added to speed_left
+equal to 0 the absolute value of the I<speed> is added to I<speed_left>
 on the end of the tick.
-This means: the lower the speed field is (but still above MIN_ACTIVE_SPEED)
+This means: the lower I<speed> is (but still above MIN_ACTIVE_SPEED)
-the more seldom the object is processed. And the higher the speed field is
+the more seldom the object is processed. And the higher I<speed> is
 the more often the object is processed.
+=item I<connected> <number>
+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
+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.
-=item no_drop (0|1)
+=item I<no_drop> (0|1)
 Sets the flag FLAG_NO_DROP.
 See Flags section below.
-=item applied (0|1)
+=item I<applied> (0|1)
 Sets the flag FLAG_APPLIED.
 See Flags section below.
-=item is_used_up (0|1)
+=item I<is_used_up> (0|1)
 Sets the flag FLAG_IS_USED_UP.
 See Flags section below.
+=item I<changing> (0|1)
+Sets the flag FLAG_CHANGING.
+See Flags section below.
-=item auto_apply (0|1)
+=item I<auto_apply> (0|1)
 Sets the flag FLAG_AUTO_APPLY.
 See Flags section below.
-=item no_steal (0|1)
+=item I<no_steal> (0|1)
 Sets the flag FLAG_NO_STEAL.
 See Flags section below.
+=item I<reflecting> (0|1)
+Sets the flag FLAG_REFLECTING.
+See Flags section below.
+=item I<reflect_spell> (0|1)
+Sets the flag FLAG_REFL_SPELL.
+See Flags section below.
-=item no_skill_ident (0|1)
+=item I<no_skill_ident> (0|1)
 Sets the flag FLAG_NO_SKILL_IDENT.
 See Flags section below.
-=item activate_on_push (0|1) (default: 1)
+=item I<activate_on_push> (0|1) (default: 1)
 Sets the flag FLAG_ACTIVATE_ON_PUSH.
 See Flags section below.
-=item activate_on_release (0|1) (default: 1)
+=item I<activate_on_release> (0|1) (default: 1)
 Sets the flag FLAG_ACTIVATE_ON_RELEASE.
 See Flags section below.
-=item editable (more than deprecated)
+=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 attribute being
+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.
 =back
 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
+For example the player adjustments of the I<hp>/I<sp>/I<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
+This flag controls whether an object is 'used up'. If it is set I<food>
-of the object is decreased by 1 each tick, and if it is lower or equal 0 after tha
+is decreased by 1 each tick, and will be removed when I<food> is lower or equal 0.
-it is removed.
-If also the flag FLAG_APPLIED is set, the 'duration' field controls whether
+If also the flag FLAG_APPLIED is set, the I<duration> field controls whether
-this object is removed or not, see the Force type below for the meaning
+this object is removed or not, see the B<FORCE> type below for the meaning
 of the duration field in this context.
 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 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 CREATORs and CONVERTERs,
+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.
 =item FLAG_AUTO_APPLY
-This flag has currently only meaning for the TREASURE type, see below.
+This flag has currently only meaning for the B<TREASURE> type, see below.
 =item FLAG_ACTIVATE_ON_PUSH
 This flag has only meaning for objects that can be linked together
-with the 'connected' field and controls wether the object should
+by the I<connected> field and controls wether the object should
 be activated when the connection is 'pushed' or it is 'released'.
+What 'pushed' and 'released' means depends on the object that
+activates the connection.
 This flag is by default on.
 =item FLAG_ACTIVATE_ON_RELEASE
 This flag has only meaning for objects that can be linked together
-with the 'connected' field and controls wether the object should
+by the I<connected> field and controls wether the object should
 be activated when the connection is 'pushed' or it is 'released'.
+What 'pushed' and 'released' means depends on the object that
+activates the connection.
 This flag is by default on.
 =item FLAG_NO_STEAL
 (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
-(objects which don't have FLAG_IDENTIFIED set) being identified by
+(objects which don't have FLAG_IDENTIFIED set) being identified
-skills.
+multiple times by skills.
-This flag is used to mark objects to never being identified by a skill
+This flag is used to mark objects which were unsuccessfully identified by a
-once a player failed to identify an object. So that multiple tries
+players skill. So that multiple tries of identifying aren't more effective than
-of identifying aren't more effective than one.
+one.
-=back
+=item FLAG_REFLECTING
-=head2 Description of type specific attributes
+This flag is used by spell effects (eg. SP_BOLT), B<THROWN_OBJ> and B<ARROW>
+to indicate whether this object reflects off walls.
+=item FLAG_REFL_SPELL
+This flag indicates whether something reflects spells, like spell reflecting
+amuletts.
+=back
+=head2 Description of type specific fields and behaviour
 The beginning of the headers of the following subsection
 are the server internal names for the objects types, see include/define.h.
-=head3 TRANSPORT - type 2 - Player transports
+=head3 B<TRANSPORT> - type 2 - Player transports
 This type is implemented by the transport extension and has currently no special
-attributes that affect it.
+fields that affect it.
-=head3 ROD - type 3 - Rods that fire spells
+=head3 B<ROD> - type 3 - Rods that fire spells
 Rods contain spells and can be fired by a player.
 =over 4
-=item level <number>
+=item I<level> <number>
-This attribute is used for calculating the spell level that can be fired
+This field is used for calculating the spell level that can be fired
 with this rod, it's also the maximum level of the spell that can be fired.
 The level of the spell that is being fired depends mostly on
 the 'use magic item' skill level of the player and 1/10 of the level of the
 rod is added as bonus.
-=item hp <number>
+=item I<hp> <number>
 The amount of spellpoints this rod has left.
-=item maxhp <number>
+=item I<maxhp> <number>
 The maximum amount of spellpoints this rod has.
-=item skill <skill name>
+=item I<skill> <skill name>
 This field determines which skill you need to apply this object.
 =back
-=head3 TREASURE - type 4 - Treasures
+=head3 B<TREASURE> - type 4 - Treasures
 This type of objects are for random treasure generation in maps.
 If this object is applied by a player it will replace itself with it's
 inventory. If it is automatically applied
 generate a treasure and replace itself with the generated treasure.
 Chests are also of this type, their treasures are generated by
 the auto apply code on map instantiation.
 =over 4
-=item hp <number>
+=item I<hp> <number>
 The number of treasures to generate.
-=item exp <level>
+=item I<exp> <level>
 If FLAG_AUTO_APPLY is not set the exp field has no further meaning
 and the difficulty for the treasurecode only depends on the maps difficulty,
 otherwise the exp field has the following meaning:
 worth a treasure is or what bonuses it is given by the treasure code.
 If this field is not set or 0 the difficulty of the map is passed to the treasure
 generation code.
-=item randomitems <treasurelist>
+=item I<randomitems> <treasurelist>
 The treasurelist to use to generate the treasure which is put in the
 treasure objects inventory.
 =back
-=head3 POTION - type 5 - Potions for drinking and other nastynesses
+=head3 B<POTION> - type 5 - Potions for drinking and other nastynesses
 These objects contain a spell and will emit it on apply, which most
 of the time has the meaning of 'drinking'.
 If no resistancy field, stat field or attacktype is set and no spell
 If the potion has FLAG_CURSED or FLAG_DAMNED set the usage of this potion
 will yield an explosion and hurt the player.
 =over 4
-=item Str, Dex, Con, Int, Wis, Cha, Pow <number>
+=item I<Str>, I<Dex>, I<Con>, I<Int>, I<Wis>, I<Cha>, I<Pow> <number>
 These stat fields determine how many stat points the player gets
 when he applies this potion.
 If FLAG_CURSED or FLAG_DAMNED is set the player will loose that many stat points.
-=item sp <number>
+=item I<sp> <number>
 If this field is set and the randomitems field is not set
 the field is interpreted as spell number, please look the right
 number up in common/loader.C.
 If this field is set the randomitems field will be unset by the
 map loading code.
-=item attacktype <attacktype>
+=item I<attacktype> <attacktype>
 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.
 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.
-=item resist_<resistancy> <number>
+=item I<resist_RESISTANCY> <number>
 If this stat is set and no spell is in the potion the potion
 will create a force that give the player this specific resistancy.
 The forces type will be changed to POTION_EFFECT (see POTION_EFFECT type below)
 and the potion will last 10 times longer than the default force archetype
 FORCE_NAME (at the moment of this writing spell/force.arc).
-=item randomitems <treasurelist>
+=item I<randomitems> <treasurelist>
 The inventory/spell of the potion will be created by calling the treasure code
 with the treasurelist specified here. (I guess it's highly undefined what
 happens if there is not a spell in the potions inventory).
-=item on_use_yield <archetype>
+=item I<on_use_yield> <archetype>
 When this object is applied an instance of <archetype> will be created.
-=item subtypes <potion subtype>
+=item I<subtypes> <potion subtype>
 see include/spells.h for possible potion subtypes, there are currently 4:
 =over 4
 Unused, default behaiour of a potion.
 =item POT_DUST
 This potion can be thrown to cast the spell that it has in it's inventory,
-the behaviour is not defined if there is not a spell in the inventory and the
+the behaviour is not defined if there is not a B<SPELL> in the inventory and the
 server will log an error.
 =item POT_FIGURINE
 Unused, default behaiour of a potion.
 =back
 =back
-=head3 FOOD - type 6 - Eatable stuff
+=head3 B<FOOD> - type 6 - Eatable stuff
 This is for objects that are representing general eatables like
 beef or bread.
-The main difference between FOOD, FLESH and DRINK is that they
+The main difference between B<FOOD>, B<FLESH> and B<DRINK> is that they
 give different messages.
-The specialty of FLESH is that it inherits the resistancies of the
+The specialty of B<FLESH> is that it inherits the resistancies of the
 monsters it was generated in and will let dragons raise their resistancies
-with that. If the monster has the POISON attacktype the FLESH
+with that. If the monster has the B<POISON> attacktype the B<FLESH>
-will change into POISON.
+will change into B<POISON>.
-If a player runs low on food he will grab for FOOD, DRINK and POISON
+If a player runs low on food he will grab for B<FOOD>, B<DRINK> and B<POISON>
-and if he doesn't find any of that he will start eating FLESH.
+and if he doesn't find any of that he will start eating B<FLESH>.
 =over 4
-=item title <string>
+=item I<title> <string>
-If the food has a title or is cursed it is considered 'special', which means that the
+If the food has B<title> set or is cursed it is considered 'special', which
-fields Str, Dex, Con, Int, Wis, Pow, resist_<resistancy>, hp and sp
+means that the fields I<Str>, I<Dex>, I<Con>, I<Int>, I<Wis>, I<Pow>,
-are interpreted and have further effects on the player.
+I<resist_RESISTANCY>, I<hp> and I<sp> are interpreted and have further effects
+on the player.
-The higher the food field is the longer the improvement of the player lasts
+The higher the I<food> field is the longer the improvement of the player lasts
-(except for hp and sp).
+(except for I<hp> and I<sp>).
-=item food <number>
+=item I<food> <number>
 This is the amount of food points the player gets when he eats this.
-=item on_use_yield <archetype>
+=item I<on_use_yield> <archetype>
 When this object is applied an instance of <archetype> will be created.
 =back
-=head3 POISON - type 7 - Poisonous stuff
+=head3 B<POISON> - type 7 - Poisonous stuff
-This type is for objects that can poison the player when drinking.
+This type is for objects that can poison the player when he drinks/applies it.
 When applied it will hit the attacked with AT_POISON and will create
-a POISONING object in the one who was hit.
+a B<POISONING> object in the one who was hit.
 =over 4
-=item level <number>
+=item I<level> <number>
 This field affects the propability of poisoning. The higher the level difference
-between the one who is hit and the poision the mose propable it is the attacked
+between the one who is hit and the poision the more propable it is the attacked
 one will be poisoned.
-=item slaying <race>
+=item I<slaying> <race>
-On poison this field has the usual meaning of 'slaying', when the
+This field has the usual meaning of 'slaying', when the
-ones race matches the slaying field the damage done by the poison
+poisoned's race matches the I<slaying> field the damage done by the poison
 is multiplied by 3.
-=item hp <number>
+=item I<hp> <number>
 This is the amount of damage the player will receive from applying this.  The
 attacktype AT_POISON will be used to hit the player and the damage will
 determine the strenght, duration and depletion of stats of the poisoning.  The
-created POISONING object which is being placed in the one who was attacked will
+created B<POISONING> object which is being placed in the one who was attacked will
 get the damage from this field (which is maybe adjusted by slaying or the
 resistancies).
-=item food <number>
+=item I<food> <number>
-1/4 of <number> will be drained from the players food.
+1/4 of <number> will be drained from the players I<food>.
-=item on_use_yield <archetype>
+=item I<on_use_yield> <archetype>
 When this object is applied an instance of <archetype> will be created.
 =back
-=head3 BOOK - type 8 - Readable books
+=head3 B<BOOK> - type 8 - Readable books
 This type is basically for representing text books in the game.
 Reading a book also identifys it (if FLAG_NO_SKILL_IDENT is not set).
 =over 4
-=item msg <text>
+=item I<msg> <text>
 This is the contents of the book. When this field is unset
 at treasure generation a random text will be inserted.
-=item skill <skill name>
+=item I<skill> <skill name>
 The skill required to read this book. (The most resonable
 skill would be literacy).
-=item exp <number>
+=item I<exp> <number>
 The experience points the player get for reading this book.
-=item subtype <readable subtype>
+=item I<subtype> <readable subtype>
 This field determines the type of the readable.
 Please see common/readable.C in the readable_message_types table.
 =back
+=head3 B<CLOCK> - type 9 - Clocks
+This type of objects just display the time when being applied.
+=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.
+FLAG_IS_TURNABLE should be set on these objects.
+=over 4
+=item I<move_type> <movetype>
+This field affects the move type with which the lightning moves through
+the map and which map cells will reflect or block it.
+=item I<attacktype> <attacktype>
+The attacktype with which it hits the objects on the map.
+=item I<dam> <number>
+The damage this bolt inflicts when it hits objects on the map.
+=item I<Dex> <number>
+This is the fork percentage, it is reduced by 10 per fork.
+And the I<dam> field is halved on each fork.
+=item I<Con> (internal)
+This value is a percentage of which the forking lightning
+is deflected to the left. This value should be mostly used internally.
+=item I<duration> <number>
+The duration the bolt stays on a map cell. This field is decreased each time
+the object is processed (see the meaning of I<speed> and I<speed_left> fields in
+the generic object field description).
+=item I<range> <number>
+This is the range of the bolt, each space it advances this field is decreased.
+=back
+=head3 B<ARROW> - type 13 - Arrows
+This is the type for objects that represent projectiles like arrows.
+The movement of B<THROWN_OBJ>s behave similar to this type.
+Flying arrows are stopped either when they hit something blocking
+(I<move_block>) or something which is alive.
+If it hits something that is alive, which doesn't have FLAG_REFL_MISSILE
+set, it will inflict damage. If FLAG_REFL_MISSILE is set it will inflict
+damage with a small chance which is affected by the I<level> field of the arrow.
+If FLAG_REFLECTING is set on the arrow it will bounce off everything
+that is not alive and blocks it's movement.
+When an arrow is being shot it's I<dam>, I<wc>, I<attacktype>, I<slaying>
+fields will be saved in the I<sp>, I<hp>, I<grace> and I<spellarg> fields of
+the object, to restore them once the arrow has been stopped.
+=over 4
+=item I<dam> <number>
+The amount of damage that is being done to the victim that gets hit.
+This field is recomputed when the arrow is fired and will consist
+of the sum of a damage bonus (see description of the B<BOW> type),
+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.
+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
+When the arrow is not being shot by an player dex_bonus and thaco_bonus and the
+level is not added.
+wc_mod is dependend on the fire mode of the bow.  For a more detailed
+explanation of dex_bonus, thaco_bonus and wc_mod please consult the code.
+=item I<magic> <number>
+This field is added to the damage of the arrow when it is shot and
+will also improve it's I<speed> by 1/5 of it's value.
+=item I<attacktype> <attacktype>
+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,
+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.
+=item I<speed> <number> (internal)
+This field shouldn't be set directly in the archetype, the arrow will get it's
+I<speed> from the bow.  This fields value has to be at least 0.5 or otherwise the
+arrow will be stopped immediatly.
+On fireing the I<speed> of the arrow is computed of 1/5 of the
+sum of the damage bonus (see BOW), bow I<magic> and arrow I<magic>. After that 1/7
+of the bows I<dam> field is added to the I<speed> of the arrow.
+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
+stopped and either sticked 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).
+=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.
+=item I<food> <number>
+The breaking percentage. 100 (%) means: breaks on usage for sure.
+=item I<inventory> (internal)
+If the flying/moving object has something in it's inventory and it stops, it
+will be replaced with it's inventory. Otherwise it will be handled as usual,
+which means: it will be calculated whether the arrow breaks and it will be
+reset for reuse.
+=item I<slaying> <string>
+When the bow that fires this arrow has it's I<slaying> field set it is copied
+to the arrows I<slaying> field. Otherwise the arrows I<slaying> field remains.
+=item I<move_type> <movetype> (internally used)
+This field is set when the arrow is shot to MOVE_FLY_LOW.
+=item I<move_on> <movetype> (internally used)
+This field is set when the arrow is shot to MOVE_FLY_LOW and MOVE_WALK.
+=item I<race> <string>
+The I<race> field is a unique key that assigns arrows, bows and quivers. When
+shooting an arrow the bows I<race> is used to search for arrows (which have the
+same I<race> as the bow) in the players inventory and will recursively search in
+the containers (which are applied and have the same I<race> as the bow and the arrow).
+=back
+=head3 B<BOW> - type 14 - Bows, those that fire B<ARROW>s
+TODO, but take into account B<ARROW> description above!
-=head3 WEAPON - type 15 - Weapons
+=head3 B<WEAPON> - type 15 - Weapons
 This type is for general hack and slash weapons like swords, maces
 and daggers and and ....
 =over 4
-=item weapontype <type id>
+=item I<weapontype> <type id>
 decides what attackmessages are generated, see include/define.h
-=item attacktype <bitmask>
+=item I<attacktype> <bitmask>
 bitfield which decides the attacktype of the damage, see include/attackinc.h
-=item dam <number>
+=item I<dam> <number>
 amount of damage being done with the attacktype
-=item item_power <level>
+=item I<item_power> <level>
 the itempower of this weapon.
-=item name
+=item I<name>
 the name of the weapon.
-=item level (internal)
+=item I<level> (internal)
 The improvement state of the weapon.
-If this field is greater than 0 the 'name' field starts with the
+If this field is greater than 0 the I<name> field starts with the
 characters name who improved this weapon.
-=item last_eat (internal)
+=item I<last_eat> (internal)
-seems to be the amount of improvements of a weapon,
+This seems to be the amount of improvements of a weapon,
 the formular for equipping a weapon seems to be (server/apply.C:check_weapon_power):
   ((who->level / 5) + 5) >= op->last_eat
-=item last_sp
+=item I<last_sp>
 the weapon speed (see magic description)
-=item food <number>
+=item I<food> <number>
 addition to food regeneration of the player
-=item hp <number>
+=item I<hp> <number>
 addition to health regeneration
-=item sp <number>
+=item I<sp> <number>
 addition to mana regeneration
-=item grace <number>
+=item I<grace> <number>
 addititon to grace regeneration
-=item gen_sp_armour <number>
+=item I<gen_sp_armour> <number>
-the players gen_sp_armour field (which is per default 10) is added the <number> amount.
+the players I<gen_sp_armour> field (which is per default 10) is being added the
-gen_sp_armour seems to be a factor with which gen_sp in do_some_living()
+<number> amount.  gen_sp_armour seems to be a factor with which gen_sp in
-is multiplied:  gen_sp *= 10/<number>
+do_some_living() is multiplied:  gen_sp *= 10/<number> meaning: values > 10 of
-meaning: values > 10 of gen_sp_armour limits the amout of regenerated
+I<gen_sp_armour> limits the amout of regenerated spellpoints.
-spellpoints.
-generally this field on weapons is in ranges of 1-30 and decides the slowdown of the
+Generally this field on weapons is in ranges of 1-30 and decides the slowdown of the
-sp regeneration.
+I<sp> regeneration.
-=item body_<body slot/part>
+=item I<body_BODYSLOT>
-the part of the body you need to use this weapon, possible values should be
+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> <number>
+=item I<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) * (<number>/100)
   'total resistance = total protections - total vulnerabilities'
 see also common/living.C:fix_player
-=item patch_(attuned|repelled|denied)
+=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 luck <number>
+=item I<luck> <number>
-this luck is added to the players luck
+this luck is added to the players I<luck>
-=item move_type
+=item I<move_type>
-if the weapon has a move_type set the player inherits it's move_type
+if the weapon has a I<move_type> set the player inherits it's I<move_type>
-=item exp <number>
+=item I<exp> <number>
 the added_speed and bonus_speed of the player is raised by <number>/3.
 if <number> < 0 then the added_speed is decreased by <number>
-=item weight
+=item I<weight>
 the weight of the weapon
-=item magic
+=item I<magic>
-the magic field affects the amounts of the following fields:
+the I<magic> field affects the amounts of the following fields:
   - wc : the players wc is adjusted by: player->wc -= (wc + magic)
   - ac : the players ac is lowered by (ac + magic) if (player->ac + magic) > 0
   - 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 <number>
+=item I<ac> <number>
-the amount of ac points the player's ac is decreased
+the amount of ac points the player's I<ac> is decreased when applying this object.
-=item wc <number>
+=item I<wc> <number>
-the amount of wc points the player's wc is decreased
+the amount of wc points the player's I<wc> is decreased when applying this object.
 =back
 =head4 Player inherits following flags from weapons:
    FLAG_XRAYS
    FLAG_BLIND
    FLAG_SEE_IN_DARK
    FLAG_UNDEAD
+=head3 B<GRIMREAPER> - type 28 - Grimreapers
+These type are mostly used for monsters, they give the
+monster the ability to dissapear after 10 hits with AT_DRAIN.
+=over 4
+=item I<value> <number>
+This field stores the hits the monster did yet.
+=back
+=head3 B<CREATOR> - type 42 - Object creators
+Once a creator is activated by a connection it creates a number of objects
+(cloned from it's inventory or a new object derived from the archetype
+named in the other_arch slot).
+If FLAG_LIVESAFE is set the number of uses is unlimited.
+=over 4
+=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>
+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<slaying> <string>
+If set the generated object's name and title will be set to this.
+=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>
+See generic object field description.
+=back
-=head3 DRINK - type 54 - Drinkable stuff
+=head3 B<DRINK> - type 54 - Drinkable stuff
-See FOOD description.
+See B<FOOD> description.
-=head3 CHECK_INV - type 64 - Inventory checkers
+=head3 B<CHECK_INV> - type 64 - Inventory checkers
 This object checks whether the player has a specific item in his
 inventory when he moves above the inventory checker. If the player has
 the item (or not, which can be controlled with a flag) a connection will be triggered.
-If you set move_block you can deny players and monsters to reach the space where
+If you set I<move_block> you can deny players and monsters to reach the space where
-the inventory checker is on, see 'move_block' description below.
+the inventory checker is on, see I<move_block> description below.
-The conditions specified by hp, slaying and race are concationated with OR.
+The conditions specified by I<hp>, I<slaying> and I<race> are OR concationated.
 So matching one of those conditions is enough.
 =over 4
-=item move_block <move type bitmask>
+=item I<move_block> <move type bitmask>
 If you set this field to block a movetype the move code will block any moves
 onto the space with the inventory checker, IF the moving object doesn't have
-(or has - if last_sp = 0) the item that the checker is searching for.
+(or has - if I<last_sp> = 0) the item that the checker is searching for.
-=item last_sp (0|1)
+=item I<last_sp> (0|1)
-If last_sp is 1 'having' the item that is being checked for will
+If I<last_sp> is 1 'having' the item that is being checked for will
 activate the connection or make the space with the checker non-blocking.
-If last_sp is 0 'not having' the item will activate the connection
+If I<last_sp> is 0 'not having' the item will activate the connection
 or make the space with the checker non-blocking.
-=item last_heal (0|1)
+=item I<last_heal> (0|1)
-If last_heal is 1 the matching item will be removed if the inventory checker
+If I<last_heal> is 1 the matching item will be removed if the inventory checker
 activates a connection and finds the item in the inventory.
 (A inventory checker that blocks a space won't remove anything from inventories)
-=item hp <number>
+=item I<hp> <number>
 If this field is not 0 the inventory checker will search for an object
 with the type id <number>.
-=item slaying <string>
+=item I<slaying> <string>
 If this field is set the inventory checker will search for an object that
-has the same string in the slaying field (for example a key string of a key).
+has the same string in the I<slaying> field (for example a key string of a key).
-=item race <string>
+=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 connected <connection id>
+=item I<connected> <connection id>
-This is the connection that will be activated.
+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.
-=back
+See also the description of the I<connected> field in the generic object field
+section.
+=back
-=head3 FLESH - type 72 - Organs and body parts
+=head3 B<FLESH> - type 72 - Organs and body parts
-See FOOD description.
+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.
+=over 4
+=item I<level> <number>
+The multiplicator, if set to 0 or lower it will destroy the objects above it.
+=item I<other_arch> <string>
+The archetype name of the objects that should be multiplied.
+=item I<connected> <number>
+See generic object field description.
+=back
-=head3 HOLE - type 94 - Holes
+=head3 B<HOLE> - type 94 - Holes
-Holes are holes in the ground where objects can fall through.  When the hole
+B<HOLE>s are holes in the ground where objects can fall through.  When the hole
 opens and/or is completly open all objects above it fall through (more
 precisely: if their head is above the hole).
+When the B<HOLE> is activated it's speed is set to 0.5.
-Trapdoors can only transfer the one who falls through to other coordinates
+These holes can only transfer the one who falls through to other coordinates
-on the B<same> map.
+on the same map.
 =over 4
-=item maxsp (0|1)
+=item I<maxsp> (0|1)
 This field negates the state of the connection: When maxsp is 1 the pit will
 open/close when the connection is deactivated.  Otherwise it will open/close
 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 maxsp is 1 the hole will remain closed until the
+connection is deactivated, and I<maxsp> is 1 the hole will remain closed until the
 connection was triggered once.
-=item connected <connection id>
+=item I<connected> <connection id>
 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.
 For example: if FLAG_ACTIVATE_ON_RELEASE is set to 0 the hole won't react when
 the connection is released.
-=item wc <number> (internal)
+=item I<wc> <number> (internal)
-This is an internal flag. If it is greater than 0 it means that the hole is not
+This is an internal field. If it is greater than 0 it means that the hole is not
 yet fully open. More preciesly: this field is the animation-step and if it is
 set to the 'closed' step of the animation the hole is closed and if it is on
-the 'open' animation step (wc = 0), the hole is open.
+the 'open' animation step (I<wc> = 0), the hole is open.
-=item sp <number>
+=item I<sp> <number>
 The destination y coordinates on the same map.
-=item hp <number>
+=item I<hp> <number>
 The destination x coordinates on the same map.
 =back
-=head3 POISONING - type 105 - The poisoning of players and monsters
+=head3 B<POISONING> - type 105 - The poisoning of players and monsters
 This type is doing the actual damage to the ones who were attacked
-via AT_POISON (or drank POISON).
+via AT_POISON (or drank B<POISON>).
 The duration is handled via the FLAG_IS_USED_UP mechanism (please look
 there for details).
 =over 4
-=item dam <number>
+=item I<dam> <number>
-Each time the poisoning is processed (which is determined by the speed and speed_left
+Each time the poisoning is proccessed (which is determined by the I<speed> and
-fields, see the general object attributes above) it hits the player with
+I<speed_left> fields, see the general object fields description above) it hits
-<number> damage and the AT_INTERNAL attacktype (means: it will simply
+the player with <number> damage and the AT_INTERNAL attacktype (means: it will
-hit the player with no strings attached).
+simply hit the player with no strings attached).
-=item food <number>
+=item I<food> <number>
-Just a note: The posion is removed when food == 1 and not when
+Just a note: The posioning is removed if I<food> == 1 and not if
-the whole duration is up, because the POISONING code has to remove
+the whole I<duration> is up, because the B<POISONING> code has to remove
 the poison-effects from the player before the FLAG_IS_USED_UP mechanism
-deletes the POISONING object.
+deletes the B<POISONING> object.
 =back
-=head3 FORCE - type 114 - Forces
+=head3 B<FORCE> - type 114 - Forces
 Forces are a very 'thin' type. They don't have much behaviour other than
 disappearing after a time and/or affecting the player if they are in his
 inventory.
-Forces only take effect on the player if they have set FLAG_APPLIED.
+Forces only take effect on the player if they have FLAG_APPLIED set.
-Whether the duration field is processed or not a tick is controlled via the
+Whether the I<duration> field is processed or not per tick is controlled by the
-speed and speed_left field. Look above at the generic description of these
+I<speed> and I<speed_left> fields. Look above in the generic object field description.
-fields.
-NOTE: Setting FLAG_IS_USED_UP on an force will also consider the 'food' field
+NOTE: If FLAG_IS_USED_UP is set on a B<FORCE> it's I<food> field will also
-like stated above in the FLAG_IS_USED_UP description. BUT: If the food field reaches
+interpreter like described in the description of the FLAG_IS_USED_UP flag.
-0 before duration and FLAG_APPLIED is set, the force will last for 'duration'.
+BUT: If I<food> reaches 0 before I<duration> and FLAG_APPLIED is set, the force
-If the FLAG_APPLIED is not set the force is removed when food reaches 0.
+will still last for I<duration>.  If the FLAG_APPLIED is not set the force is
-Generally this means: FLAG_IS_USED_UP doesn't have good semantics on forces.
+removed when I<food> reaches 0.  Generally this means: FLAG_IS_USED_UP doesn't
+have good semantics on forces, try to avoid it.
 =over 4
-=item duration
+=item I<duration>
 While this field is greater than 0 the force/object is not destroyed.  It is
 decreased each tick by 1.
 If it reaches 0 the force/object is destroyed.
 FLAG_IS_USED_UP and FLAG_APPLIED set. See the description of FLAG_IS_USED_UP
 what happens then.
 =back
-=head3 POTION_EFFECT - type 115 - Potion effects (resistancies)
+=head3 B<POTION_EFFECT> - type 115 - Potion effects (resistancies)
-This object is generated by the POTION code when the potion is a resistance
+This object is generated by the B<POTION> code when the potion is a resistance
-giving potion. It has mainly the same behaviour as a FORCE.
+giving potion. It has mainly the same behaviour as a B<FORCE>.
 The specialty of the potion effect is that the resistancy it gives is absolute,
-so if you drin a resistancy potion of fire+60 you will get 60% resistancy to
+so if you drink a resistancy potion of fire+60 you will get 60% absolute resistancy to
 fire.
 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.9 by elmex, Tue Dec 19 23:41:56 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.9 by elmex, Tue Dec 19 23:41:56 2006 UTC vs.
Revision 1.17 by elmex, Wed Dec 20 22:54:59 2006 UTC