unreal.PregenDiscoveryOptions

class unreal.PregenDiscoveryOptions(discovery_mode: PregenDiscoveryMode = Ellipsis, discovery_plugin_name: str = '', definition_prefix: str = '', initial_path: str = '', purposes: None = [], exclude_variant_sets: None = [], asset_identifier_fallback: PregenIdentifierFallbackMode = Ellipsis, asset_version_fallback: PregenVersionFallbackMode = Ellipsis)

Bases: StructBase

Pregen Discovery Options

C++ Source:

  • Plugin: USDPregen

  • Module: USDPregenWrapper

  • File: USDPregenWrapper.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_identifier_fallback (PregenIdentifierFallbackMode): [Read-Write] Strategy used when an asset has no authored identifier.

  • asset_version_fallback (PregenVersionFallbackMode): [Read-Write] Strategy used when an asset has no authored version.

  • definition_prefix (str): [Read-Write] Prefix prepended to every discovered asset definition’s name.

  • discovery_mode (PregenDiscoveryMode): [Read-Write] Permutation discovery mode (all variants vs. composed-only).

  • discovery_plugin_name (str): [Read-Write] Name of the discovery plugin to use. Empty resolves to the built-in default discovery plugin.

  • exclude_variant_sets (Array[str]): [Read-Write] Variant set names to exclude from permutation enumeration. Use “*” to exclude all variant sets.

  • initial_path (str): [Read-Write] SdfPath string identifying the prim subtree to limit discovery to. Empty means “use the discovery plugin’s chosen initial path” (typically the stage’s default prim).

    Stored as FString for USTRUCT/UPROPERTY compatibility; converted to pxr::SdfPath at the wrapper -> native boundary.

  • purposes (Array[str]): [Read-Write] UsdGeomImageable purposes to include during discovery. Empty means “include all purposes”.

property asset_identifier_fallback: PregenIdentifierFallbackMode

[Read-Write] Strategy used when an asset has no authored identifier.

Type:

(PregenIdentifierFallbackMode)

property asset_version_fallback: PregenVersionFallbackMode

[Read-Write] Strategy used when an asset has no authored version.

Type:

(PregenVersionFallbackMode)

property definition_prefix: str

[Read-Write] Prefix prepended to every discovered asset definition’s name.

Type:

(str)

property discovery_mode: PregenDiscoveryMode

[Read-Write] Permutation discovery mode (all variants vs. composed-only).

Type:

(PregenDiscoveryMode)

property discovery_plugin_name: str

[Read-Write] Name of the discovery plugin to use. Empty resolves to the built-in default discovery plugin.

Type:

(str)

property exclude_variant_sets: None

[Read-Write] Variant set names to exclude from permutation enumeration. Use “*” to exclude all variant sets.

Type:

(Array[str])

property initial_path: str

[Read-Write] SdfPath string identifying the prim subtree to limit discovery to. Empty means “use the discovery plugin’s chosen initial path” (typically the stage’s default prim).

Stored as FString for USTRUCT/UPROPERTY compatibility; converted to pxr::SdfPath at the wrapper -> native boundary.

Type:

(str)

property purposes: None

[Read-Write] UsdGeomImageable purposes to include during discovery. Empty means “include all purposes”.

Type:

(Array[str])