Interface for AZ::TickBus , which is the EBus that dispatches tick events. More...

Inherits AZ::EBusTraits .

Classes
struct	BusHandlerOrderCompare
	Determines the order in which handlers receive tick events. More...

Public Types
typedef	EventQueueMutexType
	Specifies the mutex that is used when adding and removing events from the event queue. More...

Public Types inherited from AZ::EBusTraits
using	AllocatorType
	Allocator used by the EBus . More...

using	BusIdType
	The type of ID that is used to address the EBus . More...

using	BusIdOrderCompare
	Sorting function for EBus address IDs. More...

using	BusHandlerOrderCompare
	Sorting function for EBus event handlers. More...

using	MutexType
	Locking primitive that is used when connecting handlers to the EBus or executing events. More...

using	EventQueueMutexType
	Locking primitive that is used when adding and removing events from the queue. More...

using	ConnectionPolicy
	Enables custom logic to run when a handler connects or disconnects from the EBus . More...

using	StoragePolicy
	Specifies where EBus data is stored. More...

using	RouterPolicy
	Controls the flow of EBus events. More...

Public Member Functions
	TickEvents ()
	Creates an instance of the class and sets the tick order of the handler to the default value. More...

virtual	~TickEvents ()
	Destroys the instance of the class. More...

virtual void	OnTick (float deltaTime, ScriptTimePoint time)=0
	Signals that the application has issued a tick. More...

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy
	Overrides the default AZ::EBusTraits handler policy so that multiple handlers can connect to the bus. More...

static const bool	EnableEventQueue
	Enables the event queue, which you can use to execute actions just before the OnTick event. More...

Static Public Attributes inherited from AZ::EBusTraits
static const EBusHandlerPolicy	HandlerPolicy
	Defines how many handlers can connect to an address on the EBus and the order in which handlers at each address receive events. More...

static const EBusAddressPolicy	AddressPolicy
	Defines how many addresses exist on the EBus . More...

static const bool	EnableEventQueue
	Specifies whether the EBus supports an event queue. More...

Protected Attributes
int	m_tickOrder
	The order in which a handler receives tick events relative to other handlers. More...

Friends
class	ComponentApplication

Additional Inherited Members
Protected Member Functions inherited from AZ::EBusTraits
	~EBusTraits ()=default
	A destructor. More...

Detailed Description

Interface for AZ::TickBus , which is the EBus that dispatches tick events.

These tick events are executed on the main game thread. In games, AZ::TickBus dispatches ticks even if the application is not in focus. In tools, AZ::TickBus can become inactive when the tool loses focus.

Note: Do not add a mutex to TickEvents . It is unnecessary and typically degrades performance.

Member Typedef Documentation

◆ EventQueueMutexType

typedef AZStd::mutex AZ::TickEvents::EventQueueMutexType

Specifies the mutex that is used when adding and removing events from the event queue.

This mutex is for the event queue, not TickEvents . Do not add a mutex to TickEvents .

Constructor & Destructor Documentation

◆ TickEvents()

AZ::TickEvents::TickEvents ( )

inline

Creates an instance of the class and sets the tick order of the handler to the default value.

◆ ~TickEvents()

virtual AZ::TickEvents::~TickEvents ( )

inline virtual

Destroys the instance of the class.

Member Function Documentation

◆ OnTick()

virtual void AZ::TickEvents::OnTick	(	float	deltaTime ,
		ScriptTimePoint	time
	)

pure virtual

Signals that the application has issued a tick.

Parameters

deltaTime	The delta (in seconds) from the previous tick and the current time.
time	The current time.

Friends And Related Function Documentation

◆ ComponentApplication

friend class ComponentApplication

friend

Member Data Documentation

◆ EnableEventQueue

const bool AZ::TickEvents::EnableEventQueue

static

Enables the event queue, which you can use to execute actions just before the OnTick event.

◆ HandlerPolicy

const AZ::EBusHandlerPolicy AZ::TickEvents::HandlerPolicy

static

Overrides the default AZ::EBusTraits handler policy so that multiple handlers can connect to the bus.

This bus has one address because it uses the default EBusTraits address policy. At the address, handlers receive events based on the order in which the components are initialized, unless a handler explicitly sets its TickEvents::m_tickOrder .

◆ m_tickOrder

int AZ::TickEvents::m_tickOrder

protected

The order in which a handler receives tick events relative to other handlers.

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

C:/lumberyard-root/dev/Code/Framework/AzCore/AzCore/Component/ TickBus.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Additional Inherited Members