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.

CodeHighlighter

Inherits: SyntaxHighlighter < Resource < RefCounted < Object

A syntax highlighter intended for code.

Description

By adjusting various properties of this resource, you can change the colors of strings, comments, numbers, and other text patterns inside a TextEdit control.

Properties

Dictionary

color_regions

{}

Color

function_color

Color(0, 0, 0, 1)

Dictionary

keyword_colors

{}

Dictionary

member_keyword_colors

{}

Color

member_variable_color

Color(0, 0, 0, 1)

Color

number_color

Color(0, 0, 0, 1)

Color

symbol_color

Color(0, 0, 0, 1)

Methods

void

add_color_region ( String start_key, String end_key, Color color, bool line_only=false )

void

add_keyword_color ( String keyword, Color color )

void

add_member_keyword_color ( String member_keyword, Color color )

void

clear_color_regions ( )

void

clear_keyword_colors ( )

void

clear_member_keyword_colors ( )

Color

get_keyword_color ( String keyword ) const

Color

get_member_keyword_color ( String member_keyword ) const

bool

has_color_region ( String start_key ) const

bool

has_keyword_color ( String keyword ) const

bool

has_member_keyword_color ( String member_keyword ) const

void

remove_color_region ( String start_key )

void

remove_keyword_color ( String keyword )

void

remove_member_keyword_color ( String member_keyword )


Property Descriptions

Dictionary color_regions = {}

Sets the color regions. All existing regions will be removed. The Dictionary key is the region start and end key, separated by a space. The value is the region color.


Color function_color = Color(0, 0, 0, 1)

  • void set_function_color ( Color value )

  • Color get_function_color ( )

Sets color for functions. A function is a non-keyword string followed by a '('.


Dictionary keyword_colors = {}

Sets the keyword colors. All existing keywords will be removed. The Dictionary key is the keyword. The value is the keyword color.