Interface to handle instance update in template propagation.
More...
#include <InstanceUpdateExecutorInterface.h>
Inherited by AzToolsFramework::Prefab::InstanceUpdateExecutor.
Interface to handle instance update in template propagation.
◆ AddInstanceToQueue()
virtual void AzToolsFramework::Prefab::InstanceUpdateExecutorInterface::AddInstanceToQueue |
( |
InstanceOptionalReference |
instance | ) |
|
|
pure virtual |
◆ AddTemplateInstancesToQueue()
virtual void AzToolsFramework::Prefab::InstanceUpdateExecutorInterface::AddTemplateInstancesToQueue |
( |
TemplateId |
instanceTemplateId, |
|
|
InstanceOptionalConstReference |
instanceToExclude = AZStd::nullopt |
|
) |
| |
|
pure virtual |
Adds all instances of template with given id into queue for updating them later.
- Parameters
-
instanceTemplateId | The template id used to retrieve all instances. |
instanceToExclude | The instance to be excluded. It is nullopt by default. |
Implemented in AzToolsFramework::Prefab::InstanceUpdateExecutor.
◆ QueueRootPrefabLoadedNotificationForNextPropagation()
virtual void AzToolsFramework::Prefab::InstanceUpdateExecutorInterface::QueueRootPrefabLoadedNotificationForNextPropagation |
( |
| ) |
|
|
pure virtual |
Sets the flag that tells whether root prefab instance is loaded to false. A notification OnRootPrefabInstanceLoaded will fire during the propagation if root prefab instance is loaded for the first time after this function is called.
Implemented in AzToolsFramework::Prefab::InstanceUpdateExecutor.
◆ RemoveTemplateInstanceFromQueue()
virtual void AzToolsFramework::Prefab::InstanceUpdateExecutorInterface::RemoveTemplateInstanceFromQueue |
( |
Instance * |
instance | ) |
|
|
pure virtual |
◆ SetShouldPauseInstancePropagation()
virtual void AzToolsFramework::Prefab::InstanceUpdateExecutorInterface::SetShouldPauseInstancePropagation |
( |
bool |
shouldPausePropagation | ) |
|
|
pure virtual |
Sets whether to pause instance propagation or not. When making property changes in the entity editor, pausing propagation during editing will prevent the user from losing control of the properties they are editing.
- Parameters
-
shouldPausePropagation | Flag that decides whether to pause propagation. |
Implemented in AzToolsFramework::Prefab::InstanceUpdateExecutor.
◆ UpdateTemplateInstancesInQueue()
virtual bool AzToolsFramework::Prefab::InstanceUpdateExecutorInterface::UpdateTemplateInstancesInQueue |
( |
| ) |
|
|
pure virtual |
The documentation for this class was generated from the following file:
- Code/Framework/AzToolsFramework/AzToolsFramework/Prefab/Instance/InstanceUpdateExecutorInterface.h