The Battle for Wesnoth  1.13.10+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Public Attributes | Private Attributes | List of all members
ai::candidate_action Class Referenceabstract

#include <rca.hpp>

Inheritance diagram for ai::candidate_action:
Inheritance graph

Public Member Functions

 candidate_action (rca_context &context, const config &cfg)
 
virtual ~candidate_action ()
 Destructor. More...
 
virtual double evaluate ()=0
 Evaluate the candidate action, resetting the internal state of the action. More...
 
virtual void execute ()=0
 Execute the candidate action. More...
 
bool is_enabled () const
 Is this candidate action enabled ? More...
 
void enable ()
 Enable the candidate action. More...
 
void disable ()
 Disable the candidate action. More...
 
double get_score () const
 Get the usual score of the candidate action without re-evaluation. More...
 
double get_max_score () const
 Get the upper bound of the score of the candidate action without re-evaluation. More...
 
virtual std::string get_name () const
 Get the name of the candidate action (useful for debug purposes) More...
 
const std::string & get_type () const
 Get the type of the candidate action (useful for debug purposes) More...
 
virtual std::string get_id () const
 
virtual std::string get_engine () const
 
int get_recursion_count () const
 Get the value of the recursion counter. More...
 
virtual config to_config () const
 serialize More...
 
virtual void set_to_be_removed ()
 
virtual bool to_be_removed ()
 
- Public Member Functions inherited from ai::rca_context_proxy
 rca_context_proxy ()
 
virtual ~rca_context_proxy ()
 
void init_rca_context_proxy (rca_context &target)
 
rca_contextget_rca_context ()
 Unwrap. More...
 
- Public Member Functions inherited from ai::rca_context
 rca_context ()
 Constructor. More...
 
virtual ~rca_context ()
 Destructor. More...
 
bool is_offense ()
 
void set_offense ()
 
bool is_defense ()
 
void set_defense ()
 
void clear_strategy ()
 
bool has_strategy ()
 
- Public Member Functions inherited from ai::default_ai_context
 default_ai_context ()
 Constructor. More...
 
virtual ~default_ai_context ()
 Destructor. More...
 
- Public Member Functions inherited from ai::readwrite_context
 readwrite_context ()
 
virtual ~readwrite_context ()
 
- Public Member Functions inherited from ai::readonly_context
 readonly_context ()
 
virtual ~readonly_context ()
 
- Public Member Functions inherited from ai::side_context
virtual ~side_context ()
 empty destructor More...
 
 side_context ()
 empty constructor More...
 
- Public Member Functions inherited from ai::ai_context_proxy
 ai_context_proxy ()
 
void init_ai_context_proxy (ai_context &target)
 
virtual ~ai_context_proxy ()
 
ai_contextget_ai_context ()
 Unwrap. More...
 
- Public Member Functions inherited from ai::default_ai_context_proxy
int count_free_hexes_in_castle (const map_location &loc, std::set< map_location > &checked_hexes)
 
 default_ai_context_proxy ()
 
virtual ~default_ai_context_proxy ()
 
virtual const std::vector
< target > & 
additional_targets () const
 
virtual void add_target (const target &t) const
 
virtual void clear_additional_targets () const
 
virtual default_ai_contextget_default_ai_context ()
 
virtual std::vector< targetfind_targets (const move_map &enemy_dstsrc)
 
void init_default_ai_context_proxy (default_ai_context &target)
 
virtual int rate_terrain (const unit &u, const map_location &loc) const
 
virtual config to_default_ai_context_config () const
 
- Public Member Functions inherited from ai::readwrite_context_proxy
 readwrite_context_proxy ()
 
void init_readwrite_context_proxy (readwrite_context &target)
 
virtual readwrite_contextget_readwrite_context () override
 
virtual attack_result_ptr execute_attack_action (const map_location &attacker_loc, const map_location &defender_loc, int attacker_weapon) override
 
virtual move_result_ptr execute_move_action (const map_location &from, const map_location &to, bool remove_movement=true, bool unreach_is_ok=false) override
 
virtual recall_result_ptr execute_recall_action (const std::string &id, const map_location &where=map_location::null_location(), const map_location &from=map_location::null_location()) override
 
virtual recruit_result_ptr execute_recruit_action (const std::string &unit_name, const map_location &where=map_location::null_location(), const map_location &from=map_location::null_location()) override
 
virtual stopunit_result_ptr execute_stopunit_action (const map_location &unit_location, bool remove_movement=true, bool remove_attacks=false) override
 
virtual synced_command_result_ptr execute_synced_command_action (const std::string &lua_code, const map_location &location=map_location::null_location()) override
 
virtual teamcurrent_team_w () override
 
virtual void raise_gamestate_changed () const override
 
virtual game_infoget_info_w () override
 
virtual config to_readwrite_context_config () const override
 serialize this context to config More...
 
- Public Member Functions inherited from ai::readonly_context_proxy
 readonly_context_proxy ()
 
virtual ~readonly_context_proxy ()
 
void init_readonly_context_proxy (readonly_context &target)
 
virtual readonly_contextget_readonly_context () override
 
virtual void on_readonly_context_create () override
 
virtual const teamcurrent_team () const override
 
virtual void diagnostic (const std::string &msg) override
 
virtual void log_message (const std::string &msg) override
 
virtual attack_result_ptr check_attack_action (const map_location &attacker_loc, const map_location &defender_loc, int attacker_weapon) override
 
virtual move_result_ptr check_move_action (const map_location &from, const map_location &to, bool remove_movement=true, bool unreach_is_ok=false) override
 
virtual recall_result_ptr check_recall_action (const std::string &id, const map_location &where=map_location::null_location(), const map_location &from=map_location::null_location()) override
 
virtual recruit_result_ptr check_recruit_action (const std::string &unit_name, const map_location &where=map_location::null_location(), const map_location &from=map_location::null_location()) override
 
virtual stopunit_result_ptr check_stopunit_action (const map_location &unit_location, bool remove_movement=true, bool remove_attacks=false) override
 
virtual synced_command_result_ptr check_synced_command_action (const std::string &lua_code, const map_location &location=map_location::null_location()) override
 
virtual void calculate_possible_moves (std::map< map_location, pathfind::paths > &possible_moves, move_map &srcdst, move_map &dstsrc, bool enemy, bool assume_full_movement=false, const terrain_filter *remove_destinations=nullptr) const override
 
virtual void calculate_moves (const unit_map &units, std::map< map_location, pathfind::paths > &possible_moves, move_map &srcdst, move_map &dstsrc, bool enemy, bool assume_full_movement=false, const terrain_filter *remove_destinations=nullptr, bool see_all=false) const override
 
virtual const game_infoget_info () const override
 
virtual void raise_user_interact () const override
 
defensive_position const & best_defensive_position (const map_location &unit, const move_map &dstsrc, const move_map &srcdst, const move_map &enemy_dstsrc) const override
 
virtual std::map< map_location,
defensive_position > & 
defensive_position_cache () const override
 
virtual const
unit_advancements_aspect
get_advancements () const override
 
virtual double get_aggression () const override
 
virtual int get_attack_depth () const override
 
virtual const aspect_mapget_aspects () const override
 
virtual aspect_mapget_aspects () override
 
virtual void add_aspects (std::vector< aspect_ptr > &aspects) override
 
virtual void add_facet (const std::string &id, const config &cfg) const override
 
virtual const attacks_vectorget_attacks () const override
 
virtual const wfl::variantget_attacks_as_variant () const override
 
virtual const terrain_filterget_avoid () const override
 
virtual double get_caution () const override
 
virtual const move_mapget_dstsrc () const override
 
virtual const move_mapget_enemy_dstsrc () const override
 
virtual const moves_mapget_enemy_possible_moves () const override
 
virtual const move_mapget_enemy_srcdst () const override
 
virtual engine_ptr get_engine_by_cfg (const config &cfg) override
 get engine by cfg, creating it if it is not created yet but known More...
 
virtual const std::vector
< engine_ptr > & 
get_engines () const override
 
virtual std::vector< engine_ptr > & get_engines () override
 
virtual std::string get_grouping () const override
 
virtual const std::vector
< goal_ptr > & 
get_goals () const override
 
virtual std::vector< goal_ptr > & get_goals () override
 
virtual double get_leader_aggression () const override
 
virtual config get_leader_goal () const override
 
virtual bool get_leader_ignores_keep () const override
 
virtual double get_leader_value () const override
 
virtual bool get_passive_leader () const override
 
virtual bool get_passive_leader_shares_keep () const override
 
virtual const moves_mapget_possible_moves () const override
 
virtual double power_projection (const map_location &loc, const move_map &dstsrc) const override
 Function which finds how much 'power' a side can attack a certain location with. More...
 
virtual const std::vector
< unit_ptr > & 
get_recall_list () const override
 
virtual double get_recruitment_diversity () const override
 
virtual const config get_recruitment_instructions () const override
 
virtual const std::vector
< std::string > 
get_recruitment_more () const override
 
virtual const std::vector
< std::string > 
get_recruitment_pattern () const override
 
virtual int get_recruitment_randomness () const override
 
virtual const config get_recruitment_save_gold () const override
 
virtual const move_mapget_srcdst () const override
 
virtual double get_scout_village_targeting () const override
 
virtual bool get_simple_targeting () const override
 
virtual bool get_support_villages () const override
 
virtual double get_village_value () const override
 
virtual int get_villages_per_scout () const override
 
virtual bool is_active (const std::string &time_of_day, const std::string &turns) const override
 
virtual bool is_dst_src_valid_lua () const override
 
virtual bool is_dst_src_enemy_valid_lua () const override
 
virtual bool is_src_dst_valid_lua () const override
 
virtual bool is_src_dst_enemy_valid_lua () const override
 
virtual void invalidate_defensive_position_cache () const override
 
virtual void invalidate_move_maps () const override
 
virtual void invalidate_keeps_cache () const override
 
virtual const std::set
< map_location > & 
keeps () const override
 
virtual bool leader_can_reach_keep () const override
 
virtual const map_locationnearest_keep (const map_location &loc) const override
 
virtual void recalculate_move_maps () const override
 
virtual void recalculate_move_maps_enemy () const override
 
virtual void set_dst_src_valid_lua () override
 
virtual void set_dst_src_enemy_valid_lua () override
 
virtual void set_src_dst_valid_lua () override
 
virtual void set_src_dst_enemy_valid_lua () override
 
virtual const map_locationsuitable_keep (const map_location &leader_location, const pathfind::paths &leader_paths) const override
 get most suitable keep for leader - nearest free that can be reached in 1 turn, if none - return nearest occupied that can be reached in 1 turn, if none - return nearest keep, if none - return null_location More...
 
virtual config to_readonly_context_config () const override
 serialize to config More...
 
virtual unit_stats_cache_tunit_stats_cache () const override
 
- Public Member Functions inherited from ai::side_context_proxy
 side_context_proxy ()
 
virtual ~side_context_proxy ()
 
void init_side_context_proxy (side_context &target)
 
virtual side_number get_side () const override
 Get the side number. More...
 
virtual void set_side (side_number side) override
 Set the side number. More...
 
virtual side_contextget_side_context () override
 unwrap More...
 
virtual config to_side_context_config () const override
 serialize this context to config More...
 
- Public Member Functions inherited from ai::component
 component ()
 
virtual ~component ()
 
virtual componentget_child (const path_element &child)
 
virtual std::vector< component * > get_children (const std::string &type)
 
virtual std::vector< std::string > get_children_types ()
 
virtual bool change_child (const path_element &child, const config &cfg)
 
virtual bool add_child (const path_element &child, const config &cfg)
 
virtual bool delete_child (const path_element &child)
 
property_handler_mapproperty_handlers ()
 

Static Public Attributes

static const double BAD_SCORE = 0
 
static const double HIGH_SCORE = 10000000
 

Private Attributes

recursion_counter recursion_counter_
 
bool enabled_
 
std::string engine_
 
double score_
 
double max_score_
 
std::string id_
 
std::string name_
 
std::string type_
 
bool to_be_removed_
 

Additional Inherited Members

- Public Types inherited from ai::readonly_context
typedef std::map< std::pair
< map_location, const
unit_type * >, std::pair
< battle_context_unit_stats,
battle_context_unit_stats > > 
unit_stats_cache_t
 

Detailed Description

Definition at line 34 of file rca.hpp.

Constructor & Destructor Documentation

ai::candidate_action::candidate_action ( rca_context context,
const config cfg 
)

Definition at line 35 of file rca.cpp.

References ai::rca_context_proxy::init_rca_context_proxy().

ai::candidate_action::~candidate_action ( )
virtual

Destructor.

Definition at line 45 of file rca.cpp.

Member Function Documentation

void ai::candidate_action::disable ( )

Disable the candidate action.

Definition at line 66 of file rca.cpp.

References enabled_.

Referenced by ai::lua_sticky_candidate_action_wrapper::execute().

void ai::candidate_action::enable ( )

Enable the candidate action.

Definition at line 56 of file rca.cpp.

References enabled_.

virtual double ai::candidate_action::evaluate ( )
pure virtual
virtual void ai::candidate_action::execute ( )
pure virtual
virtual std::string ai::candidate_action::get_engine ( ) const
inlinevirtual

Implements ai::component.

Definition at line 103 of file rca.hpp.

References engine_.

virtual std::string ai::candidate_action::get_id ( ) const
inlinevirtual

Implements ai::component.

Definition at line 100 of file rca.hpp.

References id_.

double ai::candidate_action::get_max_score ( ) const

Get the upper bound of the score of the candidate action without re-evaluation.

Definition at line 78 of file rca.cpp.

References max_score_.

virtual std::string ai::candidate_action::get_name ( ) const
inlinevirtual
int ai::candidate_action::get_recursion_count ( ) const
virtual

Get the value of the recursion counter.

Reimplemented from ai::readwrite_context_proxy.

Definition at line 61 of file rca.cpp.

References ai::recursion_counter::get_count(), and recursion_counter_.

double ai::candidate_action::get_score ( ) const
const std::string & ai::candidate_action::get_type ( ) const

Get the type of the candidate action (useful for debug purposes)

Definition at line 83 of file rca.cpp.

References type_.

bool ai::candidate_action::is_enabled ( ) const

Is this candidate action enabled ?

Definition at line 50 of file rca.cpp.

References enabled_.

void ai::candidate_action::set_to_be_removed ( )
virtual

Definition at line 101 of file rca.cpp.

References to_be_removed_.

Referenced by ai::lua_sticky_candidate_action_wrapper::evaluate().

bool ai::candidate_action::to_be_removed ( )
virtual

Definition at line 106 of file rca.cpp.

References to_be_removed_.

config ai::candidate_action::to_config ( ) const
virtual

Member Data Documentation

const double ai::candidate_action::BAD_SCORE = 0
static
bool ai::candidate_action::enabled_
private

Definition at line 122 of file rca.hpp.

Referenced by disable(), enable(), is_enabled(), and to_config().

std::string ai::candidate_action::engine_
private

Definition at line 125 of file rca.hpp.

Referenced by get_engine(), and to_config().

const double ai::candidate_action::HIGH_SCORE = 10000000
static

Definition at line 40 of file rca.hpp.

std::string ai::candidate_action::id_
private

Definition at line 134 of file rca.hpp.

Referenced by get_id(), and to_config().

double ai::candidate_action::max_score_
private

Definition at line 131 of file rca.hpp.

Referenced by get_max_score(), and to_config().

std::string ai::candidate_action::name_
private

Definition at line 137 of file rca.hpp.

Referenced by get_name(), and to_config().

recursion_counter ai::candidate_action::recursion_counter_
private

Definition at line 120 of file rca.hpp.

Referenced by get_recursion_count().

double ai::candidate_action::score_
private

Definition at line 128 of file rca.hpp.

Referenced by get_score(), and to_config().

bool ai::candidate_action::to_be_removed_
private

Definition at line 143 of file rca.hpp.

Referenced by set_to_be_removed(), and to_be_removed().

std::string ai::candidate_action::type_
private

Definition at line 140 of file rca.hpp.

Referenced by get_type(), and to_config().


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