unreal.InterchangeFactoryBase

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

Bases: Object

Asset factory implementation:

The first three steps use the Interchange factory node to import or reimport the UObject:

  1. BeginImportAsset_GameThread - Create the asset UObject. You can also import source data (retrieve payloads) and set up properties on the game thread.

  2. ImportAsset_Async - Import source data (retrieve payloads) and set up properties asynchronously on any thread.

  3. EndImportAsset_GameThread - Anything you need to do on the game thread to finalize the import source data and set up properties. For example, conflict resolution that needs UI.

The last three steps can modify the created UObject

  1. SetupObject_GameThread - Do any UObject setup required before the build, the UObject dependencies should exist and have all the source data and properties imported.

  2. BuildObject_GameThread - Build the asset if it can be built.

  3. FinalizeObject_GameThread - Do any final UObject setup after the build. Note that the build of an asset can be asynchronous and this function will be call after the async build is done.

Scene factory implementation:

  1. ImportSceneObject_GameThread - Create an actor in a level.

C++ Source:

  • Module: InterchangeCore

  • File: InterchangeFactoryBase.h

get_factory_asset_type() → InterchangeFactoryAssetType

Return the asset type this factory can create.

Return type:

InterchangeFactoryAssetType

get_factory_class()

Return the UClass this factory can create.

Return type:

type(Class)

get_source_filenames(object) → Array[str] or None

Fills the OutSourceFilenames array with the list of source files contained in the asset source data. Returns true if the operation was successful.

Parameters:

object (Object)

Returns:

out_source_filenames (Array[str]):

Return type:

Array[str] or None

set_source_filename(object, source_filename, source_index) → bool

Sets the object’s source at the specified index to the given SourceFileName.

Parameters:

  • object (Object)

  • source_filename (str)

  • source_index (int32)

Return type:

bool