unreal.AssetManagerSearchRules
¶
- class unreal.AssetManagerSearchRules(asset_scan_paths: None = [], include_patterns: None = [], exclude_patterns: None = [], asset_base_class: Class = Ellipsis, has_blueprint_classes: bool = False, force_synchronous_scan: bool = False, skip_virtual_path_expansion: bool = False, skip_manager_include_check: bool = False)¶
Bases:
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] Assets must inherit from this class, for blueprints this should be the instance base classasset_scan_paths
(Array[str]): [Read-Write] 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] Optional list of exclude wildcard patterns that can use *, if any of these match it will be excludedforce_synchronous_scan
(bool): [Read-Write] True if this should force a synchronous scan of the disk even if an async scan is in progresshas_blueprint_classes
(bool): [Read-Write] True if scanning for blueprints, false for all other assetsinclude_patterns
(Array[str]): [Read-Write] 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 matchskip_manager_include_check
(bool): [Read-Write] True if this test should skip the ShouldIncludeInAssetSearch function on AssetManagerskip_virtual_path_expansion
(bool): [Read-Write] True if AssetScanPaths are real paths that do not need expansion
- property asset_base_class: Class¶
[Read-Write] Assets must inherit from this class, for blueprints this should be the instance base class
- property asset_scan_paths: None¶
[Read-Write] List of top-level directories and specific assets to search, must be paths starting with /, directories should not have a trailing /
- property exclude_patterns: None¶
[Read-Write] Optional list of exclude wildcard patterns that can use *, if any of these match it will be excluded
- property force_synchronous_scan: bool¶
[Read-Write] 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: bool¶
[Read-Write] True if scanning for blueprints, false for all other assets
- Type:
(bool)
- property include_patterns: None¶
[Read-Write] 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