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

#include <unitfieldregistration.h>

Inheritance diagram for UnitFieldRegistration:
Inheritance graph
[legend]

Public Types

enum  Operation {
  RegisterOnField, UnregisterOnField, AddView, RemoveView,
  Position, Position3D, RegisterInCarrier, UnRegisterFromCarrier
}
 

Public Member Functions

 UnitFieldRegistration (Vehicle *vehicle, const MapCoordinate3D &pos, Operation operation, ContainerBase *carrier=0)
 
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 UnitAction
VehiclegetUnit (bool dontThrow=false)
 
const VehiclegetUnit (bool dontThrow=false) const
 
 UnitAction (GameMap *gamemap, int vehicleID)
 
 UnitAction (Vehicle *unit)
 
 UnitAction (GameMap *gamemap)
 
- 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 unitfieldregistration.h.

Member Enumeration Documentation

Enumerator
RegisterOnField 
UnregisterOnField 
AddView 
RemoveView 
Position 
Position3D 
RegisterInCarrier 
UnRegisterFromCarrier 

Definition at line 31 of file unitfieldregistration.h.

Constructor & Destructor Documentation

UnitFieldRegistration::UnitFieldRegistration ( Vehicle vehicle,
const MapCoordinate3D pos,
Operation  operation,
ContainerBase carrier = 0 
)

Definition at line 29 of file unitfieldregistration.cpp.

References ContainerBase::getIdentification().

Referenced by runAction().

Member Function Documentation

ASCString UnitFieldRegistration::getDescription ( ) const
virtual
GameActionID UnitFieldRegistration::getID ( ) const
protectedvirtual

Implements GameAction.

Definition at line 103 of file unitfieldregistration.cpp.

References ActionRegistry::UnitFieldRegistration.

ActionResult UnitFieldRegistration::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 270 of file unitfieldregistration.cpp.

ActionResult UnitFieldRegistration::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 261 of file unitfieldregistration.cpp.

References UnitAction::getUnit(), Position, Position3D, MapCoordinate::x, and MapCoordinate::y.

void UnitFieldRegistration::readData ( tnstream stream)
protectedvirtual

Reimplemented from UnitAction.

Definition at line 70 of file unitfieldregistration.cpp.

References MapCoordinate3D::read(), UnitAction::readData(), and tnstream::readInt().

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

Reimplemented from UnitAction.

Definition at line 90 of file unitfieldregistration.cpp.

References MapCoordinate3D::write(), UnitAction::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: