Blam::Tick Namespace Reference

Namespace containing components relating to the game tick. More...

Functions
BLAM void	PrepareTick ()
	Prepares required data for the tick loop. More...
BLAM void	TickThread ()
	Function containing the tick loop. More...
BLAM int	GetCurrentTickRate ()
	Retrieves the current tick rate. More...
BLAM int	GetCurrentTickRate10S ()
	Retrieves the average tick rate over the last 10 seconds. More...
BLAM int	GetCurrentTickRate1M ()
	Retrieves the average tick rate over the last minute. More...
BLAM int	GetCurrentTickRate5M ()
	Retrieves the average tick rate over the last 5 minutes. More...
BLAM int	MaxTicksPerSecond ()
	Retrieves the maximum number of ticks per second. More...
BLAM void	ResumeTickLoop ()
	Resumes the tick loop if it has been paused. More...
BLAM void	PauseTickLoop ()
	Temporarily pauses the tick loop. More...
BLAM void	EndTickLoop ()
	Terminates the tick loop. More...
BLAM bool	HasTickStopped ()
	Determines whether or not the tick loop has finished terminating. More...
BLAM bool	IsTickLoopRunning ()
	Determines whether or not the tick loop is currently running - NOT whether it is paused. More...
BLAM void	SetCurrentTickRate (int tickrate)
	Stops the game tick, updates the tick rate, and re-starts the game tick. More...
BLAM uint64_t	GetTotalRuntimeTicks ()
	Gets the total amount of ticks that have elapsed during program runtime. More...

Detailed Description

Namespace containing components relating to the game tick.

Function Documentation

EndTickLoop()

void Blam::Tick::EndTickLoop

(

)

Terminates the tick loop.

This should only be called at shutdown, as this will cause the tick thread to conclude as well.

Here is the caller graph for this function:

GetCurrentTickRate()

int Blam::Tick::GetCurrentTickRate

(

)

Retrieves the current tick rate.

Can be used to measure any potential performance losses.

Returns

The number of ticks elapsed this second.

GetCurrentTickRate10S()

int Blam::Tick::GetCurrentTickRate10S

(

)

Retrieves the average tick rate over the last 10 seconds.

Can be used to measure any potential performance losses.

Returns

The average tick rate over the last 10 seconds.

Here is the caller graph for this function:

GetCurrentTickRate1M()

int Blam::Tick::GetCurrentTickRate1M

(

)

Retrieves the average tick rate over the last minute.

Can be used to measure any potential performance losses.

Returns

The average tick rate over the last minute.

Here is the caller graph for this function:

GetCurrentTickRate5M()

int Blam::Tick::GetCurrentTickRate5M

(

)

Retrieves the average tick rate over the last 5 minutes.

Can be used to measure any potential performance losses.

Returns

The average tick rate over the last 5 minutes.

Here is the caller graph for this function:

GetTotalRuntimeTicks()

uint64_t Blam::Tick::GetTotalRuntimeTicks

(

)

Gets the total amount of ticks that have elapsed during program runtime.

Returns

The total amount of ticks that have elapsed.

Here is the caller graph for this function:

HasTickStopped()

bool Blam::Tick::HasTickStopped

(

)

Determines whether or not the tick loop has finished terminating.

Used to prevent premature engine shutdown while in the middle of proccessing a tick.

Returns

true if the tick loop has ended. Otherwise returns false.

Here is the caller graph for this function:

IsTickLoopRunning()

bool Blam::Tick::IsTickLoopRunning

(

)

Determines whether or not the tick loop is currently running - NOT whether it is paused.

Returns

true if the tick loop is running, false if it has been stopped (or not yet started).

Here is the caller graph for this function:

MaxTicksPerSecond()

int Blam::Tick::MaxTicksPerSecond

(

)

Retrieves the maximum number of ticks per second.

Returns

The maximum TPS.

Here is the caller graph for this function:

PauseTickLoop()

void Blam::Tick::PauseTickLoop

(

)

Temporarily pauses the tick loop.

Pausing the tick loop without stopping it entirely can be used in situations where you want to halt game simulation (in a pause screen while in singleplayer, for instance).

Here is the caller graph for this function:

PrepareTick()

void Blam::Tick::PrepareTick

(

)

Prepares required data for the tick loop.

Here is the caller graph for this function:

ResumeTickLoop()

void Blam::Tick::ResumeTickLoop

(

)

Resumes the tick loop if it has been paused.

Here is the caller graph for this function:

SetCurrentTickRate()

void Blam::Tick::SetCurrentTickRate

(

int

tickrate

)

Stops the game tick, updates the tick rate, and re-starts the game tick.

Parameters

tickrate

- The new tickrate.

Here is the call graph for this function:

Here is the caller graph for this function:

TickThread()

void Blam::Tick::TickThread

(

)

Function containing the tick loop.

This is a blocking call and should only be run in a separate thread.

Here is the call graph for this function:

Here is the caller graph for this function: