Blam::Events::TickEvent Class Reference

Class representing an engine tick event. More...

#include <TickEvent.hpp>

Inheritance diagram for Blam::Events::TickEvent:

Public Member Functions
	TickEvent (int _tick)
	Constructs a new event. More...
int	GetTickNumber ()
	Retrieves the current tick number. More...
Public Member Functions inherited from Blam::Events::Event
EventType	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...

Additional Inherited Members
Public Attributes inherited from Blam::Events::Event
EventType	event_type
	The type of the event. 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

TickEvent()

Blam::Events::TickEvent::TickEvent ( int  _tick )

inline

Constructs a new event.

Parameters

_tick

- The number of the tick that was fired. Will always be between 0 and the maximum tick rate.

Member Function Documentation

GetTickNumber()

int Blam::Events::TickEvent::GetTickNumber ( )

inline

Retrieves the current tick number.

Returns

The tick number.

---

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

• blam/components/core/events/events/TickEvent.hpp