ai::recall_result Class Reference

#include <actions.hpp>

Inheritance diagram for ai::recall_result:

Public Types
enum	result {   E_NOT_AVAILABLE_FOR_RECALLING = 6001 , E_NO_GOLD = 6003 , E_NO_LEADER = 6004 , E_LEADER_NOT_ON_KEEP = 6005 ,   E_BAD_RECALL_LOCATION = 6006 }
Public Types inherited from ai::action_result
enum	result { AI_ACTION_SUCCESS = 0 , AI_ACTION_STARTED = 1 , AI_ACTION_FAILURE = -1 }

Public Member Functions
	recall_result (side_number side, const std::string &unit_id, const map_location &where, const map_location &from)
virtual std::string	do_describe () const
Public Member Functions inherited from ai::action_result
virtual	~action_result ()
void	check_before ()
void	execute ()
bool	is_gamestate_changed () const
bool	is_ok ()
int	get_status () const

Protected Member Functions
virtual void	do_check_before ()
virtual void	do_check_after ()
virtual void	do_execute ()
virtual void	do_init_for_execution ()
Protected Member Functions inherited from ai::action_result
	action_result (side_number side)
bool	is_execution () const
int	get_side () const
game_info &	get_info () const
team &	get_my_team () const
void	set_error (int error_code, bool log_as_error=true)
bool	is_success () const
void	set_gamestate_changed ()

Private Member Functions
unit_const_ptr	get_recall_unit (const team &my_team)
bool	test_enough_gold (const team &my_team)

Private Attributes
const std::string &	unit_id_
const map_location	where_
map_location	recall_location_
map_location	recall_from_
bool	location_checked_

Detailed Description

Definition at line 203 of file actions.hpp.

Member Enumeration Documentation

result

enum ai::recall_result::result

Enumerator
E_NOT_AVAILABLE_FOR_RECALLING
E_NO_GOLD
E_NO_LEADER
E_LEADER_NOT_ON_KEEP
E_BAD_RECALL_LOCATION

Definition at line 207 of file actions.hpp.

Constructor & Destructor Documentation

recall_result()

ai::recall_result::recall_result	(	side_number	side,
		const std::string &	unit_id,
		const map_location &	where,
		const map_location &	from
	)

Definition at line 529 of file actions.cpp.

Member Function Documentation

do_check_after()

void ai::recall_result::do_check_after ( )

protectedvirtual

Implements ai::action_result.

Definition at line 601 of file actions.cpp.

References ai::action_result::AI_ACTION_FAILURE, unit_map::find(), resources::gameboard, ai::action_result::get_side(), recall_location_, ai::action_result::set_error(), unit::side(), and game_board::units().

do_check_before()

void ai::recall_result::do_check_before ( )

protectedvirtual

Implements ai::action_result.

Definition at line 558 of file actions.cpp.

References actions::check_recall_location(), E_BAD_RECALL_LOCATION, E_LEADER_NOT_ON_KEEP, E_NO_LEADER, ai::action_result::get_my_team(), get_recall_unit(), ai::action_result::get_side(), location_checked_, LOG_AI_ACTIONS, recall_from_, recall_location_, actions::RECRUIT_ALTERNATE_LOCATION, actions::RECRUIT_NO_ABLE_LEADER, actions::RECRUIT_NO_KEEP_LEADER, actions::RECRUIT_NO_LEADER, actions::RECRUIT_NO_VACANCY, actions::RECRUIT_OK, ai::action_result::set_error(), test_enough_gold(), and map_location::valid().

do_describe()

std::string ai::recall_result::do_describe ( ) const

virtual

Implements ai::action_result.

Definition at line 619 of file actions.cpp.

References ai::action_result::get_side(), map_location::null_location(), s, unit_id_, and where_.

Referenced by operator<<().

do_execute()

void ai::recall_result::do_execute ( )

protectedvirtual

Implements ai::action_result.

Definition at line 634 of file actions.cpp.

References actions::undo_list::clear(), DBG_AI_ACTIONS, replay_helper::get_recall(), ai::action_result::get_side(), ai::manager::get_singleton(), synced_context::ignore_error_function(), ai::action_result::is_ok(), ai::action_result::is_success(), location_checked_, LOG_AI_ACTIONS, ai::manager::raise_gamestate_changed(), recall_from_, recall_location_, synced_context::run_in_synced_context_if_not_already(), ai::action_result::set_gamestate_changed(), ai::action_result::sim_gamestate_changed, ai::simulated_recall(), resources::simulation_, preferences::skip_ai_moves(), resources::undo_stack, and unit_id_.

do_init_for_execution()

void ai::recall_result::do_init_for_execution ( )

protectedvirtual

Implements ai::action_result.

Definition at line 673 of file actions.cpp.

get_recall_unit()

unit_const_ptr ai::recall_result::get_recall_unit ( const team &  my_team )

private

Definition at line 540 of file actions.cpp.

References E_NOT_AVAILABLE_FOR_RECALLING, recall_list_manager::find_if_matches_id(), team::recall_list(), ai::action_result::set_error(), and unit_id_.

Referenced by do_check_before().

test_enough_gold()

bool ai::recall_result::test_enough_gold ( const team &  my_team )

private

Definition at line 549 of file actions.cpp.

References E_NO_GOLD, team::gold(), team::recall_cost(), and ai::action_result::set_error().

Referenced by do_check_before().

Member Data Documentation

location_checked_

bool ai::recall_result::location_checked_

private

Definition at line 231 of file actions.hpp.

Referenced by do_check_before(), and do_execute().

recall_from_

map_location ai::recall_result::recall_from_

private

Definition at line 230 of file actions.hpp.

Referenced by do_check_before(), and do_execute().

recall_location_

map_location ai::recall_result::recall_location_

private

Definition at line 229 of file actions.hpp.

Referenced by do_check_after(), do_check_before(), and do_execute().

unit_id_

const std::string& ai::recall_result::unit_id_

private

Definition at line 227 of file actions.hpp.

Referenced by do_describe(), do_execute(), and get_recall_unit().

where_

const map_location ai::recall_result::where_

private

Definition at line 228 of file actions.hpp.

Referenced by do_describe().

---

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

• ai/actions.hpp
• ai/actions.cpp