Used by the ReadOnlyEntitySystemComponent to query the read-only state of entities as set by systems using the API.
More...
#include <ReadOnlyEntityBus.h>
Inherits AZ::EBusTraits.
|
using | BusIdType = AzFramework::EntityContextId |
|
|
virtual void | IsReadOnly (const AZ::EntityId &entityId, bool &isReadOnly)=0 |
|
|
static const AZ::EBusHandlerPolicy | HandlerPolicy = AZ::EBusHandlerPolicy::Multiple |
|
static const AZ::EBusAddressPolicy | AddressPolicy = AZ::EBusAddressPolicy::ById |
|
Used by the ReadOnlyEntitySystemComponent to query the read-only state of entities as set by systems using the API.
◆ IsReadOnly()
virtual void AzToolsFramework::ReadOnlyEntityQueryRequests::IsReadOnly |
( |
const AZ::EntityId & |
entityId, |
|
|
bool & |
isReadOnly |
|
) |
| |
|
pure virtual |
Triggered when an entity's read-only status is queried. Allows multiple systems to weigh in on the read-only status of an entity.
- Parameters
-
| entityId | The entity whose status has changed. |
[out] | isReadOnly | The output of the query. Should only be changed to true, and left untouched if false. |
The documentation for this class was generated from the following file:
- Code/Framework/AzToolsFramework/AzToolsFramework/Entity/ReadOnly/ReadOnlyEntityBus.h