ai::move_result Class Reference

#include <actions.hpp>

Inheritance diagram for ai::move_result:

Public Types
enum	result {   E_EMPTY_MOVE = 2001 , E_NO_UNIT = 2002 , E_NOT_OWN_UNIT = 2003 , E_INCAPACITATED_UNIT = 2004 ,   E_AMBUSHED = 2005 , E_FAILED_TELEPORT = 2006 , E_OFF_MAP = 2007 , E_NO_ROUTE = 2008 }
Public Types inherited from ai::action_result
enum	result { AI_ACTION_SUCCESS = 0 , AI_ACTION_STARTED = 1 , AI_ACTION_FAILURE = -1 }

Public Member Functions
	move_result (side_number side, const map_location &from, const map_location &to, bool remove_movement, bool unreach_is_ok)
virtual std::string	do_describe () const
virtual const map_location &	get_unit_location () 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 *	get_unit ()
bool	test_route (const unit &un)

Private Attributes
const map_location	from_
const map_location	to_
bool	remove_movement_
std::shared_ptr< pathfind::plain_route >	route_
map_location	unit_location_
bool	unreach_is_ok_
bool	has_ambusher_
bool	has_interrupted_teleport_

Detailed Description

Definition at line 163 of file actions.hpp.

Member Enumeration Documentation

result

enum ai::move_result::result

Enumerator
E_EMPTY_MOVE
E_NO_UNIT
E_NOT_OWN_UNIT
E_INCAPACITATED_UNIT
E_AMBUSHED
E_FAILED_TELEPORT
E_OFF_MAP
E_NO_ROUTE

Definition at line 171 of file actions.hpp.

Constructor & Destructor Documentation

move_result()

ai::move_result::move_result	(	side_number	side,
		const map_location &	from,
		const map_location &	to,
		bool	remove_movement,
		bool	unreach_is_ok
	)

Definition at line 330 of file actions.cpp.

Member Function Documentation

do_check_after()

void ai::move_result::do_check_after ( )

protectedvirtual

Implements ai::action_result.

Definition at line 415 of file actions.cpp.

References DBG_AI_ACTIONS, do_describe(), E_AMBUSHED, E_FAILED_TELEPORT, has_ambusher_, has_interrupted_teleport_, ai::action_result::set_error(), to_, unit_location_, and unreach_is_ok_.

do_check_before()

void ai::move_result::do_check_before ( )

protectedvirtual

Implements ai::action_result.

Definition at line 398 of file actions.cpp.

References get_unit(), LOG_AI_ACTIONS, and test_route().

do_describe()

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

virtual

Implements ai::action_result.

Definition at line 432 of file actions.cpp.

References from_, ai::action_result::get_side(), remove_movement_, s, and to_.

Referenced by do_check_after(), and operator<<().

do_execute()

void ai::move_result::do_execute ( )

protectedvirtual

Implements ai::action_result.

Definition at line 447 of file actions.cpp.

References DBG_AI_ACTIONS, ai::actions::execute_stopunit_action(), unit_map::find(), from_, resources::gameboard, actions::move_unit_spectator::get_ambusher(), actions::move_unit_spectator::get_failed_teleport(), ai::action_result::get_side(), ai::manager::get_singleton(), actions::move_unit_spectator::get_unit(), has_ambusher_, has_interrupted_teleport_, ai::action_result::is_gamestate_changed(), ai::action_result::is_ok(), ai::action_result::is_success(), LOG_AI_ACTIONS, actions::move_unit_and_record(), ai::manager::raise_gamestate_changed(), remove_movement_, route_, ai::action_result::set_error(), ai::action_result::set_gamestate_changed(), actions::move_unit_spectator::set_unit(), ai::action_result::sim_gamestate_changed, ai::simulated_move(), ai::simulated_stopunit(), resources::simulation_, preferences::skip_ai_moves(), to_, unit_location_, game_board::units(), and unit_map::iterator_base< iter_types >::valid().

do_init_for_execution()

void ai::move_result::do_init_for_execution ( )

protectedvirtual

Implements ai::action_result.

Definition at line 523 of file actions.cpp.

get_unit()

const unit * ai::move_result::get_unit ( )

private

Definition at line 344 of file actions.cpp.

References E_INCAPACITATED_UNIT, E_NO_UNIT, E_NOT_OWN_UNIT, unit_map::find(), from_, resources::gameboard, ai::action_result::get_side(), unit::incapacitated(), ai::action_result::set_error(), unit::side(), and game_board::units().

Referenced by do_check_before().

get_unit_location()

const map_location & ai::move_result::get_unit_location ( ) const

virtual

Definition at line 410 of file actions.cpp.

References unit_location_.

Referenced by wfl::attack_callable::execute_self(), wfl::move_callable::execute_self(), and wfl::move_partial_callable::execute_self().

test_route()

bool ai::move_result::test_route ( const unit &  un )

private

Definition at line 363 of file actions.cpp.

References pathfind::a_star_search(), E_EMPTY_MOVE, E_NO_ROUTE, E_OFF_MAP, from_, resources::gameboard, unit::get_location(), ai::action_result::get_my_team(), pathfind::get_teleport_locations(), gamemap_base::h(), game_board::map(), unit::movement_left(), gamemap_base::on_board(), remove_movement_, route_, ai::action_result::set_error(), to_, map_location::valid(), and gamemap_base::w().

Referenced by do_check_before().

Member Data Documentation

from_

const map_location ai::move_result::from_

private

Definition at line 192 of file actions.hpp.

Referenced by do_describe(), do_execute(), get_unit(), and test_route().

has_ambusher_

bool ai::move_result::has_ambusher_

private

Definition at line 198 of file actions.hpp.

Referenced by do_check_after(), and do_execute().

has_interrupted_teleport_

bool ai::move_result::has_interrupted_teleport_

private

Definition at line 199 of file actions.hpp.

Referenced by do_check_after(), and do_execute().

remove_movement_

bool ai::move_result::remove_movement_

private

Definition at line 194 of file actions.hpp.

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

route_

std::shared_ptr<pathfind::plain_route> ai::move_result::route_

private

Definition at line 195 of file actions.hpp.

Referenced by do_execute(), and test_route().

to_

const map_location ai::move_result::to_

private

Definition at line 193 of file actions.hpp.

Referenced by do_check_after(), do_describe(), do_execute(), and test_route().

unit_location_

map_location ai::move_result::unit_location_

private

Definition at line 196 of file actions.hpp.

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

unreach_is_ok_

bool ai::move_result::unreach_is_ok_

private

Definition at line 197 of file actions.hpp.

Referenced by do_check_after().

---

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

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