Class representing an engine tick event. More...

#include <TickEvent.h>

Inheritance diagram for TickEvent:

Collaboration diagram for TickEvent:

Public Member Functions
	TickEvent (int _tick, uint64_t _total_tick)
	Constructs a new event. More...

int	GetTickNumber ()
	Retrieves the current tick number. More...

uint64_t	GetTotalTickNumber ()
	Retrieves the current total tick number. More...

Public Member Functions inherited from BlamEvent
	BlamEvent (BlamEventType type)
	Constructs a new event with the specified type. More...

BlamEventType	GetEventType ()
	Retrieves the type of the event. More...

void	SetCancelled (bool cancel)
	Sets whether or not the event should be cancelled. More...

bool	IsCancelled ()
	Determines whether or not the event has been cancelled. More...

Detailed Description

Class representing an engine tick event.

This event is fired from the engine's game tick functions. See #Blam::Tick for details.

Constructor & Destructor Documentation

Constructs a new event.

Parameters

_tick	- The number of the tick that was fired. Will always be between 0 and the maximum tick rate.
_total_tick	- The number of the tick within the amount of total program runtime ticks.

int TickEvent::GetTickNumber ( )

Retrieves the current tick number.

uint64_t TickEvent::GetTotalTickNumber ( )

Retrieves the current total tick number.

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