Version: 2021.1
  • C#


class in UnityEditor.SearchService

Suggest a change


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.


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.




Use this API to perform searches in the Scene. Engines for this type of search implement the ISceneSearchEngine interface.

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 : ISceneSearchEngine { 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, HierarchyProperty objectToFilter) { var instanceId = objectToFilter.instanceID; var obj = Object.FindObjectsOfType<GameObject>().FirstOrDefault(o => o.GetInstanceID() == instanceId); return obj != null &&, StringComparison.InvariantCultureIgnoreCase) >= 0; } }

Static Properties

EngineScopeA enum that indicates the search scope for SceneSearch engines. It is used by SceneSearchContext.

Static Methods

RegisterEngineRegisters a Scene search engine dynamically.
UnregisterEngineUnregisters a dynamically registered engine.