/src/object/object.h

#ifndef INCLUDED_OBJECT_H

#define INCLUDED_OBJECT_H



/*** Variables ***/



/** Maximum number of scroll titles generated */

#define MAX_TITLES     50



/** The titles of scrolls, ordered by sval. */

extern char scroll_adj[MAX_TITLES][16];





/*** Constants ***/



/**

 * Modes for object_desc().

 */

typedef enum

{

	ODESC_BASE   = 0x00,   /*!< Only describe the base name */

	ODESC_COMBAT = 0x01,   /*!< Also show combat bonuses */

	ODESC_EXTRA  = 0x02,   /*!< Show charges/inscriptions/pvals */



	ODESC_FULL   = ODESC_COMBAT | ODESC_EXTRA,

	                       /*!< Show entire description */



	ODESC_STORE  = 0x04,   /*!< This is an in-store description */

	ODESC_PLURAL = 0x08,   /*!< Always pluralise */

	ODESC_SINGULAR    = 0x10,    /*!< Always singular */

	ODESC_SPOIL  = 0x20,    /*!< Display regardless of player knowledge */

	ODESC_PREFIX = 0x40   /* */

} odesc_detail_t;





/**

 * Modes for item lists in "show_inven()"  "show_equip()" and "show_floor()"

 */

typedef enum

{

	OLIST_NONE   = 0x00,   /* No options */

   	OLIST_WINDOW = 0x01,   /* Display list in a sub-term (left-align) */

   	OLIST_QUIVER = 0x02,   /* Display quiver lines */

   	OLIST_GOLD   = 0x04,   /* Include gold in the list */

	OLIST_WEIGHT = 0x08,   /* Show item weight */

	OLIST_PRICE  = 0x10,   /* Show item price */

	OLIST_FAIL   = 0x20    /* Show device failure */



} olist_detail_t;





/**

 * Modes for object_info()

 */

typedef enum

{

	OINFO_NONE   = 0x00, /* No options */

	OINFO_TERSE  = 0x01, /* Keep descriptions brief, e.g. for dumps */

	OINFO_SUBJ   = 0x02, /* Describe object from the character's POV */

	OINFO_FULL   = 0x04, /* Treat object as if fully IDd */

	OINFO_DUMMY  = 0x08  /* Object does not exist (e.g. knowledge menu) */

} oinfo_detail_t;





/**

 * Pseudo-ID markers.

 */

typedef enum

{

	INSCRIP_NULL = 0,            /*!< No pseudo-ID status */

	INSCRIP_STRANGE = 1,         /*!< Item that has mixed combat bonuses */

	INSCRIP_AVERAGE = 2,         /*!< Item with no interesting features */

	INSCRIP_MAGICAL = 3,         /*!< Item with combat bonuses */

	INSCRIP_SPLENDID = 4,        /*!< Obviously good item */

	INSCRIP_EXCELLENT = 5,       /*!< Ego-item */

	INSCRIP_SPECIAL = 6,         /*!< Artifact */

	INSCRIP_UNKNOWN = 7,



	INSCRIP_MAX                  /*!< Maximum number of pseudo-ID markers */

} obj_pseudo_t;







/*** Functions ***/



/* identify.c */

extern s32b object_last_wield;



bool object_is_known(const object_type *o_ptr);

bool object_is_known_artifact(const object_type *o_ptr);

bool object_is_known_cursed(const object_type *o_ptr);

bool object_is_known_blessed(const object_type *o_ptr);

bool object_is_known_not_artifact(const object_type *o_ptr);

bool object_is_not_known_consistently(const object_type *o_ptr);

bool object_was_worn(const object_type *o_ptr);

bool object_was_fired(const object_type *o_ptr);

bool object_was_sensed(const object_type *o_ptr);

bool object_flavor_is_aware(const object_type *o_ptr);

bool object_flavor_was_tried(const object_type *o_ptr);

bool object_effect_is_known(const object_type *o_ptr);

bool object_pval_is_visible(const object_type *o_ptr);

bool object_ego_is_visible(const object_type *o_ptr);

bool object_attack_plusses_are_visible(const object_type *o_ptr);

bool object_defence_plusses_are_visible(const object_type *o_ptr);

bool object_flag_is_known(const object_type *o_ptr, int flag);

bool object_high_resist_is_possible(const object_type *o_ptr);

void object_flavor_aware(object_type *o_ptr);

void object_flavor_tried(object_type *o_ptr);

void object_notice_everything(object_type *o_ptr);

void object_notice_indestructible(object_type *o_ptr);

void object_notice_ego(object_type *o_ptr);

void object_notice_sensing(object_type *o_ptr);

void object_sense_artifact(object_type *o_ptr);

void object_notice_effect(object_type *o_ptr);

void object_notice_slay(object_type *o_ptr, int flag);

void object_notice_attack_plusses(object_type *o_ptr);

bool object_notice_flag(object_type *o_ptr, int flag);

bool object_notice_flags(object_type *o_ptr, bitflag flags[OF_SIZE]);

bool object_notice_curses(object_type *o_ptr);

void object_notice_on_defend(void);

void object_notice_on_wield(object_type *o_ptr);

void object_notice_on_firing(object_type *o_ptr);

void wieldeds_notice_flag(int flag);

void wieldeds_notice_on_attack(void);

void object_repair_knowledge(object_type *o_ptr);

bool object_FA_would_be_obvious(const object_type *o_ptr);

obj_pseudo_t object_pseudo(const object_type *o_ptr);

void sense_inventory(void);

bool easy_know(const object_type *o_ptr);

bool object_check_for_ident(object_type *o_ptr);

bool object_name_is_visible(const object_type *o_ptr);

void object_know_all_flags(object_type *o_ptr);



/* obj-desc.c */

void object_kind_name(char *buf, size_t max, int k_idx, bool easy_know);

size_t object_desc(char *buf, size_t max, const object_type *o_ptr, odesc_detail_t mode);



/* obj-info.c */

extern const slay_t slay_table[];

size_t num_slays(void);

void object_info_header(const object_type *o_ptr);



bool object_info(const object_type *o_ptr, oinfo_detail_t mode);

bool object_info_chardump(const object_type *o_ptr);

bool object_info_spoil(const object_type *o_ptr);



/* obj-make.c */

void free_obj_alloc(void);

bool init_obj_alloc(void);

s16b get_obj_num(int level, bool good);

void object_prep(object_type *o_ptr, int k_idx, int lev, aspect rand_aspect);

void apply_magic(object_type *o_ptr, int lev, bool okay, bool good, bool great);

bool make_object(object_type *j_ptr, int lev, bool good, bool great);

void make_gold(object_type *j_ptr, int lev, int coin_type);



void set_ego_xtra_sustain(bitflag flags[OF_SIZE]);

void set_ego_xtra_resist(bitflag flags[OF_SIZE]);

void set_ego_xtra_power(bitflag flags[OF_SIZE]);





/* obj-ui.c */

void show_inven(olist_detail_t mode);

void show_equip(olist_detail_t mode);

void show_floor(const int *floor_list, int floor_num, olist_detail_t mode);

bool verify_item(cptr prompt, int item);

bool get_item(int *cp, cptr pmt, cptr str, int mode);



/* obj-util.c */

void flavor_init(void);

void reset_visuals(bool unused);

void object_flags(const object_type *o_ptr, bitflag flags[OF_SIZE]);

void object_flags_known(const object_type *o_ptr, bitflag flags[OF_SIZE]);

char index_to_label(int i);

s16b label_to_inven(int c);

s16b label_to_equip(int c);

bool wearable_p(const object_type *o_ptr);

s16b wield_slot(const object_type *o_ptr);

bool slot_can_wield_item(int slot, const object_type *o_ptr);

const char *mention_use(int slot);

cptr describe_use(int i);

bool item_tester_okay(const object_type *o_ptr);

int scan_floor(int *items, int max_size, int y, int x, int mode);

void excise_object_idx(int o_idx);

void delete_object_idx(int o_idx);

void delete_object(int y, int x);

void compact_objects(int size);

void wipe_o_list(void);

s16b o_pop(void);

object_type *get_first_object(int y, int x);

object_type *get_next_object(const object_type *o_ptr);

bool is_blessed(const object_type *o_ptr);

s32b object_value(const object_type *o_ptr, int qty, int verbose);

bool object_similar(const object_type *o_ptr, const object_type *j_ptr);

void object_absorb(object_type *o_ptr, const object_type *j_ptr);

void object_wipe(object_type *o_ptr);

void object_copy(object_type *o_ptr, const object_type *j_ptr);

void object_copy_amt(object_type *dst, object_type *src, int amt);

s16b floor_carry(int y, int x, object_type *j_ptr);

void drop_near(object_type *j_ptr, int chance, int y, int x, bool verbose);

void acquirement(int y1, int x1, int level, int num, bool great);

void inven_item_charges(int item);

void inven_item_describe(int item);

void inven_item_increase(int item, int num);

void save_quiver_size(void);

void inven_item_optimize(int item);

void floor_item_charges(int item);

void floor_item_describe(int item);

void floor_item_increase(int item, int num);

void floor_item_optimize(int item);

bool inven_carry_okay(const object_type *o_ptr);

bool inven_stack_okay(const object_type *o_ptr);

s16b inven_carry(object_type *o_ptr);

s16b inven_takeoff(int item, int amt);

void inven_drop(int item, int amt);

void combine_pack(void);

void reorder_pack(void);

void open_quiver_slot(int slot);

void sort_quiver(void);

int get_use_device_chance(const object_type *o_ptr);

void distribute_charges(object_type *o_ptr, object_type *q_ptr, int amt);

void reduce_charges(object_type *o_ptr, int amt);

int number_charging(const object_type *o_ptr);

bool recharge_timeout(object_type *o_ptr);

unsigned check_for_inscrip(const object_type *o_ptr, const char *inscrip);

int lookup_kind(int tval, int sval);

bool lookup_reverse(s16b k_idx, int *tval, int *sval);

int lookup_name(int tval, const char *name);

int lookup_artifact_name(const char *name);

int lookup_sval(int tval, const char *name);

int tval_find_idx(const char *name);

const char *tval_find_name(int tval);

artifact_type *artifact_of(const object_type *o_ptr);

object_kind *object_kind_of(const object_type *o_ptr);

bool obj_is_staff(const object_type *o_ptr);

bool obj_is_wand(const object_type *o_ptr);

bool obj_is_rod(const object_type *o_ptr);

bool obj_is_potion(const object_type *o_ptr);

bool obj_is_scroll(const object_type *o_ptr);

bool obj_is_food(const object_type *o_ptr);

bool obj_is_light(const object_type *o_ptr);

bool obj_is_ring(const object_type *o_ptr);

bool obj_is_ammo(const object_type *o_ptr);

bool obj_has_charges(const object_type *o_ptr);

bool obj_can_zap(const object_type *o_ptr);

bool obj_is_activatable(const object_type *o_ptr);

bool obj_can_activate(const object_type *o_ptr);

bool obj_can_refill(const object_type *o_ptr);

bool obj_can_browse(const object_type *o_ptr);

bool obj_can_takeoff(const object_type *o_ptr);

bool obj_can_wear(const object_type *o_ptr);

bool obj_has_inscrip(const object_type *o_ptr);

u16b object_effect(const object_type *o_ptr);

object_type *object_from_item_idx(int item);

bool obj_needs_aim(object_type *o_ptr);

bool get_item_okay(int item);

int scan_items(int *item_list, size_t item_list_max, int mode);

bool item_is_available(int item, bool (*tester)(const object_type *), int mode);

extern void display_itemlist(void);

extern void display_object_idx_recall(s16b o_idx);

extern void display_object_kind_recall(s16b k_idx);



bool pack_is_full(void);

bool pack_is_overfull(void);

void pack_overflow(void);



/* obj-power.c and randart.c */

s32b object_power(const object_type *o_ptr, int verbose, ang_file *log_file, bool known);

/*

 * Some constants used in randart generation and power calculation

 * - thresholds for limiting to_hit, to_dam and to_ac

 * - fudge factor for rescaling ammo cost

 * (a stack of this many equals a weapon of the same damage output)

 */

#define INHIBIT_POWER       20000

#define HIGH_TO_AC             26

#define VERYHIGH_TO_AC         36

#define INHIBIT_AC             56

#define HIGH_TO_HIT            16

#define VERYHIGH_TO_HIT        26

#define HIGH_TO_DAM            16

#define VERYHIGH_TO_DAM        26

#define AMMO_RESCALER          20 /* this value is also used for torches */



#define sign(x) ((x) > 0 ? 1 : ((x) < 0 ? -1 : 0))



#define LOG_PRINT(string) \

        do { if (verbose) \

                file_putf(log_file, (string)); \

        } while (0);



#define LOG_PRINT1(string, value) \

        do { if (verbose) \

                file_putf(log_file, (string), (value)); \

        } while (0);



#define LOG_PRINT2(string, val1, val2) \

        do { if (verbose) \

                file_putf(log_file, (string), (val1), (val2)); \

        } while (0);



#endif /* !INCLUDED_OBJECT_H */