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

#include <putminecommand.h>

Inheritance diagram for PutMineCommand:
Inheritance graph
[legend]

Public Member Functions

 PutMineCommand (Vehicle *unit)
 
ActionResult searchFields ()
 
void setCreationTarget (const MapCoordinate &target, MineTypes mineType)
 
void setRemovalTarget (const MapCoordinate &target)
 
ActionResult go (const Context &context)
 
ASCString getCommandString () const
 
const vector< MineTypes > & getCreatableMines (const MapCoordinate &pos)
 
bool getRemovableMines (const MapCoordinate &pos)
 
vector< MapCoordinategetFields ()
 
- Public Member Functions inherited from UnitCommand
virtual vector< MapCoordinategetCoordinates () const
 this is for informational purposes, so the player can see where a Command has taken place when reviewing it More...
 
int getUnitTypeID () const
 
- Public Member Functions inherited from Command
State getState () const
 
ActionResult redo (const Context &context)
 
- 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 (Vehicle *eht)
 
- 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 UnitCommand
const VehiclegetUnit () const
 
VehiclegetUnit ()
 
int getUnitID () const
 
 UnitCommand (GameMap *map)
 
 UnitCommand (Vehicle *vehicle)
 
void readData (tnstream &stream)
 
void writeData (tnstream &stream) const
 
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
 

Friends

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 putminecommand.h.

Constructor & Destructor Documentation

PutMineCommand::PutMineCommand ( Vehicle unit)

Member Function Documentation

bool PutMineCommand::avail ( Vehicle eht)
static
ASCString PutMineCommand::getCommandString ( ) const
virtual
const vector< MineTypes > & PutMineCommand::getCreatableMines ( const MapCoordinate pos)

Definition at line 82 of file putminecommand.cpp.

Referenced by GuiFunctions::PutMineStage2::available().

ASCString PutMineCommand::getDescription ( ) const
protectedvirtual

Implements GameAction.

Definition at line 263 of file putminecommand.cpp.

References Vehicle::getName(), UnitCommand::getUnit(), and MapCoordinate::toString().

vector< MapCoordinate > PutMineCommand::getFields ( )

Definition at line 72 of file putminecommand.cpp.

GameActionID PutMineCommand::getID ( ) const
protectedvirtual

Implements GameAction.

Definition at line 258 of file putminecommand.cpp.

References ActionRegistry::PutMineCommand.

bool PutMineCommand::getRemovableMines ( const MapCoordinate pos)

Definition at line 87 of file putminecommand.cpp.

Referenced by GuiFunctions::RemoveMine::available().

ActionResult PutMineCommand::go ( const Context context)
virtual
void PutMineCommand::readData ( tnstream stream)
protectedvirtual

Reimplemented from Command.

Definition at line 219 of file putminecommand.cpp.

References MapCoordinate::read(), UnitCommand::readData(), and tnstream::readInt().

ActionResult PutMineCommand::searchFields ( )
void PutMineCommand::setCreationTarget ( const MapCoordinate target,
MineTypes  mineType 
)
void PutMineCommand::setRemovalTarget ( const MapCoordinate target)
void PutMineCommand::writeData ( tnstream stream) const
protectedvirtual

Reimplemented from Command.

Definition at line 234 of file putminecommand.cpp.

References MapCoordinate::write(), UnitCommand::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: