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

#include <viewregistration.h>

Inheritance diagram for ViewRegistration:
Inheritance graph
[legend]

Public Types

enum  Operation { AddView, RemoveView }
 

Public Member Functions

 ViewRegistration (ContainerBase *container, Operation operation)
 
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 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 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 viewregistration.h.

Member Enumeration Documentation

Enumerator
AddView 
RemoveView 

Definition at line 31 of file viewregistration.h.

Constructor & Destructor Documentation

ViewRegistration::ViewRegistration ( ContainerBase container,
Operation  operation 
)

Definition at line 29 of file viewregistration.cpp.

Member Function Documentation

ASCString ViewRegistration::getDescription ( ) const
virtual

Implements GameAction.

Definition at line 46 of file viewregistration.cpp.

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

GameActionID ViewRegistration::getID ( ) const
protectedvirtual

Implements GameAction.

Definition at line 79 of file viewregistration.cpp.

References ActionRegistry::ViewRegistration.

ActionResult ViewRegistration::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 125 of file viewregistration.cpp.

ActionResult ViewRegistration::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 120 of file viewregistration.cpp.

void ViewRegistration::readData ( tnstream stream)
protectedvirtual

Reimplemented from ContainerAction.

Definition at line 56 of file viewregistration.cpp.

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

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

Reimplemented from ContainerAction.

Definition at line 69 of file viewregistration.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: