#include <attack_type.hpp>

Inheritance diagram for attack_type:

Classes
class	specials_context_t

Public Types
using	AFFECTS = unit_ability_t::affects_t

Public Member Functions
	attack_type (const config &cfg)

const t_string &	name () const

const std::string &	id () const

const std::string &	type () const

const std::string &	icon () const

const std::string &	range () const

int	min_range () const

int	max_range () const

std::string	accuracy_parry_description () const

std::string	accuracy_parry_tooltip () const

int	accuracy () const

int	parry () const

int	damage () const

int	num_attacks () const

double	attack_weight () const

double	defense_weight () const

const ability_vector &	specials () const

config	specials_cfg () const

ability_vector	specials (const std::string &tag) const

void	set_name (const t_string &value)

void	set_id (const std::string &value)

void	set_type (const std::string &value)

void	set_icon (const std::string &value)

void	set_range (const std::string &value)

void	set_min_range (int value)

void	set_max_range (int value)

void	set_attack_alignment (const std::string &value)

void	set_accuracy (int value)

void	set_parry (int value)

void	set_damage (int value)

void	set_num_attacks (int value)

void	set_attack_weight (double value)

void	set_defense_weight (double value)

void	set_specials_cfg (const config &value)

active_ability_list	get_specials (const std::string &special) const
	Returns the currently active specials as an ability list, given the current context (see set_specials_context). More...

std::vector< unit_ability_t::tooltip_info >	special_tooltips (boost::dynamic_bitset<> *active_list=nullptr) const
	Returns a vector of names and descriptions for the specials of *this. More...

std::vector< unit_ability_t::tooltip_info >	abilities_special_tooltips (boost::dynamic_bitset<> *active_list) const

utils::optional< unit_alignments::type >	alignment () const
	Returns alignment specified by alignment_ variable. More...

std::string	alignment_str () const
	Returns alignment specified by alignment() for filtering when exist. More...

void	modified_attacks (unsigned &min_attacks, unsigned &max_attacks) const
	Calculates the number of attacks this weapon has, considering specials. More...

std::pair< std::string, std::set< std::string > >	damage_types () const
	Return a type()/replacement_type and a list of alternative_types that should be displayed in the selected unit's report. More...

std::pair< std::string, int >	effective_damage_type () const
	The type of attack used and the resistance value that does the most damage. More...

double	modified_damage () const
	Returns the damage per attack of this weapon, considering specials. More...

int	modified_chance_to_hit (int cth) const
	Return the defense value, considering specials. More...

int	composite_value (const active_ability_list &abil_list, int base_value) const
	Return the special weapon value, considering specials. More...

bool	has_filter_special_or_ability (const config &filter) const
	check if special matche More...

bool	attack_empty () const
	Returns true if this is a dummy attack_type, for example the placeholder that the unit_attack dialog uses when a defender has no weapon for a given range. More...

void	remove_special_by_filter (const config &filter)
	remove special if matche condition More...

bool	matches_filter (const config &filter, const std::string &check_if_recursion="") const
	Returns whether or not this matches the given filter*. More...

void	apply_effect (const config &cfg)
	Applies effect modifications described by cfg. More...

int	movement_used () const

void	set_movement_used (int value)

int	attacks_used () const

void	set_attacks_used (int value)

void	write (config &cfg) const

config	to_config () const

void	add_formula_context (wfl::map_formula_callable &) const

std::string	select_replacement_type (const active_ability_list &damage_type_list) const
	Select best damage type based on frequency count for replacement_type. More...

std::pair< std::string, int >	select_alternative_type (const active_ability_list &damage_type_list, const active_ability_list &resistance_list) const
	Select best damage type based on highest damage for alternative_type. More...

specials_context_t	specials_context (unit_const_ptr self, unit_const_ptr other, const map_location &unit_loc, const map_location &other_loc, bool attacking, const_attack_ptr other_attack) const

specials_context_t	specials_context (unit_const_ptr self, const map_location &loc, bool attacking=true) const

specials_context_t	specials_context_for_listing (bool attacking=true) const

void	set_changed (bool value)

bool	get_changed () const

Static Public Member Functions
static std::string	describe_effect (const config &cfg)
	Generates a description of the effect specified by cfg, if applicable. More...

Private Attributes
map_location	self_loc_

map_location	other_loc_

unit_const_ptr	self_

unit_const_ptr	other_

bool	is_attacker_

const_attack_ptr	other_attack_

bool	is_for_listing_ = false

t_string	description_

std::string	id_

std::string	type_

std::string	icon_

std::string	range_

int	min_range_

int	max_range_

utils::optional< unit_alignments::type >	alignment_

int	damage_

int	num_attacks_

double	attack_weight_

double	defense_weight_

int	accuracy_

int	movement_used_

int	attacks_used_

int	parry_

ability_vector	specials_

bool	changed_

Friends
class	specials_context_t

already added
std::string	describe_weapon_specials () const
	Returns a comma-separated string of active names for the specials of *this. More...

std::string	describe_weapon_specials_value (const std::set< std::string > &checking_tags) const

active_ability_list	get_weapon_ability (const std::string &ability) const
	Returns list for weapon like abilities for each ability type. More...

active_ability_list	get_specials_and_abilities (const std::string &special) const

bool	has_special_or_ability (const std::string &special) const
	used for abilities used like weapon and true specials More...

bool	has_active_special_or_ability_id (const std::string &special) const

bool	has_special_or_ability_with_filter (const config &filter) const
	check if special matche More...

active_ability_list	overwrite_special_overwriter (active_ability_list overwriters) const
	Filter a list of abilities or weapon specials, removing any entries that don't own the overwrite_specials attributes. More...

bool	overwrite_special_checking (active_ability_list &overwriters, const unit_ability_t &ab) const
	Check whether cfg would be overwritten by any element of overwriters. More...

bool	special_active (const unit_ability_t &ab, AFFECTS whom) const

bool	special_tooltip_active (const unit_ability_t &ab) const
	Returns whether or not the given special is active for the specified unit disregarding other units, based on the current context (see specials_context). More...

static void	weapon_specials_impl_self (std::string &temp_string, const unit_const_ptr &self, const const_attack_ptr &self_attack, const const_attack_ptr &other_attack, const map_location &self_loc, AFFECTS whom, std::set< std::string > &checking_name, const std::set< std::string > &checking_tags={})
	weapon_specials_impl_self and weapon_specials_impl_adj : check if special name can be added. More...

static void	weapon_specials_impl_adj (std::string &temp_string, const unit_const_ptr &self, const const_attack_ptr &self_attack, const const_attack_ptr &other_attack, const map_location &self_loc, AFFECTS whom, std::set< std::string > &checking_name, const std::set< std::string > &checking_tags={}, const std::string &affect_adjacents="")

static bool	special_active_impl (const const_attack_ptr &self_attack, const const_attack_ptr &other_attack, const unit_ability_t &special, AFFECTS whom)
	Returns whether or not the given special is active for the specified unit, based on the current context (see set_specials_context). More...

Detailed Description

Definition at line 40 of file attack_type.hpp.

Member Typedef Documentation

◆ AFFECTS

using attack_type::AFFECTS = unit_ability_t::affects_t

Definition at line 192 of file attack_type.hpp.

Constructor & Destructor Documentation

◆ attack_type()

attack_type::attack_type ( const config & cfg )

explicit

Definition at line 55 of file attack_type.cpp.

References unit_type_data::add_registry_entries(), cfg, description_, translation::egettext(), t_string::empty(), icon_, id_, unit_ability_t::parse_vector(), unit_type_data::specials(), specials_, specials_cfg(), and unit_types.

Member Function Documentation

◆ abilities_special_tooltips()

std::vector< unit_ability_t::tooltip_info > attack_type::abilities_special_tooltips ( boost::dynamic_bitset<> * active_list ) const

Definition at line 1066 of file abilities.cpp.

◆ accuracy()

int attack_type::accuracy ( ) const

inline

Definition at line 54 of file attack_type.hpp.

References accuracy_.

Referenced by impl_unit_attack_get(), and matches_simple_filter().

◆ accuracy_parry_description()

std::string attack_type::accuracy_parry_description ( ) const

Definition at line 93 of file attack_type.cpp.

References accuracy_, parry_, s, and utils::signed_percent().

◆ accuracy_parry_tooltip()

std::string attack_type::accuracy_parry_tooltip ( ) const

Definition at line 109 of file attack_type.cpp.

References _(), accuracy_, markup::bold(), parry_, utils::signed_percent(), and tooltip.

◆ add_formula_context()

void attack_type::add_formula_context ( wfl::map_formula_callable & callable ) const

Definition at line 855 of file abilities.cpp.

References wfl::map_formula_callable::add().

◆ alignment()

utils::optional<unit_alignments::type> attack_type::alignment ( ) const

inline

Returns alignment specified by alignment_ variable.

Definition at line 104 of file attack_type.hpp.

References alignment_.

◆ alignment_str()

std::string attack_type::alignment_str ( ) const

inline

Returns alignment specified by alignment() for filtering when exist.

Definition at line 107 of file attack_type.hpp.

References alignment_, and string_enums::enum_base< Definition >::get_string().

Referenced by impl_unit_attack_get(), matches_simple_filter(), and write().

◆ apply_effect()

void attack_type::apply_effect ( const config & cfg )

Applies effect modifications described by cfg.

Definition at line 340 of file attack_type.cpp.

References accuracy_, unit_type_data::add_registry_entries(), alignment_, config::all_children_view(), utils::apply_modifier(), attack_weight_, attacks_used_, cfg, utils::contains(), unit_ability_t::create(), damage_, defense_weight_, deprecated_message(), description_, config_attribute_value::empty(), t_string::empty(), string_enums::enum_base< Definition >::get_enum(), icon_, id_, INDEFINITE, max_range_, min_range_, movement_used_, num_attacks_, config::optional_child(), parry_, range_, remove_special_by_filter(), set_accuracy(), set_attack_alignment(), set_attack_weight(), set_attacks_used(), set_changed(), set_damage(), set_defense_weight(), set_icon(), set_max_range(), set_min_range(), set_name(), set_parry(), set_range(), set_type(), unit_type_data::specials(), specials_, utils::split(), config_attribute_value::to_int(), type_, and unit_types.

◆ attack_empty()

bool attack_type::attack_empty ( ) const

inline

Returns true if this is a dummy attack_type, for example the placeholder that the unit_attack dialog uses when a defender has no weapon for a given range.

Definition at line 155 of file attack_type.hpp.

References name(), range(), and type().

Referenced by effective_damage_type().

◆ attack_weight()

double attack_type::attack_weight ( ) const

inline

Definition at line 58 of file attack_type.hpp.

References attack_weight_.

Referenced by battle_context::choose_attacker_weapon(), and impl_unit_attack_get().

◆ attacks_used()

int attack_type::attacks_used ( ) const

inline

Definition at line 181 of file attack_type.hpp.

References attacks_used_.

Referenced by impl_unit_attack_get(), and matches_simple_filter().

◆ composite_value()

int attack_type::composite_value	(	const active_ability_list &	abil_list,
		int	base_value
	)		const

Return the special weapon value, considering specials.

Parameters

abil_list	The list of special checked.
base_value	The value modified or not by function.

Definition at line 696 of file attack_type.cpp.

References unit_abilities::effect::get_composite_value().

Referenced by modified_attacks(), and modified_chance_to_hit().

◆ damage()

int attack_type::damage ( ) const

inline

Definition at line 56 of file attack_type.hpp.

References damage_.

Referenced by impl_unit_attack_get(), matches_simple_filter(), modified_damage(), and events::mouse_handler::show_attack_dialog().

◆ damage_types()

std::pair< std::string, std::set< std::string > > attack_type::damage_types ( ) const

Return a type()/replacement_type and a list of alternative_types that should be displayed in the selected unit's report.

Returns: A type()/replacement_type and a list of alternative_types that should be displayed in the selected unit's report.

Definition at line 824 of file attack_type.cpp.

References c, active_ability_list::empty(), get_specials_and_abilities(), i, select_replacement_type(), and type().

◆ defense_weight()

double attack_type::defense_weight ( ) const

inline

Definition at line 59 of file attack_type.hpp.

References defense_weight_.

Referenced by battle_context::choose_defender_weapon(), and impl_unit_attack_get().

◆ describe_effect()

std::string attack_type::describe_effect ( const config & cfg )

static

Generates a description of the effect specified by cfg, if applicable.

This covers a subset of the effects which can be applied via apply_effect.

Definition at line 517 of file attack_type.cpp.

References cfg, config_attribute_value::empty(), utils::print_modifier(), set_accuracy(), set_attacks_used(), set_damage(), set_max_range(), set_min_range(), set_parry(), config_attribute_value::to_int(), VGETTEXT, and VNGETTEXT.

Referenced by unit::describe_builtin_effect().

◆ describe_weapon_specials()

std::string attack_type::describe_weapon_specials ( ) const

Returns a comma-separated string of active names for the specials of *this.

Empty names are skipped.

Whether or not a special is active depends on the current context (see set_specials_context)

Definition at line 1124 of file abilities.cpp.

References font::INACTIVE_COLOR, utils::join(), and markup::span_color().

Referenced by events::mouse_handler::show_attack_dialog().

◆ describe_weapon_specials_value()

std::string attack_type::describe_weapon_specials_value ( const std::set< std::string > & checking_tags ) const

Definition at line 1170 of file abilities.cpp.

References _(), add_name(), add_name_list(), and desktop::notifications::OTHER.

Referenced by events::mouse_handler::show_attack_dialog().

◆ effective_damage_type()

std::pair< std::string, int > attack_type::effective_damage_type ( ) const

The type of attack used and the resistance value that does the most damage.

Returns: The type of attack used and the resistance value that does the most damage.

Definition at line 793 of file attack_type.cpp.

References attack_empty(), active_ability_list::empty(), utils::erase_if(), get_specials_and_abilities(), i, is_attacker_, other_, other_attack_, other_loc_, select_alternative_type(), select_replacement_type(), and type().

Referenced by matches_simple_filter(), and events::mouse_handler::show_attack_dialog().

◆ get_changed()

bool attack_type::get_changed ( ) const

inline

Definition at line 316 of file attack_type.hpp.

References changed_.

◆ get_specials()

active_ability_list attack_type::get_specials ( const std::string & special ) const

Returns the currently active specials as an ability list, given the current context (see set_specials_context).

Definition at line 1001 of file abilities.cpp.

References active_ability_list::emplace_back(), loc, and desktop::notifications::OTHER.

Referenced by get_specials_and_abilities().

◆ get_specials_and_abilities()

active_ability_list attack_type::get_specials_and_abilities ( const std::string & special ) const

Parameters

special the tag name to check for

Returns: list which contains get_weapon_ability and get_specials list for each ability type, with overwritten items removed

Definition at line 1496 of file abilities.cpp.

References active_ability::ability(), active_ability_list::append(), active_ability_list::empty(), utils::erase_if(), get_specials(), get_weapon_ability(), overwrite_special_checking(), and overwrite_special_overwriter().

Referenced by damage_types(), effective_damage_type(), modified_attacks(), modified_chance_to_hit(), and modified_damage().

◆ get_weapon_ability()

active_ability_list attack_type::get_weapon_ability ( const std::string & ability ) const

Returns list for weapon like abilities for each ability type.

Definition at line 1477 of file abilities.cpp.

References active_ability_list::append_if(), i, loc, other_, other_loc_, self_, and self_loc_.

Referenced by get_specials_and_abilities().

◆ has_active_special_or_ability_id()

bool attack_type::has_active_special_or_ability_id ( const std::string & special ) const

Parameters

special id to check.

Definition at line 1660 of file abilities.cpp.

References other_, other_attack_, other_loc_, range(), self_, and self_loc_.

Referenced by matches_simple_filter().

◆ has_filter_special_or_ability()

bool attack_type::has_filter_special_or_ability ( const config & filter ) const

check if special matche

Returns: True if special matche with filter(if 'active' filter is true, check if special active).

Parameters

filter contain attributes to check(special_id, special_type etc...).

Definition at line 144 of file attack_type.cpp.

References utils::views::filter, range(), specials(), and utils::split_set().

Referenced by matches_simple_filter().

◆ has_special_or_ability()

bool attack_type::has_special_or_ability ( const std::string & special ) const

used for abilities used like weapon and true specials

Returns whether or not *this has a special ability with a tag or id equal to special.

Returns: True if the ability special is active.

Parameters

special The special being checked.

the Check is for a special ability active in the current context (see set_specials_context), including specials obtained from the opponent's attack.

Definition at line 1636 of file abilities.cpp.

References other_, other_attack_, other_loc_, range(), self_, and self_loc_.

Referenced by matches_simple_filter().

◆ has_special_or_ability_with_filter()

bool attack_type::has_special_or_ability_with_filter ( const config & filter ) const

check if special matche

Returns: True if special matche with filter(if 'active' filter is true, check if special active).

Parameters

filter if special check with filter, return true.

Definition at line 1895 of file abilities.cpp.

References utils::views::filter, utils::find_if(), other_, other_attack_, other_loc_, range(), self_, self_loc_, and specials().

Referenced by matches_simple_filter().

◆ icon()

const std::string& attack_type::icon ( ) const

inline

Definition at line 48 of file attack_type.hpp.

References icon_.

Referenced by impl_unit_attack_get(), and events::mouse_handler::show_attack_dialog().

◆ id()

const std::string& attack_type::id ( ) const

inline

Definition at line 46 of file attack_type.hpp.

References id_.

Referenced by impl_unit_attack_get(), and matches_simple_filter().

◆ matches_filter()

bool attack_type::matches_filter	(	const config &	filter,
		const std::string &	check_if_recursion = `""`
	)		const

Returns whether or not *this matches the given filter.

Definition at line 304 of file attack_type.cpp.

References utils::views::filter, and matches_simple_filter().

◆ max_range()

int attack_type::max_range ( ) const

inline

Definition at line 51 of file attack_type.hpp.

References max_range_.

Referenced by impl_unit_attack_get(), and matches_simple_filter().

◆ min_range()

int attack_type::min_range ( ) const

inline

Definition at line 50 of file attack_type.hpp.

References min_range_.

Referenced by impl_unit_attack_get(), and matches_simple_filter().

◆ modified_attacks()

void attack_type::modified_attacks	(	unsigned &	min_attacks,
		unsigned &	max_attacks
	)		const

Calculates the number of attacks this weapon has, considering specials.

This returns two numbers because of the swarm special. The actual number of attacks depends on the unit's health and should be: min_attacks + (max_attacks - min_attacks) * (current hp) / (max hp) c.f. swarm_blows()

Definition at line 709 of file attack_type.cpp.

References composite_value(), active_ability_list::empty(), ERR_NG, get_specials_and_abilities(), active_ability_list::highest(), and num_attacks().

◆ modified_chance_to_hit()

int attack_type::modified_chance_to_hit ( int cth ) const

Return the defense value, considering specials.

Parameters

cth	The chance_to_hit value modified or not by function.

Definition at line 850 of file attack_type.cpp.

References accuracy_, composite_value(), get_specials_and_abilities(), other_attack_, and parry().

◆ modified_damage()

double attack_type::modified_damage ( ) const

Returns the damage per attack of this weapon, considering specials.

Definition at line 845 of file attack_type.cpp.

References damage(), unit_abilities::effect::get_composite_double_value(), and get_specials_and_abilities().

◆ movement_used()

int attack_type::movement_used ( ) const

inline

Definition at line 179 of file attack_type.hpp.

References movement_used_.

Referenced by impl_unit_attack_get(), and matches_simple_filter().

◆ name()

const t_string& attack_type::name ( ) const

inline

Definition at line 45 of file attack_type.hpp.

References description_.

Referenced by attack_empty(), impl_unit_attack_get(), and events::mouse_handler::show_attack_dialog().

◆ num_attacks()

int attack_type::num_attacks ( ) const

inline

Definition at line 57 of file attack_type.hpp.

References num_attacks_.

Referenced by impl_unit_attack_get(), matches_simple_filter(), modified_attacks(), and events::mouse_handler::show_attack_dialog().

◆ overwrite_special_checking()

bool attack_type::overwrite_special_checking	(	active_ability_list &	overwriters,
		const unit_ability_t &	ab
	)		const

Check whether cfg would be overwritten by any element of overwriters.

Returns: True if element checked is overwritable.

Parameters

overwriters	list used for check if element is overwritable.
ab	the ability/special checked

Definition at line 1555 of file abilities.cpp.

References unit_ability_t::cfg(), deprecated_message(), active_ability_list::empty(), INDEFINITE, is_attacker_, unit_ability_t::matches_filter(), config::optional_child(), and overwrite_special_affects().

Referenced by get_specials_and_abilities(), and overwrite_special_overwriter().

◆ overwrite_special_overwriter()

active_ability_list attack_type::overwrite_special_overwriter ( active_ability_list overwriters ) const

Filter a list of abilities or weapon specials, removing any entries that don't own the overwrite_specials attributes.

Parameters

overwriters list that may have overwrite_specials attributes.

Definition at line 1519 of file abilities.cpp.

References active_ability::ability_cfg(), active_ability_list::empty(), utils::erase_if(), i, overwrite_special_affects(), overwrite_special_checking(), active_ability_list::size(), and utils::sort_if().

Referenced by get_specials_and_abilities().

◆ parry()

int attack_type::parry ( ) const

inline

Definition at line 55 of file attack_type.hpp.

References parry_.

Referenced by impl_unit_attack_get(), matches_simple_filter(), and modified_chance_to_hit().

◆ range()

const std::string& attack_type::range ( ) const

inline

Definition at line 49 of file attack_type.hpp.

References range_.

Referenced by attack_empty(), battle_context::choose_defender_weapon(), has_active_special_or_ability_id(), has_filter_special_or_ability(), has_special_or_ability(), has_special_or_ability_with_filter(), impl_unit_attack_get(), matches_simple_filter(), and events::mouse_handler::show_attack_dialog().

◆ remove_special_by_filter()

void attack_type::remove_special_by_filter ( const config & filter )

remove special if matche condition

Parameters

filter if special check with filter, it will be removed.

Definition at line 328 of file attack_type.cpp.

References utils::views::filter, i, and specials_.

Referenced by apply_effect().

◆ select_alternative_type()

std::pair< std::string, int > attack_type::select_alternative_type	(	const active_ability_list &	damage_type_list,
		const active_ability_list &	resistance_list
	)		const

Select best damage type based on highest damage for alternative_type.

Parameters

damage_type_list	list of [damage_type] to check.
resistance_list	list of "resistance" abilities to check for each type of damage checked.

Definition at line 760 of file attack_type.cpp.

References c, i, other_, and type().

Referenced by effective_damage_type().

◆ select_replacement_type()

std::string attack_type::select_replacement_type ( const active_ability_list & damage_type_list ) const

Select best damage type based on frequency count for replacement_type.

Parameters

damage_type_list list of [damage_type] to check.

Definition at line 731 of file attack_type.cpp.

References c, i, and type().

Referenced by damage_types(), and effective_damage_type().

◆ set_accuracy()

void attack_type::set_accuracy ( int value )

inline

Definition at line 78 of file attack_type.hpp.

References accuracy_, and set_changed().

Referenced by apply_effect(), describe_effect(), and impl_unit_attack_set().

◆ set_attack_alignment()

void attack_type::set_attack_alignment ( const std::string & value )

inline

Definition at line 77 of file attack_type.hpp.

References alignment_, string_enums::enum_base< Definition >::get_enum(), and set_changed().

Referenced by apply_effect().

◆ set_attack_weight()

void attack_type::set_attack_weight ( double value )

inline

Definition at line 82 of file attack_type.hpp.

References attack_weight_, and set_changed().

Referenced by apply_effect(), and impl_unit_attack_set().

◆ set_attacks_used()

void attack_type::set_attacks_used ( int value )

inline

Definition at line 182 of file attack_type.hpp.

References attacks_used_.

Referenced by apply_effect(), describe_effect(), and impl_unit_attack_set().

◆ set_changed()

void attack_type::set_changed ( bool value )

inline

Definition at line 312 of file attack_type.hpp.

References changed_.

Referenced by apply_effect(), set_accuracy(), set_attack_alignment(), set_attack_weight(), set_damage(), set_defense_weight(), set_icon(), set_id(), set_max_range(), set_min_range(), set_name(), set_num_attacks(), set_parry(), set_range(), set_specials_cfg(), and set_type().

◆ set_damage()

void attack_type::set_damage ( int value )

inline

Definition at line 80 of file attack_type.hpp.

References damage_, and set_changed().

Referenced by apply_effect(), describe_effect(), and impl_unit_attack_set().

◆ set_defense_weight()

void attack_type::set_defense_weight ( double value )

inline

Definition at line 83 of file attack_type.hpp.

References defense_weight_, and set_changed().

Referenced by apply_effect(), and impl_unit_attack_set().

◆ set_icon()

void attack_type::set_icon ( const std::string & value )

inline

Definition at line 73 of file attack_type.hpp.

References icon_, and set_changed().

Referenced by apply_effect(), and impl_unit_attack_set().

◆ set_id()

void attack_type::set_id ( const std::string & value )

inline

Definition at line 71 of file attack_type.hpp.

References id_, and set_changed().

Referenced by impl_unit_attack_set().

◆ set_max_range()

void attack_type::set_max_range ( int value )

inline

Definition at line 76 of file attack_type.hpp.

References max_range_, and set_changed().

Referenced by apply_effect(), describe_effect(), and impl_unit_attack_set().

◆ set_min_range()

void attack_type::set_min_range ( int value )

inline

Definition at line 75 of file attack_type.hpp.

References min_range_, and set_changed().

Referenced by apply_effect(), describe_effect(), and impl_unit_attack_set().

◆ set_movement_used()

void attack_type::set_movement_used ( int value )

inline

Definition at line 180 of file attack_type.hpp.

References movement_used_.

Referenced by impl_unit_attack_set().

◆ set_name()

void attack_type::set_name ( const t_string & value )

inline

Definition at line 70 of file attack_type.hpp.

References description_, and set_changed().

Referenced by apply_effect(), and impl_unit_attack_set().

◆ set_num_attacks()

void attack_type::set_num_attacks ( int value )

inline

Definition at line 81 of file attack_type.hpp.

References num_attacks_, and set_changed().

Referenced by impl_unit_attack_set().

◆ set_parry()

void attack_type::set_parry ( int value )

inline

Definition at line 79 of file attack_type.hpp.

References parry_, and set_changed().

Referenced by apply_effect(), describe_effect(), and impl_unit_attack_set().

◆ set_range()

void attack_type::set_range ( const std::string & value )

inline

Definition at line 74 of file attack_type.hpp.

References range_, and set_changed().

Referenced by apply_effect(), and impl_unit_attack_set().

◆ set_specials_cfg()

void attack_type::set_specials_cfg ( const config & value )

inline

Definition at line 84 of file attack_type.hpp.

References unit_ability_t::cfg_to_vector(), set_changed(), and specials_.

Referenced by impl_unit_attack_set().

◆ set_type()

void attack_type::set_type ( const std::string & value )

inline

Definition at line 72 of file attack_type.hpp.

References set_changed(), and type_.

Referenced by apply_effect(), and impl_unit_attack_set().

◆ special_active()

bool attack_type::special_active	(	const unit_ability_t &	ab,
		AFFECTS	whom
	)		const

Definition at line 1923 of file abilities.cpp.

References other_attack_, and special_active_impl().

◆ special_active_impl()

bool attack_type::special_active_impl	(	const const_attack_ptr &	self_attack,
		const const_attack_ptr &	other_attack,
		const unit_ability_t &	ab,
		AFFECTS	whom
	)

static

Returns whether or not the given special is active for the specified unit, based on the current context (see set_specials_context).

Parameters

self_attack	this unit's attack
other_attack	the other unit's attack
ab	the ability
whom	specifies which combatant we care about

Definition at line 1959 of file abilities.cpp.

References unit_ability_t::active_on_matches(), unit_ability_t::apply_to(), unit_ability_t::both, unit_ability_t::EITHER, unit_map::find(), map_location::get_relative_dir(), unit_map::iterator_base< iter_types >::get_shared_ptr(), unit_ability_t::in_specials_tag(), unit_ability_t::OTHER, unit_ability_t::SELF, unit_ability_t::tag(), and unit_map::iterator_base< iter_types >::valid().

Referenced by unit::get_abilities_weapons(), and special_active().

◆ special_tooltip_active()

bool attack_type::special_tooltip_active ( const unit_ability_t & ab ) const

Returns whether or not the given special is active for the specified unit disregarding other units, based on the current context (see specials_context).

Parameters

ab	the ability/special

Definition at line 2071 of file abilities.cpp.

References unit_ability_t::apply_to(), unit_ability_t::both, is_attacker_, is_for_listing_, other_, self_, and self_loc_.

◆ special_tooltips()

std::vector< unit_ability_t::tooltip_info > attack_type::special_tooltips ( boost::dynamic_bitset<> * active_list = nullptr ) const

Returns a vector of names and descriptions for the specials of *this.

Each std::pair in the vector has first = name and second = description.

This uses either the active or inactive name/description for each special, based on the current context (see set_specials_context), provided active_list is not nullptr. Otherwise specials are assumed active. If the appropriate name is empty, the special is skipped.

Definition at line 1034 of file abilities.cpp.

◆ specials() [1/2]

const ability_vector& attack_type::specials ( ) const

inline

Definition at line 60 of file attack_type.hpp.

References specials_.

Referenced by has_filter_special_or_ability(), and has_special_or_ability_with_filter().

◆ specials() [2/2]

ability_vector attack_type::specials ( const std::string & tag ) const

inline

Definition at line 66 of file attack_type.hpp.

References unit_ability_t::filter_tag(), specials_, and markup::tag().

◆ specials_cfg()

config attack_type::specials_cfg ( ) const

inline

Definition at line 62 of file attack_type.hpp.

References specials_, and unit_ability_t::vector_to_cfg().

Referenced by attack_type(), impl_unit_attack_get(), and write().

◆ specials_context() [1/2]

specials_context_t attack_type::specials_context	(	unit_const_ptr	self,
		const map_location &	loc,
		bool	attacking = `true`
	)		const

inline

Definition at line 306 of file attack_type.hpp.

References loc, and specials_context_t.

◆ specials_context() [2/2]

specials_context_t attack_type::specials_context	(	unit_const_ptr	self,
		unit_const_ptr	other,
		const map_location &	unit_loc,
		const map_location &	other_loc,
		bool	attacking,
		const_attack_ptr	other_attack
	)		const

inline

Definition at line 301 of file attack_type.hpp.

References specials_context_t.

Referenced by events::mouse_handler::show_attack_dialog(), and unit_display::unit_attack().

◆ specials_context_for_listing()

specials_context_t attack_type::specials_context_for_listing ( bool attacking = true ) const

inline

Definition at line 309 of file attack_type.hpp.

References specials_context_t.

◆ to_config()

config attack_type::to_config ( ) const

inline

Definition at line 185 of file attack_type.hpp.

References c, and write().

Referenced by impl_unit_attack_get().

◆ type()

const std::string& attack_type::type ( ) const

inline

Definition at line 47 of file attack_type.hpp.

References type_.

Referenced by attack_empty(), damage_types(), effective_damage_type(), impl_unit_attack_get(), matches_simple_filter(), select_alternative_type(), select_replacement_type(), unit_abilities::individual_effect::set(), and events::mouse_handler::show_attack_dialog().

◆ weapon_specials_impl_adj()

void attack_type::weapon_specials_impl_adj	(	std::string &	temp_string,
		const unit_const_ptr &	self,
		const const_attack_ptr &	self_attack,
		const const_attack_ptr &	other_attack,
		const map_location &	self_loc,
		AFFECTS	whom,
		std::set< std::string > &	checking_name,
		const std::set< std::string > &	checking_tags = `{}`,
		const std::string &	affect_adjacents = `""`
	)

static

Definition at line 1232 of file abilities.cpp.

References add_name().

◆ weapon_specials_impl_self()

void attack_type::weapon_specials_impl_self	(	std::string &	temp_string,
		const unit_const_ptr &	self,
		const const_attack_ptr &	self_attack,
		const const_attack_ptr &	other_attack,
		const map_location &	self_loc,
		AFFECTS	whom,
		std::set< std::string > &	checking_name,
		const std::set< std::string > &	checking_tags = `{}`
	)

static

weapon_specials_impl_self and weapon_specials_impl_adj : check if special name can be added.

Parameters

[in,out]	temp_string	the string modified and returned
[in]	self	the unit checked.
[in]	self_attack	the attack used by unit checked in this function.
[in]	other_attack	the attack used by opponent to unit checked.
[in]	self_loc	location of the unit checked.
[in]	whom	determine if unit affected or not by special ability.
[in,out]	checking_name	the reference for checking if a name is already added
[in]	checking_tags	the reference for checking if special ability type can be used

Definition at line 1210 of file abilities.cpp.

References add_name().

◆ write()

void attack_type::write ( config & cfg ) const

Definition at line 673 of file attack_type.cpp.

References accuracy_, config::add_child(), alignment_str(), attack_weight_, attacks_used_, cfg, damage_, defense_weight_, description_, icon_, id_, max_range_, min_range_, movement_used_, num_attacks_, parry_, range_, specials_cfg(), and type_.

Referenced by to_config().

Friends And Related Function Documentation

◆ specials_context_t

friend class specials_context_t

friend

Definition at line 272 of file attack_type.hpp.

Referenced by specials_context(), and specials_context_for_listing().

Member Data Documentation

◆ accuracy_

int attack_type::accuracy_

private

Definition at line 334 of file attack_type.hpp.

Referenced by accuracy(), accuracy_parry_description(), accuracy_parry_tooltip(), apply_effect(), modified_chance_to_hit(), set_accuracy(), and write().

◆ alignment_

utils::optional<unit_alignments::type> attack_type::alignment_

private

Definition at line 328 of file attack_type.hpp.

Referenced by alignment(), alignment_str(), apply_effect(), and set_attack_alignment().

◆ attack_weight_

double attack_type::attack_weight_

private

Definition at line 331 of file attack_type.hpp.

Referenced by apply_effect(), attack_weight(), set_attack_weight(), and write().

◆ attacks_used_

int attack_type::attacks_used_

private

Definition at line 336 of file attack_type.hpp.

Referenced by apply_effect(), attacks_used(), set_attacks_used(), and write().

◆ changed_

bool attack_type::changed_

private

Definition at line 339 of file attack_type.hpp.

Referenced by get_changed(), and set_changed().

◆ damage_

int attack_type::damage_

private

Definition at line 329 of file attack_type.hpp.

Referenced by apply_effect(), damage(), set_damage(), and write().

◆ defense_weight_

double attack_type::defense_weight_

private

Definition at line 332 of file attack_type.hpp.

Referenced by apply_effect(), defense_weight(), set_defense_weight(), and write().

◆ description_

t_string attack_type::description_

private

Definition at line 322 of file attack_type.hpp.

Referenced by apply_effect(), attack_type(), name(), set_name(), and write().

◆ icon_

std::string attack_type::icon_

private

Definition at line 325 of file attack_type.hpp.

Referenced by apply_effect(), attack_type(), icon(), set_icon(), and write().

◆ id_

std::string attack_type::id_

private

Definition at line 323 of file attack_type.hpp.

Referenced by apply_effect(), attack_type(), id(), set_id(), and write().

◆ is_attacker_

bool attack_type::is_attacker_

mutableprivate

Definition at line 276 of file attack_type.hpp.

Referenced by effective_damage_type(), overwrite_special_checking(), special_tooltip_active(), and attack_type::specials_context_t::specials_context_t().

◆ is_for_listing_

bool attack_type::is_for_listing_ = false

mutableprivate

Definition at line 278 of file attack_type.hpp.

Referenced by special_tooltip_active(), and attack_type::specials_context_t::specials_context_t().

◆ max_range_

int attack_type::max_range_

private

Definition at line 327 of file attack_type.hpp.

Referenced by apply_effect(), max_range(), set_max_range(), and write().

◆ min_range_

int attack_type::min_range_

private

Definition at line 327 of file attack_type.hpp.

Referenced by apply_effect(), min_range(), set_min_range(), and write().

◆ movement_used_

int attack_type::movement_used_

private

Definition at line 335 of file attack_type.hpp.

Referenced by apply_effect(), movement_used(), set_movement_used(), and write().

◆ num_attacks_

int attack_type::num_attacks_

private

Definition at line 330 of file attack_type.hpp.

Referenced by apply_effect(), num_attacks(), set_num_attacks(), and write().

◆ other_

unit_const_ptr attack_type::other_

mutableprivate

Definition at line 275 of file attack_type.hpp.

Referenced by effective_damage_type(), get_weapon_ability(), has_active_special_or_ability_id(), has_special_or_ability(), has_special_or_ability_with_filter(), select_alternative_type(), special_tooltip_active(), and attack_type::specials_context_t::specials_context_t().

◆ other_attack_

const_attack_ptr attack_type::other_attack_

mutableprivate

Definition at line 277 of file attack_type.hpp.

Referenced by effective_damage_type(), has_active_special_or_ability_id(), has_special_or_ability(), has_special_or_ability_with_filter(), modified_chance_to_hit(), special_active(), and attack_type::specials_context_t::specials_context_t().

◆ other_loc_

map_location attack_type::other_loc_

private

Definition at line 273 of file attack_type.hpp.

Referenced by effective_damage_type(), get_weapon_ability(), has_active_special_or_ability_id(), has_special_or_ability(), has_special_or_ability_with_filter(), and attack_type::specials_context_t::specials_context_t().

◆ parry_

int attack_type::parry_

private

Definition at line 337 of file attack_type.hpp.

Referenced by accuracy_parry_description(), accuracy_parry_tooltip(), apply_effect(), parry(), set_parry(), and write().

◆ range_

std::string attack_type::range_

private

Definition at line 326 of file attack_type.hpp.

Referenced by apply_effect(), range(), set_range(), and write().

◆ self_

unit_const_ptr attack_type::self_

mutableprivate

Definition at line 274 of file attack_type.hpp.

Referenced by get_weapon_ability(), has_active_special_or_ability_id(), has_special_or_ability(), has_special_or_ability_with_filter(), special_tooltip_active(), and attack_type::specials_context_t::specials_context_t().

◆ self_loc_

map_location attack_type::self_loc_

mutableprivate

Definition at line 273 of file attack_type.hpp.

Referenced by get_weapon_ability(), has_active_special_or_ability_id(), has_special_or_ability(), has_special_or_ability_with_filter(), special_tooltip_active(), and attack_type::specials_context_t::specials_context_t().

◆ specials_

ability_vector attack_type::specials_

private

Definition at line 338 of file attack_type.hpp.

Referenced by apply_effect(), attack_type(), remove_special_by_filter(), set_specials_cfg(), specials(), and specials_cfg().

◆ type_

std::string attack_type::type_

private

Definition at line 324 of file attack_type.hpp.

Referenced by apply_effect(), set_type(), type(), and write().

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

already added

Detailed Description

Member Typedef Documentation

◆ AFFECTS

Constructor & Destructor Documentation

◆ attack_type()

Member Function Documentation

◆ abilities_special_tooltips()

◆ accuracy()

◆ accuracy_parry_description()

◆ accuracy_parry_tooltip()

◆ add_formula_context()

◆ alignment()

◆ alignment_str()

◆ apply_effect()

◆ attack_empty()

◆ attack_weight()

◆ attacks_used()

◆ composite_value()

◆ damage()

◆ damage_types()

◆ defense_weight()

◆ describe_effect()

◆ describe_weapon_specials()

◆ describe_weapon_specials_value()

◆ effective_damage_type()

◆ get_changed()

◆ get_specials()

◆ get_specials_and_abilities()

◆ get_weapon_ability()

◆ has_active_special_or_ability_id()

◆ has_filter_special_or_ability()

◆ has_special_or_ability()

◆ has_special_or_ability_with_filter()

◆ icon()

◆ id()

◆ matches_filter()

◆ max_range()

◆ min_range()

◆ modified_attacks()

◆ modified_chance_to_hit()

◆ modified_damage()

◆ movement_used()

◆ name()

◆ num_attacks()

◆ overwrite_special_checking()

◆ overwrite_special_overwriter()

◆ parry()

◆ range()

◆ remove_special_by_filter()

◆ select_alternative_type()

◆ select_replacement_type()

◆ set_accuracy()

◆ set_attack_alignment()

◆ set_attack_weight()

◆ set_attacks_used()

◆ set_changed()

◆ set_damage()

◆ set_defense_weight()

◆ set_icon()

◆ set_id()

◆ set_max_range()

◆ set_min_range()

◆ set_movement_used()

◆ set_name()

◆ set_num_attacks()

◆ set_parry()

◆ set_range()

◆ set_specials_cfg()

◆ set_type()

◆ special_active()

◆ special_active_impl()

◆ special_tooltip_active()

◆ special_tooltips()