SceneSearch
Use this API to perform searches in the Scene. Engines for this type of search implement the ISceneSearchEngineV2 interface.
Read time 1 minuteLast updated 11 days ago
Definition
- Type: Class
- Namespace: UnityEditor.SearchService
- Assembly: UnityEditor.CoreModule
public static class SceneSearch
Remarks
Registered Scene search engines are called during searches in the Scene hierarchy. When the default object selector is used, they are also called for GameObject searches.
The following example creates a Scene search engine:
using System;using System.Collections.Generic;using System.Linq;using UnityEditor;using UnityEditor.SearchService;using UnityEngine;using Object = UnityEngine.Object;[SceneSearchEngine]class TestSceneFilterEngine : ISceneSearchEngineV2{ public string name => "My Custom Engine"; public void BeginSession(ISearchContext context) { } public void EndSession(ISearchContext context) { } public void BeginSearch(ISearchContext context, string query) { } public void EndSearch(ISearchContext context) { } public bool Filter(ISearchContext context, string query, HierarchyIterator objectToFilter) { var entityId = objectToFilter.entityId; var obj = Object.FindObjectsOfType<GameObject>().FirstOrDefault(o => o.GetEntityId() == entityId); return obj != null && obj.name.IndexOf(query, StringComparison.InvariantCultureIgnoreCase) >= 0; }}
Additional Resources: SceneSearchEngineAttribute, ISceneSearchEngine.
Static Fields
Value | Description |
|---|---|
| EngineScope | A enum that indicates the search scope for SceneSearch engines. It is used by SceneSearchContext. |
Static Methods
Method | Description |
|---|---|
| RegisterEngine | Registers a Scene search engine dynamically. |
| UnregisterEngine | Unregisters a dynamically registered engine. |