1. Epic GamesDeveloper
  3. UFactory

UFactory

Base class for all factories An object responsible for creating and importing new objects.

API > API/Editor > API/Editor/UnrealEd

Base class for all factories An object responsible for creating and importing new objects.

   
Name UFactory
Type class
Header File /Engine/Source/Editor/UnrealEd/Classes/Factories/Factory.h
Include Path #include "Factories/Factory.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
class UFactory : public UObject

Inheritance Hierarchy

Derived Classes

UFactory derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UFactory ( const FObjectInitializer& ObjectInitializer
)

   Factories/Factory.h  

Constants

Name Type Remarks Include Path
CurrentFilename FString Name of the file currently being imported. Factories/Factory.h
DefaultImportPriority const int32 This is the import priority that all factories are given in the default constructor. Factories/Factory.h
FileHash FMD5Hash This is the HASH for the file being imported Factories/Factory.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssetImportTask TObjectPtr< class UAssetImportTask > Task for importing file via script interfaces Factories/Factory.h
  • BlueprintReadWrite
  • Category=Misc
AutomatedImportData TObjectPtr< const class UAutomatedAssetImportData > Data for how to import files via the automated command line importing interface Factories/Factory.h
  • BlueprintReadWrite
  • Category=Misc
bEditAfterNew uint32 True if the associated editor should be opened after creating a new object. Factories/Factory.h
  • BlueprintReadWrite
  • Category=Misc
bEditorImport uint32 True if the factory imports objects from files. Factories/Factory.h
  • BlueprintReadWrite
  • Category=Misc
bText uint32 True if the factory imports objects from text. Factories/Factory.h
  • BlueprintReadWrite
  • Category=Misc
ContextClass TSubclassOf< UObject > Class of the context object used to help create the object. Factories/Factory.h
  • BlueprintReadWrite
  • Category=Misc
Formats TArray< FString > List of formats supported by the factory. Factories/Factory.h
  • BlueprintReadWrite
  • Category=Misc
ImportPriority int32 Determines the order in which factories are tried when importing or reimporting an object. Factories/Factory.h  
SupportedClass TSubclassOf< UObject > The class manufactured by this factory. Factories/Factory.h
  • BlueprintReadWrite
  • Category=Misc
SupportedWorkflows uint8 Which workflows are supported. Factories/Factory.h
  • BlueprintReadWrite
  • Category=Misc
  • Meta=(Bitmask)

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool CanCreateNew()

   Factories/Factory.h  

virtual bool CanImportBeCanceled()

 Whether the factory is checking for SlowTask::ShouldCancel() while importing and aborting the import when appropriate. Factories/Factory.h  

virtual void CleanUp()

 Do clean up after importing is done. Will be called once for multi batch import. Factories/Factory.h  

virtual bool ConfigureProperties ()

 Opens a dialog to configure the factory properties. Factories/Factory.h  

virtual bool ConfigurePropertiesAsync ( FFactoryConfigurePropertiesComplete OnComplete,
FFactoryConfigurePropertiesCancelled OnCancelled
)

 Called instead of ConfigureProperties() when an asset is being created asynchronously. Factories/Factory.h  

UObject * CreateOrOverwriteAsset ( UClass* InClass,
UObject* InParent,
FName InName,
EObjectFlags InFlags,
UObject* InTemplate
) const

 Creates an asset if it doesn't exist. Factories/Factory.h  

void DisplayOverwriteOptionsDialog ( const FText& Message
)

 Pop up message to the user asking whether they wish to overwrite existing state or not. Factories/Factory.h  

virtual bool DoesSupportClass ( UClass* Class
)

   Factories/Factory.h  

virtual bool FactoryCanImport ( const FString& Filename
)

 Whether the specified file can be imported by this factory. Factories/Factory.h  

virtual UObject * FactoryCreateFile ( UClass* InClass,
UObject* InParent,
FName InName,
EObjectFlags Flags,
const FString& Filename,
const TCHAR* Parms,
FFeedbackContext* Warn,
bool& bOutOperationCanceled
)

 Create a new object by importing it from a file name. Factories/Factory.h  

virtual UObject * FactoryCreateNew ( UClass* InClass,
UObject* InParent,
FName InName,
EObjectFlags Flags,
UObject* Context,
FFeedbackContext* Warn
)

 Create a new object by class. Factories/Factory.h  

virtual UObject * FactoryCreateNew ( UClass* InClass,
UObject* InParent,
FName InName,
EObjectFlags Flags,
UObject* Context,
FFeedbackContext* Warn,
FName CallingContext
)

 Create a new object by class. Factories/Factory.h  
Returns an array of all the additional objects created during the last imports, as some factories may produce more than one object. Factories/Factory.h  

virtual FString GetDefaultNewAssetName()

 Returns a new starting point name for newly created assets in the content browser Factories/Factory.h  

virtual FText GetDisplayName()

 Returns the name of the factory for menus Factories/Factory.h  

virtual TArray< FString > GetFormats()

   Factories/Factory.h  

virtual IImportSettingsParser * GetImportSettingsParser()

   Factories/Factory.h  

virtual uint32 GetMenuCategories ()

 When shown in menus, this is the category containing this factory. Factories/Factory.h  

virtual const TArray< FText > & GetMenuCategorySubMenus()

 Branch of sub-menus containing factory under each provided category. Factories/Factory.h  
Returns an optional override brush name for the new asset menu. Factories/Factory.h  
Returns an optional override brush name for the new asset menu. Factories/Factory.h  

UClass * GetSupportedClass()

   Factories/Factory.h  

virtual void GetSupportedFileExtensions ( TArray< FString >& OutExtensions
) const

 Creates a list of file extensions supported by this factory Factories/Factory.h  

virtual EFactoryCreateWorkflow GetSupportedWorkflows()

   Factories/Factory.h  

virtual FText GetToolTip()

 Returns the tooltip text description of this factory Factories/Factory.h  

virtual FString GetToolTipDocumentationExcerpt()

 Returns the documentation excerpt that should be use for the rich tool tip for this factory Factories/Factory.h  

virtual FString GetToolTipDocumentationPage()

 Returns the documentation page that should be use for the rich tool tip for this factory Factories/Factory.h  

virtual UObject * ImportObject ( UClass* InClass,
UObject* InOuter,
FName InName,
EObjectFlags Flags,
const FString& Filename,
const TCHAR* Parms,
bool& OutCanceled
)

   Factories/Factory.h  

virtual bool ImportUntypedBulkDataFromText ( const TCHAR*& Buffer,
FBulkData& BulkData
)

   Factories/Factory.h  

virtual bool IsAutomatedImport()

   Factories/Factory.h  

virtual bool IsSupportedFileExtension ( FStringView InExtension
) const

 Returns true if the provided file extension is supported Factories/Factory.h  

void ResetState ()

 Resets the saved state of this factory. Factories/Factory.h  
Resolves SupportedClass for factories which support multiple classes. Factories/Factory.h  

bool ScriptFactoryCanImport ( const FString& Filename
)

 Whether the specified file can be imported by this factory. (Implemented in script) Factories/Factory.h
  • BlueprintImplementableEvent
  • Category="Miscellaneous"

bool ScriptFactoryCreateFile ( UAssetImportTask* InTask
)

 Import object(s) using a task via script Factories/Factory.h
  • BlueprintImplementableEvent
  • Category="Miscellaneous"

void SetAssetImportTask ( UAssetImportTask* Task
)

 Sets the import task being used with this factory Factories/Factory.h  

void SetAutomatedAssetImportData ( const UAutomatedAssetImportData* Data
)

 Sets the automated import data being used with this factory Factories/Factory.h  

virtual bool ShouldShowInNewMenu()

 Returns true if this factory should be shown in the New Asset menu (by default calls CanCreateNew). Factories/Factory.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual UObject * FactoryCreateBinary ( UClass* InClass,
UObject* InParent,
FName InName,
EObjectFlags Flags,
UObject* Context,
const TCHAR* Type,
const uint8*& Buffer,
const uint8* BufferEnd,
FFeedbackContext* Warn,
bool& bOutOperationCanceled
)

 Create a new object by importing it from a binary buffer (cancelable). Factories/Factory.h  

virtual UObject * FactoryCreateBinary ( UClass* InClass,
UObject* InParent,
FName InName,
EObjectFlags Flags,
UObject* Context,
const TCHAR* Type,
const uint8*& Buffer,
const uint8* BufferEnd,
FFeedbackContext* Warn
)

 Create a new object by importing it from a binary buffer. Factories/Factory.h  

virtual UObject * FactoryCreateText ( UClass* InClass,
UObject* InParent,
FName InName,
EObjectFlags Flags,
UObject* Context,
const TCHAR* Type,
const TCHAR*& Buffer,
const TCHAR* BufferEnd,
FFeedbackContext* Warn
)

 Create a new object by importing it from a text buffer. Factories/Factory.h  

virtual UObject * FactoryCreateText ( UClass* InClass,
UObject* InParent,
FName InName,
EObjectFlags Flags,
UObject* Context,
const TCHAR* Type,
const TCHAR*& Buffer,
const TCHAR* BufferEnd,
FFeedbackContext* Warn,
bool& bOutOperationCanceled
)

 Create a new object by importing it from a text buffer. Factories/Factory.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

   Factories/Factory.h  

static FString GetCurrentFilename()

 Get the name of the file currently being imported. Factories/Factory.h  

static int32 GetDefaultImportPriority()

 Get the default import priority for factories. Factories/Factory.h  

static FMD5Hash GetFileHash ()

 Get the Hash for the file being imported. Factories/Factory.h  

static bool SortFactoriesByPriority ( const UFactory& A,
const UFactory& B
)

 Helper function to sort an array of factories by their import priority - use as a predicate for Sort Factories/Factory.h  

static UObject * StaticImportObject ( UClass* Class,
UObject* InOuter,
FName Name,
EObjectFlags Flags,
const TCHAR* Filename,
UObject* Context,
UFactory* Factory,
const TCHAR* Parms,
FFeedbackContext* Warn,
int32 MaxImportFileSize
)

   Factories/Factory.h  

static UObject * StaticImportObject ( UClass* Class,
UObject* InOuter,
FName Name,
EObjectFlags Flags,
bool& bOutOperationCanceled,
const TCHAR* Filename,
UObject* Context,
UFactory* Factory,
const TCHAR* Parms,
FFeedbackContext* Warn,
int32 MaxImportFileSize
)

   Factories/Factory.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page