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

#include <removemine.h>

Inheritance diagram for RemoveMine:
Inheritance graph
[legend]

Public Member Functions

 RemoveMine (GameMap *gamemap, const MapCoordinate &position, int mineID=0)
 mineID = 0 will remove all mines on that field More...
 
ASCString getDescription () const
 
 ~RemoveMine ()
 
- 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 ()
 

Protected Member Functions

virtual GameActionID getID () const
 
virtual ActionResult runAction (const Context &context)
 
virtual ActionResult undoAction (const Context &context)
 
virtual ActionResult verify ()
 
virtual void readData (tnstream &stream)
 
virtual void writeData (tnstream &stream) const
 
- 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

- Static Public Member Functions inherited from GameAction
static GameActionreadFromStream (tnstream &stream, GameMap *map)
 

Detailed Description

Definition at line 30 of file removemine.h.

Constructor & Destructor Documentation

RemoveMine::RemoveMine ( GameMap gamemap,
const MapCoordinate position,
int  mineID = 0 
)

mineID = 0 will remove all mines on that field

Definition at line 28 of file removemine.cpp.

RemoveMine::~RemoveMine ( )

Definition at line 146 of file removemine.cpp.

Member Function Documentation

ASCString RemoveMine::getDescription ( ) const
virtual

Implements GameAction.

Definition at line 35 of file removemine.cpp.

References ASCString::toString(), and MapCoordinate::toString().

GameActionID RemoveMine::getID ( ) const
protectedvirtual

Implements GameAction.

Definition at line 77 of file removemine.cpp.

References ActionRegistry::RemoveMine.

void RemoveMine::readData ( tnstream stream)
protectedvirtual
ActionResult RemoveMine::runAction ( const Context context)
protectedvirtual

Implements GameAction.

Definition at line 82 of file removemine.cpp.

References GameMap::getField(), GameAction::getMap(), MapField::mines, and tnstream::writing.

ActionResult RemoveMine::undoAction ( const Context context)
protectedvirtual
ActionResult RemoveMine::verify ( )
protectedvirtual

Definition at line 141 of file removemine.cpp.

void RemoveMine::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: