Version: 2023.2
LanguageEnglish
  • C#

HierarchySearchQueryDescriptor

class in Unity.Hierarchy

/

Implemented in:UnityEngine.HierarchyCoreModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Encapsulates all the query filters and text values that are used to filter a hierarchy.

Static Properties

Empty The default empty query.
InvalidQuery The default invalid query.

Properties

Filters User-defined filters. Filters are in this form [filterName][operator][filterValue]. For example: t:Light. Each of these filters can be used by a NodeHandler to filter according to domain-specific characteristics.
Invalid Whether the query invalid. An invalid query yields no node.
IsEmpty Whether the query is empty.
IsSystemOnlyQuery Whether the query uses system filters. This means NodeHandlers won't be called for filtering.
IsValid Whether the query is valid.
Strict Whether the query is evaluated strictly. This means that if any filters are invalid, then the whole query is invalid.
SystemFilters The filters used by the hierarchy. Filters are in this form: [filterName][operator][filterValue]. For example: nodetype:gameobject. These filters are global to all NodeHandlers.
TextValues All textual values. For example: "cube"

Constructors

HierarchySearchQueryDescriptor The constructor for a query.