#include <PrefabPublicInterface.h>
Inherited by AzToolsFramework::Prefab::PrefabPublicHandler.
PrefabPublicInterface Interface to expose Prefab functionality directly to UI and Scripting. Functions will correctly call the Undo/Redo system under the hood.
◆ CreateEntity()
| virtual PrefabEntityResult AzToolsFramework::Prefab::PrefabPublicInterface::CreateEntity |
( |
AZ::EntityId |
parentId, |
|
|
const AZ::Vector3 & |
position |
|
) |
| |
|
pure virtual |
Creates a new entity under the entity with id 'parentId' and propagates a change to the template of the owning instance of parentId.
- Parameters
-
| parentId | The id of the parent entity to parent the newly added entity under. |
| position | The transform position of the entity being added. |
- Returns
- Returns the entityId of the newly created entity, or an error message if the operation failed.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ CreatePrefabAndSaveToDisk()
| virtual CreatePrefabResult AzToolsFramework::Prefab::PrefabPublicInterface::CreatePrefabAndSaveToDisk |
( |
const EntityIdList & |
entityIds, |
|
|
AZ::IO::PathView |
filePath |
|
) |
| |
|
pure virtual |
Create a prefab out of the entities provided, at the path provided, and save it in disk immediately. Automatically detects descendants of entities, and discerns between entities and child instances. Note: It calls CreatePrefabInMemory internally and then saves the new template in disk.
- Parameters
-
| entityIds | The entities that should form the new prefab (along with their descendants). |
| filePath | The absolute path for the new prefab file. |
- Returns
- An outcome object with an entityId of the new prefab's container entity; on failure, it comes with an error message detailing the cause of the error.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ CreatePrefabInDisk()
| virtual CreatePrefabResult AzToolsFramework::Prefab::PrefabPublicInterface::CreatePrefabInDisk |
( |
const EntityIdList & |
entityIds, |
|
|
AZ::IO::PathView |
filePath |
|
) |
| |
|
pure virtual |
◆ CreatePrefabInMemory()
| virtual CreatePrefabResult AzToolsFramework::Prefab::PrefabPublicInterface::CreatePrefabInMemory |
( |
const EntityIdList & |
entityIds, |
|
|
AZ::IO::PathView |
filePath |
|
) |
| |
|
pure virtual |
Create a prefab out of the entities provided, at the path provided, and keep it in memory. Automatically detects descendants of entities, and discerns between entities and child instances. Note: The newly created prefab template cannot be undo/redo. Undo will not remove the templace in system.
- Parameters
-
| entityIds | The entities that should form the new prefab (along with their descendants). |
| filePath | The absolute path for the new prefab file. |
- Returns
- An outcome object with an entityId of the new prefab's container entity; on failure, it comes with an error message detailing the cause of the error.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ DeleteEntitiesAndAllDescendantsInInstance()
| virtual PrefabOperationResult AzToolsFramework::Prefab::PrefabPublicInterface::DeleteEntitiesAndAllDescendantsInInstance |
( |
const EntityIdList & |
entityIds | ) |
|
|
pure virtual |
Deletes all entities and their descendants from the owning instance. Bails if the entities don't all belong to the same instance.
- Parameters
-
| entities | The entities to delete. Their descendants will be discovered by this function. |
- Returns
- An outcome object; on failure, it comes with an error message detailing the cause of the error.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ DetachPrefab()
| virtual PrefabOperationResult AzToolsFramework::Prefab::PrefabPublicInterface::DetachPrefab |
( |
const AZ::EntityId & |
containerEntityId | ) |
|
|
pure virtual |
If the entity id is a container entity id, detaches the prefab instance corresponding to it. This includes converting the container entity into a regular entity and putting it under the parent prefab, removing the link between this instance and the parent, removing links between this instance and its nested instances, and adding entities directly owned by this instance under the parent instance. Bails if the entity is not a container entity or belongs to the level prefab instance.
- Parameters
-
| containerEntityId | The container entity id of the instance to detach. |
- Returns
- An outcome object; on failure, it comes with an error message detailing the cause of the error.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ DuplicateEntitiesInInstance()
| virtual DuplicatePrefabResult AzToolsFramework::Prefab::PrefabPublicInterface::DuplicateEntitiesInInstance |
( |
const EntityIdList & |
entityIds | ) |
|
|
pure virtual |
Duplicates all entities in the owning instance. Bails if the entities don't all belong to the same instance.
- Parameters
-
| entities | The entities to duplicate. |
- Returns
- An outcome object with a list of ids of target entities' duplicates if duplication succeeded; on failure, it comes with an error message detailing the cause of the error.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ EntitiesBelongToSameInstance()
| virtual bool AzToolsFramework::Prefab::PrefabPublicInterface::EntitiesBelongToSameInstance |
( |
const EntityIdList & |
entityIds | ) |
const |
|
pure virtual |
Detects if a list of entities are under the same instance. The instance of a container entity is special cased to be the parent instance of its instance.
- Parameters
-
| entityIds | The list of entities to query. |
- Returns
- True if all entities in the list have the same instance, false otherwise.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ GenerateUndoNodesForEntityChangeAndUpdateCache()
| virtual PrefabOperationResult AzToolsFramework::Prefab::PrefabPublicInterface::GenerateUndoNodesForEntityChangeAndUpdateCache |
( |
AZ::EntityId |
entityId, |
|
|
UndoSystem::URSequencePoint * |
parentUndoBatch |
|
) |
| |
|
pure virtual |
Store the changes between the current entity state and its last cached state into undo/redo commands. These changes are stored as patches to the owning prefab instance template, as appropriate. The function also triggers the redo() of the nodes it creates, triggering propagation on the next tick.
- Parameters
-
| entityId | The entity to patch. |
| parentUndoBatch | The undo batch the undo nodes should be parented to. |
- Returns
- Returns Success if the node was generated correctly, or an error message otherwise.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ GetInstanceContainerEntityId()
| virtual AZ::EntityId AzToolsFramework::Prefab::PrefabPublicInterface::GetInstanceContainerEntityId |
( |
AZ::EntityId |
entityId | ) |
const |
|
pure virtual |
Gets the entity id for the instance container of the owning instance.
- Parameters
-
| entityId | The id of the entity to query. |
- Returns
- The entity id of the instance container owning the queried entity.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ GetLevelInstanceContainerEntityId()
| virtual AZ::EntityId AzToolsFramework::Prefab::PrefabPublicInterface::GetLevelInstanceContainerEntityId |
( |
| ) |
const |
|
pure virtual |
◆ GetOwningInstancePrefabPath()
| virtual AZ::IO::Path AzToolsFramework::Prefab::PrefabPublicInterface::GetOwningInstancePrefabPath |
( |
AZ::EntityId |
entityId | ) |
const |
|
pure virtual |
Get the file path to the prefab file for the prefab instance owning the entity provided.
- Parameters
-
| entityId | The id for the entity being queried. |
- Returns
- Returns the path to the prefab, or an empty path if the entity is owned by the level.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ HasUnsavedChanges()
| virtual PrefabRequestResult AzToolsFramework::Prefab::PrefabPublicInterface::HasUnsavedChanges |
( |
AZ::IO::Path |
prefabFilePath | ) |
const |
|
pure virtual |
Gets whether the prefab has unsaved changes.
- Parameters
-
| filePath | The path to the prefab to query. |
- Returns
- Returns true if the prefab has unsaved changes, false otherwise. If path is invalid, returns an error message.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ InstantiatePrefab()
| virtual InstantiatePrefabResult AzToolsFramework::Prefab::PrefabPublicInterface::InstantiatePrefab |
( |
AZStd::string_view |
filePath, |
|
|
AZ::EntityId |
parentId, |
|
|
const AZ::Vector3 & |
position |
|
) |
| |
|
pure virtual |
Instantiate a prefab from a prefab file.
- Parameters
-
| filePath | The path to the prefab file to instantiate. |
| parentId | The entity id the prefab should be a child of in the transform hierarchy. |
| position | The position in world space the prefab should be instantiated in. |
- Returns
- An outcome object with an entityId of the new prefab's container entity; on failure, it comes with an error message detailing the cause of the error.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ IsInstanceContainerEntity()
| virtual bool AzToolsFramework::Prefab::PrefabPublicInterface::IsInstanceContainerEntity |
( |
AZ::EntityId |
entityId | ) |
const |
|
pure virtual |
Detects if an entity is the container entity for its owning prefab instance.
- Parameters
-
| entityId | The entity to query. |
- Returns
- True if the entity is the container entity for its owning prefab instance, false otherwise.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ IsLevelInstanceContainerEntity()
| virtual bool AzToolsFramework::Prefab::PrefabPublicInterface::IsLevelInstanceContainerEntity |
( |
AZ::EntityId |
entityId | ) |
const |
|
pure virtual |
Detects if an entity is the container entity for the level prefab instance.
- Parameters
-
| entityId | The entity to query. |
- Returns
- True if the entity is the container entity for the level prefab instance, false otherwise.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ IsOwnedByPrefabInstance()
| virtual bool AzToolsFramework::Prefab::PrefabPublicInterface::IsOwnedByPrefabInstance |
( |
AZ::EntityId |
entityId | ) |
const |
|
pure virtual |
◆ IsOwnedByProceduralPrefabInstance()
| virtual bool AzToolsFramework::Prefab::PrefabPublicInterface::IsOwnedByProceduralPrefabInstance |
( |
AZ::EntityId |
entityId | ) |
const |
|
pure virtual |
Detects if an entity is owned by a procedural prefab.
- Parameters
-
| entityId | The entity to query. |
- Returns
- True if the entity is owned by a procedural prefab instance, false otherwise.
Implemented in AzToolsFramework::Prefab::PrefabPublicHandler.
◆ SavePrefab()
| virtual PrefabOperationResult AzToolsFramework::Prefab::PrefabPublicInterface::SavePrefab |
( |
AZ::IO::Path |
filePath | ) |
|
|
pure virtual |
The documentation for this class was generated from the following file:
- Code/Framework/AzToolsFramework/AzToolsFramework/Prefab/PrefabPublicInterface.h
1.9.6