unreal.PregenStorageOptions

class unreal.PregenStorageOptions(storage_plugin_name: str = '', manifest_dir: str = '', package_sub_path_template: str = '')

Bases: StructBase

Pregen Storage Options

C++ Source:

  • Plugin: USDPregen

  • Module: USDPregenWrapper

  • File: USDPregenWrapper.h

Editor Properties: (see get_editor_property/set_editor_property)

  • manifest_dir (str): [Read-Write] Directory where manifest files should be written.

    Used by the built-in JsonStoragePlugin. UObject-backed plugins ignore this since their manifests are UAssets, not files on disk.

    Empty => plugin default (JsonStoragePlugin falls back to the USDPREGEN_DEFAULT_STORAGE_DIR environment variable, then to “<HOME>/UE_UsdPregen_Manifests”).

  • package_sub_path_template (str): [Read-Write] ${PLACEHOLDER} template used to build the package sub-path for generated UAssets. Recognized substitutions are documented on IStoragePlugin::ResolvePackageSubPathTemplate.

    Example: TEXT(“assets/${DEFINITION_NAME}/${PERMUTATION_ID}”) produces “assets/tree_02/2559017893”.

    Empty => plugin default (IStoragePlugin::DefaultPackageSubPathTemplate).

  • storage_plugin_name (str): [Read-Write] Name of the storage plugin to use. An empty string will use the built-in JSON plugin (“json_storage”).

property manifest_dir: str

[Read-Write] Directory where manifest files should be written.

Used by the built-in JsonStoragePlugin. UObject-backed plugins ignore this since their manifests are UAssets, not files on disk.

Empty => plugin default (JsonStoragePlugin falls back to the USDPREGEN_DEFAULT_STORAGE_DIR environment variable, then to “<HOME>/UE_UsdPregen_Manifests”).

Type:

(str)

property package_sub_path_template: str

[Read-Write] ${PLACEHOLDER} template used to build the package sub-path for generated UAssets. Recognized substitutions are documented on IStoragePlugin::ResolvePackageSubPathTemplate.

Example: TEXT(“assets/${DEFINITION_NAME}/${PERMUTATION_ID}”) produces “assets/tree_02/2559017893”.

Empty => plugin default (IStoragePlugin::DefaultPackageSubPathTemplate).

Type:

(str)

property storage_plugin_name: str

[Read-Write] Name of the storage plugin to use. An empty string will use the built-in JSON plugin (“json_storage”).

Type:

(str)