Advanced Strategic Command
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
TrainUnitCommand Class Reference

#include <trainunitcommand.h>

Inheritance diagram for TrainUnitCommand:
Inheritance graph

Public Member Functions

 TrainUnitCommand (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< MapCoordinategetCoordinates () 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 Public Member Functions inherited from GameAction
static GameActionreadFromStream (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
ContainerBasegetContainer (bool dontThrow=false)
const ContainerBasegetContainer (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...
GameMapgetMap ()
const GameMapgetMap () const


template<class Child >
GameActionGameActionCreator (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 trainunitcommand.h.

Constructor & Destructor Documentation

TrainUnitCommand::TrainUnitCommand ( ContainerBase carrier)

Definition at line 80 of file trainunitcommand.cpp.

Member Function Documentation

bool TrainUnitCommand::avail ( const ContainerBase carrier,
const Vehicle unit 
ASCString TrainUnitCommand::getCommandString ( ) const

Implements Command.

Definition at line 184 of file trainunitcommand.cpp.

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

ASCString TrainUnitCommand::getDescription ( ) const
GameActionID TrainUnitCommand::getID ( ) const

Implements GameAction.

Definition at line 192 of file trainunitcommand.cpp.

References ActionRegistry::TrainUnitCommand.

ActionResult TrainUnitCommand::go ( const Context context)
void TrainUnitCommand::readData ( tnstream stream)

Reimplemented from ContainerCommand.

Definition at line 161 of file trainunitcommand.cpp.

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

void TrainUnitCommand::setUnit ( Vehicle unit)

Definition at line 177 of file trainunitcommand.cpp.

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

void TrainUnitCommand::writeData ( tnstream stream) const

Friends And Related Function Documentation

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

Definition at line 114 of file action.h.

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