Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

FuzzySearchMatch

Experimental: This class may be changed or removed in future versions.

Inherits: RefCounted < Object

Result returned by FuzzySearch containing match information.

Properties

int

original_index

-1

int

score

0

String

target

""

Methods

Array[Vector2i]

get_matched_substrings() const

Property Descriptions

int original_index = -1 🔗

  • void set_original_index(value: int)

  • int get_original_index()

The original index of target in the provided array of targets when using FuzzySearch.search_all() otherwise -1.

int score = 0 🔗

  • void set_score(value: int)

  • int get_score()

Match score determined by FuzzySearch. Scores are not normalized and generally should not be directly compared between different queries.

String target = "" 🔗

Target string which was matched against.

Method Descriptions

Array[Vector2i] get_matched_substrings() const 🔗

Returns each matched substring interval of target. The Vector2i.x component is the start of the interval and the Vector2i.y component is the length, corresponding to the arguments for String.substr().

User-contributed notes

Please read the User-contributed notes policy before submitting a comment.