commands.h File Reference

#include "vec2i.h"

Go to the source code of this file.

commands.h - The commands header file.
#define	FlushCommands   1
typedef unsigned short	UnitRef
void	CommandQuit (int player)
	Prepare command quit. More...
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 *dest, 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 &, 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 &what, int flush)
	Prepare command train. More...
void	CommandCancelTraining (CUnit &unit, int slot, const CUnitType *type)
	Prepare command cancel training. More...
void	CommandUpgradeTo (CUnit &unit, CUnitType &what, int flush, bool instant=false)
	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=false)
	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 player, bool state, int opponent)
	Prepare shared vision command. More...
void	SendCommandStopUnit (CUnit &unit)
	Send stop command. More...
void	SendCommandStandGround (CUnit &unit, int flush)
	Send stand ground command. More...
void	SendCommandDefend (CUnit &unit, CUnit &dest, int flush)
	Send defend command. More...
void	SendCommandFollow (CUnit &unit, CUnit &dest, int flush)
	Send follow command. More...
void	SendCommandMove (CUnit &unit, const Vec2i &pos, int flush)
	Send move command. More...
void	SendCommandRepair (CUnit &unit, const Vec2i &pos, CUnit *dest, int flush)
	Send repair command. More...
void	SendCommandAutoRepair (CUnit &unit, int on)
	Send auto repair command. More...
void	SendCommandAttack (CUnit &unit, const Vec2i &pos, CUnit *dest, int flush)
	Send attack command. More...
void	SendCommandAttackGround (CUnit &unit, const Vec2i &pos, int flush)
	Send attack ground command. More...
void	SendCommandPatrol (CUnit &unit, const Vec2i &pos, int flush)
	Send patrol command. More...
void	SendCommandBoard (CUnit &unit, CUnit &dest, int flush)
	Send board command. More...
void	SendCommandUnload (CUnit &unit, const Vec2i &pos, CUnit *what, int flush)
	Send unload command. More...
void	SendCommandBuildBuilding (CUnit &unit, const Vec2i &pos, CUnitType &what, int flush)
	Send build building command. More...
void	SendCommandExplore (CUnit &unit, int flush)
	Send explore command. More...
void	SendCommandDismiss (CUnit &unit)
	Send cancel building command. More...
void	SendCommandResourceLoc (CUnit &unit, const Vec2i &pos, int flush)
	Send harvest location command. More...
void	SendCommandResource (CUnit &unit, CUnit &dest, int flush)
	Send harvest command. More...
void	SendCommandReturnGoods (CUnit &unit, CUnit *dest, int flush)
	Send return goods command. More...
void	SendCommandTrainUnit (CUnit &unit, CUnitType &what, int flush)
	Send train command. More...
void	SendCommandCancelTraining (CUnit &unit, int slot, const CUnitType *type)
	Send cancel training command. More...
void	SendCommandUpgradeTo (CUnit &unit, CUnitType &what, int flush)
	Send upgrade to command. More...
void	SendCommandCancelUpgradeTo (CUnit &unit)
	Send cancel upgrade to command. More...
void	SendCommandResearch (CUnit &unit, CUpgrade &what, int flush)
	Send research command. More...
void	SendCommandCancelResearch (CUnit &unit)
	Send cancel research command. More...
void	SendCommandSpellCast (CUnit &unit, const Vec2i &pos, CUnit *dest, int spellid, int flush)
	Send spell cast command. More...
void	SendCommandAutoSpellCast (CUnit &unit, int spellid, int on)
	Send auto spell cast command. More...
void	SendCommandDiplomacy (int player, int state, int opponent)
	Send diplomacy command. More...
void	SendCommandSharedVision (int player, bool state, int opponent)
	Send shared vision command. More...
void	ExecCommand (unsigned char type, UnitRef unum, unsigned short x, unsigned short y, UnitRef dest)
	Execute a command (from network). More...
void	ExecExtendedCommand (unsigned char type, int status, unsigned char arg1, unsigned short arg2, unsigned short arg3, unsigned short arg4)
	Execute an extended command (from network). More...

Macro Definition Documentation

FlushCommands

#define FlushCommands   1

Typedef Documentation

UnitRef

typedef unsigned short UnitRef

Unit references over network, or for memory saving.

Function Documentation

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.

This function gives a unit a new command. If the command is given by the user the function with Send prefix should be used.

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.

ExecCommand()

void ExecCommand	(	unsigned char	msgnr,
		UnitRef	unum,
		unsigned short	x,
		unsigned short	y,
		UnitRef	dstnr
	)

Execute a command (from network).

Execute a command (from network).

Parameters

msgnr	Network message type
unum	Unit number (slot) that receive the command.
x	optional X map position.
y	optional y map position.
dstnr	optional destination unit.

ExecExtendedCommand()

void ExecExtendedCommand	(	unsigned char	type,
		int	status,
		unsigned char	arg1,
		unsigned short	arg2,
		unsigned short	arg3,
		unsigned short	arg4
	)

Execute an extended command (from network).

Execute an extended command (from network).

Parameters

type	Network extended message type
status	Bit 7 of message type
arg1	Messe argument 1
arg2	Messe argument 2
arg3	Messe argument 3
arg4	Messe argument 4

arg1: 0:true / 1:false

CommandLog(...);

CommandLog(...);

arg1: 0:cShadowCasting / 1:cSimpleRadial

CommandLog(...);

CommandLog(...);

Arg2: Opaque fields flags

CommandLog(...);

CommandLog(...);

arg1: enable/disable fog

arg2: request for update

CommandLog(...);

SendCommandAttack()

void SendCommandAttack	(	CUnit &	unit,
		const Vec2i &	pos,
		CUnit *	attack,
		int	flush
	)

Send attack command.

Send command: Unit attack unit or at position.

Parameters

unit	pointer to unit.
pos	map tile position to attack.
attack	or !=NoUnitP unit to be attacked.
flush	Flag flush all pending commands.

SendCommandAttackGround()

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

Send attack ground command.

Send command: Unit attack ground.

Parameters

unit	pointer to unit.
pos	map tile position to fire on.
flush	Flag flush all pending commands.

SendCommandAutoRepair()

void SendCommandAutoRepair	(	CUnit &	unit,
		int	on
	)

Send auto repair command.

Send command: Unit auto repair.

Parameters

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

SendCommandAutoSpellCast()

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

Send auto spell cast command.

Send command: Unit auto spell cast.

Parameters

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

SendCommandBoard()

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

Send board command.

Send command: Unit board unit.

Parameters

unit	pointer to unit.
dest	Destination to be boarded.
flush	Flag flush all pending commands.

SendCommandBuildBuilding()

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

Send build building command.

Send command: Unit builds building at position.

Parameters

unit	pointer to unit.
pos	map tile position of construction.
what	pointer to unit-type of the building.
flush	Flag flush all pending commands.

SendCommandCancelResearch()

void SendCommandCancelResearch

(

CUnit &

unit

)

Send cancel research command.

Send command: Cancel Building/unit research.

Parameters

unit	pointer to unit.

SendCommandCancelTraining()

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

Send cancel training command.

Send command: Cancel training.

Parameters

unit	Pointer to unit.
slot	Slot of training queue to cancel.
type	Unit-type of unit to cancel.

SendCommandCancelUpgradeTo()

void SendCommandCancelUpgradeTo

(

CUnit &

unit

)

Send cancel upgrade to command.

Send command: Cancel building upgrading to.

Parameters

unit	Pointer to unit.

SendCommandDefend()

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

Send defend command.

Send command: Defend some unit.

Parameters

unit	pointer to unit.
dest	defend this unit.
flush	Flag flush all pending commands.

SendCommandDiplomacy()

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

Send diplomacy command.

Send command: Diplomacy changed.

Parameters

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

SendCommandDismiss()

void SendCommandDismiss

(

CUnit &

unit

)

Send cancel building command.

Send command: Cancel this building construction.

Parameters

unit	pointer to unit.

SendCommandExplore()

void SendCommandExplore	(	CUnit &	unit,
		int	flush
	)

Send explore command.

Send command: Unit explores the map.

Parameters

unit	pointer to unit.
flush	Flag flush all pending commands.

SendCommandFollow()

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

Send follow command.

Send command: Follow unit to position.

Parameters

unit	pointer to unit.
dest	follow this unit.
flush	Flag flush all pending commands.

SendCommandMove()

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

Send move command.

Send command: Move unit to position.

Parameters

unit	pointer to unit.
pos	map tile position to move to.
flush	Flag flush all pending commands.

SendCommandPatrol()

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

Send patrol command.

Send command: Unit patrol between current and position.

Parameters

unit	pointer to unit.
pos	map tile position to patrol between.
flush	Flag flush all pending commands.

SendCommandRepair()

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

Send repair command.

Send command: Unit repair.

Parameters

unit	Pointer to unit.
pos	map tile position to repair.
dest	Unit to be repaired.
flush	Flag flush all pending commands.

SendCommandResearch()

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

Send research command.

Send command: Building/unit research.

Parameters

unit	pointer to unit.
what	research-type of the research.
flush	Flag flush all pending commands.

SendCommandResource()

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

Send harvest command.

Send command: Unit harvest resources

Parameters

unit	pointer to unit.
dest	pointer to destination (oil-platform,gold mine).
flush	Flag flush all pending commands.

SendCommandResourceLoc()

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

Send harvest location command.

Send command: Unit harvests a location (wood for now).

Parameters

unit	pointer to unit.
pos	map tile position where to harvest.
flush	Flag flush all pending commands.

SendCommandReturnGoods()

void SendCommandReturnGoods	(	CUnit &	unit,
		CUnit *	goal,
		int	flush
	)

Send return goods command.

Send command: Unit return goods.

Parameters

unit	pointer to unit.
goal	pointer to destination of the goods. (NULL=search best)
flush	Flag flush all pending commands.

SendCommandSharedVision()

void SendCommandSharedVision	(	int	player,
		bool	state,
		int	opponent
	)

Send shared vision command.

Send command: Shared vision changed.

Parameters

player	Player which changes his state.
state	New shared vision state.
opponent	Opponent.

SendCommandSpellCast()

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

Send spell cast command.

Send command: Unit spell cast on position/unit.

Parameters

unit	pointer to unit.
pos	map tile position where to cast spell.
dest	Cast spell on unit (if exist).
spellid	Spell type id.
flush	Flag flush all pending commands.

SendCommandStandGround()

void SendCommandStandGround	(	CUnit &	unit,
		int	flush
	)

Send stand ground command.

Send command: Unit stand ground.

Parameters

unit	pointer to unit.
flush	Flag flush all pending commands.

SendCommandStopUnit()

void SendCommandStopUnit

(

CUnit &

unit

)

Send stop command.

Send command: Unit stop.

Parameters

unit	pointer to unit.

SendCommandTrainUnit()

void SendCommandTrainUnit	(	CUnit &	unit,
		CUnitType &	what,
		int	flush
	)

Send train command.

Send command: Building/unit train new unit.

Parameters

unit	pointer to unit.
what	pointer to unit-type of the unit to be trained.
flush	Flag flush all pending commands.

SendCommandUnload()

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

Send unload command.

Send command: Unit unload unit.

Parameters

unit	pointer to unit.
pos	map tile position of unload.
what	Passagier to be unloaded.
flush	Flag flush all pending commands.

SendCommandUpgradeTo()

void SendCommandUpgradeTo	(	CUnit &	unit,
		CUnitType &	what,
		int	flush
	)

Send upgrade to command.

Send command: Building starts upgrading to.

Parameters

unit	pointer to unit.
what	pointer to unit-type of the unit upgrade.
flush	Flag flush all pending commands.