The SearchProvider class executes searches for specific types of items, and manages thumbnails, descriptions, and sub-filters.
It has the following basic API:
public class SearchProvider { public SearchProvider(string id, string displayName = null); // Creates an Item bound to this provider. public SearchItem CreateItem(string id, string label = null, string description = null, Texture2D thumbnail = null); // Utility functions to check whether the search text matches a string. public static bool MatchSearchGroups(string searchContext, string content); public static bool MatchSearchGroups(string searchContext, string content, out int startIndex, out int endIndex); // The provider's unique ID. public NameId name; // Text token to "filter" a provider (for example, "me:", "p:", and "s:"). public string filterId; // This provider is only active when a search explicitly specifies it with // its filterId. public bool isExplicitProvider; // Handler to fetch and format the label of a search item. public FetchStringHandler fetchLabel; // Handler to provide an async description for an item. Called just before // Search displays the item. // Allows a plug-in provider to fetch long descriptions only when // Search needs them. public FetchStringHandler fetchDescription; // Handler to provider an async thumbnail for an item. Called just before // Search displays the item. // Allows a plug-in provider to fetch/generate previews only when // Search needs them. public PreviewHandler fetchThumbnail; // Handler to support drag interactions. It is up to the SearchProvider // to properly set up the DragAndDrop manager. public StartDragHandler startDrag; // Called when the selection changes and Search can track it. public TrackSelectionHandler trackSelection; // MANDATORY: Handler to get items for a search context. public GetItemsHandler fetchItems; // A Search Provider can return a list of words that help the user complete // their search query. public GetKeywordsHandler fetchKeywords; // List of sub-filters that are visible in the FilterWindow for a // SearchProvider (see AssetProvider for an example). public List<NameId> subCategories; // Called when the Search window opens. Allows the Provider to perform // some caching. public Action onEnable; // Called when the Search window closes. Allows the Provider to release // cached resources. public Action onDisable; // Int to sort the Provider. Affects the order of search results and the // order in which providers are shown in the FilterWindow. public int priority; // Called when Search opens in "contextual mode". If you return true // it means the provider is enabled for this search context. public IsEnabledForContextualSearch isEnabledForContextualSearch; }
When you launch the Search window, it calls onEnable
, which you can use to cache resources.
When you close the Search window, it calls onDisable
, which you can use to release resources.
Because the Search item list uses a virtual scrolling algorithm, some SearchItem
fields (for example, label
, thumbnail
, and description
) are fetched on demand, if they are not already provided.
To populate those fields after the items are created, you need to initialize the SearchProvider
with specific handlers (fetchLabel
, fetchDescription
, fetchThumbnail
).
You can register a callback on trackSelection
to have Search do something whenever you select an item in the search results using the mouse or the keyboard. For example, the AssetAny media or data that can be used in your game or project. An asset may come from a file created outside of Unity, such as a 3D Model, an audio file or an image. You can also create some asset types in Unity, such as an Animator Controller, an Audio Mixer or a Render Texture. More info
See in Glossary and SceneA Scene contains the environments and menus of your game. Think of each unique Scene file as a unique level. In each Scene, you place your environments, obstacles, and decorations, essentially designing and building your game in pieces. More info
See in Glossary providers use the trackSelection
callback to ping the selected item in Search.
Some Search Providers return items that you can drag and drop into the Scene. If you are creating a custom provider whose items support drag and drop, implement startDrag
.
For example, the Asset and Scene providers populate the DragAndDrop
structure with the relevant item UIDs to allow proper drag and drop interactions.
When you open the Search window with the Alt Shift + C shortcut, it starts a contextual search, meaning Search searches the window that has focus.
When you launch a contextual search, providers that override isEnabledForContextualSearch
check to see if they should be enabled, as in the following example:
// Taken from Scene hierarchy provider: // Makes the provider part of the contextual search if the Scene view or the // Hierarchy window has focus. isEnabledForContextualSearch = () => QuickSearchTool.IsFocusedWindowTypeName("SceneView") || QuickSearchTool.IsFocusedWindowTypeName("SceneHierarchyWindow");
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.