ai::recruit_result Class Reference

#include <actions.hpp>

Inheritance diagram for ai::recruit_result:

Public Types
enum	result {   E_NOT_AVAILABLE_FOR_RECRUITING = 3001 , E_UNKNOWN_OR_DUMMY_UNIT_TYPE = 3002 , E_NO_GOLD = 3003 , E_NO_LEADER = 3004 ,   E_LEADER_NOT_ON_KEEP = 3005 , E_BAD_RECRUIT_LOCATION = 3006 }
Public Types inherited from ai::action_result
enum	result { AI_ACTION_SUCCESS = 0 , AI_ACTION_STARTED = 1 , AI_ACTION_FAILURE = -1 }

Public Member Functions
	recruit_result (side_number side, const std::string &unit_name, 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
const unit_type *	get_unit_type_known (const std::string &recruit)
bool	test_enough_gold (const team &my_team, const unit_type &type)

Private Attributes
const std::string &	unit_name_
const map_location &	where_
map_location	recruit_location_
map_location	recruit_from_
bool	location_checked_

Detailed Description

Definition at line 234 of file actions.hpp.

Member Enumeration Documentation

result

enum ai::recruit_result::result

Enumerator
E_NOT_AVAILABLE_FOR_RECRUITING
E_UNKNOWN_OR_DUMMY_UNIT_TYPE
E_NO_GOLD
E_NO_LEADER
E_LEADER_NOT_ON_KEEP
E_BAD_RECRUIT_LOCATION

Definition at line 238 of file actions.hpp.

Constructor & Destructor Documentation

recruit_result()

ai::recruit_result::recruit_result	(	side_number	side,
		const std::string &	unit_name,
		const map_location &	where,
		const map_location &	from
	)

Definition at line 665 of file actions.cpp.

Member Function Documentation

do_check_after()

void ai::recruit_result::do_check_after ( )

protectedvirtual

Implements ai::action_result.

Definition at line 738 of file actions.cpp.

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

do_check_before()

void ai::recruit_result::do_check_before ( )

protectedvirtual

Implements ai::action_result.

Definition at line 695 of file actions.cpp.

References actions::check_recruit_location(), E_BAD_RECRUIT_LOCATION, E_LEADER_NOT_ON_KEEP, E_NO_LEADER, ai::action_result::get_my_team(), ai::action_result::get_side(), get_unit_type_known(), location_checked_, LOG_AI_ACTIONS, actions::RECRUIT_ALTERNATE_LOCATION, recruit_from_, recruit_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(), unit_name_, and map_location::valid().

do_describe()

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

virtual

Implements ai::action_result.

Definition at line 756 of file actions.cpp.

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

Referenced by operator<<().

do_execute()

void ai::recruit_result::do_execute ( )

protectedvirtual

Implements ai::action_result.

Definition at line 771 of file actions.cpp.

References actions::undo_list::clear(), DBG_AI_ACTIONS, unit_type_data::find(), replay_helper::get_recruit(), ai::action_result::get_side(), ai::manager::get_singleton(), unit_type::id(), ai::action_result::is_ok(), ai::action_result::is_success(), location_checked_, LOG_AI_ACTIONS, ai::manager::raise_gamestate_changed(), recruit_from_, recruit_location_, synced_context::run_in_synced_context_if_not_already(), ai::action_result::set_gamestate_changed(), ai::action_result::sim_gamestate_changed, ai::simulated_recruit(), resources::simulation_, resources::undo_stack, unit_name_, and unit_types.

do_init_for_execution()

void ai::recruit_result::do_init_for_execution ( )

protectedvirtual

Implements ai::action_result.

Definition at line 804 of file actions.cpp.

get_unit_type_known()

const unit_type * ai::recruit_result::get_unit_type_known ( const std::string &  recruit )

private

Definition at line 676 of file actions.cpp.

References E_UNKNOWN_OR_DUMMY_UNIT_TYPE, unit_type_data::find(), ai::action_result::set_error(), and unit_types.

Referenced by do_check_before().

test_enough_gold()

bool ai::recruit_result::test_enough_gold ( const team &  my_team, const unit_type &  type  )

private

Definition at line 686 of file actions.cpp.

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

Referenced by do_check_before().

Member Data Documentation

location_checked_

bool ai::recruit_result::location_checked_

private

Definition at line 264 of file actions.hpp.

Referenced by do_check_before(), and do_execute().

recruit_from_

map_location ai::recruit_result::recruit_from_

private

Definition at line 263 of file actions.hpp.

Referenced by do_check_before(), and do_execute().

recruit_location_

map_location ai::recruit_result::recruit_location_

private

Definition at line 262 of file actions.hpp.

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

unit_name_

const std::string& ai::recruit_result::unit_name_

private

Definition at line 260 of file actions.hpp.

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

where_

const map_location& ai::recruit_result::where_

private

Definition at line 261 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