unreal.Factory

class unreal.Factory(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

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

C++ Source:

  • Module: UnrealEd

  • File: Factory.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_import_task (AssetImportTask): [Read-Write] Task for importing file via script interfaces

  • automated_import_data (AutomatedAssetImportData): [Read-Write] Data for how to import files via the automated command line importing interface

  • context_class (type(Class)): [Read-Write] Class of the context object used to help create the object.

  • create_new (bool): [Read-Write] The default value to return from CanCreateNew()

  • edit_after_new (bool): [Read-Write] true if the associated editor should be opened after creating a new object.

  • editor_import (bool): [Read-Write] true if the factory imports objects from files.

  • formats (Array[str]): [Read-Write] List of formats supported by the factory. Each entry is of the form “ext;Description” where ext is the file extension.

  • supported_class (type(Class)): [Read-Write] The class manufactured by this factory.

  • text (bool): [Read-Write] true if the factory imports objects from text.

property asset_import_task: AssetImportTask

[Read-Write] Task for importing file via script interfaces

Type:

(AssetImportTask)

property automated_import_data: AutomatedAssetImportData

[Read-Write] Data for how to import files via the automated command line importing interface

Type:

(AutomatedAssetImportData)

property context_class: Class

[Read-Write] Class of the context object used to help create the object.

Type:

(type(Class))

property create_new: bool

[Read-Write] The default value to return from CanCreateNew()

Type:

(bool)

property edit_after_new: bool

[Read-Write] true if the associated editor should be opened after creating a new object.

Type:

(bool)

property editor_import: bool

[Read-Write] true if the factory imports objects from files.

Type:

(bool)

property formats: None

[Read-Write] List of formats supported by the factory. Each entry is of the form “ext;Description” where ext is the file extension.

Type:

(Array[str])

script_factory_can_import(filename) bool

Whether the specified file can be imported by this factory. (Implemented in script)

Parameters:

filename (str) –

Returns:

true if the file is supported, false otherwise.

Return type:

bool

script_factory_create_file(task) bool

Import object(s) using a task via script

Parameters:

task (AssetImportTask) –

Returns:

True if script implements

Return type:

bool

property supported_class: Class

[Read-Write] The class manufactured by this factory.

Type:

(type(Class))

property text: bool

[Read-Write] true if the factory imports objects from text.

Type:

(bool)