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.
CloseAdditional information specific to the filter.
You can add and remove any additional information on a filter at any given time. This information is not used by the QueryEngine and does not affect the filtering in any way. Use to provide a way to store pertinent information related to a filter that you can fetch at a later time.
using System.Collections.Generic; using System.Linq; using UnityEditor; using UnityEditor.Search; using UnityEngine; static class Example_IQueryEngineFilter_AddMetaInfo { static List<MyObjectType> s_Data; static QueryEngine<MyObjectType> SetupQueryEngine() { // Set up the query engine var queryEngine = new QueryEngine<MyObjectType>(); // Add a filter for MyObjectType.id that supports all operators queryEngine.AddFilter("id", myObj => myObj.id); // Add a description to the filter var descriptionKey = "desc"; var descriptionValue = "This filters the objects based on their id."; var exampleKey = "example"; var exampleValue = "id>10 or id=2"; queryEngine.TryGetFilter("id", out var filter); filter.AddOrUpdateMetaInfo(descriptionKey, descriptionValue) .AddOrUpdateMetaInfo(exampleKey, exampleValue); return queryEngine; } [MenuItem("Examples/IQueryEngineFilter/AddMetaInfo")] public static void RunExample() { var queryEngine = SetupQueryEngine(); var descriptionKey = "desc"; var allFilters = queryEngine.GetAllFilters(); var filtersWithDescription = allFilters.Where(f => f.metaInfo.ContainsKey(descriptionKey)); queryEngine.TryGetFilter("id", out var filter); Debug.Assert(filter != null, "Filter \"id\" should not be null."); Debug.Assert(filtersWithDescription.Contains(filter), "Filter \"id\" should have a description."); // For the sake of the documentation, redefine a new description key. var descriptionMetaInfoKey = "desc"; filter.RemoveMetaInfo(descriptionMetaInfoKey); filtersWithDescription = allFilters.Where(f => f.metaInfo.ContainsKey(descriptionMetaInfoKey)); Debug.Assert(!filtersWithDescription.Contains(filter), "Filter \"id\" should not have a description."); filter.ClearMetaInfo(); var filtersWithMetaInfo = queryEngine.GetAllFilters().Where(f => f.metaInfo.Count > 0); Debug.Assert(!filtersWithMetaInfo.Contains(filter), "Filter \"id\" should not have any meta info."); } /// <summary> /// Custom type. This is the type of objects that will be searched by the QueryEngine. /// </summary> class MyObjectType { public int id { get; set; } public string name { get; set; } public Vector2 position { get; set; } public bool active { get; set; } public MyObjectType() { id = 0; name = ""; position = Vector2.zero; active = false; } 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.