AzToolsFramework::Prefab::PrefabOverrideHandler Class Reference

Public Member Functions
bool	AreOverridesPresent (AZ::Dom::Path path, LinkId linkId) const
AZStd::optional< PatchType >	GetPatchType (AZ::Dom::Path path, LinkId linkId) const
bool	RevertOverrides (AZ::Dom::Path path, LinkId linkId) const
bool	PushOverridesToPrefab (const AZ::Dom::Path &path, AZStd::string_view relativePath, InstanceOptionalReference targetInstance) const
bool	PushOverridesToLink (const AZ::Dom::Path &path, AZStd::string_view relativePath, LinkId sourceLinkId, LinkId targetLinkId) const

Member Function Documentation

AreOverridesPresent()

bool AzToolsFramework::Prefab::PrefabOverrideHandler::AreOverridesPresent	(	AZ::Dom::Path	path,
		LinkId	linkId
	)		const

Checks whether overrides are present on the link object matching the linkId at the provided path.

Parameters

path	The path to check for overrides on the link object.
linkId	The id of the link object to check for overrides.

Returns

true if overrides are present at the given path on the link object matching the link id.

GetPatchType()

AZStd::optional< PatchType > AzToolsFramework::Prefab::PrefabOverrideHandler::GetPatchType	(	AZ::Dom::Path	path,
		LinkId	linkId
	)		const

Gets the patch type on the link object matching the linkId at the provided path.

Parameters

path	The path to get override type on the link object.
linkId	The id of the link object to get overrides on.

Returns

a patch type if an override is present at the given path on the link object matching the link id.

PushOverridesToLink()

bool AzToolsFramework::Prefab::PrefabOverrideHandler::PushOverridesToLink	(	const AZ::Dom::Path &	path,
		AZStd::string_view	relativePath,
		LinkId	sourceLinkId,
		LinkId	targetLinkId
	)		const

Pushes overrides corresponding to the provided path from one link to another. For this to work, overrides should target a descendant of both source and target links, and targetLink should be a descendant of sourceLink.

Parameters

path	The path at which overrides should be applied.
relativePath	The relative path from the instance currently holding the overrides to the one that will receive them.
sourceLinkId	The id for the link currently holding the overrides.
targetLinkId	The id for the link that will be receive the overrides.

Returns

Whether overrides are applied successfully.

PushOverridesToPrefab()

bool AzToolsFramework::Prefab::PrefabOverrideHandler::PushOverridesToPrefab	(	const AZ::Dom::Path &	path,
		AZStd::string_view	relativePath,
		InstanceOptionalReference	targetInstance
	)		const

Pushes overrides corresponding to the provided path to the prefab template of the prefab instance.

Parameters

path	The path at which overrides should be applied.
relativePath	The relative path from the instance currently holding the overrides to the one that will receive them.
targetInstance	The instance whose prefab template the overrides will be pushed to.

Returns

Whether overrides are applied successfully.

RevertOverrides()

bool AzToolsFramework::Prefab::PrefabOverrideHandler::RevertOverrides	(	AZ::Dom::Path	path,
		LinkId	linkId
	)		const

Revert overrides corresponding to the provided path from the overrides stored in the link matching the link id.

Parameters

path	The path at which overrides should be reverted from.
linkId	The id of the link from which overrides should be reverted.

Returns

Whether overrides are reverted successfully.

---

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

• Code/Framework/AzToolsFramework/AzToolsFramework/Prefab/Overrides/PrefabOverrideHandler.h