A client for running a replay. More...

#include <sc2_replay_observer.h>

Inheritance diagram for sc2::ReplayObserver:

Public Member Functions
ReplayControlInterface *	ReplayControl ()

ObserverActionInterface *	ObserverAction ()

virtual bool	IgnoreReplay (const ReplayInfo &replay_info, uint32_t &player_id)

void	SetControl (ControlInterface *control)

Public Member Functions inherited from sc2::Client
const ObservationInterface *	Observation () const
	The ObservationInterface is used to query game state.

QueryInterface *	Query ()
	The UnitQuery interface is used to issue commands to units.

DebugInterface *	Debug ()
	The DebugInterface allows a derived class to print text, draw primitive shapes and spawn/destroy units.

ControlInterface *	Control ()

const ControlInterface *	Control () const

void	Reset ()

Public Member Functions inherited from sc2::ClientEvents
virtual void	OnGameFullStart ()
	Called when a game is started after a load. Fast restarting will not call this.

virtual void	OnGameStart ()
	Called when a game is started or restarted.

virtual void	OnGameEnd ()
	Called when a game has ended.

virtual void	OnStep ()

virtual void	OnUnitDestroyed (const Unit *)

virtual void	OnUnitCreated (const Unit *)

virtual void	OnUnitIdle (const Unit *)

virtual void	OnUpgradeCompleted (UpgradeID)

virtual void	OnBuildingConstructionComplete (const Unit *)

virtual void	OnNydusDetected ()
	Called when a nydus is placed.

virtual void	OnNuclearLaunchDetected ()
	Called when a nuclear launch is detected.

virtual void	OnUnitEnterVision (const Unit *)

virtual void	OnError (const std::vector< ClientError > &, const std::vector< std::string > &={})
	Called for various errors the library can encounter. See ClientError enum for possible errors.

Detailed Description

A client for running a replay.

Member Function Documentation

virtual bool sc2::ReplayObserver::IgnoreReplay	(	const ReplayInfo &	replay_info,
		uint32_t &	player_id
	)

virtual

Determines if the replay should be filtered out.

Parameters

replay_info Replay information used to decide if the replay should be filtered.

Returns: If 'true', the replay will be rejected and not analyzed.

ObserverActionInterface* sc2::ReplayObserver::ObserverAction ( )

Obtains the observer action interface.

Returns: The observer action interface.

ReplayControlInterface* sc2::ReplayObserver::ReplayControl ( )

Obtains the replay control interface.

Returns: The replay control interface.

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

include/sc2api/sc2_replay_observer.h

Public Member Functions

Detailed Description

Member Function Documentation