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

繼承: SyntaxHighlighter < Resource < RefCounted < Object

用於程式碼的語法高亮器。

說明

通過調整該資源的各種屬性,可以更改 TextEdit 控制項內的字串、注釋、數位、和其他文字圖案的顏色。

屬性

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)

方法

void

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

void

add_keyword_color(keyword: String, color: Color)

void

add_member_keyword_color(member_keyword: String, color: Color)

void

clear_color_regions()

void

clear_keyword_colors()

void

clear_member_keyword_colors()

Color

get_keyword_color(keyword: String) const

Color

get_member_keyword_color(member_keyword: String) const

bool

has_color_region(start_key: String) const

bool

has_keyword_color(keyword: String) const

bool

has_member_keyword_color(member_keyword: String) const

void

remove_color_region(start_key: String)

void

remove_keyword_color(keyword: String)

void

remove_member_keyword_color(member_keyword: String)


屬性說明

Dictionary color_regions = {} 🔗

設定顏色區域。現有區域都將被移除。Dictionary 的鍵為該區域的開始鍵和結束鍵,用空格隔開。對應的值為區域的顏色。


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

  • void set_function_color(value: Color)

  • Color get_function_color()

設定函式的顏色。函式是後跟“(”的非關鍵字字串。


Dictionary keyword_colors = {} 🔗

設定關鍵字的顏色。現有關鍵字都將被移除。Dictionary 的鍵為關鍵字。對應的值為關鍵字的顏色。


Dictionary member_keyword_colors = {} 🔗

設定成員關鍵字的顏色。現有成員關鍵字都將被移除。Dictionary 的鍵為成員關鍵字。對應的值為成員關鍵字的顏色。


Color member_variable_color = Color(0, 0, 0, 1) 🔗

  • void set_member_variable_color(value: Color)

  • Color get_member_variable_color()

設定成員變數的顏色。成員變數是以“.”開頭的非關鍵字、非函式字串。


Color number_color = Color(0, 0, 0, 1) 🔗

  • void set_number_color(value: Color)

  • Color get_number_color()

設定數字的顏色。


Color symbol_color = Color(0, 0, 0, 1) 🔗

  • void set_symbol_color(value: Color)

  • Color get_symbol_color()

設定符號的顏色。


方法說明

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

Adds a color region (such as for comments or strings) from start_key to end_key. Both keys should be symbols, and start_key must not be shared with other delimiters.

If line_only is true or end_key is an empty String, the region does not carry over to the next line.


void add_keyword_color(keyword: String, color: Color) 🔗

設定關鍵字的顏色。

關鍵字不能包含除“_”之外的任何符號。


void add_member_keyword_color(member_keyword: String, color: Color) 🔗

設定成員關鍵字的顏色。

成員關鍵字不能包含除“_”之外的任何符號。

如果前面有“.”,則不會高亮顯示。


void clear_color_regions() 🔗

移除所有顏色區域。


void clear_keyword_colors() 🔗

移除所有關鍵字。


void clear_member_keyword_colors() 🔗

移除所有成員關鍵字。


Color get_keyword_color(keyword: String) const 🔗

返回某個關鍵字的顏色。


Color get_member_keyword_color(member_keyword: String) const 🔗

返回某個成員關鍵字的顏色。


bool has_color_region(start_key: String) const 🔗

如果開始鍵存在則返回 true,否則返回 false


bool has_keyword_color(keyword: String) const 🔗

如果關鍵字存在則返回 true,否則返回 false


bool has_member_keyword_color(member_keyword: String) const 🔗

如果成員關鍵字存在則返回 true,否則返回 false


void remove_color_region(start_key: String) 🔗

移除使用該開始鍵的顏色區域。


void remove_keyword_color(keyword: String) 🔗

移除關鍵字。


void remove_member_keyword_color(member_keyword: String) 🔗

移除成員關鍵字。