Unity - Scripting API: Search.ObjectIndexer.IndexWord
Success!
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.
Submission failed
For 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.
Declaration
public void IndexWord(int documentIndex, ref string word, bool exact, int scoreModifier);
Parameters
| Parameter | Description |
|---|---|
| documentIndex | Document where the indexed word was found. |
| word | Word to add to the index. |
| exact | If true, we will also store an exact match entry for this word. |
| scoreModifier | Modified to apply to the base match score for a specific word. |
Description
Adds a new word coming from a specific document to the index. The word will be added with multiple variations allowing partial search.
The following example indexes a word that can be used to search indexed prefabs with myawesomeword, myawe, etc.
Declaration
public void IndexWord(int documentIndex, ref string word, int maxVariations, bool exact, int scoreModifier);
Parameters
| Parameter | Description |
|---|---|
| documentIndex | Document where the indexed word was found. |
| word | Word to add to the index. |
| maxVariations | Maximum number of variations to compute. Cannot be higher than the length of the word. |
| exact | If true, the indexer will also store an exact match entry for this word. |
| scoreModifier | Modified to apply to the base match score for a specific word. |
Description
The word will be added with a maximum of variation. This can be used to save some space for very large words.