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

#include <renamecontainercommand.h>

Inheritance diagram for RenameContainerCommand:
Inheritance graph
[legend]

Public Member Functions

 RenameContainerCommand (ContainerBase *container)
 
void setName (const ASCString &publicName, const ASCString &privateName)
 
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 *container)
 
- 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
 
ActionResult undoAction (const Context &context)
 
- 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)
 
- 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 renamecontainercommand.h.

Constructor & Destructor Documentation

RenameContainerCommand::RenameContainerCommand ( ContainerBase container)

Definition at line 46 of file renamecontainercommand.cpp.

Member Function Documentation

bool RenameContainerCommand::avail ( const ContainerBase container)
static

Definition at line 37 of file renamecontainercommand.cpp.

Referenced by go(), and UnitInfoPanel::unitNaming().

ASCString RenameContainerCommand::getCommandString ( ) const
virtual

Implements Command.

Definition at line 120 of file renamecontainercommand.cpp.

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

ASCString RenameContainerCommand::getDescription ( ) const
protectedvirtual
GameActionID RenameContainerCommand::getID ( ) const
protectedvirtual

Implements GameAction.

Definition at line 128 of file renamecontainercommand.cpp.

References ActionRegistry::RenameContainerCommand.

ActionResult RenameContainerCommand::go ( const Context context)
virtual
void RenameContainerCommand::readData ( tnstream stream)
protectedvirtual
void RenameContainerCommand::setName ( const ASCString publicName,
const ASCString privateName 
)

Definition at line 54 of file renamecontainercommand.cpp.

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

ActionResult RenameContainerCommand::undoAction ( const Context context)
protectedvirtual
void RenameContainerCommand::writeData ( tnstream stream) const
protectedvirtual

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: