describe.h File Reference

#include <string>
#include <sstream>
#include "externs.h"
#include "enum.h"
#include "mon-info.h"

Include dependency graph for describe.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	describe_info
class	alt_desc_proc
Enumerations
enum	item_description_type {   IDESC_WANDS = 0, IDESC_POTIONS, IDESC_SCROLLS, IDESC_RINGS,   IDESC_SCROLLS_II, IDESC_STAVES, NUM_IDESC }
enum	book_mem_or_forget { BOOK_MEM, BOOK_FORGET, BOOK_NEITHER }
Functions
void	append_spells (std::string &desc, const item_def &item)
bool	is_dumpable_artefact (const item_def &item, bool verbose)
std::string	get_item_description (const item_def &item, bool verbose, bool dump=false, bool noquote=false)
std::string	god_title (god_type which_god, species_type which_species)
void	describe_god (god_type which_god, bool give_title)
void	describe_feature_wide (const coord_def &pos)
void	get_feature_desc (const coord_def &gc, describe_info &inf)
void	set_feature_desc_long (const std::string &raw_name, const std::string &desc)
void	set_feature_quote (const std::string &raw_name, const std::string &quote)
bool	describe_item (item_def &item, bool allow_inscribe=false, bool shopping=false)
void	get_item_desc (const item_def &item, describe_info &inf, bool terse=false)
void	inscribe_item (item_def &item, bool msgwin)
void	append_weapon_stats (std::string &description, const item_def &item)
void	append_armour_stats (std::string &description, const item_def &item)
void	append_missile_info (std::string &description)
void	describe_monsters (const monster_info &mi, bool force_seen=false, const std::string &footer="", bool wait_until_key_pressed=true)
void	get_monster_db_desc (const monster_info &mi, describe_info &inf, bool &has_stat_desc, bool force_seen=false)
void	get_spell_desc (const spell_type spell, describe_info &inf)
void	describe_spell (spell_type spelled, const item_def *item=NULL)
std::string	short_ghost_description (const monster *mon, bool abbrev=false)
std::string	get_ghost_description (const monster_info &mi, bool concise=false)
std::string	get_skill_description (skill_type skill, bool need_title=false)
void	describe_skill (skill_type skill)
void	print_description (const std::string &desc)
void	print_description (const describe_info &inf)
template<class T>
void	process_description (T &proc, const describe_info &inf)
void	trim_randart_inscrip (item_def &item)
std::string	artefact_auto_inscription (const item_def &item)
void	add_autoinscription (item_def &item, std::string ainscrip)
void	add_autoinscription (item_def &item)
void	add_inscription (item_def &item, std::string inscrip)
const char *	trap_name (trap_type trap)
int	str_to_trap (const std::string &s)
int	count_desc_lines (const std::string _desc, const int width)

---

Enumeration Type Documentation

enum book_mem_or_forget

Enumerator:

BOOK_MEM
BOOK_FORGET
BOOK_NEITHER

enum item_description_type

Enumerator:

IDESC_WANDS
IDESC_POTIONS
IDESC_SCROLLS
IDESC_RINGS
IDESC_SCROLLS_II
IDESC_STAVES
NUM_IDESC

---

Function Documentation

void add_autoinscription

(

item_def &

item

)

Here is the call graph for this function:

void add_autoinscription	(	item_def &	item,
		std::string	ainscrip
	)

Here is the call graph for this function:

void add_inscription	(	item_def &	item,
		std::string	inscrip
	)

Here is the call graph for this function:

void append_armour_stats	(	std::string &	description,
		const item_def &	item
	)

Here is the call graph for this function:

void append_missile_info

(

std::string &

description

)

void append_spells	(	std::string &	desc,
		const item_def &	item
	)

Here is the call graph for this function:

void append_weapon_stats	(	std::string &	description,
		const item_def &	item
	)

Here is the call graph for this function:

std::string artefact_auto_inscription

(

const item_def &

item

)

Here is the call graph for this function:

int count_desc_lines	(	const std::string	_desc,
		const int	width
	)

Here is the call graph for this function:

void describe_feature_wide

(

const coord_def &

pos

)

Here is the call graph for this function:

void describe_god	(	god_type	which_god,
		bool	give_title
	)

Here is the call graph for this function:

bool describe_item	(	item_def &	item,
		bool	allow_inscribe = false,
		bool	shopping = false
	)

Here is the call graph for this function:

void describe_monsters	(	const monster_info &	mi,
		bool	force_seen = false,
		const std::string &	footer = "",
		bool	wait_until_key_pressed = true
	)

Here is the call graph for this function:

void describe_skill

(

skill_type

skill

)

Here is the call graph for this function:

void describe_spell	(	spell_type	spelled,
		const item_def *	item = NULL
	)

Here is the call graph for this function:

void get_feature_desc	(	const coord_def &	gc,
		describe_info &	inf
	)

Here is the call graph for this function:

std::string get_ghost_description	(	const monster_info &	mi,
		bool	concise = false
	)

Here is the call graph for this function:

void get_item_desc	(	const item_def &	item,
		describe_info &	inf,
		bool	terse = false
	)

Here is the call graph for this function:

std::string get_item_description	(	const item_def &	item,
		bool	verbose,
		bool	dump = false,
		bool	noquote = false
	)

Here is the call graph for this function:

void get_monster_db_desc	(	const monster_info &	mi,
		describe_info &	inf,
		bool &	has_stat_desc,
		bool	force_seen = false
	)

Here is the call graph for this function:

std::string get_skill_description	(	skill_type	skill,
		bool	need_title = false
	)

Here is the call graph for this function:

void get_spell_desc	(	const spell_type	spell,
		describe_info &	inf
	)

std::string god_title	(	god_type	which_god,
		species_type	which_species
	)

Here is the call graph for this function:

void inscribe_item	(	item_def &	item,
		bool	msgwin
	)

Here is the call graph for this function:

bool is_dumpable_artefact	(	const item_def &	item,
		bool	verbose
	)

Here is the call graph for this function:

void print_description

(

const describe_info &

inf

)

Here is the call graph for this function:

void print_description

(

const std::string &

desc

)

Here is the call graph for this function:

template<class T>

void process_description	(	T &	proc,
		const describe_info &	inf
	)			[inline]

Here is the call graph for this function:

void set_feature_desc_long	(	const std::string &	raw_name,
		const std::string &	desc
	)

Here is the call graph for this function:

void set_feature_quote	(	const std::string &	raw_name,
		const std::string &	quote
	)

Here is the call graph for this function:

std::string short_ghost_description	(	const monster *	mon,
		bool	abbrev = false
	)

Here is the call graph for this function:

int str_to_trap

(

const std::string &

s

)

const char* trap_name

(

trap_type

trap

)

void trim_randart_inscrip

(

item_def &

item

)

Here is the call graph for this function: