ai::action_result Class Reference

#include <actions.hpp>

Inheritance diagram for ai::action_result:

Public Types
enum	result { AI_ACTION_SUCCESS = 0 , AI_ACTION_STARTED = 1 , AI_ACTION_FAILURE = -1 }

Public Member Functions
virtual	~action_result ()
void	check_before ()
void	execute ()
bool	is_gamestate_changed () const
bool	is_ok ()
int	get_status () const
virtual std::string	do_describe () const =0

Protected Member Functions
	action_result (side_number side)
virtual void	do_check_before ()=0
virtual void	do_check_after ()=0
virtual void	do_execute ()=0
virtual void	do_init_for_execution ()=0
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
void	check_after ()
void	init_for_execution ()
void	set_ok_checked ()

Private Attributes
bool	return_value_checked_
int	side_
int	status_
bool	is_execution_
bool	is_gamestate_changed_

Friends
void	sim_gamestate_changed (action_result *result, bool gamestate_changed)

Detailed Description

Definition at line 38 of file actions.hpp.

Member Enumeration Documentation

result

enum ai::action_result::result

Enumerator
AI_ACTION_SUCCESS
AI_ACTION_STARTED
AI_ACTION_FAILURE

Definition at line 43 of file actions.hpp.

Constructor & Destructor Documentation

~action_result()

ai::action_result::~action_result ( )

virtual

Definition at line 75 of file actions.cpp.

References DBG_AI_ACTIONS, and return_value_checked_.

action_result()

ai::action_result::action_result ( side_number  side )

protected

Definition at line 70 of file actions.cpp.

Member Function Documentation

check_after()

void ai::action_result::check_after ( )

private

Definition at line 82 of file actions.cpp.

References do_check_after().

Referenced by execute().

check_before()

void ai::action_result::check_before

(

)

Definition at line 87 of file actions.cpp.

References do_check_before().

Referenced by execute(), and ai::execute_or_check().

do_check_after()

virtual void ai::action_result::do_check_after ( )

protectedpure virtual

Implemented in ai::synced_command_result, ai::stopunit_result, ai::recruit_result, ai::recall_result, ai::move_result, and ai::attack_result.

Referenced by check_after().

do_check_before()

virtual void ai::action_result::do_check_before ( )

protectedpure virtual

Implemented in ai::synced_command_result, ai::stopunit_result, ai::recruit_result, ai::recall_result, ai::move_result, and ai::attack_result.

Referenced by check_before().

do_describe()

virtual std::string ai::action_result::do_describe ( ) const

pure virtual

Implemented in ai::synced_command_result, ai::stopunit_result, ai::recruit_result, ai::recall_result, ai::move_result, and ai::attack_result.

Referenced by set_error().

do_execute()

virtual void ai::action_result::do_execute ( )

protectedpure virtual

Implemented in ai::synced_command_result, ai::stopunit_result, ai::recruit_result, ai::recall_result, ai::move_result, and ai::attack_result.

Referenced by execute().

do_init_for_execution()

virtual void ai::action_result::do_init_for_execution ( )

protectedpure virtual

Implemented in ai::synced_command_result, ai::stopunit_result, ai::recruit_result, ai::recall_result, ai::move_result, and ai::attack_result.

Referenced by init_for_execution().

execute()

void ai::action_result::execute

(

)

Definition at line 92 of file actions.cpp.

References check_after(), check_before(), DBG_AI_ACTIONS, do_execute(), init_for_execution(), is_execution_, is_ok(), and is_success().

Referenced by ai::execute_or_check(), ai::default_recruitment::recruitment::execute_recall(), ai::default_recruitment::recruitment::execute_recruit(), wfl::recall_callable::execute_self(), and wfl::recruit_callable::execute_self().

get_info()

game_info & ai::action_result::get_info ( ) const

protected

Definition at line 163 of file actions.cpp.

References ai::manager::get_active_ai_info_for_side(), get_side(), and ai::manager::get_singleton().

Referenced by ai::attack_result::do_execute().

get_my_team()

team & ai::action_result::get_my_team ( ) const

protected

Definition at line 168 of file actions.cpp.

References resources::gameboard, game_board::get_team(), and side_.

Referenced by ai::attack_result::do_check_before(), ai::recall_result::do_check_before(), ai::recruit_result::do_check_before(), and ai::move_result::test_route().

get_side()

int ai::action_result::get_side ( ) const

inlineprotected

Definition at line 87 of file actions.hpp.

References side_.

Referenced by ai::recall_result::do_check_after(), ai::recruit_result::do_check_after(), ai::attack_result::do_check_before(), ai::recall_result::do_check_before(), ai::recruit_result::do_check_before(), ai::attack_result::do_describe(), ai::move_result::do_describe(), ai::recall_result::do_describe(), ai::recruit_result::do_describe(), ai::stopunit_result::do_describe(), ai::synced_command_result::do_describe(), ai::move_result::do_execute(), ai::recall_result::do_execute(), ai::recruit_result::do_execute(), get_info(), ai::move_result::get_unit(), and ai::stopunit_result::get_unit().

get_status()

int ai::action_result::get_status

(

)

const

Definition at line 148 of file actions.cpp.

References status_.

Referenced by ai::default_recruitment::recruitment::execute(), wfl::attack_callable::execute_self(), wfl::move_callable::execute_self(), wfl::move_partial_callable::execute_self(), wfl::recall_callable::execute_self(), wfl::recruit_callable::execute_self(), and ai::transform_ai_action().

init_for_execution()

void ai::action_result::init_for_execution ( )

private

Definition at line 111 of file actions.cpp.

References AI_ACTION_SUCCESS, do_init_for_execution(), is_gamestate_changed_, return_value_checked_, and status_.

Referenced by execute().

is_execution()

bool ai::action_result::is_execution ( ) const

protected

Definition at line 158 of file actions.cpp.

References is_execution_.

Referenced by set_error().

is_gamestate_changed()

bool ai::action_result::is_gamestate_changed

(

)

const

Definition at line 119 of file actions.cpp.

References is_gamestate_changed_.

Referenced by ai::move_result::do_execute(), wfl::attack_callable::execute_self(), wfl::move_callable::execute_self(), wfl::move_partial_callable::execute_self(), wfl::recall_callable::execute_self(), wfl::recruit_callable::execute_self(), and ai::transform_ai_action().

is_ok()

bool ai::action_result::is_ok

(

)

Definition at line 124 of file actions.cpp.

References is_success(), and return_value_checked_.

Referenced by ai::attack_result::do_execute(), ai::move_result::do_execute(), ai::recall_result::do_execute(), ai::recruit_result::do_execute(), ai::stopunit_result::do_execute(), ai::synced_command_result::do_execute(), execute(), ai::default_recruitment::recruitment::execute(), ai::default_recruitment::recruitment::execute_recall(), ai::default_recruitment::recruitment::execute_recruit(), wfl::attack_callable::execute_self(), wfl::move_callable::execute_self(), wfl::move_partial_callable::execute_self(), wfl::recall_callable::execute_self(), wfl::recruit_callable::execute_self(), and ai::transform_ai_action().

is_success()

bool ai::action_result::is_success ( ) const

protected

Definition at line 153 of file actions.cpp.

References AI_ACTION_SUCCESS, and status_.

Referenced by ai::move_result::do_execute(), ai::recall_result::do_execute(), ai::recruit_result::do_execute(), ai::stopunit_result::do_execute(), ai::synced_command_result::do_execute(), execute(), and is_ok().

set_error()

void ai::action_result::set_error ( int  error_code, bool  log_as_error = true  )

protected

Definition at line 130 of file actions.cpp.

References do_describe(), ERR_AI_ACTIONS, ai::actions::get_error_name(), is_execution(), LOG_AI_ACTIONS, and status_.

Referenced by ai::move_result::do_check_after(), ai::recall_result::do_check_after(), ai::recruit_result::do_check_after(), ai::stopunit_result::do_check_after(), ai::attack_result::do_check_before(), ai::recall_result::do_check_before(), ai::recruit_result::do_check_before(), ai::attack_result::do_execute(), ai::move_result::do_execute(), ai::recall_result::get_recall_unit(), ai::move_result::get_unit(), ai::stopunit_result::get_unit(), ai::recruit_result::get_unit_type_known(), ai::recall_result::test_enough_gold(), ai::recruit_result::test_enough_gold(), and ai::move_result::test_route().

set_gamestate_changed()

void ai::action_result::set_gamestate_changed ( )

protected

Definition at line 143 of file actions.cpp.

References is_gamestate_changed_.

Referenced by ai::attack_result::do_execute(), ai::move_result::do_execute(), ai::recall_result::do_execute(), ai::recruit_result::do_execute(), ai::stopunit_result::do_execute(), and ai::synced_command_result::do_execute().

set_ok_checked()

void ai::action_result::set_ok_checked ( )

private

Friends And Related Function Documentation

sim_gamestate_changed

void sim_gamestate_changed ( action_result *  result, bool  gamestate_changed  )

friend

Definition at line 1108 of file actions.cpp.

Referenced by ai::attack_result::do_execute(), ai::move_result::do_execute(), ai::recall_result::do_execute(), ai::recruit_result::do_execute(), ai::stopunit_result::do_execute(), and ai::synced_command_result::do_execute().

Member Data Documentation

is_execution_

bool ai::action_result::is_execution_

private

Definition at line 123 of file actions.hpp.

Referenced by execute(), and is_execution().

is_gamestate_changed_

bool ai::action_result::is_gamestate_changed_

private

Definition at line 125 of file actions.hpp.

Referenced by init_for_execution(), is_gamestate_changed(), and set_gamestate_changed().

return_value_checked_

bool ai::action_result::return_value_checked_

private

Definition at line 114 of file actions.hpp.

Referenced by init_for_execution(), is_ok(), and ~action_result().

side_

int ai::action_result::side_

private

Definition at line 117 of file actions.hpp.

Referenced by get_my_team(), and get_side().

status_

int ai::action_result::status_

private

Definition at line 120 of file actions.hpp.

Referenced by get_status(), init_for_execution(), is_success(), and set_error().

---

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

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