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::Prefab::PrefabIntegrationManager Class Referencefinal

Inherits PrefabInstanceContainerNotificationBus::Handler, AzToolsFramework::Prefab::PrefabIntegrationInterface, PrefabFocusNotificationBus::Handler, AzToolsFramework::Prefab::PrefabPublicNotificationBus::Handler, EditorEntityContextNotificationBus::Handler, and AzToolsFramework::ActionManagerRegistrationNotificationBus::Handler.

Public Member Functions

 AZ_CLASS_ALLOCATOR (PrefabIntegrationManager, AZ::SystemAllocator)
 
void OnStartPlayInEditorBegin () override
 
void OnStopPlayInEditor () override
 
void OnPrefabFocusChanged (AZ::EntityId previousContainerEntityId, AZ::EntityId newContainerEntityId) override
 
void OnPrefabFocusRefreshed () override
 
void OnPrefabComponentActivate (AZ::EntityId entityId) override
 
void OnPrefabComponentDeactivate (AZ::EntityId entityId) override
 
AZ::EntityId CreateNewEntityAtPosition (const AZ::Vector3 &position, AZ::EntityId parentId) override
 
int HandleRootPrefabClosure (TemplateId templateId) override
 
void SaveCurrentPrefab () override
 Saves the prefab currently focused in the main editor window and all its descendants.
 
void OnActionUpdaterRegistrationHook () override
 
void OnActionRegistrationHook () override
 
void OnWidgetActionRegistrationHook () override
 
void OnMenuBindingHook () override
 
void OnToolBarBindingHook () override
 
void OnPostActionManagerRegistrationHook () override
 
- Public Member Functions inherited from AzToolsFramework::Prefab::PrefabIntegrationInterface
 AZ_RTTI (PrefabIntegrationInterface, "{B88AE045-7711-49BC-8336-45003D1C9116}")
 
virtual AZ::EntityId CreateNewEntityAtPosition (const AZ::Vector3 &position, AZ::EntityId parentId)=0
 
virtual int HandleRootPrefabClosure (TemplateId templateId)=0
 
virtual void SaveCurrentPrefab ()=0
 Saves the prefab currently focused in the main editor window and all its descendants.
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Member Function Documentation

◆ CreateNewEntityAtPosition()

AZ::EntityId AzToolsFramework::Prefab::PrefabIntegrationManager::CreateNewEntityAtPosition ( const AZ::Vector3 &  position,
AZ::EntityId  parentId 
)
overridevirtual

Create a new entity at the position provided.

Parameters
positionThe position the new entity will be created at.
parentIdThe id of the parent of the newly created entity.
Returns
The id of the newly created entity.

Implements AzToolsFramework::Prefab::PrefabIntegrationInterface.

◆ HandleRootPrefabClosure()

int AzToolsFramework::Prefab::PrefabIntegrationManager::HandleRootPrefabClosure ( TemplateId  templateId)
overridevirtual

Handles the save on close behavior for the root prefab with the TemplateId provided.

Parameters
templateIdThe id of the template the user chose to close.

Implements AzToolsFramework::Prefab::PrefabIntegrationInterface.

◆ SaveCurrentPrefab()

void AzToolsFramework::Prefab::PrefabIntegrationManager::SaveCurrentPrefab ( )
overridevirtual

Saves the prefab currently focused in the main editor window and all its descendants.

Implements AzToolsFramework::Prefab::PrefabIntegrationInterface.

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