Inherits AzToolsFramework::Prefab::InstanceUpdateExecutorInterface.
◆ AddInstanceToQueue()
void AzToolsFramework::Prefab::InstanceUpdateExecutor::AddInstanceToQueue |
( |
InstanceOptionalReference |
instance | ) |
|
|
overridevirtual |
◆ AddTemplateInstancesToQueue()
void AzToolsFramework::Prefab::InstanceUpdateExecutor::AddTemplateInstancesToQueue |
( |
TemplateId |
instanceTemplateId, |
|
|
InstanceOptionalConstReference |
instanceToExclude = AZStd::nullopt |
|
) |
| |
|
overridevirtual |
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. |
Implements AzToolsFramework::Prefab::InstanceUpdateExecutorInterface.
◆ QueueRootPrefabLoadedNotificationForNextPropagation()
void AzToolsFramework::Prefab::InstanceUpdateExecutor::QueueRootPrefabLoadedNotificationForNextPropagation |
( |
| ) |
|
|
overridevirtual |
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.
Implements AzToolsFramework::Prefab::InstanceUpdateExecutorInterface.
◆ RemoveTemplateInstanceFromQueue()
void AzToolsFramework::Prefab::InstanceUpdateExecutor::RemoveTemplateInstanceFromQueue |
( |
Instance * |
instance | ) |
|
|
overridevirtual |
◆ SetShouldPauseInstancePropagation()
void AzToolsFramework::Prefab::InstanceUpdateExecutor::SetShouldPauseInstancePropagation |
( |
bool |
shouldPausePropagation | ) |
|
|
overridevirtual |
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. |
Implements AzToolsFramework::Prefab::InstanceUpdateExecutorInterface.
◆ UpdateTemplateInstancesInQueue()
bool AzToolsFramework::Prefab::InstanceUpdateExecutor::UpdateTemplateInstancesInQueue |
( |
| ) |
|
|
overridevirtual |
The documentation for this class was generated from the following file:
- Code/Framework/AzToolsFramework/AzToolsFramework/Prefab/Instance/InstanceUpdateExecutor.h