Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog to learn more. |
Interface for AZ::SystemTickBus , which is the EBus that dispatches system tick events. More...
Inherits AZ::EBusTraits .
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 |
|
virtual void | OnSystemTick ()=0 |
Signals that the application has issued a system 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 OnSystemTick 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...
|
|
Additional Inherited Members |
|
Protected Member Functions inherited from AZ::EBusTraits | |
~EBusTraits ()=default | |
A destructor.
More...
|
|
Detailed Description
Interface for AZ::SystemTickBus , which is the EBus that dispatches system tick events.
System tick events are only dispatched for some tools, never during games. System ticks are dispatched even when the tool is not in focus.
- Note
- Do not add a mutex to SystemTickEvents . It is unnecessary and typically degrades performance.
Member Typedef Documentation
◆ EventQueueMutexType
typedef AZStd::mutex AZ::SystemTickEvents::EventQueueMutexType |
Specifies the mutex that is used when adding and removing events from the event queue.
This mutex is for the event queue, not SystemTickEvents . Do not add a mutex to SystemTickEvents .
Member Function Documentation
◆ OnSystemTick()
|
pure virtual |
Signals that the application has issued a system tick.
Member Data Documentation
◆ EnableEventQueue
|
static |
Enables the event queue, which you can use to execute actions just before the OnSystemTick event.
◆ 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.
The documentation for this class was generated from the following file:
- C:/lumberyard-root/dev/Code/Framework/AzCore/AzCore/Component/ TickBus.h