begins_tag


Description:

[ Version ( deprecated = true , deprecated_since = "3.20" ) ]
public bool begins_tag (TextTag? tag)

Warning: begins_tag is deprecated since 3.20.

Returns true if tag is toggled on at exactly this point.

Note:

Use starts_tag instead.

If tag is null, returns true if any tag is toggled on at this point.

Note that if begins_tag returns true, it means that this is at the beginning of the tagged range, and that the character at this is inside the tagged range. In other words, unlike ends_tag, if begins_tag returns true, has_tag will also return true for the same parameters.

Parameters:

this

an iterator

tag

a TextTag, or null

Returns:

whether this is the start of a range tagged with tag