class in UnityEditor.SearchService
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.
CloseFor 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.
CloseThis attribute lets you register a custom advanced object selector validator.
An advanced object selector is an object selector that can be customized programatically to be opened on specific object fields, without modifying the object fields themselves. It also allows total control over the UI, so you can create your own search window if you wish to. There are two methods that need to be registered: the object selector handler and the validator. The handler opens the object selector, and the validator validates that the object selector can be opened for the current selection context. Here is an example using Search to open a custom object selector only for materials:
using System; using System.Linq; using UnityEditor.Search; using UnityEditor.SearchService; using UnityEngine; static class MaterialSelector { const string MaterialSelectorId = "material_selector"; static ISearchView s_SearchView; [AdvancedObjectSelectorValidator(MaterialSelectorId)] static bool HandleAdvancedObjectSelectorValidation(ObjectSelectorSearchContext context) { // This selector only works for assets. if ((context.visibleObjects & VisibleObjects.Assets) == 0) return false; // This selector only supports materials and their derived types. if (!OnlyMaterialTypes(context)) return false; return true; } [AdvancedObjectSelector(MaterialSelectorId, "Material Selector", 10)] static void HandleAdvancedObjectSelector(AdvancedObjectSelectorEventType eventType, in AdvancedObjectSelectorParameters parameters) { switch (eventType) { case AdvancedObjectSelectorEventType.BeginSession: BeginSession(parameters); break; case AdvancedObjectSelectorEventType.EndSession: EndSession(parameters); break; case AdvancedObjectSelectorEventType.SetSearchFilter: SetSearchFilter(parameters); break; case AdvancedObjectSelectorEventType.OpenAndSearch: OpenSelector(parameters); break; }; } static void BeginSession(in AdvancedObjectSelectorParameters parameters) { // Here you can cache some data if needed. } static void EndSession(in AdvancedObjectSelectorParameters parameters) { // Here you can clear the cached data if needed. // EndSession can be called in two ways: // 1. Naturally when the selectorClosedHandler is called upon closing the window (which you should do in your window if you don't use Search). // 2. Forcefully when a new session is started before the current one is finished. // In the second case, we need to close the window to avoid any issues since the ObjectSelector API does not support concurrent selectors. if ((parameters.context.endSessionModes & ObjectSelectorSearchEndSessionModes.CloseSelector) != 0) { s_SearchView?.Close(); } s_SearchView = null; } static void SetSearchFilter(in AdvancedObjectSelectorParameters parameters) { // Here you can handle the request to set a new search filter. s_SearchView?.SetSearchText(parameters.searchFilter); } static void OpenSelector(in AdvancedObjectSelectorParameters parameters) { var selectContext = parameters.context; var selectorCloseHandler = parameters.selectorClosedHandler; var trackingHandler = parameters.trackingHandler; // This selector handles any kind of materials, but if a specific material type is passed // in the context, then only this type of material will be shown. var searchText = string.Join(" or ", selectContext.requiredTypeNames.Select(typeName => $"t={typeName}")); var searchContext = SearchService.CreateContext("asset", searchText); var viewState = SearchViewState.CreatePickerState("Material", searchContext, selectHandler: (item, canceled) => selectorCloseHandler(item?.ToObject(), canceled), trackingHandler: (item) => trackingHandler(item?.ToObject()), null); viewState.windowTitle = new GUIContent("Material Selector"); viewState.position = SearchUtils.GetMainWindowCenteredPosition(new Vector2(600, 400)); s_SearchView = SearchService.ShowPicker(viewState); } static bool OnlyMaterialTypes(ObjectSelectorSearchContext context) { var requiredTypes = context.requiredTypes.Zip(context.requiredTypeNames, (type, name) => new Tuple<Type, string>(type, name)); return requiredTypes.All(typeAndName => { return typeAndName.Item1 != null && typeof(Material).IsAssignableFrom(typeAndName.Item1) || typeAndName.Item2.Contains("material", StringComparison.OrdinalIgnoreCase); }); } }
The signature of the method registered with the attribute AdvancedObjectSelectorAttribute must be the following:
static void HandleAdvancedObjectSelector(AdvancedObjectSelectorEventType eventType, in AdvancedObjectSelectorParameters parameters)
The signature of the method registered with the attribute AdvancedObjectSelectorValidatorAttribute must be the following:
static bool HandleAdvancedObjectSelectorValidation(ObjectSelectorSearchContext context)
Note: Those custom advanced object selectors are only active when the Object Selector Engine is set to "Advanced" (see Preferences/Search settings page).
AdvancedObjectSelectorValidatorAttribute | Registers a method to act as an advanced object selector validator. |
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.