Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzToolsFramework::Prefab::PrefabAdapterInterface Class Referenceabstract

Public Member Functions

 AZ_RTTI (PrefabAdapterInterface, "{8272C235-1642-432F-8A51-63E9B4488D55}")
 
virtual void AddPropertyLabelNode (AZ::DocumentPropertyEditor::AdapterBuilder *adapterBuilder, AZStd::string_view labelText, const AZ::Dom::Path &relativePathFromEntity, AZ::EntityId entityId)=0
 

Member Function Documentation

◆ AddPropertyLabelNode()

virtual void AzToolsFramework::Prefab::PrefabAdapterInterface::AddPropertyLabelNode ( AZ::DocumentPropertyEditor::AdapterBuilder *  adapterBuilder,
AZStd::string_view  labelText,
const AZ::Dom::Path &  relativePathFromEntity,
AZ::EntityId  entityId 
)
pure virtual

Adds a property label node to the DPE DOM and configures its style if an override is present on the entity at the provided path.

Parameters
adapterBuilderThe builder to use to add the property label node.
labelTextThe text string to be displayed in label.
relativePathFromEntityThe path as seen by the entity a component or its properties.
entityIdThe entity id to use to query the prefab system about the presence of overrides.

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