Differences

This shows you the differences between two versions of the page.

--- dev:object_fields [2018/04/12 04:12]
karl First round of page cleanup. Since the most Meaning: lines contain the comment from the objekt.h , name them in a Comment: line, and Meaning afterwards
+++ dev:object_fields [2020/11/23 08:34] (current)
ryo [anim_suffix] update
@@ Line 3: / Line 3: @@
 This is the description of fields of the object structure, and what they are used to.
+The struct [[object_fields_living|living]] and struct [[object_fields_key_value|key_value]] have their own pages. \\
+The term [[Shared Strings]] has it's own page, too. \\
 See also page [[Objects]] .
 ===== Issues ==
-FIXME This page needs complete rebuild. It is unsorted and too large to scroll and to read with almost no content.\\
+FIXME \\
-It appears that server internal variables like //next// and //prev// have mixed with archetype attributes. \\
 **These Object Fields are for now sorted alphabetically [[:arch:arch_attributes:1_index|here]] ** . \\
 Whenever =field= gets changed, please do it in the sorted pages in the :arch:arch_attributes:* namespace.
-Jump down to [[#"living" structure fields]] , [[#Key/value fields]]
 <WRAP lo>
 FIXME fill in the blanks :) add sharedstring info
-FIXME maybe this should be part of the object.h file directly?
+FIXME make a script to either do object.h -> this page, or this page -> object.h \\
+IMHO one should put this data into object.h, in doxygen format, and make a script to do object.h -> this page  --- //[[user:rednaxela|Alex Schultz]] 2007/01/03 12:50//
-FIXME make a script to either do object.h -> this page, or this page -> object.h
-  * IMHO one should put this data into object.h, in doxygen format, and make a script to do object.h -> this page  --- //[[user:rednaxela|Alex Schultz]] 2007/01/03 12:50//
 </WRAP>
@@ Line 224: / Line 220: @@
 } object;
 </code>
+----
 ===== Head Part of Struct ==
@@ Line 393: / Line 391: @@
 Comment: Used to determine combined animations
-Meaning: NEW introduced since ?
+When a player or a monster attacks or uses a skill, if this suffix is defined on the weapon (combat) or the skill (skill use), the server tries to find an animation named "[player_or_monster_animation]_[anim_suffix]".
+For instance, for a Fenx using an animation "fenx_player" who uses a sword (anim_suffix "sword"), when attacking, the "fenx_player_sword" animation will be used if it exists.
+If no suffix is defined or the animation doesn't exist, then nothing happens, else the animation is applied until it finished.
 ==== title ====
 Type: const char * (shared string)
@@ Line 639: / Line 640: @@
 Meaning: Mainly the skill level which a character has to have to successfully cast magic upon monster-with-level .
+==== last_eat ====
+Type: sint16
+Comment: How long since we last ate
+Meaning:
 ==== last_heal ====
 Type: sint32
+Comment: Last healed. Depends on constitution
 Meaning:
@@ Line 649: / Line 659: @@
 ==== last_sp ====
 Type: sint32
+Comment: As last_heal, but for spell points
 Meaning:
@@ Line 657: / Line 669: @@
     * 3: make all monsters fall asleep
     * 4: charm all monsters
-  * new sp for praying skill when changing god?
-    * FIXME check what it means when praying
   * for CHECK_INV, 0 means player must have object, else player must not have object
-  * for healing, how many sp to regenerate
+  * for TRIGGER_ALTAR ??
-  * for TRIGGER_ALTAR ?? FIXME
+    * FIXME
-  * for DISEASEs, the SYMPTOM's last_sp FIXME
+  * for DISEASEs, the SYMPTOM's last_sp
+    * FIXME
   * for objects being thrown, the max number of moves to exist
   * for monsters, regenerate sp
+  * for healing, how many sp to regenerate
+  * new sp for praying skill when changing god?
+    * FIXME check what it means when praying
 ==== last_grace ====
 Type: sint16
-Meaning:
+Comment: As last_sp, except for grace
-==== last_eat ====
-Type: sint16
 Meaning:
@@ Line 678: / Line 689: @@
 ==== invisible ====
 Type: sint16
+Comment: How much longer the object will be invis
 Meaning:
@@ Line 683: / Line 696: @@
 ==== pick_up ====
 Type: uint8
+Comment: See crossfire.doc
 Meaning:
@@ Line 689: / Line 704: @@
 Type: sint8
-Meaning:
+Comment: Power rating of the object
+Meaning: The character has a limited item power maximum to be able to apply magical items. \\
+If the sum of the item_power of all applied items reaches the allowed maximum, \\
+no more magical item with //item_power > 0// can be wielded / worn.
 ==== gen_sp_armour ====
 Type: sint8
+Comment: Sp regen penalty this object has (was last_heal)
+Meaning:
+==== glow_radius ====
+Type: sint8
+Comment: indicates the glow radius of the object
 Meaning:
@@ Line 698: / Line 726: @@
 ==== weight ====
 Type: sint32
+Comment: Attributes of the object
 Meaning:
@@ Line 703: / Line 733: @@
 ==== weight_limit ====
 Type: sint32
+Comment: Weight-limit of object
 Meaning:
@@ Line 708: / Line 740: @@
 ==== carrying ====
 Type: sint32
+Comment: How much weight this object contains
 Meaning:
-==== glow_radius ====
-Type: sint8
-Meaning:
 ==== stats ====
 Type: living
+Comment: Str, Con, Dex, etc
 Meaning:
+See [[#"living" structure fields]] on this page.
 ==== perm_exp ====
 Type: sint64
+Comment: Permanent exp
 Meaning:
@@ Line 729: / Line 765: @@
 Type: const char * (shared string)
-Meaning:
+Comment:
+Meaning: Not anymore included since when ?
 ==== current_weapon ====
 Type: obj *
+Comment: Pointer to the weapon currently used
 Meaning:
@@ Line 738: / Line 778: @@
 ==== weapontype ====
 Type: uint32
+Comment: Type of weapon
 Meaning:
@@ Line 744: / Line 786: @@
 Type: uint32
-Meaning:
+Comment:
+Meaning: Not included anymore since when ?
 ==== body_info ====
 Type: sint8[NUM_BODY_LOCATIONS]
+Comment: Body info as loaded from the file
 Meaning:
@@ Line 753: / Line 799: @@
 ==== body_used ====
 Type: sint8[NUM_BODY_LOCATIONS]
+Comment: Calculated value based on items equipped
 Meaning:
@@ Line 758: / Line 806: @@
 ==== owner ====
 Type: obj *
+Comment: Pointer to the object which controls this one. Owner should not be referred to directly - object_get_owner() should be used instead.
 Meaning:
@@ Line 763: / Line 813: @@
 ==== ownercount ====
 Type: tag_t
+Comment: What count the owner had (in case owner has been freed)
 Meaning:
@@ Line 768: / Line 820: @@
 ==== enemy ====
 Type: obj *
+Comment: Monster/player to follow even if not closest
 Meaning:
@@ Line 773: / Line 827: @@
 ==== attacked_by ====
 Type: obj *
+Comment: This object start to attack us! only player & monster
 Meaning:
@@ Line 779: / Line 835: @@
 Type: tag_t
-Meaning:
+Comment: The tag of attacker, so we can be sure
-==== randomitems ====
-Type: treasureliststruct *
 Meaning:
@@ Line 788: / Line 841: @@
 ==== run_away ====
 Type: uint16
+Comment: Monster runs away if it's hp goes below this percentage.
 Meaning:
+==== randomitems ====
+Type: treasureliststruct *
+Comment: Items to be generated
+Meaning:
 ==== chosen_skill ====
 Type: obj *
+Comment: The skill chosen to use
 Meaning:
@@ Line 798: / Line 863: @@
 ==== hide ====
 Type: uint32
+Comment: The object is hidden, not invisible
 Meaning:
@@ Line 803: / Line 870: @@
 ==== move_status ====
 Type: sint32
+Comment: What stage in attack mode
 Meaning:
@@ Line 808: / Line 877: @@
 ==== attack_movement ====
 Type: uint16
+Comment: What kind of attack movement
 Meaning:
@@ Line 813: / Line 884: @@
 ==== will_apply ====
 Type: uint8
+Comment: See crossfire.doc and @ref WILL_APPLY_xxx
 Meaning:
+==== sound_chance ====
+Type: sint8
+Comment: Probability, 0 to 100, of the object emitting a sound.
+Meaning: NEW since when ?
 ==== spellitem ====
 Type: obj *
+Comment: Spell ability monster is choosing to use
 Meaning:
@@ Line 823: / Line 905: @@
 ==== expmul ====
 Type: double
+Comment: needed experience = (calc_exp*expmul) - means some races/classes can need less/more exp to gain levels
 Meaning:
-==== duration ====
+==== casting_time ====
 Type: sint16
-Meaning:
+Comment: Time left before spell goes off
-==== duration_modifier ====
-Type: uint8
 Meaning:
-==== casting_time ====
+==== duration ====
 Type: sint16
+Comment: How long the spell lasts
 Meaning:
-==== spell ====
+==== duration_modifier ====
-Type: obj *
+Type: uint8
+Comment: how level modifies duration
 Meaning:
-==== start_holding ====
+==== range ====
-Type: uint16
+Type: sint8
+Comment: Range of the spell
 Meaning:
-==== spellarg ====
+==== range_modifier ====
-Type: char *
+Type: uint8
+Comment: How going up in level effects range
 Meaning:
@@ Line 858: / Line 947: @@
 ==== dam_modifier ====
 Type: uint8
+Comment: How going up in level effects damage
 Meaning:
-==== range ====
-Type: sint8
+==== spell ====
+Type: obj *
+Comment: Spell that was being cast
 Meaning:
-==== range_modifier ====
+==== spellarg ====
-Type: uint8
+Type: char *
+Comment: No comment available
 Meaning:
+==== start_holding ====
+Type: uint16
+Comment:
+Meaning: Not included anymore ?
 ==== arch ====
 Type: archt *
+Comment: Pointer to archetype
 Meaning:
@@ Line 878: / Line 984: @@
 ==== other_arch ====
 Type: archt *
+Comment: Pointer used for various things - mostly used for what this objects turns into or what this object creates
 Meaning:
 ==== flags ====
 Type: uint32[4]
+Comment: Various flags
 Meaning:
@@ Line 888: / Line 999: @@
 ==== animation_id ====
 Type: uint16
+Comment: An index into the animation array
 Meaning:
@@ Line 893: / Line 1006: @@
 ==== anim_speed ====
 Type: uint8
+Comment: Ticks between animation-frames
 Meaning:
 ==== last_anim ====
 Type: uint8
+Comment: Last sequence used to draw face
 Meaning:
+==== temp_animation_id ====
+Type: uint16
+Comment: An index into the temporary animation array
+Meaning:
+==== temp_anim_speed ====
+Type: uint8
+Comment: Ticks between temporary animation-frames
+Meaning:
 ==== elevation ====
 Type: sint32
+Comment: Elevation of this terrain - used in weather code
 Meaning:
@@ Line 908: / Line 1044: @@
 ==== smoothlevel ====
 Type: uint8
+Comment: how to smooth this square around
 Meaning:
@@ Line 913: / Line 1051: @@
 ==== map_layer ====
 Type: uint8
+Comment: What level to draw this on the map
 Meaning:
 ==== move_type ====
 Type: MoveType
+Comment: Type of movement this object uses
 Meaning:
@@ Line 925: / Line 1068: @@
 Type: MoveType
-Meaning:  Prevents a character or monster from moving onto a tile occupied by the object.
+Comment: What movement types this blocks
-  * Each part of a multi-tile object may have a unique setting, unlike many other modifiers that are omitted or ignored in non-head parts.
+Meaning:  Prevents a character or monster from moving onto a tile occupied by the object. \\
+Each part of a multi-tile object may have an unique setting, unlike many other modifiers \\
+that are omitted or ignored in non-head parts.
 See also [[objects#move_block]] on the [[objects]] page.
 ==== move_allow ====
 Type: MoveType
+Comment: What movement types explicitly allowed
 Meaning:
@@ Line 937: / Line 1086: @@
 ==== move_on ====
 Type: MoveType
+Comment: Move types affected moving on to this space
 Meaning:
@@ Line 942: / Line 1093: @@
 ==== move_off ====
 Type: MoveType
+Comment: Move types affected moving off this space
 Meaning:
@@ Line 947: / Line 1100: @@
 ==== move_slow ====
 Type: MoveType
+Comment: Movement types this slows down
 Meaning:
@@ Line 952: / Line 1107: @@
 ==== move_slow_penalty ====
 Type: float
+Comment: How much this slows down the object
 Meaning:
 ==== custom_name ====
 Type: const char * (shared string)
+Comment: Custom name assigned by player
 Meaning:
@@ Line 962: / Line 1122: @@
 ==== key_values ====
 Type: key_value *
+Comment: Fields not explictly known by the loader.
 Meaning:
@@ Line 969: / Line 1131: @@
 Type: uint8
-Meaning:
+Comment:
+Meaning: Not included anymore ?
+----
 ====== "living" structure fields =====
 ==== Str ====

Crossfire Wiki

User Tools

Site Tools

Differences

Page Tools