unreal.PregenImportOptions

class unreal.PregenImportOptions(source_file_path: str = '', target_uid: str = '', permutation_layer_path: str = '', title: str = '', discovery_options: PregenDiscoveryOptions = Ellipsis, storage_options: PregenStorageOptions = Ellipsis, automated: bool = False, auto_save_packages: bool = False)

Bases: StructBase

Describes a single pregen import. Passed to FUSDPregenInterchangeModule::ImportFile and also exposed to Blueprint / Python via UUSDPregenBlueprintLibrary.

Forward-compatible with worker-driven imports that need to filter to a single target, apply permutation overlays, override plugins, etc.

C++ Source:

  • Plugin: USDPregen

  • Module: USDPregenInterchange

  • File: USDPregenInterchangeModule.h

Editor Properties: (see get_editor_property/set_editor_property)

  • auto_save_packages (bool): [Read-Write] When true, ImportFile calls Storage->PersistManifestPayload(…) for each target whose manifest was Stored, AND saves imported asset packages to disk after import completes

  • automated (bool): [Read-Write] When true, ImportFile runs the underlying Interchange import in automated mode (FImportAssetParameters::bIsAutomated = true), which suppresses the modal pipeline-options dialog and any other UI prompts.

  • discovery_options (PregenDiscoveryOptions): [Read-Write] Options for the discovery plugin, including the name of the plugin to use. Empty values fall back to defaults

  • permutation_layer_path (str): [Read-Write] Optional USD layer to sublayer onto the entry stage to apply permutation operations. Empty means no permutation layer.

  • source_file_path (str): [Read-Write] Required: USD file to import.

  • storage_options (PregenStorageOptions): [Read-Write] Options for the storage plugin, including the name of the plugin to use. Empty values fall back to defaults

  • target_uid (str): [Read-Write] Optional filter to import only a specific target. Empty means to import all discovered targets.

  • title (str): [Read-Write] Optional human-readable label for logs.

property auto_save_packages: bool

[Read-Write] When true, ImportFile calls Storage->PersistManifestPayload(…) for each target whose manifest was Stored, AND saves imported asset packages to disk after import completes

Type:

(bool)

property automated: bool

[Read-Write] When true, ImportFile runs the underlying Interchange import in automated mode (FImportAssetParameters::bIsAutomated = true), which suppresses the modal pipeline-options dialog and any other UI prompts.

Type:

(bool)

property discovery_options: PregenDiscoveryOptions

[Read-Write] Options for the discovery plugin, including the name of the plugin to use. Empty values fall back to defaults

Type:

(PregenDiscoveryOptions)

property permutation_layer_path: str

[Read-Write] Optional USD layer to sublayer onto the entry stage to apply permutation operations. Empty means no permutation layer.

Type:

(str)

property source_file_path: str

USD file to import.

Type:

(str)

Type:

[Read-Write] Required

property storage_options: PregenStorageOptions

[Read-Write] Options for the storage plugin, including the name of the plugin to use. Empty values fall back to defaults

Type:

(PregenStorageOptions)

property target_uid: str

[Read-Write] Optional filter to import only a specific target. Empty means to import all discovered targets.

Type:

(str)

property title: str

[Read-Write] Optional human-readable label for logs.

Type:

(str)