ViewRegistration Class Reference

#include <viewregistration.h>

Inheritance diagram for ViewRegistration:

Inheritance graph
[legend]
List of all members.

Public Types

enum  Operation { AddView, RemoveView }

Public Member Functions

 ViewRegistration (ContainerBase *container, Operation operation)
ASCString getDescription () const

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.
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.
virtual void readData (tnstream &stream)
virtual void writeData (tnstream &stream) const

Friends

template<class Child>
GameActionGameActionCreator (GameMap *map)

Detailed Description

Definition at line 29 of file viewregistration.h.


Member Enumeration Documentation

enum ViewRegistration::Operation

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 [protected, virtual]

Implements GameAction.

Definition at line 79 of file viewregistration.cpp.

References ActionRegistry::ViewRegistration.

ActionResult ViewRegistration::runAction ( const Context context  )  [protected, virtual]

Implements GameAction.

Definition at line 84 of file viewregistration.cpp.

References ContainerBase::addview(), AddView, ContainerAction::getContainer(), ContainerBase::removeview(), and RemoveView.

ActionResult ViewRegistration::undoAction ( const Context context  )  [protected, virtual]

Implements GameAction.

Definition at line 103 of file viewregistration.cpp.

References AddView, ContainerBase::addview(), ContainerAction::getContainer(), ContainerBase::removeview(), and RemoveView.

ActionResult ViewRegistration::preCheck (  )  [protected, virtual]

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.

ActionResult ViewRegistration::postCheck (  )  [protected, virtual]

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.

void ViewRegistration::readData ( tnstream stream  )  [protected, virtual]

Reimplemented from ContainerAction.

Definition at line 56 of file viewregistration.cpp.

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

void ViewRegistration::writeData ( tnstream stream  )  const [protected, virtual]

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:
Generated on Mon May 21 01:48:07 2012 for Advanced Strategic Command by  doxygen 1.5.1