unreal.AssetManagerSearchRules

class unreal.AssetManagerSearchRules(asset_scan_paths=[], include_patterns=[], exclude_patterns=[], asset_base_class=None, has_blueprint_classes=False, force_synchronous_scan=False, skip_virtual_path_expansion=False, skip_manager_include_check=False)

Bases: unreal.StructBase

Rules for how to scan the asset registry for assets matching path and type descriptions

C++ Source:

  • Module: Engine

  • File: AssetManagerTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_base_class (type(Class)): [Read-Write] Asset Base Class: Assets must inherit from this class, for blueprints this should be the instance base class

  • asset_scan_paths (Array(str)): [Read-Write] Asset Scan Paths: List of top-level directories and specific assets to search, must be paths starting with /, directories should not have a trailing /

  • exclude_patterns (Array(str)): [Read-Write] Exclude Patterns: Optional list of exclude wildcard patterns that can use *, if any of these match it will be excluded

  • force_synchronous_scan (bool): [Read-Write] Force Synchronous Scan: True if this should force a synchronous scan of the disk even if an async scan is in progress

  • has_blueprint_classes (bool): [Read-Write] Has Blueprint Classes: True if scanning for blueprints, false for all other assets

  • include_patterns (Array(str)): [Read-Write] Include Patterns: Optional list of include wildcard patterns using * that will get matched against full package path. If there are any at least one of these must match

  • skip_manager_include_check (bool): [Read-Write] Skip Manager Include Check: True if this test should skip the ShouldIncludeInAssetSearch function on AssetManager

  • skip_virtual_path_expansion (bool): [Read-Write] Skip Virtual Path Expansion: True if AssetScanPaths are real paths that do not need expansion

property asset_base_class

[Read-Write] Asset Base Class: Assets must inherit from this class, for blueprints this should be the instance base class

Type

(type(Class))

property asset_scan_paths

[Read-Write] Asset Scan Paths: List of top-level directories and specific assets to search, must be paths starting with /, directories should not have a trailing /

Type

(Array(str))

property exclude_patterns

[Read-Write] Exclude Patterns: Optional list of exclude wildcard patterns that can use *, if any of these match it will be excluded

Type

(Array(str))

property force_synchronous_scan

[Read-Write] Force Synchronous Scan: True if this should force a synchronous scan of the disk even if an async scan is in progress

Type

(bool)

property has_blueprint_classes

[Read-Write] Has Blueprint Classes: True if scanning for blueprints, false for all other assets

Type

(bool)

property include_patterns

[Read-Write] Include Patterns: Optional list of include wildcard patterns using * that will get matched against full package path. If there are any at least one of these must match

Type

(Array(str))

property skip_manager_include_check

[Read-Write] Skip Manager Include Check: True if this test should skip the ShouldIncludeInAssetSearch function on AssetManager

Type

(bool)

property skip_virtual_path_expansion

[Read-Write] Skip Virtual Path Expansion: True if AssetScanPaths are real paths that do not need expansion

Type

(bool)