object.h

Go to the documentation of this file.

/*
 * static char *rcsid_object_h =
 *   "$Id: object.h 11578 2009-02-23 22:02:27Z lalo $";
 */

/*
    CrossFire, A Multiplayer game for X-windows

    Copyright (C) 2001 Mark Wedel & Crossfire Development Team
    Copyright (C) 1992 Frank Tore Johansen

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    The authors can be reached via e-mail at crossfire-devel@real-time.com
*/

#include "dialog.h"

#ifndef OBJECT_H
#define OBJECT_H

typedef uint32 tag_t;
#define NUM_BODY_LOCATIONS      13  
#define BODY_ARMS               1   
typedef struct body_locations_struct {
    const char *save_name;      
    const char *use_name;       
    const char *nonuse_name;    
} body_locations_struct;

extern body_locations_struct body_locations[NUM_BODY_LOCATIONS];

typedef struct _key_value {
    const char *key;
    const char *value;
    struct _key_value *next;
} key_value;

#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 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)

typedef struct obj {
    /* These variables are not changed by copy_object() */
    struct pl   *contr;         
    struct obj  *next;          
    struct obj  *prev;          
    struct obj  *active_next;   
    struct obj  *active_prev;   
    struct obj  *below;         
    struct obj  *above;         
                                /* Note: stacked in the *same *environment*/
    struct obj  *inv;           
    struct obj  *container;     
    struct obj  *env;           
    struct obj  *more;          
    struct obj  *head;          
    struct mapdef *map;         
    tag_t       count;          
    struct struct_dialog_information *dialog_information; 
    /* These get an extra add_refcount(), after having been copied by memcpy().
     * All fields beow this point are automatically copied by memcpy.  If
     * adding something that needs a refcount updated, make sure you modify
     * copy_object to do so.  Everything below here also gets cleared
     * by clear_object()
     */
    const char  *name;          
    const char  *name_pl;       
    const char  *anim_suffix;   
    const char  *title;         
    const char  *race;          
    const char  *slaying;       
    const char  *skill;         
    const char  *msg;           
    const char  *lore;          
    sint16      x, y;           
    sint16      ox, oy;         
    float       speed;          
    float       speed_left;     
    New_Face    *face;          
    uint32      nrof;           
    sint8       direction;      
    sint8       facing;         
    /* This next big block are basically used for monsters and equipment */
    uint8       type;           
    uint8       subtype;        
    uint16      client_type;    
    sint16      resist[NROFATTACKS]; 
    uint32      attacktype;     
    uint32      path_attuned;   
    uint32      path_repelled;  
    uint32      path_denied;    
    const char  *materialname;  
    uint16      material;       
    sint8       magic;          
    uint8       state;          
    sint32      value;          
    sint16      level;          
    /* Note that the last_.. values are sometimes used for non obvious
     * meanings by some objects, eg, sp penalty, permanent exp.
     */
    sint32      last_eat;       
    sint32      last_heal;      
    sint32      last_sp;        
    sint16      last_grace;     
    sint16      invisible;      
    uint8       pick_up;        
    sint8       item_power;     
    sint8       gen_sp_armour;  
    sint8       glow_radius;    
    sint32      weight;         
    sint32      weight_limit;   
    sint32      carrying;       
    living      stats;          
    sint64      perm_exp;       
    struct obj  *current_weapon; 
    uint32      weapontype;     
    sint8       body_info[NUM_BODY_LOCATIONS];  
    sint8       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 */
    struct obj  *owner;         
    tag_t       ownercount;     
    struct obj  *enemy;         
    struct obj  *attacked_by;   
    tag_t       attacked_by_count; 
    uint16      run_away;          
    struct treasureliststruct *randomitems; 
    struct obj  *chosen_skill;  
    uint32      hide;           
    /* changes made by kholland@sunlab.cit.cornell.edu */
    /* allows different movement patterns for attackers */
    sint32      move_status;    
    uint16      attack_movement;
    uint8       will_apply;     
    sint8       sound_chance;   
    struct obj  *spellitem;     
    double      expmul;         
    /* Spell related information, may be useful elsewhere
     * Note that other fields are used - these files are basically
     * only used in spells.
     */
    sint16      casting_time;   
    sint16      duration;       
    uint8       duration_modifier; 
    sint8       range;          
    uint8       range_modifier; 
    uint8       dam_modifier;   
    struct obj  *spell;         
    char        *spellarg;

    /* Following are values used by any object */
    struct archt *arch;         
    struct archt *other_arch;   
    uint32      flags[4];       
    uint16      animation_id;   
    uint8       anim_speed;     
    uint8       last_anim;      
    uint16      temp_animation_id; 
    uint8       temp_anim_speed; 
    uint8       temp_last_anim; 
    sint32      elevation;      
    uint8       smoothlevel;    
    uint8       map_layer;      
    MoveType    move_type;      
    MoveType    move_block;     
    MoveType    move_allow;     
    MoveType    move_on;        
    MoveType    move_off;       
    MoveType    move_slow;      
    float       move_slow_penalty; 
    const char  *custom_name;   
    key_value   *key_values;    
    uint8       no_save;        
    sint16      *discrete_damage; 
    tag_t       *spell_tags;
} object;

typedef struct oblnk {
    object *ob;
    struct oblnk *next;
    tag_t id;
} objectlink;

typedef struct oblinkpt {
    struct oblnk *link;
    long value;           
    struct oblinkpt *next;
} oblinkpt;

typedef struct archt {
    const char *name;       
    struct archt *next;     
    struct archt *head;     
    struct archt *more;     
    object clone;           
    sint8 tail_x, tail_y;   
    int reference_count;    
} archetype;

extern object *objects;
extern object *active_objects;
extern object *free_objects;
extern object objarray[STARTMAX];

extern int nrofallocobjects;
extern int nroffreeobjects;

#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 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_SINGULARITY_LEN    11              
#define ARCH_DETECT_MAGIC       "detect_magic"  
#define ARCH_DEPLETION          "depletion"     
#define ARCH_SYMPTOM            "symptom"       
#endif /* OBJECT_H */