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

#include <changeobjectproperty.h>

Inheritance diagram for ChangeObjectProperty:
Inheritance graph
[legend]

Public Types

enum  Property { Damage }
 

Public Member Functions

 ChangeObjectProperty (GameMap *map, MapCoordinate &pos, Object *object, Property property, int value, bool valueIsAbsolute=true)
 
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 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 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 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 changeobjectproperty.h.

Member Enumeration Documentation

Enumerator
Damage 

Definition at line 32 of file changeobjectproperty.h.

Constructor & Destructor Documentation

ChangeObjectProperty::ChangeObjectProperty ( GameMap map,
MapCoordinate pos,
Object object,
Property  property,
int  value,
bool  valueIsAbsolute = true 
)

Definition at line 28 of file changeobjectproperty.cpp.

Member Function Documentation

ASCString ChangeObjectProperty::getDescription ( ) const
virtual

Implements GameAction.

Definition at line 47 of file changeobjectproperty.cpp.

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

GameActionID ChangeObjectProperty::getID ( ) const
protectedvirtual

Implements GameAction.

Definition at line 91 of file changeobjectproperty.cpp.

References ActionRegistry::ChangeObjectProperty.

ActionResult ChangeObjectProperty::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 163 of file changeobjectproperty.cpp.

ActionResult ChangeObjectProperty::preCheck ( )
protectedvirtual

preCheck is called before an action is redone and should check the preconditions for the action.

The map should be in exactly the same state as it was when the action was first run. This method should check various key indicators to insurce the unmodifiedness of the map. The cheat detection of Replays heavily relies on this mechanism.

Reimplemented from GameAction.

Definition at line 155 of file changeobjectproperty.cpp.

void ChangeObjectProperty::readData ( tnstream stream)
protectedvirtual

Implements GameAction.

Definition at line 61 of file changeobjectproperty.cpp.

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

ActionResult ChangeObjectProperty::runAction ( const Context context)
protectedvirtual

Implements GameAction.

Definition at line 135 of file changeobjectproperty.cpp.

ActionResult ChangeObjectProperty::undoAction ( const Context context)
protectedvirtual

Implements GameAction.

Definition at line 150 of file changeobjectproperty.cpp.

void ChangeObjectProperty::writeData ( tnstream stream) const
protectedvirtual

Implements GameAction.

Definition at line 78 of file changeobjectproperty.cpp.

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