MoveUnitCommand Class Reference

#include <moveunitcommand.h>

Inheritance diagram for MoveUnitCommand:


Public Types
enum	SeachCapabilities { NoInterrupt = 1, DisableHeightChange = 2, LimitVerticalDirection = 4, ShortestHeightChange = 8 }
typedef map< MapCoordinate, AttackWeap >	FieldList
Public Member Functions
	MoveUnitCommand (Vehicle *unit)
void	setFlags (int flags)
ActionResult	searchFields (int height=-1, int capabilities=0)
void	setVerticalDirection (int dir)
	defines whether we want to end up either at the same level of height (0), lower(<0), or heigher(>0)
int	getVerticalDirection () const
void	calcPath ()
const AStar3D::Path &	getPath ()
void	setDestination (const MapCoordinate &destination)
void	setDestination (const MapCoordinate3D &destination)
ASCString	getCommandString () const
bool	isFieldReachable (const MapCoordinate &pos, bool direct)
	checks if the field can be reached by the unit this turn Precondition: searchFields(int,int) was called
bool	isFieldReachable3D (const MapCoordinate3D &pos, bool direct)
const set< MapCoordinate3D > &	getReachableFields ()
	this will return a 2D representation of the reachable fields.
const set< MapCoordinate3D > &	getReachableFieldsIndirect ()
const Vehicle *	getUnit () const
Vehicle *	getUnit ()
bool	longDistAvailable (const MapCoordinate &pos)
virtual vector< MapCoordinate >	getCoordinates () const
	this is for informational purposes, so the player can see where a Command has taken place when reviewing it
int	getCompletion ()
bool	operatable ()
	checks if the task can still be operated.
void	rearm ()
Static Public Member Functions
static bool	avail (Vehicle *eht)
static bool	ascendAvail (Vehicle *eht)
static bool	descendAvail (Vehicle *eht)
Protected Member Functions
void	readData (tnstream &stream)
void	writeData (tnstream &stream) const
GameActionID	getID () const
ASCString	getDescription () const
ActionResult	go (const Context &context)
Friends
template<class Child>
GameAction *	GameActionCreator (GameMap *map)

Detailed Description

Definition at line 36 of file moveunitcommand.h.

Member Typedef Documentation

typedef map<MapCoordinate,AttackWeap > MoveUnitCommand::FieldList

Definition at line 42 of file moveunitcommand.h.

Member Enumeration Documentation

enum MoveUnitCommand::SeachCapabilities

Enumerator:

NoInterrupt	the unit will not interrupt the movement if it runs onto a mine of into reaction fire
DisableHeightChange	the unit will not change its height even if that would provide a shortcut
LimitVerticalDirection
ShortestHeightChange	we want only results on a certain level of height

Definition at line 75 of file moveunitcommand.h.

Constructor & Destructor Documentation

MoveUnitCommand::MoveUnitCommand ( Vehicle * unit )

Definition at line 97 of file moveunitcommand.cpp.

References ContainerBase::getMap(), and GameMap::sigCoordinateShift.

Member Function Documentation

bool MoveUnitCommand::avail ( Vehicle * eht ) [static]

Definition at line 36 of file moveunitcommand.cpp.

References Vehicle::canMove().

Referenced by GuiFunctions::MovementBase::available(), SearchReconquerBuilding::testfield(), and unitMovement().

bool MoveUnitCommand::ascendAvail ( Vehicle * eht ) [static]

Definition at line 46 of file moveunitcommand.cpp.

References Vehicle::getHeightChange().

Referenced by GuiFunctions::Ascend::available().

bool MoveUnitCommand::descendAvail ( Vehicle * eht ) [static]

Definition at line 54 of file moveunitcommand.cpp.

References Vehicle::getHeightChange().

Referenced by GuiFunctions::Descend::available().

void MoveUnitCommand::readData ( tnstream & stream ) [protected, virtual]

Reimplemented from UnitCommand.

Definition at line 424 of file moveunitcommand.cpp.

References MapCoordinate3D::read(), UnitCommand::readData(), and tnstream::readInt().

void MoveUnitCommand::writeData ( tnstream & stream ) const [protected, virtual]

Reimplemented from UnitCommand.

Definition at line 440 of file moveunitcommand.cpp.

References MapCoordinate3D::write(), UnitCommand::writeData(), and tnstream::writeInt().

GameActionID MoveUnitCommand::getID ( ) const [protected, virtual]

Implements GameAction.

Definition at line 456 of file moveunitcommand.cpp.

References ActionRegistry::MoveUnitCommand.

ASCString MoveUnitCommand::getDescription ( ) const [protected, virtual]

Implements GameAction.

Definition at line 461 of file moveunitcommand.cpp.

References Vehicle::getName(), getUnit(), and MapCoordinate::toString().

ActionResult MoveUnitCommand::go ( const Context & context ) [protected, virtual]

void MoveUnitCommand::setFlags ( int flags ) [inline]

Definition at line 81 of file moveunitcommand.h.

ActionResult MoveUnitCommand::searchFields	(	int	height = `-1`,
		int	capabilities = `0`
	)

void MoveUnitCommand::setVerticalDirection ( int dir )

defines whether we want to end up either at the same level of height (0), lower(<0), or heigher(>0)

Definition at line 415 of file moveunitcommand.cpp.

References LimitVerticalDirection.

int MoveUnitCommand::getVerticalDirection ( ) const [inline]

Definition at line 88 of file moveunitcommand.h.

Referenced by GuiFunctions::Movement::available(), GuiFunctions::MovementBase::available(), and searchFields().

void MoveUnitCommand::calcPath ( )

Definition at line 300 of file moveunitcommand.cpp.

References AStar3D::findPath(), GameMap::getField(), GameAction::getMap(), getUnit(), isFieldReachable3D(), and pi.

Referenced by go().

const AStar3D::Path & MoveUnitCommand::getPath ( )

Definition at line 352 of file moveunitcommand.cpp.

Referenced by GuiFunctions::MovementBase::available().

void MoveUnitCommand::setDestination ( const MapCoordinate & destination )

Definition at line 245 of file moveunitcommand.cpp.

References Command::Evaluated, MapField::getContainer(), GameMap::getField(), GameAction::getMap(), Command::getState(), getUnit(), searchFields(), Command::setState(), Command::SetUp, MapCoordinate::x, and MapCoordinate::y.

void MoveUnitCommand::setDestination ( const MapCoordinate3D & destination )

Definition at line 239 of file moveunitcommand.cpp.

References Command::setState(), and Command::SetUp.

ASCString MoveUnitCommand::getCommandString ( ) const [virtual]

Implements Command.

Definition at line 450 of file moveunitcommand.cpp.

References ASCString::format(), MapCoordinate3D::getNumericalHeight(), UnitCommand::getUnitID(), MapCoordinate::x, and MapCoordinate::y.

bool MoveUnitCommand::isFieldReachable	(	const MapCoordinate &	pos,
		bool	direct
	)

checks if the field can be reached by the unit this turn Precondition: searchFields(int,int) was called

Note:: this function accepts a 2D position, so you can not check whether the unit can reach a certain level of height This is geared for usage by the GUI and less suited to AI, which should rather use isFieldReachable3D

Parameters:

	pos	the destination field to check
	direct	if true then only return true of the unit can stop on the destination field if false, then fields over which the unit can pass, but cannot stop (for example because another unit is standing there) will also return true

Definition at line 277 of file moveunitcommand.cpp.

References MapCoordinate::x, and MapCoordinate::y.

Referenced by GuiFunctions::MovementBase::available(), and SearchReconquerBuilding::testfield().

bool MoveUnitCommand::isFieldReachable3D	(	const MapCoordinate3D &	pos,
		bool	direct
	)

Definition at line 291 of file moveunitcommand.cpp.

References AStar3D::findPath(), GameAction::getMap(), and getUnit().

Referenced by calcPath().

const set<MapCoordinate3D>& MoveUnitCommand::getReachableFields ( ) [inline]

this will return a 2D representation of the reachable fields.

That means, if the unit can go to different levels of height on the same field, this set will only contain the level of height which can be reached with the least movement.

These functions are geared towards the 2D user interface and are not well suited to AI usage

Definition at line 118 of file moveunitcommand.h.

const set<MapCoordinate3D>& MoveUnitCommand::getReachableFieldsIndirect ( ) [inline]

Definition at line 119 of file moveunitcommand.h.

const Vehicle* MoveUnitCommand::getUnit ( ) const [inline]

Reimplemented from UnitCommand.

Definition at line 121 of file moveunitcommand.h.

References UnitCommand::getUnit().

Referenced by calcPath(), getDescription(), go(), isFieldReachable3D(), longDistAvailable(), operatable(), searchFields(), and setDestination().