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.
ClosegetSearchDataCallback | Callback used to get the data to be matched against the search words. Takes an object of type TData and returns an IEnumerable of strings. |
stringComparison | String comparison options. |
Sets the callback used to fetch the data that is matched against the search words.
This function lets you register a callback that will be called on each element of the data set you are trying to filter, in order to retrieve the search data that will be compared against search words (for example, words that are not filters). Here is an example:
// Set up what data from objects of type MyObjectType will be matched against search words queryEngine.SetSearchDataCallback(myObj => new[] { myObj.id.ToString(), myObj.name });
For a more complete example on how to use this function, see QueryEngine.
getSearchDataCallback | Callback used to get the data to be matched against the search words. Takes an object of type TData and returns an IEnumerable of strings. |
searchWordTransformerCallback | Callback used to transform a search word during the query parsing. Useful when doing lowercase or uppercase comparison. Can return null or an empty string to remove the word from the query. |
stringComparison | String comparison options. |
Sets the callback used to fetch the data that is matched against the search words.
This function lets you register a callback that will be called on each element of the data set you are trying to filter, in order to retrieve the search data that will be compared against search words (for example, words that are not filters). Also, it gives you tha ability to apply a transformation on the search words themselves to prepare the comparison. This transformation is only done once when the query is parsed.
using System; using System.Collections.Generic; using System.Linq; using UnityEditor; using UnityEditor.Search; using UnityEngine; static class Example_QueryEngine_SetSearchDataCallback { static List<MyObjectType> s_Data; [MenuItem("Examples/QueryEngine/SetSearchDataCallback")] public static void RunExample() { // Set up the query engine var queryEngine = new QueryEngine<MyObjectType>(); // Set the search data callback with a word transformer. // The word transformer will make sure that the words used for comparison are already converted to lowercase, // which will increase performance by doing comparisons with Ordinal instead of OrdinalIgnoreCase queryEngine.SetSearchDataCallback(myObj => new[] { myObj.id.ToString(), myObj.name }, word => word.ToLowerInvariant(), StringComparison.Ordinal); s_Data = new List<MyObjectType>() { new MyObjectType { id = 0, name = "Test 1", position = new Vector2(0, 0), active = false }, new MyObjectType { id = 1, name = "Test 2", position = new Vector2(0, 1), active = true }, new MyObjectType { id = 2, name = "Test 3", position = new Vector2(1, 0), active = false }, new MyObjectType { id = 3, name = "Test 4", position = new Vector2(1.2f, 0), active = false }, }; // Find all items that contain "test" in the search data var query = queryEngine.ParseQuery("Test"); var filteredData = query.Apply(s_Data).ToList(); Debug.Assert(filteredData.Count == 4, $"There should be 4 items in the filtered list but found {filteredData.Count} items."); Debug.Assert(filteredData.Contains(s_Data[0]), "Test 1 should be in the list as its name contains \"test\"."); Debug.Assert(filteredData.Contains(s_Data[1]), "Test 2 should be in the list as its name contains \"test\"."); Debug.Assert(filteredData.Contains(s_Data[2]), "Test 3 should be in the list as its name contains \"test\"."); Debug.Assert(filteredData.Contains(s_Data[3]), "Test 4 should be in the list as its name contains \"test\"."); // Find all items that have exactly "test 4" in the search data. query = queryEngine.ParseQuery("!\"Test 4\""); filteredData = query.Apply(s_Data).ToList(); Debug.Assert(filteredData.Count == 1, $"There should be 1 item in the filtered list but found {filteredData.Count} items."); Debug.Assert(filteredData.Contains(s_Data[3]), "Test 4 should be in the list as its name is exactly \"test 4\"."); } class MyObjectType { public int id { get; set; } string m_Name = string.Empty; public string name { get => m_Name; set => m_Name = value.ToLowerInvariant(); } public Vector2 position { get; set; } = Vector2.zero; public bool active { get; set; } public override string ToString() { return $"({id}, {name}, ({position.x}, {position.y}), {active})"; } } }
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.