command.cpp File Reference

#include "stratagus.h"
#include "actions.h"
#include "action/action_built.h"
#include "action/action_build.h"
#include "action/action_research.h"
#include "action/action_train.h"
#include "action/action_upgradeto.h"
#include "commands.h"
#include "map.h"
#include "pathfinder.h"
#include "player.h"
#include "spells.h"
#include "translate.h"
#include "upgrade.h"
#include "ui.h"
#include "unit.h"
#include "unit_manager.h"
#include "unittype.h"

Functions
command.cpp - Give units a command.
static void	ReleaseOrders (CUnit &unit)
static COrderPtr *	GetNextOrder (CUnit &unit, int flush)
static void	RemoveOrder (CUnit &unit, unsigned int order)
static void	ClearNewAction (CUnit &unit)
static void	ClearSavedAction (CUnit &unit)
static bool	IsUnitValidForNetwork (const CUnit &unit)
void	CommandStopUnit (CUnit &unit)
	Prepare command stop. More...
void	CommandStandGround (CUnit &unit, int flush)
	Prepare command stand ground. More...
void	CommandDefend (CUnit &unit, CUnit &dest, int flush)
	Prepare command defend. More...
void	CommandFollow (CUnit &unit, CUnit &dest, int flush)
	Prepare command follow. More...
void	CommandMove (CUnit &unit, const Vec2i &pos, int flush)
	Prepare command move. More...
void	CommandRepair (CUnit &unit, const Vec2i &pos, CUnit *dest, int flush)
	Prepare command repair. More...
void	CommandAutoRepair (CUnit &unit, int on)
	Send auto repair command. More...
void	CommandAttack (CUnit &unit, const Vec2i &pos, CUnit *target, int flush)
	Prepare command attack. More...
void	CommandAttackGround (CUnit &unit, const Vec2i &pos, int flush)
	Prepare command attack ground. More...
void	CommandPatrolUnit (CUnit &unit, const Vec2i &pos, int flush)
	Prepare command patrol. More...
void	CommandBoard (CUnit &unit, CUnit &dest, int flush)
	Prepare command board. More...
void	CommandUnload (CUnit &unit, const Vec2i &pos, CUnit *what, int flush)
	Prepare command unload. More...
void	CommandBuildBuilding (CUnit &unit, const Vec2i &pos, CUnitType &what, int flush)
	Prepare command build. More...
void	CommandExplore (CUnit &unit, int flush)
	Prepare command explore. More...
void	CommandDismiss (CUnit &unit)
	Prepare command dismiss. More...
void	CommandResourceLoc (CUnit &unit, const Vec2i &pos, int flush)
	Prepare command resource location. More...
void	CommandResource (CUnit &unit, CUnit &dest, int flush)
	Prepare command resource. More...
void	CommandReturnGoods (CUnit &unit, CUnit *depot, int flush)
	Prepare command return. More...
void	CommandTrainUnit (CUnit &unit, CUnitType &type, int)
	Prepare command train. More...
void	CommandCancelTraining (CUnit &unit, int slot, const CUnitType *type)
	Prepare command cancel training. More...
void	CommandUpgradeTo (CUnit &unit, CUnitType &type, int flush, bool instant)
	Prepare command upgrade to. More...
void	CommandTransformIntoType (CUnit &unit, CUnitType &type)
	immediate transforming into type. More...
void	CommandCancelUpgradeTo (CUnit &unit)
	Prepare command cancel upgrade to. More...
void	CommandResearch (CUnit &unit, CUpgrade &what, int flush)
	Prepare command research. More...
void	CommandCancelResearch (CUnit &unit)
	Prepare command cancel research. More...
void	CommandSpellCast (CUnit &unit, const Vec2i &pos, CUnit *dest, const SpellType &spell, int flush, bool isAutocast)
	Prepare command spellcast. More...
void	CommandAutoSpellCast (CUnit &unit, int spellid, int on)
	Prepare command auto spellcast. More...
void	CommandDiplomacy (int player, int state, int opponent)
	Prepare diplomacy command. More...
void	CommandSharedVision (int playerIndex, bool state, int opponentIndex)
	Prepare shared vision command. More...
void	CommandQuit (int player)
	Prepare command quit. More...

Function Documentation

ClearNewAction()

static void ClearNewAction ( CUnit &  unit )

static

ClearSavedAction()

static void ClearSavedAction ( CUnit &  unit )

static

Clear the saved action.

Parameters

unit	Unit pointer, that get the saved action cleared.

Note

If we make a new order, we must clear any saved actions.

Internal functions, must protect it, if needed.

CommandAttack()

void CommandAttack	(	CUnit &	unit,
		const Vec2i &	pos,
		CUnit *	target,
		int	flush
	)

Prepare command attack.

Attack with unit at new position

Parameters

unit	pointer to unit.
pos	map position to attack.
target	or unit to be attacked.
flush	if true, flush command queue.

CommandAttackGround()

void CommandAttackGround	(	CUnit &	unit,
		const Vec2i &	pos,
		int	flush
	)

Prepare command attack ground.

Attack ground with unit.

Parameters

unit	pointer to unit.
pos	map position to fire on.
flush	if true, flush command queue.

CommandAutoRepair()

void CommandAutoRepair	(	CUnit &	unit,
		int	on
	)

Send auto repair command.

Auto repair.

Parameters

unit	pointer to unit.
on	1 for auto repair on, 0 for off.

CommandAutoSpellCast()

void CommandAutoSpellCast	(	CUnit &	unit,
		int	spellid,
		int	on
	)

Prepare command auto spellcast.

Auto spell cast.

Parameters

unit	pointer to unit.
spellid	Spell id.
on	1 for auto cast on, 0 for off.

CommandBoard()

void CommandBoard	(	CUnit &	unit,
		CUnit &	dest,
		int	flush
	)

Prepare command board.

Board a transporter with unit.

Parameters

unit	pointer to unit.
dest	unit to be boarded.
flush	if true, flush command queue.

CommandBuildBuilding()

void CommandBuildBuilding	(	CUnit &	unit,
		const Vec2i &	pos,
		CUnitType &	what,
		int	flush
	)

Prepare command build.

Send a unit building

Parameters

unit	pointer to unit.
pos	map position to build.
what	Unit type to build.
flush	if true, flush command queue.

CommandCancelResearch()

void CommandCancelResearch

(

CUnit &

unit

)

Prepare command cancel research.

Cancel Building researching.

Parameters

unit	Pointer to unit.

CommandCancelTraining()

void CommandCancelTraining	(	CUnit &	unit,
		int	slot,
		const CUnitType *	type
	)

Prepare command cancel training.

Cancel the training of an unit.

Parameters

unit	pointer to unit.
slot	slot number to cancel.
type	Unit-type to cancel.

CommandCancelUpgradeTo()

void CommandCancelUpgradeTo

(

CUnit &

unit

)

Prepare command cancel upgrade to.

Cancel building upgrading to.

Parameters

unit	pointer to unit.

CommandDefend()

void CommandDefend	(	CUnit &	unit,
		CUnit &	dest,
		int	flush
	)

Prepare command defend.

Follow unit and defend it

Parameters

unit	pointer to unit.
dest	unit to follow
flush	if true, flush command queue.

CommandDiplomacy()

void CommandDiplomacy	(	int	player,
		int	state,
		int	opponent
	)

Prepare diplomacy command.

Diplomacy changed.

Parameters

player	Player which changes his state.
state	New diplomacy state.
opponent	Opponent.

CommandDismiss()

void CommandDismiss

(

CUnit &

unit

)

Prepare command dismiss.

Cancel the building construction, or kill a unit.

Parameters

unit	pointer to unit.

CommandExplore()

void CommandExplore	(	CUnit &	unit,
		int	flush
	)

Prepare command explore.

Send a unit exploring

Parameters

unit	pointer to unit.
flush	if true, flush command queue.

CommandFollow()

void CommandFollow	(	CUnit &	unit,
		CUnit &	dest,
		int	flush
	)

Prepare command follow.

Follow unit to new position

Parameters

unit	pointer to unit.
dest	unit to be followed
flush	if true, flush command queue.

CommandMove()

void CommandMove	(	CUnit &	unit,
		const Vec2i &	pos,
		int	flush
	)

Prepare command move.

Move unit to new position

Parameters

unit	pointer to unit.
pos	map position to move to.
flush	if true, flush command queue.

CommandPatrolUnit()

void CommandPatrolUnit	(	CUnit &	unit,
		const Vec2i &	pos,
		int	flush
	)

Prepare command patrol.

Let a unit patrol from current to new position

FIXME: want to support patroling between units.

Parameters

unit	pointer to unit.
pos	map position to patrol between.
flush	if true, flush command queue.

CommandQuit()

void CommandQuit

(

int

player

)

Prepare command quit.

Player quit.

Parameters

player

Player number that quit.

CommandRepair()

void CommandRepair	(	CUnit &	unit,
		const Vec2i &	pos,
		CUnit *	dest,
		int	flush
	)

Prepare command repair.

Repair unit

Parameters

unit	pointer to unit.
pos	map position to repair.
dest	or unit to be repaired. FIXME: not supported
flush	if true, flush command queue.

CommandResearch()

void CommandResearch	(	CUnit &	unit,
		CUpgrade &	what,
		int	flush
	)

Prepare command research.

Building starts researching.

Parameters

unit	pointer to unit.
what	what to research.
flush	if true, flush command queue.

CommandResource()

void CommandResource	(	CUnit &	unit,
		CUnit &	dest,
		int	flush
	)

Prepare command resource.

Send unit to harvest resources

Parameters

unit	pointer to unit.
dest	destination unit.
flush	if true, flush command queue.

CommandResourceLoc()

void CommandResourceLoc	(	CUnit &	unit,
		const Vec2i &	pos,
		int	flush
	)

Prepare command resource location.

Send unit harvest a location

Parameters

unit	pointer to unit.
pos	map position for harvest.
flush	if true, flush command queue.

CommandReturnGoods()

void CommandReturnGoods	(	CUnit &	unit,
		CUnit *	depot,
		int	flush
	)

Prepare command return.

Let unit returning goods.

Parameters

unit	pointer to unit.
depot	bring goods to this depot.
flush	if true, flush command queue.

CommandSharedVision()

void CommandSharedVision	(	int	playerIndex,
		bool	state,
		int	opponentIndex
	)

Prepare shared vision command.

Shared vision changed.

Parameters

playerIndex	Player which changes his state.
state	New shared vision state.
opponentIndex	Opponent.

TODO: change ThisPlayer to currently rendered player/players #RenderTargets

CommandSpellCast()

void CommandSpellCast	(	CUnit &	unit,
		const Vec2i &	pos,
		CUnit *	dest,
		const SpellType &	spell,
		int	flush,
		bool	isAutocast
	)

Prepare command spellcast.

Cast a spell at position or unit.

Parameters

unit	Pointer to unit.
pos	map position to spell cast on.
dest	Spell cast on unit (if exist).
spell	Spell type pointer.
flush	If true, flush command queue.

CommandStandGround()

void CommandStandGround	(	CUnit &	unit,
		int	flush
	)

Prepare command stand ground.

Stand ground.

Parameters

unit	pointer to unit.
flush	if true, flush command queue.

CommandStopUnit()

void CommandStopUnit

(

CUnit &

unit

)

Prepare command stop.

Stop unit.

Parameters

unit	pointer to unit.

CommandTrainUnit()

void CommandTrainUnit	(	CUnit &	unit,
		CUnitType &	type,
		int
	)

Prepare command train.

Building starts training an unit.

Parameters

unit	pointer to unit.
type	unit type to train.
flush	if true, flush command queue.

CommandTransformIntoType()

void CommandTransformIntoType	(	CUnit &	unit,
		CUnitType &	type
	)

immediate transforming into type.

Immediate transforming unit into type.

Parameters

unit	pointer to unit.
type	upgrade to type

CommandUnload()

void CommandUnload	(	CUnit &	unit,
		const Vec2i &	pos,
		CUnit *	what,
		int	flush
	)

Prepare command unload.

Unload a transporter.

Parameters

unit	pointer to unit.
pos	map position to unload.
what	unit to be unloaded, NULL for all.
flush	if true, flush command queue.

CommandUpgradeTo()

void CommandUpgradeTo	(	CUnit &	unit,
		CUnitType &	type,
		int	flush,
		bool	instant
	)

Prepare command upgrade to.

Building starts upgrading to.

Parameters

unit	pointer to unit.
type	upgrade to type
flush	if true, flush command queue.

GetNextOrder()

static COrderPtr* GetNextOrder ( CUnit &  unit, int  flush  )

static

Get next free order slot.

Parameters

unit	pointer to unit.
flush	if true, flush order queue.

Returns

Pointer to next free order slot.

IsUnitValidForNetwork()

static bool IsUnitValidForNetwork ( const CUnit &  unit )

static

ReleaseOrders()

static void ReleaseOrders ( CUnit &  unit )

static

Release all orders of a unit.

Parameters

unit	Pointer to unit.

RemoveOrder()

static void RemoveOrder ( CUnit &  unit, unsigned int  order  )

static

Remove an order from the list of orders pending

Parameters

unit	pointer to unit
order	number of the order to remove