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 | Static Public Member Functions | List of all members
AzToolsFramework::ReadOnlyEntitySystemComponent Class Referencefinal

#include <ReadOnlyEntitySystemComponent.h>

Inherits AZ::Component, AzToolsFramework::ReadOnlyEntityPublicInterface, AzToolsFramework::ReadOnlyEntityQueryInterface, and EditorEntityContextNotificationBus::Handler.

Public Member Functions

 AZ_COMPONENT (ReadOnlyEntitySystemComponent, "{B32EB03F-D88F-4B3A-9C16-071AF04DA646}")
 
void Activate () override
 
void Deactivate () override
 
bool IsReadOnly (const AZ::EntityId &entityId) override
 Returns whether the entity id provided is registered as read-only.
 
void RefreshReadOnlyState (const EntityIdList &entityIds) override
 
void RefreshReadOnlyStateForAllEntities () override
 
void OnPrepareForContextReset () override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 

Detailed Description

System Component to track read-only entity registration. An entity registered as ReadOnly cannot be altered in the Editor.

Member Function Documentation

◆ IsReadOnly()

bool AzToolsFramework::ReadOnlyEntitySystemComponent::IsReadOnly ( const AZ::EntityId &  entityId)
overridevirtual

Returns whether the entity id provided is registered as read-only.

Implements AzToolsFramework::ReadOnlyEntityPublicInterface.

◆ RefreshReadOnlyState()

void AzToolsFramework::ReadOnlyEntitySystemComponent::RefreshReadOnlyState ( const EntityIdList &  entityIds)
overridevirtual

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

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

Implements AzToolsFramework::ReadOnlyEntityQueryInterface.

◆ RefreshReadOnlyStateForAllEntities()

void AzToolsFramework::ReadOnlyEntitySystemComponent::RefreshReadOnlyStateForAllEntities ( )
overridevirtual

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

Implements AzToolsFramework::ReadOnlyEntityQueryInterface.

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