Abstract base class for all the whiteboard planned actions. More...

#include <action.hpp>

Inheritance diagram for wb::action:

Classes
struct	ctor_err

Public Types
enum	error { OK, INVALID_LOCATION, NO_UNIT, UNIT_CHANGED, LOCATION_OCCUPIED, TOO_FAR, NO_TARGET, NO_ATTACK_LEFT, NOT_AN_ENEMY, UNIT_UNAVAILABLE, NOT_ENOUGH_GOLD, NO_LEADER }
	Possible errors. More...

Public Member Functions
	action (size_t team_index, bool hidden)

	action (config const &, bool hidden)

virtual	~action ()

virtual std::ostream &	print (std::ostream &s) const =0

virtual void	accept (visitor &v)=0

virtual void	execute (bool &success, bool &complete)=0
	Output parameters: success: Whether or not to continue an execute-all after this execution complete: Whether or not to delete this action after execution. More...

virtual void	apply_temp_modifier (unit_map &unit_map)=0
	Applies temporarily the result of this action to the specified unit map. More...

virtual void	remove_temp_modifier (unit_map &unit_map)=0
	Removes the result of this action from the specified unit map. More...

virtual void	draw_hex (const map_location &hex)=0
	Gets called by display when drawing a hex, to allow actions to draw to the screen. More...

virtual void	redraw ()
	Redrawing function, called each time the action situation might have changed. More...

void	hide ()
	Sets whether or not the action should be drawn on the screen. More...

void	show ()

bool	hidden () const

bool	is_numbering_hex (const map_location &hex) const
	Indicates whether this hex is the preferred hex to draw the numbering for this action. More...

virtual map_location	get_numbering_hex () const =0

virtual unit_ptr	get_unit () const =0
	Return the unit targeted by this action. More...

size_t	get_unit_id () const
	Returns the id of the unit targeted by this action. More...

virtual fake_unit_ptr	get_fake_unit ()=0

size_t	team_index () const
	Returns the index of the team that owns this action. More...

int	side_number () const
	Returns the number of the side that owns this action, i.e. More...

virtual config	to_config () const
	Constructs and returns a config object representing this object. More...

virtual error	check_validity () const =0
	Check the validity of the action. More...

bool	valid ()
	Returns whether this action is valid or not. More...

Static Public Member Functions
static action_ptr	from_config (config const &, bool hidden)
	Constructs an object of a subclass of wb::action using a config. More...

Private Member Functions
virtual void	do_hide ()
	Called by the non-virtual hide() and show(), respectively. More...

virtual void	do_show ()

Private Attributes
size_t	team_index_

bool	hidden_

Detailed Description

Abstract base class for all the whiteboard planned actions.

Definition at line 33 of file action.hpp.

Member Enumeration Documentation

enum wb::action::error

Possible errors.

Returned by the check function.

Enumerator
OK
INVALID_LOCATION
NO_UNIT
UNIT_CHANGED
LOCATION_OCCUPIED
TOO_FAR
NO_TARGET
NO_ATTACK_LEFT
NOT_AN_ENEMY
UNIT_UNAVAILABLE
NOT_ENOUGH_GOLD
NO_LEADER

Definition at line 104 of file action.hpp.

Constructor & Destructor Documentation

wb::action::action	(	size_t	team_index,
		bool	hidden
	)

Definition at line 95 of file action.cpp.

wb::action::action	(	config const &	cfg,
		bool	hidden
	)

Definition at line 101 of file action.cpp.

References team_index_, and resources::teams.

wb::action::~action ( )

virtual

Definition at line 113 of file action.cpp.

Member Function Documentation

virtual void wb::action::accept ( visitor & v )

pure virtual

Implemented in wb::suppose_dead, wb::move, wb::recruit, wb::attack, wb::recall, and dummy_action.

Referenced by wb::highlighter::highlight(), and wb::highlighter::unhighlight().

virtual void wb::action::apply_temp_modifier ( unit_map & unit_map )

pure virtual

Applies temporarily the result of this action to the specified unit map.

Implemented in wb::move, wb::suppose_dead, wb::recruit, wb::attack, wb::recall, and dummy_action.

virtual error wb::action::check_validity ( ) const

pure virtual

Check the validity of the action.

Returns: the error preventing the action from being executed.

Return values

OK	if there isn't any error (the action can be executed.)

Implemented in wb::suppose_dead, wb::move, wb::recruit, wb::attack, wb::recall, and dummy_action.

Referenced by valid().

virtual void wb::action::do_hide ( )

inlineprivatevirtual

Called by the non-virtual hide() and show(), respectively.

Reimplemented in wb::move, wb::recruit, wb::recall, and wb::attack.

Definition at line 137 of file action.hpp.

Referenced by hide().

virtual void wb::action::do_show ( )

inlineprivatevirtual

Reimplemented in wb::move, wb::recruit, wb::recall, and wb::attack.

Definition at line 138 of file action.hpp.

Referenced by show().

virtual void wb::action::draw_hex ( const map_location & hex )

pure virtual

Gets called by display when drawing a hex, to allow actions to draw to the screen.

Implemented in wb::move, wb::suppose_dead, wb::recruit, wb::attack, wb::recall, and dummy_action.

Referenced by wb::manager::draw_hex().

virtual void wb::action::execute	(	bool &	success,
		bool &	complete
	)

pure virtual

Output parameters: success: Whether or not to continue an execute-all after this execution complete: Whether or not to delete this action after execution.

Implemented in wb::suppose_dead, wb::move, wb::recruit, wb::attack, wb::recall, and dummy_action.