Advanced Strategic Command: RecycleUnitCommand Class Reference

Advanced Strategic Command

#include <recycleunitcommand.h>

Inheritance diagram for RecycleUnitCommand:

Inheritance graph

Public Member Functions
	RecycleUnitCommand (ContainerBase *carrier)

ActionResult	go (const Context &context)

ASCString	getCommandString () const

void	setUnit (Vehicle *unit)

Public Member Functions inherited from Command
State	getState () const

ActionResult	redo (const Context &context)

virtual vector< MapCoordinate >	getCoordinates () const
	this is for informational purposes, so the player can see where a Command has taken place when reviewing it More...

Public Member Functions inherited from GameAction
ActionResult	execute (const Context &context)

ActionResult	undo (const Context &context)

void	read (tnstream &stream)

void	write (tnstream &stream) const

void	write (tnstream &stream, bool persistChildren) const

virtual	~GameAction ()

Static Public Member Functions
static bool	avail (const ContainerBase carrier, const Vehicle unit)

static Resources	getOutput (const ContainerBase carrier, const Vehicle unit)

Static Public Member Functions inherited from GameAction
static GameAction *	readFromStream (tnstream &stream, GameMap *map)

Protected Member Functions
void	readData (tnstream &stream)

void	writeData (tnstream &stream) const

GameActionID	getID () const

ASCString	getDescription () const

Protected Member Functions inherited from ContainerCommand
ContainerBase *	getContainer (bool dontThrow=false)

const ContainerBase *	getContainer (bool dontThrow=false) const

int	getContainerID () const

	ContainerCommand (ContainerBase *container)

	ContainerCommand (GameMap *map)

ActionResult	checkExecutionPrecondition () const

Protected Member Functions inherited from Command
	Command (GameMap *gamemap)

void	setState (State state)

virtual ActionResult	runAction (const Context &context)

virtual ActionResult	undoAction (const Context &context)

Protected Member Functions inherited from GameAction
void	deleteChildren ()

	GameAction (GameMap *map)

void	addChild (GameAction *action)
	adds a child action. Ownership of the child action is passed to THIS More...

virtual ActionResult	preCheck ()
	preCheck is called before an action is redone and should check the preconditions for the action. More...

virtual ActionResult	postCheck ()
	postCheck is called after an action has been redone and should check that the state of the map is exactly the same as it was after the action has been executed the first time. More...

virtual bool	undoOrderChildFirst () const
	determines the order in which the child actions are undone. More...

GameMap *	getMap ()

const GameMap *	getMap () const

Friends
template<class Child >
GameAction *	GameActionCreator (GameMap *map)

Additional Inherited Members
Public Types inherited from Command
enum	State { Planned, Evaluated, SetUp, Run, Finished, Failed }

Detailed Description

Definition at line 32 of file recycleunitcommand.h.

Constructor & Destructor Documentation

RecycleUnitCommand::RecycleUnitCommand ( ContainerBase * carrier )

Definition at line 75 of file recycleunitcommand.cpp.

Member Function Documentation

bool RecycleUnitCommand::avail	(	const ContainerBase *	carrier,
		const Vehicle *	unit
	)

static

Definition at line 37 of file recycleunitcommand.cpp.

References ContainerBase::findUnit(), ContainerBase::isBuilding(), and Vehicle::networkid.

Referenced by CargoGuiFunctions::RecycleUnitCommandButton::available(), getOutput(), go(), and recycleUnit().

ASCString RecycleUnitCommand::getCommandString ( ) const

virtual

Implements Command.

Definition at line 156 of file recycleunitcommand.cpp.

References ASCString::format(), and ContainerCommand::getContainerID().

ASCString RecycleUnitCommand::getDescription ( ) const

protectedvirtual

Implements GameAction.

Definition at line 169 of file recycleunitcommand.cpp.

References ContainerCommand::getContainer(), GameAction::getMap(), Vehicle::getName(), ContainerBase::getName(), and GameMap::getUnit().

GameActionID RecycleUnitCommand::getID ( ) const

protectedvirtual

Implements GameAction.

Definition at line 164 of file recycleunitcommand.cpp.

References ActionRegistry::RecycleUnitCommand.

Resources RecycleUnitCommand::getOutput	(	const ContainerBase *	carrier,
		const Vehicle *	unit
	)

static

Definition at line 52 of file recycleunitcommand.cpp.

References avail(), ContainerBase::baseType, ContainerBase::damage, destructoutput, ContainerBase::getCargo(), ContainerBaseType::hasFunction(), Resources::material, ContainerBaseType::productionCost, ContainerBaseType::RecycleUnits, recyclingoutput, and Vehicle::typ.

Referenced by CargoGuiFunctions::RecycleUnitCommandButton::getName(), and go().

ActionResult RecycleUnitCommand::go ( const Context & context )

virtual

void RecycleUnitCommand::readData ( tnstream & stream )

protectedvirtual

Reimplemented from ContainerCommand.

Definition at line 133 of file recycleunitcommand.cpp.

References ContainerCommand::readData(), tnstream::readInt(), and RecycleUnitCommandVersion.

void RecycleUnitCommand::setUnit ( Vehicle * unit )

Definition at line 149 of file recycleunitcommand.cpp.

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

Referenced by testRecycling().

void RecycleUnitCommand::writeData ( tnstream & stream ) const

protectedvirtual

Reimplemented from ContainerCommand.

Definition at line 142 of file recycleunitcommand.cpp.

References RecycleUnitCommandVersion, ContainerCommand::writeData(), and tnstream::writeInt().

Friends And Related Function Documentation

template<class Child >

GameAction* GameActionCreator ( GameMap * map )

friend

Definition at line 114 of file action.h.

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