RegExMatch

Inherits: Reference < Object

Contains the results of a RegEx search.

Description

Contains the results of a single RegEx match returned by RegEx.search and RegEx.search_all. It can be used to find the position and range of the match and its capturing groups, and it can extract its substring for you.

Methods

intget_end ( Variant name=0 ) const
intget_group_count ( ) const
intget_start ( Variant name=0 ) const
Stringget_string ( Variant name=0 ) const

Property Descriptions

Default{}
Getterget_names()

A dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one.


Default[  ]
Getterget_strings()

An Array of the match and its capturing groups.


Default""
Getterget_subject()

The source string used with the search pattern to find this matching result.

Method Descriptions

Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it’s a named group). The default value of 0 refers to the whole pattern.

Returns -1 if the group did not match or doesn’t exist.


  • int get_group_count ( ) const

Returns the number of capturing groups.


Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it’s a named group). The default value of 0 refers to the whole pattern.

Returns -1 if the group did not match or doesn’t exist.


Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it’s a named group). The default value of 0 refers to the whole pattern.

Returns an empty string if the group did not match or doesn’t exist.

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.