ai::recall_result Class Reference

#include <actions.hpp>

Inheritance diagram for ai::recall_result:

Collaboration diagram for ai::recall_result:

List of all members.

Public Types
enum	tresult {   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 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
Protected Member Functions
virtual void	do_check_before ()
virtual void	do_check_after ()
virtual void	do_execute ()
virtual void	do_init_for_execution ()
Private Member Functions
bool	test_available_for_recalling (const team &my_team)
bool	test_enough_gold (const team &my_team)
const unit *	get_leader ()
bool	test_leader_on_keep (const unit &my_leader)
bool	test_suitable_recall_location (const unit &my_leader)
Private Attributes
const std::string &	unit_id_
const map_location	where_
map_location	recall_location_
map_location	recall_from_

---

Detailed Description

Definition at line 199 of file actions.hpp.

---

Member Enumeration Documentation

enum ai::recall_result::tresult

Enumerator:

E_NOT_AVAILABLE_FOR_RECALLING
E_NO_GOLD
E_NO_LEADER
E_LEADER_NOT_ON_KEEP
E_BAD_RECALL_LOCATION

Reimplemented from ai::action_result.

Definition at line 203 of file actions.hpp.

---

Constructor & Destructor Documentation

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

Definition at line 520 of file actions.cpp.

---

Member Function Documentation

void ai::recall_result::do_check_after

(

)

[protected, virtual]

Implements ai::action_result.

Definition at line 621 of file actions.cpp.

void ai::recall_result::do_check_before

(

)

[protected, virtual]

Implements ai::action_result.

Definition at line 586 of file actions.cpp.

std::string ai::recall_result::do_describe

(

)

const [virtual]

Implements ai::action_result.

Definition at line 640 of file actions.cpp.

Referenced by operator<<().

Here is the caller graph for this function:

void ai::recall_result::do_execute

(

)

[protected, virtual]

Implements ai::action_result.

Definition at line 656 of file actions.cpp.

void ai::recall_result::do_init_for_execution

(

)

[protected, virtual]

Implements ai::action_result.

Definition at line 699 of file actions.cpp.

const unit * ai::recall_result::get_leader

(

)

[private]

Definition at line 550 of file actions.cpp.

bool ai::recall_result::test_available_for_recalling

(

const team &

my_team

)

[private]

Definition at line 530 of file actions.cpp.

bool ai::recall_result::test_enough_gold

(

const team &

my_team

)

[private]

Definition at line 541 of file actions.cpp.

bool ai::recall_result::test_leader_on_keep

(

const unit &

my_leader

)

[private]

Definition at line 561 of file actions.cpp.

bool ai::recall_result::test_suitable_recall_location

(

const unit &

my_leader

)

[private]

Definition at line 570 of file actions.cpp.

---

Member Data Documentation

map_location ai::recall_result::recall_from_ [private]

Definition at line 231 of file actions.hpp.

map_location ai::recall_result::recall_location_ [private]

Definition at line 230 of file actions.hpp.

const std::string& ai::recall_result::unit_id_ [private]

Definition at line 228 of file actions.hpp.

const map_location ai::recall_result::where_ [private]

Definition at line 229 of file actions.hpp.

---

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

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