1. Epic GamesDeveloper
  3. UExporter

UExporter

API > API/Runtime > API/Runtime/Engine

   
Name UExporter
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Exporters/Exporter.h
Include Path #include "Exporters/Exporter.h"

Syntax

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

Inheritance Hierarchy

Derived Classes

UExporter derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UExporter ( const FObjectInitializer& ObjectInitializer
)

   Exporters/Exporter.h  

Structs

Name Remarks
FExportPackageParams Export parameters
FExportToFileParams  

Constants

Name Type Remarks Include Path
bEnableDebugBrackets const bool (debugging purposes only) Exporters/Exporter.h
CurrentFilename FString   Exporters/Exporter.h
RegisteredExporters TSet< TWeakObjectPtr< UExporter > > The set of registered exporters. Exporters/Exporter.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bForceFileOperations uint32 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) Exporters/Exporter.h  
bSelectedOnly uint32 If true, this will export only the selected objects Exporters/Exporter.h  
bText uint32 If true, this will export the data as text Exporters/Exporter.h
  • BlueprintReadWrite
  • Category=Misc
ExportRootScope TObjectPtr< class UObject > 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 Exporters/Exporter.h
  • Transient
ExportTask TObjectPtr< class UAssetExportTask >   Exporters/Exporter.h
  • BlueprintReadWrite
  • Category=Misc
FormatDescription TArray< FString > Descriptiong of the export format Exporters/Exporter.h
  • BlueprintReadWrite
  • Category=Misc
FormatExtension TArray< FString > File extension to use for this exporter Exporters/Exporter.h
  • BlueprintReadWrite
  • Category=Misc
PreferredFormatIndex int32 Index into FormatExtension/FormatDescription of the preferred export format. Exporters/Exporter.h  
SupportedClass TSubclassOf< class UObject > Supported class of this exporter Exporters/Exporter.h
  • BlueprintReadWrite
  • Category=Misc
TextIndent int32 Current indentation of spaces of the exported text Exporters/Exporter.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Export object to binary Exporters/Exporter.h  

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 Exporters/Exporter.h  

virtual void ExportPackageInners ( FExportPackageParams& ExpPackageParams
)

 Export Package Inner Exporters/Exporter.h  

virtual void ExportPackageObject ( FExportPackageParams& ExpPackageParams
)

 Export Package Object Exporters/Exporter.h  

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

 Export object to text Exporters/Exporter.h  

virtual bool GetBatchMode()

 Return true if the exporter is in batch mode. Exporters/Exporter.h  

virtual bool GetCancelBatch()

 Return true if the exporter batch was cancel. Exporters/Exporter.h  

virtual int32 GetFileCount ( UObject* Object
) const

 Number of binary files to export for this object. Exporters/Exporter.h  

virtual bool GetShowExportOption()

 Return true if the exporter must show the export options. Exporters/Exporter.h  

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

 Differentiates the filename for objects with multiple files to export. Exporters/Exporter.h  

bool ScriptRunAssetExportTask ( UAssetExportTask* Task
)

 Export the given object to file. Overridden by script based exporters. Exporters/Exporter.h
  • BlueprintImplementableEvent
  • Category="Miscellaneous"

virtual void SetBatchMode ( bool InBatchExportMode
)

 Set the exporter batch mode. Exporters/Exporter.h  

virtual void SetCancelBatch ( bool InCancelBatch
)

 Set the exporter batch cancel state. Exporters/Exporter.h  

virtual void SetShowExportOption ( bool InShowExportOption
)

 Set if the exporter should show or hide the export options. Exporters/Exporter.h  

virtual bool SupportsObject ( UObject* Object
) const

 Returns whether this exporter supports the specific object. Exporters/Exporter.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( FArchive& Ar
)

   Exporters/Exporter.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

 Emits the starting line for a subobject definition. Exporters/Exporter.h  

void EmitEndObject ( FOutputDevice& Ar
)

 Emits the ending line for a subobject definition. Exporters/Exporter.h  

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. Exporters/Exporter.h  

Static

Name Remarks Include Path Unreal Specifiers

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

 Export object to an archive Exporters/Exporter.h  

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

 Export this object to a file. Exporters/Exporter.h  

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 Exporters/Exporter.h  

static UExporter * FindExporter ( UObject* Object,
const TCHAR* Filetype
)

 Find an exporter for the object and filetype. Exporters/Exporter.h  

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

 Should the given object be considered selected by the current export? Exporters/Exporter.h  

static bool RunAssetExportTask ( UAssetExportTask* Task
)

 Export the given object to file. Exporters/Exporter.h
  • BlueprintCallable
  • Category="Miscellaneous"

static bool RunAssetExportTasks ( const TArray< UAssetExportTask* >& ExportTasks
)

 Export the given objects to files. Exporters/Exporter.h
  • BlueprintCallable
  • Category="Miscellaneous"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page