Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::TickRequests Class Referenceabstract

Interface for AZ::TickRequestBus, which components use to make tick-related requests. More...

Inherits AZ::EBusTraits.

Public Member Functions

virtual float GetTickDeltaTime ()=0
 Gets the latest time between ticks. More...
 
virtual ScriptTimePoint GetTimeAtCurrentTick ()=0
 Gets the time in seconds since the epoch. More...
 

Additional Inherited Members

- Public Types inherited from AZ::EBusTraits
using AllocatorType = AZStd::allocator
 Allocator used by the EBus. More...
 
using BusIdType = NullBusId
 The type of ID that is used to address the EBus. More...
 
using BusIdOrderCompare = NullBusIdCompare
 Sorting function for EBus address IDs. More...
 
using BusHandlerOrderCompare = BusHandlerCompareDefault
 Sorting function for EBus event handlers. More...
 
using MutexType = NullMutex
 Locking primitive that is used when connecting handlers to the EBus or executing events. More...
 
using EventQueueMutexType = NullMutex
 Locking primitive that is used when adding and removing events from the queue. More...
 
template<class Bus >
using ConnectionPolicy = EBusConnectionPolicy< Bus >
 Enables custom logic to run when a handler connects or disconnects from the EBus. More...
 
template<class Context >
using StoragePolicy = EBusEnvironmentStoragePolicy< Context >
 Specifies where EBus data is stored. More...
 
template<class Bus >
using RouterPolicy = EBusRouterPolicy< Bus >
 Controls the flow of EBus events. 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 Member Functions inherited from AZ::EBusTraits
 ~EBusTraits ()=default
 A destructor. More...
 

Detailed Description

Interface for AZ::TickRequestBus, which components use to make tick-related requests.

Available requests are to get the time between ticks or the current time in seconds.

Member Function Documentation

◆ GetTickDeltaTime()

virtual float AZ::TickRequests::GetTickDeltaTime ( )
pure virtual

Gets the latest time between ticks.

◆ GetTimeAtCurrentTick()

virtual ScriptTimePoint AZ::TickRequests::GetTimeAtCurrentTick ( )
pure virtual

Gets the time in seconds since the epoch.


The documentation for this class was generated from the following file:
  • C:/lumberyard-root/dev/Code/Framework/AzCore/AzCore/Component/TickBus.h