ProjectSearch
class in
UnityEditor.SearchService
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
Description
Use this API to perform searches in the Project. Engines for this type of search implement the IProjectSearchEngine interface.
Registered Project search engines are called during searches in the Project browser. When the default object selector is used, they are also called for Asset searches.
The following example creates a Project search engine:
using System;
using System.Collections.Generic;
using System.Linq;
using UnityEditor;
using UnityEditor.SearchService;
using UnityEngine;
using Object = UnityEngine.Object;
[ProjectSearchEngine]
class TestProjectSearchEngine : IProjectSearchEngine
{
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 IEnumerable<string> Search(ISearchContext context, string query, Action<IEnumerable<string>> asyncItemsReceived)
{
var allPaths = AssetDatabase.GetAllAssetPaths();
var filteredPaths = allPaths.Where(path => !path.StartsWith("Library")).Where(path => path.IndexOf(query, StringComparison.InvariantCultureIgnoreCase) >= 0).ToList();
return filteredPaths;
}
}
Static Properties
| Property |
Description |
| EngineScope | A enum that indicates the search scope for ProjectSearch engines. It is used by ProjectSearchContext. |