1. Epic GamesDeveloper
  3. UExporter

UExporter

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Exporters

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Exporters/Exporter.h
Include #include "Exporters/Exporter.h"

Syntax

UCLASS (Abstract, Transient, MinimalAPI)  
class UExporter : public UObject

Variables

  Type Name Description
Protected variable bool BatchExportMode The exporter is in batch mode.
Public variable UProperty 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)
Public variable UProperty uint32: 1 bSelectedOnly If true, this will export only the selected objects
Public variable UProperty Category BlueprintReadWrite uint32: 1 bText If true, this will export the data as text
Protected variable bool CancelBatch If set to true and BatchExportMode is also true, all other export from this bulk export should be cancel
Public variable UProperty Transient 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
Public variable UProperty Category BlueprintReadWrite TObjectPtr< class UAssetExportTask > ExportTask  
Public variable UProperty Category BlueprintReadWrite TArray< FString > FormatDescription Descriptiong of the export format
Public variable UProperty Category BlueprintReadWrite TArray< FString > FormatExtension File extension to use for this exporter
Public variable UProperty int32 PreferredFormatIndex Index into FormatExtension/FormatDescription of the preferred export format.
Protected variable bool ShowExportOption The exporter will show the export options if this field is true
Public variable UProperty Category BlueprintReadWrite TSubclassOf< class UObject > SupportedClass Supported class of this exporter
Public variable UProperty int32 TextIndent Current indentation of spaces of the exported text

Constructors

  Type Name Description
Public function  

UExporter ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void

EmitBeginObject ( FOutputDevice& Ar,
UObject* Obj,
uint32 PortFlags
)

 Emits the starting line for a subobject definition.
Protected function void Emits the ending line for a subobject definition.
Public function Virtual bool

ExportBinary ( UObject* Object,
const TCHAR* Type,
FArchive& Ar,
FFeedbackContext* Warn,
int32 FileIndex,
uint32 PortFlags
)

 Export object to binary
Protected function Virtual void

ExportComponentExtra ( const FExportObjectInnerContext* Context,
const TArray< UActorComponent* >& Components,
FOutputDevice& Ar,
uint32 PortFlags
)

 Allows the Exporter to export any extra information it would like about each instanced object.
Public function void

ExportObjectInner ( const FExportObjectInnerContext* Context,
UObject* Object,
FOutputDevice& Ar,
uint32 PortFlags
)

 Single entry point to export an object's subobjects, its components, and its properties
Public function Virtual void Export Package Inner
Public function Virtual void Export Package Object
Public function Virtual bool

ExportText ( const FExportObjectInnerContext* Context,
UObject* Object,
const TCHAR* Type,
FOutputDevice& Ar,
FFeedbackContext* Warn,
uint32 PortFlags
)

 Export object to text
Public function Static bool

ExportToArchive ( UObject* Object,
UExporter* Exporter,
FArchive& Ar,
const TCHAR* FileType,
int32 FileIndex
)

 Export object to an archive
Public function Static int32

ExportToFile ( UObject* Object,
UExporter* Exporter,
const TCHAR* Filename,
bool InSelectedOnly,
bool NoReplaceIdentical,
bool Prompt
)

 Export this object to a file.
Public function Static int32 Export the given object to a file.
Public function Static bool

ExportToOutputDevice ( const FExportObjectInnerContext* Context,
UObject* Object,
UExporter* InExporter,
FOutputDevice& Out,
const TCHAR* FileType,
int32 Indent,
uint32 PortFlags,
bool bInSelectedOnly,
UObject* ExportRootScope
)

 Export object to a device
Public function Static UExporter *

FindExporter ( UObject* Object,
const TCHAR* Filetype
)

 Find an exporter for the object and filetype.
Public function Virtual Const bool Return true if the exporter is in batch mode.
Public function Virtual Const bool Return true if the exporter batch was cancel.
Public function Virtual Const int32

GetFileCount ( UObject* Object
)

 Number of binary files to export for this object.
Public function Virtual Const bool Return true if the exporter must show the export options.
Public function Virtual Const FString

GetUniqueFilename ( UObject* Object,
const TCHAR* Filename,
int32 FileIndex,
int32 FileCount
)

 Differentiates the filename for objects with multiple files to export.
Public function Static bool

IsObjectSelectedForExport ( const FExportObjectInnerContext* Context,
const UObject* Object
)

 Should the given object be considered selected by the current export?
Public function Static UFunction BlueprintCallable, Category bool Export the given object to file.
Public function Static UFunction BlueprintCallable, Category bool

RunAssetExportTasks ( const TArray< UAssetExportTask* >& ExportTasks
)

 Export the given objects to files.
Public function UFunction Category, BlueprintImplementableEvent bool Export the given object to file. Overridden by script based exporters.
Public function Virtual void

SetBatchMode ( bool InBatchExportMode
)

 Set the exporter batch mode.
Public function Virtual void

SetCancelBatch ( bool InCancelBatch
)

 Set the exporter batch cancel state.
Public function Virtual void

SetShowExportOption ( bool InShowExportOption
)

 Set if the exporter should show or hide the export options.
Public function Virtual Const bool

SupportsObject ( UObject* Object
)

 Returns whether this exporter supports the specific object.

Overridden from UObject

  Type Name Description
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public struct FExportPackageParams Export parameters  
Public struct FExportToFileParams    

Constants

Name Description
bEnableDebugBrackets (debugging purposes only)
CurrentFilename  
RegisteredExporters The set of registered exporters.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page