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

#include <putobjectcommand.h>

Inheritance diagram for PutObjectCommand:
Inheritance graph
[legend]

Public Member Functions

 PutObjectCommand (Vehicle *unit)
 
ActionResult searchFields ()
 
VehiclegetAttacker ()
 
void setTarget (const MapCoordinate &target, int objectID)
 
ActionResult go (const Context &context)
 
ASCString getCommandString () const
 
const set< int > & getCreatableObjects (const MapCoordinate &pos)
 
const set< int > & getRemovableObjects (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 putobjectcommand.h.

Constructor & Destructor Documentation

PutObjectCommand::PutObjectCommand ( Vehicle unit)

Definition at line 50 of file putobjectcommand.cpp.

Member Function Documentation

bool PutObjectCommand::avail ( Vehicle eht)
static
Vehicle* PutObjectCommand::getAttacker ( )
inline

Definition at line 65 of file putobjectcommand.h.

References UnitCommand::getUnit().

ASCString PutObjectCommand::getCommandString ( ) const
virtual
const set< int > & PutObjectCommand::getCreatableObjects ( const MapCoordinate pos)

Definition at line 69 of file putobjectcommand.cpp.

Referenced by GuiFunctions::ObjectBuildingGui::eval().

ASCString PutObjectCommand::getDescription ( ) const
protectedvirtual
vector< MapCoordinate > PutObjectCommand::getFields ( )

Definition at line 57 of file putobjectcommand.cpp.

GameActionID PutObjectCommand::getID ( ) const
protectedvirtual

Implements GameAction.

Definition at line 298 of file putobjectcommand.cpp.

References ActionRegistry::PutObjectCommand.

const set< int > & PutObjectCommand::getRemovableObjects ( const MapCoordinate pos)

Definition at line 74 of file putobjectcommand.cpp.

Referenced by GuiFunctions::ObjectBuildingGui::eval().

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

Reimplemented from Command.

Definition at line 267 of file putobjectcommand.cpp.

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

ActionResult PutObjectCommand::searchFields ( )
void PutObjectCommand::setTarget ( const MapCoordinate target,
int  objectID 
)
void PutObjectCommand::writeData ( tnstream stream) const
protectedvirtual

Reimplemented from Command.

Definition at line 278 of file putobjectcommand.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: