object.h

Go to the documentation of this file.

 
#ifndef OBJECT_H
#define OBJECT_H
 
#include "sstring.h"
 
#include "dialog.h"
 
typedef uint32_t tag_t;
#define NUM_BODY_LOCATIONS      13  
#define BODY_ARMS               1   
struct body_locations_struct {
    const char *save_name;      
    const char *use_name;       
    const char *nonuse_name;    
};
 
extern body_locations_struct body_locations[NUM_BODY_LOCATIONS];
 
extern const char *const move_name[];
 
struct key_value {
    const char *key;          
    const char *value;        
    key_value  *next;  
};
 
#define WILL_APPLY_HANDLE       0x1   
#define WILL_APPLY_TREASURE     0x2   
#define WILL_APPLY_EARTHWALL    0x4   
#define WILL_APPLY_DOOR         0x8   
#define WILL_APPLY_FOOD         0x10  
 
 
#define object_was_destroyed(op, old_tag) \
    (op->count != old_tag || QUERY_FLAG(op, FLAG_FREED))
 
 
#define SPELL_TAG_SIZE 16
 
#define OB_SPELL_TAG_HASH(op, count)    (op->spell_tags[count&0xf])
 
#define OB_SPELL_TAG_MATCH(op, count)   (op->spell_tags[count&0xf] == count)
 
#define CUSTOM_NAME_FIELD   "custom_name"
 
enum object_type {
    PLAYER = 1,
    TRANSPORT = 2, 
    ROD = 3,
    TREASURE = 4,
    POTION = 5,
    FOOD = 6,
    POISON = 7,
    BOOK = 8,
    CLOCK = 9,
    DRAGON_FOCUS = 10, 
    ARROW = 13,
    BOW = 14,
    WEAPON = 15,
    ARMOUR = 16,
    PEDESTAL = 17,
    ALTAR = 18,
    LOCKED_DOOR = 20,
    SPECIAL_KEY = 21,
    MAP = 22,
    DOOR = 23,
    KEY = 24,
    TIMED_GATE = 26,
    TRIGGER = 27,
    GRIMREAPER = 28,
    MAGIC_EAR = 29,
    TRIGGER_BUTTON = 30,
    TRIGGER_ALTAR = 31,
    TRIGGER_PEDESTAL = 32,
    SHIELD = 33,
    HELMET = 34,
    MONEY = 36,
    CLASS = 37, 
    AMULET = 39,
    PLAYERMOVER = 40,
    TELEPORTER = 41,
    CREATOR = 42,
    SKILL = 43, 
    EARTHWALL = 45,
    GOLEM = 46,
    THROWN_OBJ = 48,
    BLINDNESS = 49,
    GOD = 50,
    DETECTOR = 51,       
    TRIGGER_MARKER = 52, 
    DEAD_OBJECT = 53,
    DRINK = 54,
    MARKER = 55, 
    HOLY_ALTAR = 56,
    PLAYER_CHANGER = 57,
    BATTLEGROUND = 58, 
    PEACEMAKER = 59,   
    GEM = 60,
    FIREWALL = 62,
    CHECK_INV = 64,  
    MOOD_FLOOR = 65, 
    EXIT = 66,
    ENCOUNTER = 67,
    SHOP_FLOOR = 68,
    SHOP_MAT = 69,
    RING = 70,
    FLOOR = 71,      
    FLESH = 72,      
    INORGANIC = 73,  
    SKILL_TOOL = 74, 
    LIGHTER = 75,
    WALL = 77,        
    MISC_OBJECT = 79, 
    MONSTER = 80,     
    LAMP = 82,        
    DUPLICATOR = 83,  
    SPELLBOOK = 85,
    CLOAK = 87,
    SPINNER = 90,
    GATE = 91,
    BUTTON = 92,
    CF_HANDLE = 93,
    HOLE = 94, /* When open, objects fall through */
    TRAPDOOR = 95,
    SIGN = 98,
    BOOTS = 99,
    GLOVES = 100,
    SPELL = 101,
    SPELL_EFFECT = 102,
    CONVERTER = 103,
    BRACERS = 104,
    POISONING = 105,
    SAVEBED = 106,
    WAND = 109,
    SCROLL = 111,
    DIRECTOR = 112,
    GIRDLE = 113,
    FORCE = 114,
    POTION_RESIST_EFFECT = 115, 
    EVENT_CONNECTOR = 116,      
    CLOSE_CON = 121,            
    CONTAINER = 122,
    ARMOUR_IMPROVER = 123,
    WEAPON_IMPROVER = 124,
    SKILLSCROLL = 130, 
    DEEP_SWAMP = 138,
    IDENTIFY_ALTAR = 139,
    SHOP_INVENTORY = 150, 
    RUNE = 154,
    TRAP = 155,
    POWER_CRYSTAL = 156,
    CORPSE = 157,
    DISEASE = 158,
    SYMPTOM = 159,
    BUILDER = 160,  
    MATERIAL = 161, 
    MIMIC = 162,
    LIGHTABLE = 163, 
    OBJECT_TYPE_MAX = 164, 
};
 
typedef uint32_t ob_flags[4];
 
struct object {
    /* These variables are not changed by object_copy() */
    struct player   *contr;         
    object  *next;          
    object  *prev;          
    object  *active_next;   
    object  *active_prev;   
    object  *below;         
    object  *above;         
                                /* Note: stacked in the *same *environment*/
    object  *inv;           
    object  *container;     
    object  *env;           
    object  *more;          
    object  *head;          
    struct mapstruct *map;      
    tag_t       count;          
    struct_dialog_information *dialog_information; 
    /* These get an extra add_refcount(), after having been copied by memcpy().
     *
     * Fields below name (included) are copied by memcpy in object_copy().
     *
     * If adding something that needs a refcount updated, make sure you modify
     * object_copy() to do so.
     * Everything below here also gets cleared by object_clear().
     */
    sstring     name;           
    /* Place new attributes that should get copied and cleared below name */
 
    sstring     artifact;       
    sstring     name_pl;        
    sstring     anim_suffix;    
    sstring     title;          
    sstring     race;           
    sstring     slaying;        
    sstring     skill;          
    sstring     msg;            
    sstring     lore;           
    int16_t      x, y;           
    int16_t      ox, oy;         
    float       speed;          
    float       speed_left;     
    float       weapon_speed;   
    float       weapon_speed_left; 
    const Face    *face;    
    uint32_t      nrof;          
    int8_t       direction;      
    int8_t       facing;         
    /* This next big block are basically used for monsters and equipment */
    uint8_t       type;           
    uint8_t       subtype;        
    uint16_t      client_type;    
    int16_t      resist[NROFATTACKS]; 
    uint32_t      attacktype;     
    uint32_t      path_attuned;   
    uint32_t      path_repelled;  
    uint32_t      path_denied;    
    sstring       materialname;   
    uint16_t      material;       
    int8_t       magic;          
    uint8_t       state;          
    int32_t      value;          
    int16_t      level;          
    /* Note that the last_.. values are sometimes used for non obvious
     * meanings by some objects, eg, sp penalty, permanent exp.
     */
    int32_t      last_eat;       
    int32_t      last_heal;      
    int32_t      last_sp;        
    int16_t      last_grace;     
    int16_t      invisible;      
    uint8_t       pick_up;        
    int8_t       item_power;     
    int8_t       gen_sp_armour;  
    int8_t       glow_radius;    
    int32_t      weight;         
    int32_t      weight_limit;   
    int32_t      carrying;       
    living       stats;          
    int64_t      total_exp;      
    object  *current_weapon; 
    uint32_t      weapontype;     
    int8_t       body_info[NUM_BODY_LOCATIONS];  
    int8_t       body_used[NUM_BODY_LOCATIONS];  
                                /* See the doc/Developers/objects for more info about body locations */
 
    /* Following mostly refers to fields only used for monsters */
    object  *owner;         
    tag_t       ownercount;     
    object  *enemy;         
    object  *attacked_by;   
    tag_t       attacked_by_count; 
    uint8_t       run_away;          
    struct treasurelist *randomitems; 
    object  *chosen_skill;  
    uint8_t      hide;           
    /* changes made by kholland@sunlab.cit.cornell.edu */
    /* allows different movement patterns for attackers */
    int32_t      move_status;    
    uint16_t      attack_movement;
    uint8_t       will_apply;     
    uint8_t       sound_chance;   
    object  *spellitem;     
    double      expmul;         
    /* Spell related information, may be useful elsewhere
     * Note that other fields are used - these files are basically
     * only used in spells.
     */
    int16_t      casting_time;   
    int16_t      duration;       
    uint8_t       duration_modifier; 
    int8_t       range;          
    uint8_t       range_modifier; 
    uint8_t       dam_modifier;   
    object  *spell;         
    char        *spellarg;      
    /* Following are values used by any object */
    struct archetype *arch;         
    struct archetype *other_arch;   
    ob_flags    flags;             
    const Animations *animation;   
    uint8_t       anim_speed;     
    uint8_t       last_anim;      
    const Animations *temp_animation; 
    uint8_t       temp_anim_speed; 
    uint8_t       smoothlevel;    
    uint8_t       map_layer;      
    MoveType    move_type;      
    MoveType    move_block;     
    MoveType    move_allow;     
    MoveType    move_on;        
    MoveType    move_off;       
    MoveType    move_slow;      
    float       move_slow_penalty; 
    key_value   *key_values;    
    tag_t       *spell_tags;      
    uint64_t    event_bitmask;  
    /* This used to be a key/value, but this is on all world maps and needs to be fast. */
    int elevation;
 
    uint32_t light_cached_time; //< tick this was cached
    int light_cached; //< 1 for in the light, 0 for not
};
 
struct objectlink {
    object *ob;         
    objectlink *next; 
    tag_t id;           
};
 
struct oblinkpt {
    objectlink *link;          
    long value;           
    oblinkpt *next;       
};
 
struct archetype {
    sstring name;           
    archetype *head;     
    archetype *more;     
    object clone;           
    int8_t tail_x, tail_y;   
    int reference_count;    
};
 
extern object *objects;
extern object *active_objects;
 
extern int nrofallocobjects;
extern int nroffreeobjects;
 
static inline void compare_flags(ob_flags *ret, const object *p, const object *q) {
    for (int i = 0; i < 4; i++) {
        (*ret)[i] = p->flags[i] ^ q->flags[i];
    }
}
 
static inline int query_flag(const object *op, int flag) {
    return op->flags[flag / 32] & (1U << (flag % 32));
}
 
static inline void clear_flag(object *op, int flag) {
    op->flags[flag / 32] &= ~(1U << (flag % 32));
}
 
static inline void set_flag(object *op, int flag) {
    op->flags[flag / 32] |= (1U << (flag % 32));
}
 
#define LOOK_OBJ(ob) (!ob->invisible && ob->type != PLAYER && ob->type != EVENT_CONNECTOR)
 
#define UP_OBJ_INSERT   1   
#define UP_OBJ_REMOVE   2   
#define UP_OBJ_CHANGE   3   
#define UP_OBJ_FACE     4   
 
 
#define FREE_OBJ_FREE_INVENTORY      1 
#define FREE_OBJ_NO_DESTROY_CALLBACK 2 
#define FREE_OBJ_DROP_ABOVE_FLOOR    4 
 
 
#define INS_NO_MERGE            0x0001  
#define INS_ABOVE_FLOOR_ONLY    0x0002  
#define INS_NO_WALK_ON          0x0004  
#define INS_ON_TOP              0x0008  
#define INS_BELOW_ORIGINATOR    0x0010  
#define INS_MAP_LOAD            0x0020  
 
#define ARCH_SINGULARITY        "singularity"   
#define ARCH_DETECT_MAGIC       "detect_magic"  
#define ARCH_DEPLETION          "depletion"     
#define ARCH_SYMPTOM            "symptom"       
#define ARCH_PORTAL_FAILED      "town_portal_failed"    
#define ARCH_SPELL_BLOCKED      "spell_blocked" 
#define ARCH_SPELL_BUNGLE       "spell_bungle"  
#define MONSTER_EXCLUDE_FROM_READABLE_KEY  "exclude_from_readable"  
#define HEAD(op) ((op)->head != NULL ? (op)->head : (op))
 
static inline bool IS_PLAYER(object *op) {
    return op->type == PLAYER;
}
 
static inline bool CAN_PROBE(const object *ob) {
    return QUERY_FLAG(ob, FLAG_ALIVE) &&
        (ob->type == PLAYER || QUERY_FLAG(ob, FLAG_MONSTER));
}
 
static inline uint32_t NROF(const object * const ob) {
    return ob->nrof ? ob->nrof : 1;
}
 
object *find_force(object *op, const char *name);
 
object *add_force(object *op, const char *name, int duration);
 
#endif /* OBJECT_H */