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

#include <inflictdamage.h>

Inheritance diagram for InflictDamage:
Inheritance graph
[legend]

Public Member Functions

 InflictDamage (ContainerBase *container, int damage)
 
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 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 void readData (tnstream &stream)
 
virtual void writeData (tnstream &stream) const
 
- Protected Member Functions inherited from ContainerAction
void setID (int id)
 should usually not be called, the ID should only be set through the constructor More...
 
ContainerBasegetContainer (bool dontThrow=false)
 
const ContainerBasegetContainer (bool dontThrow=false) const
 
 ContainerAction (ContainerBase *container)
 
 ContainerAction (GameMap *map)
 
- 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 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 29 of file inflictdamage.h.

Constructor & Destructor Documentation

InflictDamage::InflictDamage ( ContainerBase container,
int  damage 
)

Definition at line 30 of file inflictdamage.cpp.

Member Function Documentation

ASCString InflictDamage::getDescription ( ) const
virtual

Implements GameAction.

Definition at line 39 of file inflictdamage.cpp.

References ASCString::toString().

GameActionID InflictDamage::getID ( ) const
protectedvirtual

Implements GameAction.

Definition at line 72 of file inflictdamage.cpp.

References ActionRegistry::InflictDamage.

ActionResult InflictDamage::postCheck ( )
protectedvirtual

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.

The cheat detection of Replays heavily relies on this mechanism.

Reimplemented from GameAction.

Definition at line 108 of file inflictdamage.cpp.

References ContainerBase::damage, and ContainerAction::getContainer().

void InflictDamage::readData ( tnstream stream)
protectedvirtual

Reimplemented from ContainerAction.

Definition at line 46 of file inflictdamage.cpp.

References ContainerAction::readData(), and tnstream::readInt().

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

Implements GameAction.

Definition at line 97 of file inflictdamage.cpp.

References ContainerBase::damage, and ContainerAction::getContainer().

void InflictDamage::writeData ( tnstream stream) const
protectedvirtual

Reimplemented from ContainerAction.

Definition at line 60 of file inflictdamage.cpp.

References ContainerAction::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: