unreal.ARFilter

class unreal.ARFilter(package_names=[], package_paths=[], object_paths=[], class_names=[], recursive_classes_exclusion_set=[], recursive_paths=False, recursive_classes=False, include_only_on_disk_assets=False)

Bases: unreal.StructBase

A struct to serve as a filter for Asset Registry queries. Each component element is processed as an ‘OR’ operation while all the components are processed together as an ‘AND’ operation.

C++ Source:

  • Module: AssetRegistry
  • File: ARFilter.h

Editor Properties: (see get_editor_property/set_editor_property)

  • class_names (Array(Name)): [Read-Write] The filter component for class 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] 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
  • object_paths (Array(Name)): [Read-Write] The filter component containing specific object paths
  • package_names (Array(Name)): [Read-Write] The filter component for package names
  • package_paths (Array(Name)): [Read-Write] The filter component for package paths
  • recursive_classes (bool): [Read-Write] If true, subclasses of ClassNames will also be included and RecursiveClassesExclusionSet will be excluded.
  • recursive_classes_exclusion_set (Set(Name)): [Read-Write] Only if bRecursiveClasses is true, the results will exclude classes (and subclasses) in this list
  • recursive_paths (bool): [Read-Write] If true, PackagePath components will be recursive
class_names

(Array(Name)) – [Read-Write] The filter component for class 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] 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

object_paths

(Array(Name)) – [Read-Write] The filter component containing specific object paths

package_names

(Array(Name)) – [Read-Write] The filter component for package names

package_paths

(Array(Name)) – [Read-Write] The filter component for package paths

recursive_classes

(bool) – [Read-Write] If true, subclasses of ClassNames will also be included and RecursiveClassesExclusionSet will be excluded.

recursive_classes_exclusion_set

(Set(Name)) – [Read-Write] Only if bRecursiveClasses is true, the results will exclude classes (and subclasses) in this list

recursive_paths

(bool) – [Read-Write] If true, PackagePath components will be recursive