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

#include <spawnmine.h>

Inheritance diagram for SpawnMine:
Inheritance graph
[legend]

Public Member Functions

 SpawnMine (GameMap *gamemap, const MapCoordinate &position, MineTypes mineType, int owner, int strength)
 
ASCString getDescription () const
 
- 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 31 of file spawnmine.h.

Constructor & Destructor Documentation

SpawnMine::SpawnMine ( GameMap gamemap,
const MapCoordinate position,
MineTypes  mineType,
int  owner,
int  strength 
)

Definition at line 28 of file spawnmine.cpp.

Member Function Documentation

ASCString SpawnMine::getDescription ( ) const
virtual

Implements GameAction.

Definition at line 40 of file spawnmine.cpp.

References MapCoordinate::toString().

GameActionID SpawnMine::getID ( ) const
protectedvirtual

Implements GameAction.

Definition at line 78 of file spawnmine.cpp.

References ActionRegistry::SpawnMine.

void SpawnMine::readData ( tnstream stream)
protectedvirtual

Implements GameAction.

Definition at line 47 of file spawnmine.cpp.

References mineDataVersion, MapCoordinate::read(), and tnstream::readInt().

ActionResult SpawnMine::runAction ( const Context context)
protectedvirtual
ActionResult SpawnMine::undoAction ( const Context context)
protectedvirtual

Implements GameAction.

Definition at line 104 of file spawnmine.cpp.

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

ActionResult SpawnMine::verify ( )
protectedvirtual

Definition at line 125 of file spawnmine.cpp.

References GameAction::getMap().

void SpawnMine::writeData ( tnstream stream) const
protectedvirtual

Implements GameAction.

Definition at line 65 of file spawnmine.cpp.

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