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

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.14 by elmex, Wed Dec 20 19:53:10 2006 UTC vs.
Revision 1.15 by elmex, Wed Dec 20 20:25: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 I<this>.
 =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 is_used_up (0|1)
 Sets the flag FLAG_IS_USED_UP.
 See Flags section below.
+=item changing (0|1)
+Sets the flag FLAG_CHANGING.
+See Flags section below.
 =item auto_apply (0|1)
 Sets the flag FLAG_AUTO_APPLY.
 See Flags section below.
 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
+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 object is removed or not, see the 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 'state' field of the object is 0 the object will be processed periodically.
+Otherwise it won't "change";
 =item FLAG_IS_A_TEMPLATE (internal use)
 This flag is set on the inventory of generators like CREATORs and CONVERTERs,
 or other objects that have the flags FLAG_GENERATOR and FLAG_CONTENT_ON_GEN set.
 This flag indicates whether something reflects spells, like spell reflecting
 amuletts.
 =back
-=head2 Description of type specific attributes
+=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
 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
 Rods contain spells and can be fired by a player.
 =over 4
 =item 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.
 =back
 =head3 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 archetype from the other_arch slot).
+(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
 be used.
 =item speed <number>
 If speed is set the creator will create an object periodically,
-see speed and speed_left fields in general object attribute description
+see speed and speed_left fields in general object field description
 for more details on how this period works.
 =item slaying <string>
 If set the generated object's name and
 title will be set to this.
 =item other_arch <string>
-If the inventory of the creator is empty objects of the
+If the inventory of the creator is empty new objects
-archetype <string> will be generated.
+will be derived from the archetype named by <string>.
 =item connected <number>
-See generic object attribute section.
+See generic object field section.
 =back
 =head3 DRINK - type 54 - Drinkable stuff
 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 connected field in the generic object attribute
+See also the description of the connected field in the generic object field
 section.
 =back
 =head3 FLESH - type 72 - Organs and body parts
 See FOOD description.
 =head3 MISC_OBJECT - type 79 - Misc. objects
 A type for any object that has no special behaviour.
+=head3 LAMP - type 82 - A lamp
+This object makes light.
 =head3 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.
 The multiplicator, if set to 0 or lower it will destroy the objects above it.
 =item other_arch <string>
-The archetype name of the objects which will be multiplied.
+The archetype name of the objects that should be multiplied.
 =item connected <number>
-See generic object attribute section.
+See generic object field section.
 =back
 =head3 HOLE - type 94 - Holes
 =over 4
 =item dam <number>
 Each time the poisoning is processed (which is determined by the speed and speed_left
-fields, see the general object attributes above) it hits the player with
+fields, see the general object fields above) it hits the player with
 <number> damage and the AT_INTERNAL attacktype (means: it will simply
 hit the player with no strings attached).
 =item food <number>
 inventory.
 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
+speed and speed_left field. Look above in the generic object field description.
-fields.
 NOTE: Setting FLAG_IS_USED_UP on an force will also consider the 'food' field
 like stated above in the FLAG_IS_USED_UP description. BUT: If the food field reaches
 0 before duration and FLAG_APPLIED is set, the force will last for 'duration'.
 If the FLAG_APPLIED is not set the force is removed when food reaches 0.

Diff Legend

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

Comparing deliantra/server/pod/objects.pod (file contents): Revision 1.14 by elmex, Wed Dec 20 19:53:10 2006 UTC vs. Revision 1.15 by elmex, Wed Dec 20 20:25:59 2006 UTC

Diff Legend

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.14 by elmex, Wed Dec 20 19:53:10 2006 UTC vs.
Revision 1.15 by elmex, Wed Dec 20 20:25:59 2006 UTC