Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Attributes | List of all members
AzToolsFramework::ReadOnlyEntityQueryRequests Class Referenceabstract

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.

Public Types

using BusIdType = AzFramework::EntityContextId
 

Public Member Functions

virtual void IsReadOnly (const AZ::EntityId &entityId, bool &isReadOnly)=0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Detailed Description

Used by the ReadOnlyEntitySystemComponent to query the read-only state of entities as set by systems using the API.

Member Function Documentation

◆ 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
entityIdThe entity whose status has changed.
[out]isReadOnlyThe 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: