word | Word to add to the index. |
score | Relevance score of the word. |
documentIndex | Document where the indexed word was found. |
size | Number of variations to compute. |
minVariations | Minimum number of variations to compute. Cannot be higher than the length of the word. |
maxVariations | Maximum number of variations to compute. Cannot be higher than the length of the word. |
Adds a new word coming from a document to the index. The word is added with multiple variations allowing partial search.
using UnityEditor; using UnityEditor.Search; using UnityEngine; static class Example_SearchIndexer_AddWord { [MenuItem("Examples/SearchIndexer/AddWord")] public static void Run() { // Create a search indexer var searchIndexer = new SearchIndexer("SearchIndexerAddWordExample"); // Indicate that Search is about to index documents. searchIndexer.Start(); // Add a document var di = searchIndexer.AddDocument("My/File/Path"); // Index some words var baseScore = 42; // This will index all variation of the word awesome, i.e. aw, awe, awes, aweso, awesom and awesome searchIndexer.AddWord("awesome", baseScore, di); // This will index an exact match for "unity", so no variation. searchIndexer.AddWord("unity", "unity".Length, baseScore, di); // This will only index variations for the word from character indexes 3 to 6, e.g. thi, this, thisi and thisis searchIndexer.AddWord("thisisitasuperlongword", 3, 6, baseScore, di); // Indicate that searchIndexer is finished indexing a document and is ready to search. searchIndexer.Finish(() => { // Search the index foreach (var result in searchIndexer.Search("unity awes this")) Debug.Log($"Found document [{result.index}] {result.id} ({result.score})"); }); } }
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.