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 | Protected Member Functions | List of all members
AzToolsFramework::EditorEntityContextComponent Class Reference

#include <EditorEntityContextComponent.h>

Inherits AZ::Component, AzFramework::EntityContext, EditorEntityContextRequestBus::Handler, EditorEntityContextPickingRequestBus::Handler, EditorLegacyGameModeNotificationBus::Handler, and SliceEditorEntityOwnershipServiceNotificationBus::Handler.

Public Member Functions

 AZ_COMPONENT (EditorEntityContextComponent, "{92E3029B-6F4E-4628-8306-45D51EE59B8C}")
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
AzFramework::EntityContextId GetEditorEntityContextId () override
 
AzFramework::EntityContext * GetEditorEntityContextInstance () override
 
void ResetEditorContext () override
 
AZ::EntityId CreateNewEditorEntity (const char *name) override
 
AZ::EntityId CreateNewEditorEntityWithId (const char *name, const AZ::EntityId &entityId) override
 
void AddEditorEntity (AZ::Entity *entity) override
 
void AddEditorEntities (const EntityList &entities) override
 
void HandleEntitiesAdded (const EntityList &entities) override
 
void FinalizeEditorEntity (AZ::Entity *entity) override
 
bool CloneEditorEntities (const EntityIdList &sourceEntities, EntityList &resultEntities, AZ::SliceComponent::EntityIdToEntityIdMap &sourceToCloneEntityIdMap) override
 
bool DestroyEditorEntity (AZ::EntityId entityId) override
 
bool SaveToStreamForEditor (AZ::IO::GenericStream &stream, const EntityList &entitiesInLayers, AZ::SliceComponent::SliceReferenceToInstancePtrs &instancesInLayers) override
 
void GetLooseEditorEntities (EntityList &entityList) override
 
bool SaveToStreamForGame (AZ::IO::GenericStream &stream, AZ::DataStream::StreamType streamType) override
 
bool LoadFromStream (AZ::IO::GenericStream &stream) override
 
bool LoadFromStreamWithLayers (AZ::IO::GenericStream &stream, QString levelPakFile) override
 
void StartPlayInEditor () override
 
void StopPlayInEditor () override
 
bool IsEditorRunningGame () override
 
bool IsEditorRequestingGame () override
 
bool IsEditorEntity (AZ::EntityId id) override
 
void AddRequiredComponents (AZ::Entity &entity) override
 
const AZ::ComponentTypeList & GetRequiredComponentTypes () override
 
bool MapEditorIdToRuntimeId (const AZ::EntityId &editorId, AZ::EntityId &runtimeId) override
 
bool MapRuntimeIdToEditorId (const AZ::EntityId &runtimeId, AZ::EntityId &editorId) override
 
bool SupportsViewportEntityIdPicking () override
 
void PrepareForContextReset () override
 
bool ValidateEntitiesAreValidForContext (const EntityList &entities) override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 

Protected Member Functions

void OnContextEntitiesAdded (const EntityList &entities) override
 
void OnContextEntityRemoved (const AZ::EntityId &id) override
 
void SetupEditorEntity (AZ::Entity *entity)
 
void SetupEditorEntities (const EntityList &entities)
 
void LoadFromStreamComplete (bool loadedSuccessfully)
 

Detailed Description

System component responsible for owning the edit-time entity context.

The editor entity context owns entities in the world, within the editor. These entities typically own components inheriting from EditorComponentBase.

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