UExporter

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Exporters/Exporter.h

Include

#include "Exporters/Exporter.h"

Syntax

class UExporter : public UObject

Variables

Name Description

Protected variable

bool

 

BatchExportMode

The exporter is in batch mode.

Public variable

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

uint32: 1

 

bSelectedOnly

If true, this will export only the selected objects

Public variable

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

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

UAssetExportTas...

 

ExportTask

Public variable

TArray< FString...

 

FormatDescription

Descriptiong of the export format

Public variable

TArray< FString...

 

FormatExtension

File extension to use for this exporter

Public variable

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

TSubclassOf< cl...

 

SupportedClass

Supported class of this exporter

Public variable

int32

 

TextIndent

Current indentation of spaces of the exported text

Constructors

Name Description

Public function

UExporter

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

void

 

EmitBeginObject

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

Emits the starting line for a subobject definition.

Protected function

void

 

EmitEndObject

(
    FOutputDevice& Ar
)

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...,
    const TArray< UActorComponent*...,
    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...,
    UObject* Object,
    FOutputDevice& Ar,
    uint32 PortFlags
)

Single entry point to export an object's subobjects, its components, and its properties

Public function Virtual

void

 

ExportPackageInners

(
    FExportPackageParams& ExpPackagePa...
)

Export Package Inner

Public function Virtual

void

 

ExportPackageObject

(
    FExportPackageParams& ExpPackagePa...
)

Export Package Object

Public function Virtual

bool

 

ExportText

(
    const FExportObjectInnerContext...,
    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

void

 

ExportToOutputDevice

(
    const FExportObjectInnerContext...,
    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

 

GetBatchMode()

Return true if the exporter is in batch mode.

Public function Virtual Const

bool

 

GetCancelBatch()

Return true if the exporter batch was cancel.

Public function Virtual Const

int32

 

GetFileCount()

Number of binary files to export for this object.

Public function Virtual Const

bool

 

GetShowExportOption()

Return true if the exporter must show the export options.

Public function Virtual

FString

 

GetUniqueFilename

(
    const TCHAR* Filename,
    int32 FileIndex
)

Differentiates the filename for objects with multiple files to export.

Public function Static

bool

 

RunAssetExportTask

(
    UAssetExportTask* Task
)

Export the given object to file.

Public function Static

bool

 

RunAssetExportTasks

(
    const TArray< UAssetExportTask*...
)

Export the given objects to files.

Public function

bool

 

ScriptRunAssetExportTask

(
    UAssetExportTask* Task
)

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

Name Description

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Classes

Name

Description

Public struct

FExportPackageParams

Export parameters

Public struct

FExportToFileParams

Constants

Name

Description

bEnableDebugBrackets

(debugging purposes only)

CurrentFilename

RegisteredExporters

The set of registered exporters.

Deprecated Functions

Name Description

Public function Static

int32

 

ExportToFileEx

(
    FExportToFileParams& ExportParams
)

ExportToFileEx was deprecated, please use RunAssetExportTask.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback