Open 3D Engine AzCore 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.
AZ::ExportedComponent Struct Reference

#include <ComponentExport.h>

Public Member Functions

 AZ_TYPE_INFO (ExportedComponent, "{F8A00B8B-6981-4508-B939-731563849B97}")
 
 ExportedComponent (AZ::Component *component, bool deleteAfterExport, bool componentExportHandled=true)
 

Public Attributes

AZ::Componentm_component
 Pointer to exported component. Null is valid, and conveys no component should be exported.
 
bool m_deleteAfterExport
 If true (false by default), the returned component will be cleaned up by the asset pipeline.
 
bool m_componentExportHandled
 

Detailed Description

Descriptor used when converting editor components to runtime components (slice processing, play-in-editor, etc).

Member Data Documentation

◆ m_componentExportHandled

bool AZ::ExportedComponent::m_componentExportHandled

If true (true by default), the component export has been handled. This allows callbacks to announce whether they've handled or ignored the export. If this has been set to false, anything set in m_component or m_deleteAfterExport will be ignored. If it has been set to true, the m_component value will be used as the exported component. (A value of null in m_component means "don't export anything")


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