Spore ModAPI  2.4.0
API for creating C++ mods for Spore
Public Types | Public Member Functions | Protected Attributes | List of all members
Simulator::cGonzagoTimer Class Reference

A class for measuring time inside Simulator modes. This is the equivalent to the Clock class. More...

#include <cGonzagoTimer.h>

Inheritance diagram for Simulator::cGonzagoTimer:
DefaultRefCounted

Public Types

typedef LARGE_INTEGER(* TimeFunction_t) ()
 

Public Member Functions

 cGonzagoTimer (TimeFunction_t pTimeFunction)
 
 cGonzagoTimer ()
 
virtual ~cGonzagoTimer ()
 
void Stop ()
 
void SetTime (LARGE_INTEGER time)
 
void UpdateTime ()
 
void Start ()
 
bool IsRunning ()
 Tells whether the timer is currently running and, therefore, measuring time. More...
 
LARGE_INTEGER GetElapsed ()
 Returns the elapsed time, in milliseconds. More...
 
- Public Member Functions inherited from DefaultRefCounted
 DefaultRefCounted ()
 
virtual int AddRef ()
 
virtual int Release ()
 
virtual int GetReferenceCount ()
 

Protected Attributes

LARGE_INTEGER mElapsedTime
 
LARGE_INTEGER field_10
 
bool mbRunning
 
TimeFunction_t mpTimeFunction
 
- Protected Attributes inherited from DefaultRefCounted
int mnRefCount = 0
 

Additional Inherited Members

- Protected Member Functions inherited from DefaultRefCounted
virtual ~DefaultRefCounted ()
 

Detailed Description

A class for measuring time inside Simulator modes. This is the equivalent to the Clock class.

Member Typedef Documentation

◆ TimeFunction_t

typedef LARGE_INTEGER(* Simulator::cGonzagoTimer::TimeFunction_t) ()

Constructor & Destructor Documentation

◆ cGonzagoTimer() [1/2]

Simulator::cGonzagoTimer::cGonzagoTimer ( TimeFunction_t  pTimeFunction)

◆ cGonzagoTimer() [2/2]

Simulator::cGonzagoTimer::cGonzagoTimer ( )

◆ ~cGonzagoTimer()

virtual Simulator::cGonzagoTimer::~cGonzagoTimer ( )
inlinevirtual

Member Function Documentation

◆ GetElapsed()

LARGE_INTEGER Simulator::cGonzagoTimer::GetElapsed ( )

Returns the elapsed time, in milliseconds.

◆ IsRunning()

bool Simulator::cGonzagoTimer::IsRunning ( )

Tells whether the timer is currently running and, therefore, measuring time.

◆ SetTime()

void Simulator::cGonzagoTimer::SetTime ( LARGE_INTEGER  time)

◆ Start()

void Simulator::cGonzagoTimer::Start ( )

◆ Stop()

void Simulator::cGonzagoTimer::Stop ( )

◆ UpdateTime()

void Simulator::cGonzagoTimer::UpdateTime ( )

Member Data Documentation

◆ field_10

LARGE_INTEGER Simulator::cGonzagoTimer::field_10
protected

◆ mbRunning

bool Simulator::cGonzagoTimer::mbRunning
protected

◆ mElapsedTime

LARGE_INTEGER Simulator::cGonzagoTimer::mElapsedTime
protected

◆ mpTimeFunction

TimeFunction_t Simulator::cGonzagoTimer::mpTimeFunction
protected

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