IReplayLogger Class Reference

Replay log recorder interface. More...

#include <Replay.h>

Inheritance diagram for IReplayLogger:

Public Member Functions
	IReplayLogger ()
virtual	~IReplayLogger ()
virtual void	StartGame (JS::MutableHandleValue attribs)=0
	Started the game with the given game attributes. More...
virtual void	Turn (u32 n, u32 turnLength, std::vector< SimulationCommand > &commands)=0
	Run the given turn with the given collection of player commands. More...
virtual void	Hash (const std::string &hash, bool quick)=0
	Optional hash of simulation state (for sync checking). More...
virtual void	SaveMetadata (const CSimulation2 &simulation)=0
	Saves metadata.json containing part of the simulation state used for the summary screen. More...
virtual OsPath	GetDirectory () const =0
	Remember the directory containing the commands.txt file, so that we can save additional files to it. More...

Detailed Description

Replay log recorder interface.

Call its methods at appropriate times during the game.

Constructor & Destructor Documentation

IReplayLogger()

IReplayLogger::IReplayLogger ( )

inline

~IReplayLogger()

virtual IReplayLogger::~IReplayLogger ( )

inlinevirtual

Member Function Documentation

GetDirectory()

virtual OsPath IReplayLogger::GetDirectory ( ) const

pure virtual

Remember the directory containing the commands.txt file, so that we can save additional files to it.

Implemented in CReplayLogger, and CDummyReplayLogger.

Hash()

virtual void IReplayLogger::Hash ( const std::string &  hash, bool  quick  )

pure virtual

Optional hash of simulation state (for sync checking).

Implemented in CReplayLogger, and CDummyReplayLogger.

SaveMetadata()

virtual void IReplayLogger::SaveMetadata ( const CSimulation2 &  simulation )

pure virtual

Saves metadata.json containing part of the simulation state used for the summary screen.

Implemented in CReplayLogger, and CDummyReplayLogger.

StartGame()

virtual void IReplayLogger::StartGame ( JS::MutableHandleValue  attribs )

pure virtual

Started the game with the given game attributes.

Implemented in CReplayLogger, and CDummyReplayLogger.

Turn()

virtual void IReplayLogger::Turn ( u32  n, u32  turnLength, std::vector< SimulationCommand > &  commands  )

pure virtual

Run the given turn with the given collection of player commands.

Implemented in CReplayLogger, and CDummyReplayLogger.

---

The documentation for this class was generated from the following file:

• /zpool0/docker-engine-docs/source/ps/Replay.h