SyntaxHighlighter #

virtual func _clear_highlighting_cache() -> void#

Virtual method which can be overridden to clear any local caches.

virtual const func _get_line_syntax_highlighting(line: int) -> Dictionary#

Virtual method which can be overridden to return syntax highlighting data.

See get_line_syntax_highlighting for more details.

virtual func _update_cache() -> void#

Virtual method which can be overridden to update any local caches.

func clear_highlighting_cache() -> void#

Clears all cached syntax highlighting data.

Then calls overridable method _clear_highlighting_cache.

func get_line_syntax_highlighting(line: int) -> Dictionary#

Returns the syntax highlighting data for the line at index line. If the line is not cached, calls _get_line_syntax_highlighting first to calculate the data.

Each entry is a column number containing a nested Dictionary. The column number denotes the start of a region, the region will end if another region is found, or at the end of the line. The nested Dictionary contains the data for that region. Currently only the key "color" is supported.

Example: Possible return value. This means columns 0 to 4 should be red, and columns 5 to the end of the line should be green:

{
    0: {
        "color": Color(1, 0, 0)
    },
    5: {
        "color": Color(0, 1, 0)
    }
}

const func get_text_edit() -> TextEdit#

Returns the associated TextEdit node.

func update_cache() -> void#

Clears then updates the SyntaxHighlighter caches. Override _update_cache for a callback.

Note: This is called automatically when the associated TextEdit node, updates its own cache.