Version: 2023.1
LanguageEnglish
  • C#

ObjectIndexer.IndexNumber

Suggest a change

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.

Close

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.

Close

Cancel

Declaration

public void IndexNumber(int documentIndex, string name, double number);

Parameters

documentIndex Document where the indexed value was found.
name Key used to retrieve the value.
number Number value to store in the index.

Description

Adds a key-number value pair to the index. The key won't be added with variations.

The following example uses IndexNumber to index a number testsize property that can be searched using common number operators such as >=, i.e. testsize>=4.2.

[CustomObjectIndexer(typeof(Collider), version = 3)]
static void IndexObjectSize(CustomObjectIndexerTarget target, ObjectIndexer indexer)
{
    var collider = target.target as Collider;
    if (collider == null)
        return;

    var boundingBoxSize = collider.bounds.size;
    var totalSize = boundingBoxSize.x * boundingBoxSize.y;
    indexer.IndexNumber(target.documentIndex, "testsize", totalSize);
}