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 Member Functions | List of all members
AzToolsFramework::ReadOnlyEntityQueryInterface Class Referenceabstract

An entity registered as read-only cannot be altered in the editor. More...

#include <ReadOnlyEntityInterface.h>

Inherited by AzToolsFramework::ReadOnlyEntitySystemComponent [private].

Public Member Functions

 AZ_RTTI (ReadOnlyEntityQueryInterface, "{2ACD63C5-1F3E-4DE8-880E-8115F857D329}")
 
virtual void RefreshReadOnlyState (const EntityIdList &entityIds)=0
 
virtual void RefreshReadOnlyStateForAllEntities ()=0
 

Detailed Description

An entity registered as read-only cannot be altered in the editor.

Member Function Documentation

◆ RefreshReadOnlyState()

virtual void AzToolsFramework::ReadOnlyEntityQueryInterface::RefreshReadOnlyState ( const EntityIdList &  entityIds)
pure virtual

Refreshes the cached read-only status for the entities provided.

Parameters
entityIdsThe entityIds whose read-only state will be queried again.

Implemented in AzToolsFramework::ReadOnlyEntitySystemComponent.

◆ RefreshReadOnlyStateForAllEntities()

virtual void AzToolsFramework::ReadOnlyEntityQueryInterface::RefreshReadOnlyStateForAllEntities ( )
pure virtual

Refreshes the cached read-only status for all entities. Useful when disconnecting a handler at runtime.

Implemented in AzToolsFramework::ReadOnlyEntitySystemComponent.

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