Choose your operating system:
Windows
macOS
Linux
|
Module |
|
|
Header |
/Engine/Source/Editor/UnrealEd/Classes/Factories/Factory.h |
|
Include |
#include "Factories/Factory.h" |
class UFactory : public UObject
Base class for all factories An object responsible for creating and importing new objects.
| Name | Description | ||
|---|---|---|---|
|
|
AdditionalImportedObjects |
||
|
|
TObjectPtr< cla... |
AssetImportTask |
Task for importing file via script interfaces |
|
|
TObjectPtr< con... |
AutomatedImportData |
Data for how to import files via the automated command line importing interface |
|
|
uint32: 1 |
bCreateNew |
The default value to return from CanCreateNew() |
|
|
uint32: 1 |
bEditAfterNew |
True if the associated editor should be opened after creating a new object. |
|
|
uint32: 1 |
bEditorImport |
True if the factory imports objects from files. |
|
|
uint32: 1 |
bText |
True if the factory imports objects from text. |
|
|
TSubclassOf< UO... |
ContextClass |
Class of the context object used to help create the object. |
|
|
Formats |
List of formats supported by the factory. |
|
|
|
ImportPriority |
Determines the order in which factories are tried when importing or reimporting an object. |
|
|
|
OverwriteYesOrNoToAllState |
For interactive object imports, this value indicates whether the user wants objects to be automatically overwritten (See EAppReturnType), or -1 if the user should be prompted. |
|
|
|
TSubclassOf< UO... |
SupportedClass |
The class manufactured by this factory. |
| Name | Description | |
|---|---|---|
|
|
UFactory ( |
| Name | Description | ||
|---|---|---|---|
|
|
AddReferencedObjects ( |
||
|
|
CanCreateNew() |
||
|
|
CanImportBeCanceled() |
Whether the factory is checking for SlowTask::ShouldCancel() while importing and aborting the import when appropriate. |
|
|
|
CleanUp() |
Do clean up after importing is done. Will be called once for multi batch import. |
|
|
|
ConfigureProperties() |
Opens a dialog to configure the factory properties. |
|
|
|
UObject *... |
CreateOrOverwriteAsset ( |
Creates an asset if it doesn't exist. |
|
|
DisplayOverwriteOptionsDialog ( |
Pop up message to the user asking whether they wish to overwrite existing state or not. |
|
|
|
DoesSupportClass ( |
||
|
|
FactoryCanImport ( |
Whether the specified file can be imported by this factory. |
|
|
|
UObject *... |
FactoryCreateBinary ( |
Create a new object by importing it from a binary buffer (cancelable). |
|
|
UObject *... |
FactoryCreateBinary ( |
Create a new object by importing it from a binary buffer. |
|
|
UObject *... |
FactoryCreateFile ( |
Create a new object by importing it from a file name. |
|
|
UObject *... |
FactoryCreateNew ( |
Create a new object by class. |
|
|
UObject *... |
FactoryCreateNew ( |
Create a new object by class. |
|
|
UObject *... |
FactoryCreateText ( |
Create a new object by importing it from a text buffer. |
|
|
UObject *... |
FactoryCreateText ( |
Create a new object by importing it from a text buffer. |
|
|
const TArray... |
GetAdditionalImportedObjects() |
Returns an array of all the additional objects created during the last imports, as some factories may produce more than one object. |
|
|
GetCurrentFilename() |
Get the name of the file currently being imported. |
|
|
|
GetDefaultImportPriority() |
Get the default import priority for factories. |
|
|
|
GetDefaultNewAssetName() |
Returns a new starting point name for newly created assets in the content browser |
|
|
|
GetDisplayName() |
Returns the name of the factory for menus |
|
|
|
GetFileHash() |
Get the Hash for the file being imported. |
|
|
|
IImportSetti... |
GetImportSettingsParser() |
|
|
|
GetMenuCategories() |
When shown in menus, this is the category containing this factory. |
|
|
|
const TArray... |
GetMenuCategorySubMenus() |
Branch of sub-menus containing factory under each provided category. |
|
|
GetNewAssetThumbnailOverride() |
Returns an optional override brush name for the new asset menu. |
|
|
|
UClass * |
GetSupportedClass() |
|
|
|
GetSupportedFileExtensions |
Creates a list of file extensions supported by this factory |
|
|
|
GetToolTip() |
Returns the tooltip text description of this factory |
|
|
|
GetToolTipDocumentationExcerpt() |
Returns the documentation excerpt that should be use for the rich tool tip for this factory |
|
|
|
GetToolTipDocumentationPage() |
Returns the documentation page that should be use for the rich tool tip for this factory |
|
|
|
UObject *... |
ImportObject |
|
|
|
ImportUntypedBulkDataFromText ( |
||
|
|
IsAutomatedImport() |
||
|
|
IsSupportedFileExtension ( |
Returns true if the provided file extension is supported |
|
|
|
ResetState() |
Resets the saved state of this factory. |
|
|
|
UClass * |
ResolveSupportedClass() |
Resolves SupportedClass for factories which support multiple classes. |
|
|
ScriptFactoryCanImport ( |
Whether the specified file can be imported by this factory. (Implemented in script) |
|
|
|
ScriptFactoryCreateFile ( |
Import object(s) using a task via script |
|
|
|
SetAssetImportTask ( |
Sets the import task being used with this factory |
|
|
|
SetAutomatedAssetImportData ( |
Sets the automated import data being used with this factory |
|
|
|
ShouldShowInNewMenu() |
Returns true if this factory should be shown in the New Asset menu (by default calls CanCreateNew). |
|
|
|
SortFactoriesByPriority |
Helper function to sort an array of factories by their import priority - use as a predicate for Sort |
|
|
|
UObject *... |
StaticImportObject |
|
|
|
UObject *... |
StaticImportObject ( |
|
Name |
Description |
|---|---|
|
CurrentFilename |
Name of the file currently being imported. |
|
DefaultImportPriority |
This is the import priority that all factories are given in the default constructor. |
|
FileHash |
This is the HASH for the file being imported |