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.

Checking the stable version of the documentation...

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 ( 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 )

属性说明

Dictionary color_regions = {}

设置颜色区域。现有区域都将被移除。Dictionary 的键为该区域的开始键和结束键，用空格隔开。对应的值为区域的颜色。

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

  • void set_function_color ( Color value )

  • 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 ( Color value )

  • Color get_member_variable_color ( )

设置成员变量的颜色。成员变量是以“.”开头的非关键字、非函数字符串。

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

  • void set_number_color ( Color value )

  • Color get_number_color ( )

设置数字的颜色。

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

  • void set_symbol_color ( Color value )

  • Color get_symbol_color ( )

设置符号的颜色。

方法说明

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

添加颜色区域，类似注释和字符串。

开始键和结束键都必须是符号。只有开始键必须是唯一的。

line_only 表示该区域应该持续到该行的末尾，还是延续到下一行。如果结束键为空，则自动设置为true。

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

如果开始键存在则返回 true，否则返回 false。

bool has_keyword_color ( String keyword ) const

如果关键字存在则返回 true，否则返回 false。

bool has_member_keyword_color ( String member_keyword ) const

如果成员关键字存在则返回 true，否则返回 false。

void remove_color_region ( String start_key )

移除使用该开始键的颜色区域。

void remove_keyword_color ( String keyword )

移除关键字。

void remove_member_keyword_color ( String member_keyword )

移除成员关键字。