Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

AddWord

Adds a new word coming from a document to the index. The word is added with multiple variations allowing partial search.
Read time 4 minutesLast updated 12 days ago

Definition

AddWord(string, int, int)

Adds a new word coming from a document to the index. The word is added with multiple variations allowing partial search.
public void AddWord(string word, int score, int documentIndex)

Parameters

word

string
Word to add to the index.

score

int
Relevance score of the word.

documentIndex

int
Document where the indexed word was found.

Examples

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("SearchIndexerExample", FileUtil.GetUniqueTempPathInProject());        // 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;        // These calls will index the words "awesome", "unity" and "thisisitasuperlongword". These words will be searchable by prefixes or exact matches.        searchIndexer.AddWord("awesome", baseScore, di);        searchIndexer.AddWord("unity", baseScore, di);        searchIndexer.AddWord("thisisitasuperlongword", 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})");            // Dispose of the SearchIndexer when you are done with it.            searchIndexer.Dispose();        });    }}

AddWord(string, int, int, int)

Adds a new word coming from a document to the index. The word is added with multiple variations allowing partial search.
Warning
Deprecated. AddWord with variations is no longer supported. Variations are handled automatically internally. Please use AddWord(string word, int score, int documentIndex)
public void AddWord(string word, int size, int score, int documentIndex)

Parameters

word

string
Word to add to the index.

size

int
Number of variations to compute.

score

int
Relevance score of the word.

documentIndex

int
Document where the indexed word was found.

Examples

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("SearchIndexerExample", FileUtil.GetUniqueTempPathInProject());        // 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;        // These calls will index the words "awesome", "unity" and "thisisitasuperlongword". These words will be searchable by prefixes or exact matches.        searchIndexer.AddWord("awesome", baseScore, di);        searchIndexer.AddWord("unity", baseScore, di);        searchIndexer.AddWord("thisisitasuperlongword", 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})");            // Dispose of the SearchIndexer when you are done with it.            searchIndexer.Dispose();        });    }}

AddWord(string, int, int, int, int)

Adds a new word coming from a document to the index. The word is added with multiple variations allowing partial search.
Warning
Deprecated. AddWord with variations is no longer supported. Variations are handled automatically internally. Please use AddWord(string word, int score, int documentIndex)
public void AddWord(string word, int minVariations, int maxVariations, int score, int documentIndex)

Parameters

word

string
Word to add to the index.

minVariations

int
Minimum number of variations to compute. Cannot be higher than the length of the word.

maxVariations

int
Maximum number of variations to compute. Cannot be higher than the length of the word.

score

int
Relevance score of the word.

documentIndex

int
Document where the indexed word was found.

Examples

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("SearchIndexerExample", FileUtil.GetUniqueTempPathInProject());        // 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;        // These calls will index the words "awesome", "unity" and "thisisitasuperlongword". These words will be searchable by prefixes or exact matches.        searchIndexer.AddWord("awesome", baseScore, di);        searchIndexer.AddWord("unity", baseScore, di);        searchIndexer.AddWord("thisisitasuperlongword", 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})");            // Dispose of the SearchIndexer when you are done with it.            searchIndexer.Dispose();        });    }}