Navigation
Unreal Engine C++ API Reference > Runtime > Engine > Exporters
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UExporter
- UActorElementsExporterT3D
- UAnimSequenceExporterUSD
- UComponentElementsExporterT3D
- UExporterFBX
- UAnimSequenceExporterFBX
- ULevelExporterFBX
- USkeletalMeshExporterFBX
- UStaticMeshExporterFBX
- UGLTFExporter
- UGLTFAnimSequenceExporter
- UGLTFLevelExporter
- UGLTFLevelSequenceExporter
- UGLTFLevelVariantSetsExporter
- UGLTFMaterialExporter
- UGLTFSkeletalMeshExporter
- UGLTFStaticMeshExporter
- ULevelExporterLOD
- ULevelExporterOBJ
- ULevelExporterSTL
- ULevelExporterT3D
- ULevelExporterUSD
- ULevelSequenceExporterUsd
- ULidarPointCloudFileIO
- UMaterialExporterUsd
- UModelExporterT3D
- UObjectExporterT3D
- UPolysExporterOBJ
- UPolysExporterT3D
- URenderTargetExporterEXR
- URenderTargetExporterPNG
- USequenceExporterT3D
- USkeletalMeshExporterUsd
- USoundExporterOGG
- USoundExporterWAV
- USoundSurroundExporterWAV
- UStaticMeshExporterOBJ
- UStaticMeshExporterUsd
- UTextBufferExporterTXT
- UTextureCubeExporterHDR
- URenderTargetCubeExporterHDR
- UTextureExporterGeneric
- UTextureExporterBMP
- UVirtualTextureBuilderExporterBMP
- UTextureExporterDDS
- UVirtualTextureBuilderExporterDDS
- UTextureExporterEXR
- UVirtualTextureBuilderExporterEXR
- UTextureExporterHDR
- UVirtualTextureBuilderExporterHDR
- UTextureExporterPNG
- UVirtualTextureBuilderExporterPNG
- UTextureExporterTGA
- UTextureExporterJPEG
- UTextureExporterPCX
- UVectorFieldExporter
References
Module | Engine |
Header | /Engine/Source/Runtime/Engine/Classes/Exporters/Exporter.h |
Include | #include "Exporters/Exporter.h" |
Syntax
class UExporter : public UObject
Variables
Type | Name | Description | |
---|---|---|---|
![]() |
bool | BatchExportMode | The exporter is in batch mode. |
![]() |
uint32: 1 | bForceFileOperations | If true, this will force the exporter code to create a file-based Ar (this can keep large output files from taking too much memory) |
![]() |
uint32: 1 | bSelectedOnly | If true, this will export only the selected objects |
![]() |
uint32: 1 | bText | If true, this will export the data as text |
![]() |
bool | CancelBatch | If set to true and BatchExportMode is also true, all other export from this bulk export should be cancel |
![]() |
TObjectPtr< class UObject > | ExportRootScope | The root scope of objects to be exported, only used if PPF_ExportsNotFullyQualfied is set Objects being exported that are contained within ExportRootScope will use just their name instead of a full path |
![]() |
TObjectPtr< class UAssetExportTask > | ExportTask | |
![]() |
TArray< FString > | FormatDescription | Descriptiong of the export format |
![]() |
TArray< FString > | FormatExtension | File extension to use for this exporter |
![]() |
int32 | PreferredFormatIndex | Index into FormatExtension/FormatDescription of the preferred export format. |
![]() |
bool | ShowExportOption | The exporter will show the export options if this field is true |
![]() |
TSubclassOf< class UObject > | SupportedClass | Supported class of this exporter |
![]() |
int32 | TextIndent | Current indentation of spaces of the exported text |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
UExporter
(
const FObjectInitializer& ObjectInitializer |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | EmitBeginObject
(
FOutputDevice& Ar, |
Emits the starting line for a subobject definition. |
![]() |
void | EmitEndObject
(
FOutputDevice& Ar |
Emits the ending line for a subobject definition. |
![]() ![]() |
bool | ExportBinary
(
UObject* Object, |
Export object to binary |
![]() ![]() |
void | ExportComponentExtra
(
const FExportObjectInnerContext* Context, |
Allows the Exporter to export any extra information it would like about each instanced object. |
![]() |
void | ExportObjectInner
(
const FExportObjectInnerContext* Context, |
Single entry point to export an object's subobjects, its components, and its properties |
![]() ![]() |
void | ExportPackageInners
(
FExportPackageParams& ExpPackageParams |
Export Package Inner |
![]() ![]() |
void | ExportPackageObject
(
FExportPackageParams& ExpPackageParams |
Export Package Object |
![]() ![]() |
bool | ExportText
(
const FExportObjectInnerContext* Context, |
Export object to text |
![]() ![]() |
bool | ExportToArchive
(
UObject* Object, |
Export object to an archive |
![]() ![]() |
int32 | ExportToFile
(
UObject* Object, |
Export this object to a file. |
![]() ![]() |
bool | ExportToOutputDevice
(
const FExportObjectInnerContext* Context, |
Export object to a device |
![]() ![]() |
UExporter * | FindExporter
(
UObject* Object, |
Find an exporter for the object and filetype. |
![]() ![]() ![]() |
bool | GetBatchMode () |
Return true if the exporter is in batch mode. |
![]() ![]() ![]() |
bool | Return true if the exporter batch was cancel. | |
![]() ![]() ![]() |
int32 | GetFileCount
(
UObject* Object |
Number of binary files to export for this object. |
![]() ![]() ![]() |
bool | Return true if the exporter must show the export options. | |
![]() ![]() ![]() |
FString | GetUniqueFilename
(
UObject* Object, |
Differentiates the filename for objects with multiple files to export. |
![]() ![]() |
bool | IsObjectSelectedForExport
(
const FExportObjectInnerContext* Context, |
Should the given object be considered selected by the current export? |
![]() ![]() |
bool | RunAssetExportTask
(
UAssetExportTask* Task |
Export the given object to file. |
![]() ![]() |
bool | RunAssetExportTasks
(
const TArray< UAssetExportTask* >& ExportTasks |
Export the given objects to files. |
![]() |
bool | ScriptRunAssetExportTask
(
UAssetExportTask* Task |
Export the given object to file. Overridden by script based exporters. |
![]() ![]() |
void | SetBatchMode
(
bool InBatchExportMode |
Set the exporter batch mode. |
![]() ![]() |
void | SetCancelBatch
(
bool InCancelBatch |
Set the exporter batch cancel state. |
![]() ![]() |
void | SetShowExportOption
(
bool InShowExportOption |
Set if the exporter should show or hide the export options. |
![]() ![]() ![]() |
bool | SupportsObject
(
UObject* Object |
Returns whether this exporter supports the specific object. |
Overridden from UObject
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | Handles reading, writing, and reference collecting using FArchive. |
Classes
Type | Name | Description | |
---|---|---|---|
![]() |
FExportPackageParams | Export parameters | |
![]() |
FExportToFileParams |
Constants
Name | Description |
---|---|
bEnableDebugBrackets | (debugging purposes only) |
CurrentFilename | |
RegisteredExporters | The set of registered exporters. |
Deprecated Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
int32 | ExportToFileEx
(
FExportToFileParams& ExportParams |
ExportToFileEx was deprecated, please use RunAssetExportTask. |