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::PrefabConversionUtils::EditorInfoRemover Class Reference

Inherits AzToolsFramework::Prefab::PrefabConversionUtils::PrefabProcessor.

Public Types

using RemoveEditorInfoResult = AZ::Outcome< void, AZStd::string >
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (EditorInfoRemover, AZ::SystemAllocator)
 
 AZ_RTTI (AzToolsFramework::Prefab::PrefabConversionUtils::EditorInfoRemover, "{50B48C7E-C9DE-48DE-8438-1A186A8EEAC8}", PrefabProcessor)
 
void Process (PrefabProcessorContext &prefabProcessorContext) override
 
RemoveEditorInfoResult RemoveEditorInfo (PrefabDocument &prefab, AZ::SerializeContext *serializeContext, PrefabProcessorContext &prefabProcessorContext)
 
- Public Member Functions inherited from AzToolsFramework::Prefab::PrefabConversionUtils::PrefabProcessor
 AZ_CLASS_ALLOCATOR (PrefabProcessor, AZ::SystemAllocator)
 
 AZ_RTTI (PrefabProcessor, "{393C95DF-C0DA-4EF0-A081-9CA899649DDD}")
 
virtual void Process (PrefabProcessorContext &context)=0
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Protected Types

using RemoveEditorOnlyEntitiesResult = AZ::Outcome< void, AZStd::string >
 
using ExportEntityResult = AZ::Outcome< AZStd::unique_ptr< AZ::Entity >, AZStd::string >
 
using ResolveExportedComponentResult = AZ::Outcome< AZ::ExportedComponent, AZStd::string >
 
using ShouldExportResult = AZ::Outcome< bool, AZStd::string >
 
using BuildGameEntityResult = AZ::Outcome< void, AZStd::string >
 
using ExportComponentResult = AZ::Outcome< void, AZStd::string >
 

Protected Member Functions

void SetEditorOnlyEntityHandlerFromCandidates (const EntityList &entities)
 
bool HasValidEditorOnlyHandler () const
 
void ClearEditorOnlyEntityIds ()
 
void AddEntityIdIfEditorOnly (AZ::Entity *entity)
 
RemoveEditorOnlyEntitiesResult RemoveEditorOnlyEntities (EntityList &entities)
 
ExportEntityResult ExportEntity (AZ::Entity *sourceEntity, PrefabProcessorContext &context)
 
ResolveExportedComponentResult ResolveExportedComponent (AZ::ExportedComponent &component, PrefabProcessorContext &prefabProcessorContext)
 
ShouldExportResult ShouldExportComponent (AZ::Component *component, PrefabProcessorContext &prefabProcessorContext) const
 
BuildGameEntityResult BuildGameEntity (AzToolsFramework::Components::EditorComponentBase *editorComponent, AZ::Entity *sourceEntity, AZ::Entity *exportEntity)
 
ExportComponentResult ExportComponent (AZ::Component *component, PrefabProcessorContext &prefabProcessorContext, AZ::Entity *sourceEntity, AZ::Entity *exportEntity)
 

Static Protected Member Functions

static void GetEntitiesFromInstance (AzToolsFramework::Prefab::Instance &instance, EntityList &hierarchyEntities)
 
static bool ReadComponentAttribute (AZ::Component *component, AZ::Edit::Attribute *attribute, AZStd::vector< AZ::Crc32 > &attributeTags)
 

Protected Attributes

AZ::SerializeContext * m_serializeContext { nullptr }
 
EditorOnlyEntityHandlerm_editorOnlyEntityHandler { nullptr }
 
EditorOnlyEntityHandlers m_editorOnlyEntityHandlerCandidates
 
ComponentRequirementsValidator m_componentRequirementsValidator
 
EntityIdSet m_editorOnlyEntityIds
 

Member Function Documentation

◆ Process()

void AzToolsFramework::Prefab::PrefabConversionUtils::EditorInfoRemover::Process ( PrefabProcessorContext prefabProcessorContext)
overridevirtual

Member Data Documentation

◆ m_editorOnlyEntityHandlerCandidates

EditorOnlyEntityHandlers AzToolsFramework::Prefab::PrefabConversionUtils::EditorInfoRemover::m_editorOnlyEntityHandlerCandidates
protected
Initial value:
{
aznew WorldEditorOnlyEntityHandler(),
aznew UiEditorOnlyEntityHandler() }

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