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

#include <transfercontrolcommand.h>

Inheritance diagram for TransferControlCommand:
Inheritance graph

Public Types

typedef vector< const Player * > Receivers
- Public Types inherited from Command
enum  State {
  Planned, Evaluated, SetUp, Run,
  Finished, Failed

Public Member Functions

 TransferControlCommand (ContainerBase *item)
Receivers getReceivers ()
void setReceiver (const Player *receiver)
ActionResult go (const Context &context)
ASCString getCommandString () const
- 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 *item)
- 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)

Detailed Description

Definition at line 32 of file transfercontrolcommand.h.

Member Typedef Documentation

typedef vector<const Player*> TransferControlCommand::Receivers

Definition at line 36 of file transfercontrolcommand.h.

Constructor & Destructor Documentation

TransferControlCommand::TransferControlCommand ( ContainerBase item)

Definition at line 79 of file transfercontrolcommand.cpp.

Member Function Documentation

bool TransferControlCommand::avail ( const ContainerBase item)
ASCString TransferControlCommand::getCommandString ( ) const

Implements Command.

Definition at line 152 of file transfercontrolcommand.cpp.

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

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

Implements GameAction.

Definition at line 160 of file transfercontrolcommand.cpp.

References ActionRegistry::TransferControlCommand.

TransferControlCommand::Receivers TransferControlCommand::getReceivers ( )

Definition at line 73 of file transfercontrolcommand.cpp.

References ContainerCommand::getContainer(), and GameAction::getMap().

Referenced by avail(), and go().

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

Reimplemented from ContainerCommand.

Definition at line 127 of file transfercontrolcommand.cpp.

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

void TransferControlCommand::setReceiver ( const Player receiver)
void TransferControlCommand::writeData ( tnstream stream) const

Reimplemented from ContainerCommand.

Definition at line 136 of file transfercontrolcommand.cpp.

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

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: