#include <PrefabSystemComponentInterface.h>

Inherited by AzToolsFramework::Prefab::PrefabSystemComponent [private].

Public Types
using	InstantiatedEntitiesCallback = AZStd::function< void(AZStd::vector< AZ::Entity * > &)>

Public Member Functions
	AZ_RTTI (PrefabSystemComponentInterface, "{8E95A029-67F9-4F74-895F-DDBFE29516A0}")

virtual TemplateReference	FindTemplate (TemplateId id)=0

virtual LinkReference	FindLink (const LinkId &id)=0

virtual TemplateId	AddTemplate (const AZ::IO::Path &filePath, PrefabDom prefabDom)=0

virtual void	UpdateTemplateFilePath (TemplateId templateId, const AZ::IO::PathView &filePath)=0

virtual void	RemoveTemplate (TemplateId templateId)=0

virtual void	RemoveAllTemplates ()=0

virtual LinkId	AddLink (TemplateId sourceTemplateId, TemplateId targetTemplateId, PrefabDomValue::MemberIterator &instanceIterator, InstanceOptionalReference instance)=0

virtual LinkId	CreateLink (TemplateId linkTargetId, TemplateId linkSourceId, const InstanceAlias &instanceAlias, const PrefabDomConstReference linkPatches, const LinkId &linkId=InvalidLinkId)=0

virtual bool	RemoveLink (const LinkId &linkId)=0

virtual TemplateId	GetTemplateIdFromFilePath (AZ::IO::PathView filePath) const =0

virtual bool	IsTemplateDirty (TemplateId templateId)=0

virtual void	SetTemplateDirtyFlag (TemplateId templateId, bool dirty)=0

virtual bool	AreDirtyTemplatesPresent (TemplateId rootTemplateId)=0

virtual void	SaveAllDirtyTemplates (TemplateId rootTemplateId)=0

virtual AZStd::set< AZ::IO::PathView >	GetDirtyTemplatePaths (TemplateId rootTemplateId)=0

virtual PrefabDom &	FindTemplateDom (TemplateId templateId)=0

virtual void	UpdatePrefabTemplate (TemplateId templateId, const PrefabDom &updatedDom)=0

virtual void	PropagateTemplateChanges (TemplateId templateId, InstanceOptionalConstReference instanceToExclude=AZStd::nullopt)=0

virtual AZStd::unique_ptr< Instance >	InstantiatePrefab (AZ::IO::PathView filePath, InstanceOptionalReference parent=AZStd::nullopt, const InstantiatedEntitiesCallback &instantiatedEntitiesCallback={})=0

virtual AZStd::unique_ptr< Instance >	InstantiatePrefab (TemplateId templateId, InstanceOptionalReference parent=AZStd::nullopt, const InstantiatedEntitiesCallback &instantiatedEntitiesCallback={})=0

virtual AZStd::unique_ptr< Instance >	CreatePrefab (const AZStd::vector< AZ::Entity * > &entities, AZStd::vector< AZStd::unique_ptr< Instance > > &&nestedInstances, AZ::IO::PathView filePath, AZStd::unique_ptr< AZ::Entity > containerEntity=nullptr, InstanceOptionalReference parent=AZStd::nullopt, bool shouldCreateLinks=true)=0

virtual AZStd::unique_ptr< Instance >	CreatePrefabWithCustomEntityAliases (const AZStd::map< EntityAlias, AZ::Entity * > &entities, AZStd::vector< AZStd::unique_ptr< Instance > > &&nestedInstances, AZ::IO::PathView filePath, AZStd::unique_ptr< AZ::Entity > containerEntity=nullptr, InstanceOptionalReference parent=AZStd::nullopt, bool shouldCreateLinks=true)=0

Detailed Description

PrefabSystemComponentInterface Interface serviced by the Prefab System Component.

Member Function Documentation

◆ AddLink()

virtual LinkId AzToolsFramework::Prefab::PrefabSystemComponentInterface::AddLink	(	TemplateId	sourceTemplateId,
		TemplateId	targetTemplateId,
		PrefabDomValue::MemberIterator &	instanceIterator,
		InstanceOptionalReference	instance
	)

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ AddTemplate()

virtual TemplateId AzToolsFramework::Prefab::PrefabSystemComponentInterface::AddTemplate	(	const AZ::IO::Path &	filePath,
		PrefabDom	prefabDom
	)

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ AreDirtyTemplatesPresent()

virtual bool AzToolsFramework::Prefab::PrefabSystemComponentInterface::AreDirtyTemplatesPresent ( TemplateId rootTemplateId )

pure virtual

Recursive function to check if the template is dirty or if any dirty templates are presents in the links of the template.

Parameters

rootTemplateId The id of the template provided as the beginning template to check the outgoing links.

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ CreateLink()

virtual LinkId AzToolsFramework::Prefab::PrefabSystemComponentInterface::CreateLink	(	TemplateId	linkTargetId,
		TemplateId	linkSourceId,
		const InstanceAlias &	instanceAlias,
		const PrefabDomConstReference	linkPatches,
		const LinkId &	linkId = `InvalidLinkId`
	)

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ CreatePrefab()

virtual AZStd::unique_ptr< Instance > AzToolsFramework::Prefab::PrefabSystemComponentInterface::CreatePrefab	(	const AZStd::vector< AZ::Entity * > &	entities,
		AZStd::vector< AZStd::unique_ptr< Instance > > &&	nestedInstances,
		AZ::IO::PathView	filePath,
		AZStd::unique_ptr< AZ::Entity >	containerEntity = `nullptr`,
		InstanceOptionalReference	parent = `AZStd::nullopt`,
		bool	shouldCreateLinks = `true`
	)

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ CreatePrefabWithCustomEntityAliases()

virtual AZStd::unique_ptr< Instance > AzToolsFramework::Prefab::PrefabSystemComponentInterface::CreatePrefabWithCustomEntityAliases	(	const AZStd::map< EntityAlias, AZ::Entity * > &	entities,
		AZStd::vector< AZStd::unique_ptr< Instance > > &&	nestedInstances,
		AZ::IO::PathView	filePath,
		AZStd::unique_ptr< AZ::Entity >	containerEntity = `nullptr`,
		InstanceOptionalReference	parent = `AZStd::nullopt`,
		bool	shouldCreateLinks = `true`
	)

pure virtual

Creates a prefab instance using the entities and nested instances provided.

Parameters

entities	The map of entities to add to the instance. Map ensures insertion order.
nestedInstances	The instances to add to the newly created instance.
filePath	The path at which the prefab should be created.
containerEntity	The container entity for the new instance.
parent	The parent instance of the newly created instance.

Returns: The new instance created.

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ FindLink()

virtual LinkReference AzToolsFramework::Prefab::PrefabSystemComponentInterface::FindLink ( const LinkId & id )

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ FindTemplate()

virtual TemplateReference AzToolsFramework::Prefab::PrefabSystemComponentInterface::FindTemplate ( TemplateId id )

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ GetDirtyTemplatePaths()

virtual AZStd::set< AZ::IO::PathView > AzToolsFramework::Prefab::PrefabSystemComponentInterface::GetDirtyTemplatePaths ( TemplateId rootTemplateId )

pure virtual

Recursive function that fetches the set of dirty templates given a starting template to check for outgoing links.

Parameters

rootTemplateId The id of the template provided as the beginning template to check the outgoing links.

Returns: The set of dirty template paths populated.

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ GetTemplateIdFromFilePath()

virtual TemplateId AzToolsFramework::Prefab::PrefabSystemComponentInterface::GetTemplateIdFromFilePath ( AZ::IO::PathView filePath ) const

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ InstantiatePrefab() [1/2]

virtual AZStd::unique_ptr< Instance > AzToolsFramework::Prefab::PrefabSystemComponentInterface::InstantiatePrefab	(	AZ::IO::PathView	filePath,
		InstanceOptionalReference	parent = `AZStd::nullopt`,
		const InstantiatedEntitiesCallback &	instantiatedEntitiesCallback = `{}`
	)

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ InstantiatePrefab() [2/2]

virtual AZStd::unique_ptr< Instance > AzToolsFramework::Prefab::PrefabSystemComponentInterface::InstantiatePrefab	(	TemplateId	templateId,
		InstanceOptionalReference	parent = `AZStd::nullopt`,
		const InstantiatedEntitiesCallback &	instantiatedEntitiesCallback = `{}`
	)

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ IsTemplateDirty()

virtual bool AzToolsFramework::Prefab::PrefabSystemComponentInterface::IsTemplateDirty ( TemplateId templateId )

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ RemoveAllTemplates()

virtual void AzToolsFramework::Prefab::PrefabSystemComponentInterface::RemoveAllTemplates ( )

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ RemoveLink()

virtual bool AzToolsFramework::Prefab::PrefabSystemComponentInterface::RemoveLink ( const LinkId & linkId )

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ RemoveTemplate()

virtual void AzToolsFramework::Prefab::PrefabSystemComponentInterface::RemoveTemplate ( TemplateId templateId )

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ SaveAllDirtyTemplates()

virtual void AzToolsFramework::Prefab::PrefabSystemComponentInterface::SaveAllDirtyTemplates ( TemplateId rootTemplateId )

pure virtual

Recursive function to save if the template is dirty and save all the dirty templates in the links of the template.

Parameters

rootTemplateId The id of the template provided as the beginning template to check the outgoing links.

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ SetTemplateDirtyFlag()

virtual void AzToolsFramework::Prefab::PrefabSystemComponentInterface::SetTemplateDirtyFlag	(	TemplateId	templateId,
		bool	dirty
	)

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ UpdatePrefabTemplate()

virtual void AzToolsFramework::Prefab::PrefabSystemComponentInterface::UpdatePrefabTemplate	(	TemplateId	templateId,
		const PrefabDom &	updatedDom
	)

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

◆ UpdateTemplateFilePath()

virtual void AzToolsFramework::Prefab::PrefabSystemComponentInterface::UpdateTemplateFilePath	(	TemplateId	templateId,
		const AZ::IO::PathView &	filePath
	)

pure virtual

Implemented in AzToolsFramework::Prefab::PrefabSystemComponent.

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

Code/Framework/AzToolsFramework/AzToolsFramework/Prefab/PrefabSystemComponentInterface.h

Public Types

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddLink()

◆ AddTemplate()

◆ AreDirtyTemplatesPresent()

◆ CreateLink()

◆ CreatePrefab()

◆ CreatePrefabWithCustomEntityAliases()

◆ FindLink()

◆ FindTemplate()

◆ GetDirtyTemplatePaths()

◆ GetTemplateIdFromFilePath()

◆ InstantiatePrefab() [1/2]

◆ InstantiatePrefab() [2/2]

◆ IsTemplateDirty()

◆ RemoveAllTemplates()

◆ RemoveLink()

◆ RemoveTemplate()

◆ SaveAllDirtyTemplates()

◆ SetTemplateDirtyFlag()

◆ UpdatePrefabTemplate()

◆ UpdateTemplateFilePath()