unreal.ARFilter

class unreal.ARFilter(package_names: Array[Name] = [], package_paths: Array[Name] = [], soft_object_paths: Array[SoftObjectPath] = [], class_paths: Array[TopLevelAssetPath] = [], recursive_class_paths_exclusion_set: Set[TopLevelAssetPath] = [], class_names: Array[Name] = [], recursive_classes_exclusion_set: Set[Name] = [], recursive_paths: bool = False, recursive_classes: bool = False, include_only_on_disk_assets: bool = False)

Bases: StructBase

A struct to serve as a filter for Asset Registry queries. (mirrored in ARFilter.h)

C++ Source:

  • Module: CoreUObject

  • File: NoExportTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • class_names (Array[Name]): [Read-Write] Class Names: [DEPRECATED] - Class names are now represented by path names. Please use ClassPaths instead. deprecated: Short asset class names must be converted to full asset pathnames. Use ClassPaths instead.

  • class_paths (Array[TopLevelAssetPath]): [Read-Write] Class Paths: The filter component for class path names. Instances of the specified classes, but not subclasses (by default), will be included. Derived classes will be included only if bRecursiveClasses is true.

  • include_only_on_disk_assets (bool): [Read-Write] Include Only on Disk Assets: If true, only on-disk assets will be returned. Be warned that this is rarely what you want and should only be used for performance reasons

  • package_names (Array[Name]): [Read-Write] Package Names: The filter component for package names

  • package_paths (Array[Name]): [Read-Write] Package Paths: The filter component for package paths

  • recursive_class_paths_exclusion_set (Set[TopLevelAssetPath]): [Read-Write] Recursive Class Paths Exclusion Set: Only if bRecursiveClasses is true, the results will exclude classes (and subclasses) in this list

  • recursive_classes (bool): [Read-Write] Recursive Classes: If true, subclasses of ClassNames will also be included and RecursiveClassesExclusionSet will be excluded.

  • recursive_classes_exclusion_set (Set[Name]): [Read-Write] Recursive Classes Exclusion Set: [DEPRECATED] - Class names are now represented by path names. Please use RecursiveClassPathsExclusionSet instead. deprecated: Short asset class names must be converted to full asset pathnames. Use RecursiveClassPathsExclusionSet instead.

  • recursive_paths (bool): [Read-Write] Recursive Paths: If true, PackagePath components will be recursive

  • soft_object_paths (Array[SoftObjectPath]): [Read-Write] Soft Object Paths: The filter component containing specific object paths

property class_names: Array[Name]

[Read-Write] Class Names: [DEPRECATED] - Class names are now represented by path names. Please use ClassPaths instead. deprecated: Short asset class names must be converted to full asset pathnames. Use ClassPaths instead.

Type:

(Array[Name])

property class_paths: Array[TopLevelAssetPath]

[Read-Write] Class Paths: The filter component for class path names. Instances of the specified classes, but not subclasses (by default), will be included. Derived classes will be included only if bRecursiveClasses is true.

Type:

(Array[TopLevelAssetPath])

get_blueprint_assets() → Array[AssetData]

Gets asset data for all blueprint assets that match the filter. ClassPaths in the filter specify the blueprint’s parent class.

Returns:

out_asset_data (Array[AssetData]):

Return type:

Array[AssetData]

property include_only_on_disk_assets: bool

[Read-Write] Include Only on Disk Assets: If true, only on-disk assets will be returned. Be warned that this is rarely what you want and should only be used for performance reasons

Type:

(bool)

property package_names: Array[Name]

[Read-Write] Package Names: The filter component for package names

Type:

(Array[Name])

property package_paths: Array[Name]

[Read-Write] Package Paths: The filter component for package paths

Type:

(Array[Name])

property recursive_class_paths_exclusion_set: Set[TopLevelAssetPath]

[Read-Write] Recursive Class Paths Exclusion Set: Only if bRecursiveClasses is true, the results will exclude classes (and subclasses) in this list

Type:

(Set[TopLevelAssetPath])

property recursive_classes: bool

[Read-Write] Recursive Classes: If true, subclasses of ClassNames will also be included and RecursiveClassesExclusionSet will be excluded.

Type:

(bool)

property recursive_classes_exclusion_set: Set[Name]

[Read-Write] Recursive Classes Exclusion Set: [DEPRECATED] - Class names are now represented by path names. Please use RecursiveClassPathsExclusionSet instead. deprecated: Short asset class names must be converted to full asset pathnames. Use RecursiveClassPathsExclusionSet instead.

Type:

(Set[Name])

property recursive_paths: bool

[Read-Write] Recursive Paths: If true, PackagePath components will be recursive

Type:

(bool)

property soft_object_paths: Array[SoftObjectPath]

[Read-Write] Soft Object Paths: The filter component containing specific object paths

Type:

(Array[SoftObjectPath])