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

#include <consumeammo.h>

Inheritance diagram for ConsumeAmmo:
Inheritance graph
[legend]

Public Member Functions

 ConsumeAmmo (ContainerBase *veh, int ammoType, int slot, int count)
 
ASCString getDescription () const
 
void setAmmoProduction (bool prod)
 specifies if ammo shall be produced if there is not enough ammo available and the container has ammo production capabilities More...
 
- 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
 
void readData (tnstream &stream)
 
void writeData (tnstream &stream) 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 consumeammo.h.

Constructor & Destructor Documentation

ConsumeAmmo::ConsumeAmmo ( ContainerBase veh,
int  ammoType,
int  slot,
int  count 
)

Definition at line 32 of file consumeammo.cpp.

Member Function Documentation

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

Implements GameAction.

Definition at line 100 of file consumeammo.cpp.

References ActionRegistry::ConsumeAmmo.

ActionResult ConsumeAmmo::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 208 of file consumeammo.cpp.

References Vehicle::ammo, and ContainerAction::getContainer().

void ConsumeAmmo::readData ( tnstream stream)
protectedvirtual
ActionResult ConsumeAmmo::runAction ( const Context context)
protectedvirtual
void ConsumeAmmo::setAmmoProduction ( bool  prod)

specifies if ammo shall be produced if there is not enough ammo available and the container has ammo production capabilities

Definition at line 94 of file consumeammo.cpp.

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

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: