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

Добавляет цветовую область (например, для комментариев или строк) от start_key до end_key. Оба ключа должны быть символами, и start_key не должен использоваться совместно с другими разделителями.

Если line_only — это true или end_key — это пустая String, область не переносится на следующую строку.

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

Удаляет ключевое слово участника.