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...

CodeEdit

Успадковує: TextEdit < Control < CanvasItem < Node < Object

Багаторядковий текстовий редактор, призначений для редагування коду.

Опис

CodeEdit — це спеціалізований TextEdit, призначений для редагування файлів звичайного текстового коду. Він має багато функцій, які зазвичай зустрічаються в редакторах коду, наприклад номери рядків, згортання рядків, завершення коду, керування відступами та керування рядками/коментарями.

Примітка: Незалежно від мови CodeEdit за замовчуванням завжди використовуватиме напрямок тексту зліва направо для правильного відображення вихідного коду.

Властивості

bool

auto_brace_completion_enabled

false

bool

auto_brace_completion_highlight_matching

false

Dictionary

auto_brace_completion_pairs

{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }

bool

code_completion_enabled

false

Array[String]

code_completion_prefixes

[]

Array[String]

delimiter_comments

[]

Array[String]

delimiter_strings

["' '", "\" \""]

bool

gutters_draw_bookmarks

false

bool

gutters_draw_breakpoints_gutter

false

bool

gutters_draw_executing_lines

false

bool

gutters_draw_fold_gutter

false

bool

gutters_draw_line_numbers

false

int

gutters_line_numbers_min_digits

3

bool

gutters_zero_pad_line_numbers

false

bool

indent_automatic

false

Array[String]

indent_automatic_prefixes

[":", "{", "[", "("]

int

indent_size

4

bool

indent_use_spaces

false

LayoutDirection

layout_direction

2 (overrides Control)

bool

line_folding

false

Array[int]

line_length_guidelines

[]

bool

symbol_lookup_on_click

false

bool

symbol_tooltip_on_hover

false

TextDirection

text_direction

1 (overrides TextEdit)

Методи

void

_confirm_code_completion(replace: bool) virtual

Array[Dictionary]

_filter_code_completion_candidates(candidates: Array[Dictionary]) virtual const

void

_request_code_completion(force: bool) virtual

void

add_auto_brace_completion_pair(start_key: String, end_key: String)

void

add_code_completion_option(type: CodeCompletionKind, display_text: String, insert_text: String, text_color: Color = Color(1, 1, 1, 1), icon: Resource = null, value: Variant = null, location: int = 1024)

void

add_comment_delimiter(start_key: String, end_key: String, line_only: bool = false)

void

add_string_delimiter(start_key: String, end_key: String, line_only: bool = false)

bool

can_fold_line(line: int) const

void

cancel_code_completion()

void

clear_bookmarked_lines()

void

clear_breakpointed_lines()

void

clear_comment_delimiters()

void

clear_executing_lines()

void

clear_string_delimiters()

void

confirm_code_completion(replace: bool = false)

void

convert_indent(from_line: int = -1, to_line: int = -1)

void

create_code_region()

void

delete_lines()

void

do_indent()

void

duplicate_lines()

void

duplicate_selection()

void

fold_all_lines()

void

fold_line(line: int)

String

get_auto_brace_completion_close_key(open_key: String) const

PackedInt32Array

get_bookmarked_lines() const

PackedInt32Array

get_breakpointed_lines() const

Dictionary

get_code_completion_option(index: int) const

Array[Dictionary]

get_code_completion_options() const

int

get_code_completion_selected_index() const

String

get_code_region_end_tag() const

String

get_code_region_start_tag() const

String

get_delimiter_end_key(delimiter_index: int) const

Vector2

get_delimiter_end_position(line: int, column: int) const

String

get_delimiter_start_key(delimiter_index: int) const

Vector2

get_delimiter_start_position(line: int, column: int) const

PackedInt32Array

get_executing_lines() const

Array[int]

get_folded_lines() const

String

get_text_for_code_completion() const

String

get_text_for_symbol_lookup() const

String

get_text_with_cursor_char(line: int, column: int) const

bool

has_auto_brace_completion_close_key(close_key: String) const

bool

has_auto_brace_completion_open_key(open_key: String) const

bool

has_comment_delimiter(start_key: String) const

bool

has_string_delimiter(start_key: String) const

void

indent_lines()

int

is_in_comment(line: int, column: int = -1) const

int

is_in_string(line: int, column: int = -1) const

bool

is_line_bookmarked(line: int) const

bool

is_line_breakpointed(line: int) const

bool

is_line_code_region_end(line: int) const

bool

is_line_code_region_start(line: int) const

bool

is_line_executing(line: int) const

bool

is_line_folded(line: int) const

void

join_lines(line_ending: String = " ")

void

move_lines_down()

void

move_lines_up()

void

remove_comment_delimiter(start_key: String)

void

remove_string_delimiter(start_key: String)

void

request_code_completion(force: bool = false)

void

set_code_completion_selected_index(index: int)

void

set_code_hint(code_hint: String)

void

set_code_hint_draw_below(draw_below: bool)

void

set_code_region_tags(start: String = "region", end: String = "endregion")

void

set_line_as_bookmarked(line: int, bookmarked: bool)

void

set_line_as_breakpoint(line: int, breakpointed: bool)

void

set_line_as_executing(line: int, executing: bool)

void

set_symbol_lookup_word_as_valid(valid: bool)

void

toggle_foldable_line(line: int)

void

toggle_foldable_lines_at_carets()

void

unfold_all_lines()

void

unfold_line(line: int)

void

unindent_lines()

void

update_code_completion_options(force: bool)

Властивості теми

Color

bookmark_color

Color(0.5, 0.64, 1, 0.8)

Color

brace_mismatch_color

Color(1, 0.2, 0.2, 1)

Color

breakpoint_color

Color(0.9, 0.29, 0.3, 1)

Color

code_folding_color

Color(0.8, 0.8, 0.8, 0.8)

Color

completion_background_color

Color(0.17, 0.16, 0.2, 1)

Color

completion_existing_color

Color(0.87, 0.87, 0.87, 0.13)

Color

completion_scroll_color

Color(1, 1, 1, 0.29)

Color

completion_scroll_hovered_color

Color(1, 1, 1, 0.4)

Color

completion_selected_color

Color(0.26, 0.26, 0.27, 1)

Color

executing_line_color

Color(0.98, 0.89, 0.27, 1)

Color

folded_code_region_color

Color(0.68, 0.46, 0.77, 0.2)

Color

line_length_guideline_color

Color(0.3, 0.5, 0.8, 0.1)

Color

line_number_color

Color(0.67, 0.67, 0.67, 0.4)

int

completion_lines

7

int

completion_max_width

50

int

completion_scroll_width

6

Texture2D

bookmark

Texture2D

breakpoint

Texture2D

can_fold

Texture2D

can_fold_code_region

Texture2D

completion_color_bg

Texture2D

executing_line

Texture2D

folded

Texture2D

folded_code_region

Texture2D

folded_eol_icon

StyleBox

completion

Сигнали

breakpoint_toggled(line: int) 🔗

Видається, коли точка зупинки додається або видаляється з рядка. Якщо рядок видаляється за допомогою клавіші Backspace, сигнал видається на старому рядку.

code_completion_requested() 🔗

Видається, коли користувач запитує завершення коду. Цей сигнал не буде надіслано, якщо _request_code_completion() перевизначено або code_completion_enabled має значення false.

symbol_hovered(symbol: String, line: int, column: int) 🔗

Видається, коли користувач наводить курсор на символ. На відміну від Control.mouse_entered, цей сигнал видається не відразу, а коли курсор знаходиться над символом протягом ProjectSettings.gui/timers/tooltip_delay_sec секунд.

Примітка: symbol_tooltip_on_hover має бути true, щоб цей сигнал випромінювався.

symbol_lookup(symbol: String, line: int, column: int) 🔗

Видається, коли користувач натискає дійсний символ.

symbol_validate(symbol: String) 🔗

Видається, коли користувач наводить курсор на символ. Символ слід перевірити та відповісти на нього, викликавши set_symbol_lookup_word_as_valid().

Примітка: symbol_lookup_on_click має бути true, щоб цей сигнал випромінювався.

Переліки

enum CodeCompletionKind: 🔗

CodeCompletionKind KIND_CLASS = 0

Позначає опцію як клас.

CodeCompletionKind KIND_FUNCTION = 1

Позначає опцію як функцію.

CodeCompletionKind KIND_SIGNAL = 2

Позначає опцію як сигнал Godot.

CodeCompletionKind KIND_VARIABLE = 3

Позначає опцію як змінну.

CodeCompletionKind KIND_MEMBER = 4

Позначає опцію як учасника.

CodeCompletionKind KIND_ENUM = 5

Позначає параметр як запис переліку.

CodeCompletionKind KIND_CONSTANT = 6

Позначає опцію як константу.

CodeCompletionKind KIND_NODE_PATH = 7

Позначає опцію як шлях вузла Godot.

CodeCompletionKind KIND_FILE_PATH = 8

Позначає параметр як шлях до файлу.

CodeCompletionKind KIND_PLAIN_TEXT = 9

Позначає параметр як некласифікований або простий текст.

CodeCompletionKind KIND_KEYWORD = 10

Marks the option as a keyword.

enum CodeCompletionLocation: 🔗

CodeCompletionLocation LOCATION_LOCAL = 0

Параметр є локальним щодо розташування запиту на завершення коду - наприклад, локальна змінна. Подальше значення розташування представляє параметри із зовнішнього класу, точне значення відображає, наскільки далеко вони знаходяться (з точки зору внутрішніх класів).

CodeCompletionLocation LOCATION_PARENT_MASK = 256

Опція з класу-вмістника або батьківського класу, відносно розташування запиту на завершення коду. Виконайте побітове АБО з глибиною класу (наприклад, 0 для локального класу, 1 для батьківського, 2 для дідуся та бабусі тощо). щоб зберегти глибину опції в класі або батьківському класі.

CodeCompletionLocation LOCATION_OTHER_USER_CODE = 512

Параметр береться з коду користувача, який не є локальним і не входить до похідного класу (наприклад, автозавантаження Singletons).

CodeCompletionLocation LOCATION_OTHER = 1024

Опція походить з іншого коду двигуна, не охопленого іншими константами enum - наприклад, вбудовані класи.

Описи властивостей

bool auto_brace_completion_enabled = false 🔗

  • void set_auto_brace_completion_enabled(value: bool)

  • bool is_auto_brace_completion_enabled()

Якщо true, використовує auto_brace_completion_pairs, щоб автоматично вставляти закриваючу дужку, коли відкриваюча дужка вставляється шляхом введення чи автозаповнення. Також автоматично видаляє закриваючу фігурну дужку під час використання зворотного простору на відкривній дужці.

bool auto_brace_completion_highlight_matching = false 🔗

  • void set_highlight_matching_braces_enabled(value: bool)

  • bool is_highlight_matching_braces_enabled()

Якщо true, підсвічує пари фігурних дужок, коли вставка знаходиться на одній із них, використовуючи auto_brace_completion_pairs. У разі збігу пари будуть підкреслені. Якщо дужка не відповідає, вона забарвлюється brace_mismatch_color.

Dictionary auto_brace_completion_pairs = { "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" } 🔗

  • void set_auto_brace_completion_pairs(value: Dictionary)

  • Dictionary get_auto_brace_completion_pairs()

Встановлює автозаповнення пар дужок. Для кожного запису в словнику ключ є відкриваючою фігурною дужкою, а значенням є відповідна йому закриваюча дужка. Дужка — це String із символів. Перегляньте auto_brace_completion_enabled і auto_brace_completion_highlight_matching.

bool code_completion_enabled = false 🔗

  • void set_code_completion_enabled(value: bool)

  • bool is_code_completion_enabled()

Якщо true, дія ProjectSettings.input/ui_text_completion_query вимагає завершення коду. Щоб впоратися з цим, перегляньте _request_code_completion() або code_completion_requested.

Array[String] code_completion_prefixes = [] 🔗

  • void set_code_completion_prefixes(value: Array[String])

  • Array[String] get_code_completion_prefixes()

Встановлює префікси, які запускатимуть завершення коду.

Array[String] delimiter_comments = [] 🔗

  • void set_comment_delimiters(value: Array[String])

  • Array[String] get_comment_delimiters()

Встановлює розділювачі коментарів. Усі існуючі розділювачі коментарів буде видалено.

Array[String] delimiter_strings = ["' '", "\" \""] 🔗

  • void set_string_delimiters(value: Array[String])

  • Array[String] get_string_delimiters()

Встановлює розділювачі рядків. Усі існуючі розділювачі рядків буде видалено.

bool gutters_draw_bookmarks = false 🔗

  • void set_draw_bookmarks_gutter(value: bool)

  • bool is_drawing_bookmarks_gutter()

Якщо true, закладки малюються в канаві. Цей канал використовується спільно з точками зупинки та рядками виконання. Перегляньте set_line_as_bookmarked().

bool gutters_draw_breakpoints_gutter = false 🔗

  • void set_draw_breakpoints_gutter(value: bool)

  • bool is_drawing_breakpoints_gutter()

Якщо true, точки зупину малюються в каналі. Цей жолоб спільний із закладками та лініями виконання. Клацання на жолобі перемикає точку розриву для рядка, див. set_line_as_breakpoint().

bool gutters_draw_executing_lines = false 🔗

  • void set_draw_executing_lines_gutter(value: bool)

  • bool is_drawing_executing_lines_gutter()

Якщо true, рядки виконання позначаються в канаві. Цей канал використовується спільно з точками зупинки та закладками. Перегляньте set_line_as_executing().

bool gutters_draw_fold_gutter = false 🔗

  • void set_draw_fold_gutter(value: bool)

  • bool is_drawing_fold_gutter()

Якщо true, малюється жолоб складки. У цьому каналі піктограма can_fold_code_region намальована для кожної лінії згортання (див. can_fold_line()), а піктограма folded_code_region намальована для кожної лінії згинання (див. is_line_folded()). Ці піктограми можна натиснути, щоб перемкнути стан згортання, див. toggle_foldable_line(). line_folding має бути true, щоб відображати значки.

bool gutters_draw_line_numbers = false 🔗

  • void set_draw_line_numbers(value: bool)

  • bool is_draw_line_numbers_enabled()

Якщо true, буде намальовано межу номера рядка. Номери рядків починаються з 1 і збільшуються для кожного рядка тексту. Якщо клацнути та перетягнути рядок у рядку, ви виберете цілі рядки тексту.

int gutters_line_numbers_min_digits = 3 🔗

  • void set_line_numbers_min_digits(value: int)

  • int get_line_numbers_min_digits()

Мінімальна ширина в цифрах, зарезервована для межі рядка номера.

bool gutters_zero_pad_line_numbers = false 🔗

  • void set_line_numbers_zero_padded(value: bool)

  • bool is_line_numbers_zero_padded()

Якщо true, номери рядків, намальовані в канаві, доповнюються нулями на основі загальної кількості рядків. Вимагає, щоб параметр gutters_draw_line_numbers мав значення true.

bool indent_automatic = false 🔗

  • void set_auto_indent_enabled(value: bool)

  • bool is_auto_indent_enabled()

Якщо true, додатковий відступ буде автоматично вставлено, коли додається новий рядок і знайдено префікс у indent_automatic_prefixes. Якщо ключ відкриття пари фігурних дужок знайдено, відповідну закриваючу дужку буде переміщено в інший новий рядок (див. auto_brace_completion_pairs).

Array[String] indent_automatic_prefixes = [":", "{", "[", "("] 🔗

  • void set_auto_indent_prefixes(value: Array[String])

  • Array[String] get_auto_indent_prefixes()

Префікси для запуску автоматичного відступу. Використовується, коли indent_automatic має значення true.

int indent_size = 4 🔗

  • void set_indent_size(value: int)

  • int get_indent_size()

Розмір відступу табуляції (одне натискання Tab) у символах. Якщо indent_use_spaces увімкнено, кількість пробілів для використання.

bool indent_use_spaces = false 🔗

  • void set_indent_using_spaces(value: bool)

  • bool is_indent_using_spaces()

Використовуйте пробіли замість табуляції для відступу.

bool line_folding = false 🔗

  • void set_line_folding_enabled(value: bool)

  • bool is_line_folding_enabled()

Якщо true, рядки можна згорнути. Інакше такі методи згортання рядків, як fold_line(), не працюватимуть, а can_fold_line() завжди повертатиме false. Див. gutters_draw_fold_gutter.

Array[int] line_length_guidelines = [] 🔗

  • void set_line_length_guidelines(value: Array[int])

  • Array[int] get_line_length_guidelines()

Малює вертикальні лінії у наданих стовпцях. Перший запис вважається основною чіткою напрямною лінією та малюється більш помітно.

bool symbol_lookup_on_click = false 🔗

  • void set_symbol_lookup_on_click_enabled(value: bool)

  • bool is_symbol_lookup_on_click_enabled()

Установіть, коли натиснуто перевірене слово з symbol_validate, має видаватись symbol_lookup.

bool symbol_tooltip_on_hover = false 🔗

  • void set_symbol_tooltip_on_hover_enabled(value: bool)

  • bool is_symbol_tooltip_on_hover_enabled()

Якщо значення true, то при наведенні курсора на слово випромінюється сигнал symbol_hovered.

Описи методів

void _confirm_code_completion(replace: bool) virtual 🔗

Перевизначте цей метод, щоб визначити спосіб вставлення вибраного запису. Якщо replace має значення true, будь-який існуючий текст слід замінити.

Array[Dictionary] _filter_code_completion_candidates(candidates: Array[Dictionary]) virtual const 🔗

Перевизначте цей метод, щоб визначити, які елементи в candidates мають відображатися.

Як candidates, так і повернення є масивом Array Dictionary, див. get_code_completion_option() для вмісту Dictionary.

void _request_code_completion(force: bool) virtual 🔗

Перевизначте цей метод, щоб визначити, що відбувається, коли користувач запитує завершення коду. Якщо force має значення true, будь-які перевірки слід обійти.

void add_auto_brace_completion_pair(start_key: String, end_key: String) 🔗

Додає пару дужок.

І початкова, і кінцева клавіші мають бути символами. Тільки ключ запуску має бути унікальним.

void add_code_completion_option(type: CodeCompletionKind, display_text: String, insert_text: String, text_color: Color = Color(1, 1, 1, 1), icon: Resource = null, value: Variant = null, location: int = 1024) 🔗

Відправляє елемент до черги потенційних кандидатів для меню автозаповнення. Викличте update_code_completion_options(), щоб оновити список.

location вказує розташування параметра відносно розташування запиту на завершення коду. Перегляньте CodeCompletionLocation, щоб дізнатися, як встановити це значення.

Примітка: цей список замінить усіх поточних кандидатів.

void add_comment_delimiter(start_key: String, end_key: String, line_only: bool = false) 🔗

Додає роздільник коментаря від start_key до end_key. Обидва ключі мають бути символами, а start_key не має бути спільним з іншими роздільниками.

Якщо line_only має значення true або end_key є порожнім String, область не переноситься на наступний рядок.

void add_string_delimiter(start_key: String, end_key: String, line_only: bool = false) 🔗

Визначає роздільник рядка від start_key до end_key. Обидва ключі мають бути символами, а start_key не має бути спільним з іншими роздільниками.

Якщо line_only має значення true або end_key є порожнім String, область не переноситься на наступний рядок.

bool can_fold_line(line: int) const 🔗

Повертає true, якщо вказаний рядок можна згорнути. Рядок можна згорнути, якщо він є початком дійсної області коду (див. get_code_region_start_tag()), якщо він є початком блоку коментаря чи рядка, або якщо наступний непорожній рядок має більший відступ (див. TextEdit.get_indent_level()).

void cancel_code_completion() 🔗

Скасовує меню автозаповнення.

void clear_bookmarked_lines() 🔗

Очищає всі закладені рядки.

void clear_breakpointed_lines() 🔗

Очищає всі лінії з точками розриву.

void clear_comment_delimiters() 🔗

Видаляє всі розділювачі коментарів.

void clear_executing_lines() 🔗

Очищає всі виконані рядки.

void clear_string_delimiters() 🔗

Видаляє всі розділювачі рядків.

void confirm_code_completion(replace: bool = false) 🔗

Вставте вибраний запис у текст. Якщо replace є true, будь-який існуючий текст замінюється замість об'єднання.

void convert_indent(from_line: int = -1, to_line: int = -1) 🔗

Перетворює відступи рядків між from_line і to_line на табуляції або пробіли, як установлено indent_use_spaces.

Значення -1 перетворюють увесь текст.

void create_code_region() 🔗

Створює нову область коду з виділенням. Необхідно визначити принаймні один однорядковий роздільник коментаря (див. add_comment_delimiter()).

Область коду – це частина коду, яка підсвічується під час згортання та може допомогти впорядкувати ваш скрипт.

Початкові та кінцеві теги регіону коду можна налаштувати (див. set_code_region_tags()).

Області коду розмежовуються за допомогою початкових і кінцевих тегів (відповідно region і endregion за замовчуванням), яким передує один рядковий роздільник коментаря. (наприклад, #region і #endregion)

void delete_lines() 🔗

Видаляє всі виділені рядки або рядки, на яких є вставка.

void do_indent() 🔗

Якщо виділення немає, відступ вставляється біля каретки. В іншому випадку вибрані рядки мають відступ, як indent_lines(). Еквівалент дії ProjectSettings.input/ui_text_indent. Використовувані символи відступу залежать від indent_use_spaces і indent_size.

void duplicate_lines() 🔗

Дублює всі рядки, виділені будь-якою вставкою. Дублює весь рядок під поточним, незалежно від того, де в рядку знаходиться курсор.

void duplicate_selection() 🔗

Дублює весь виділений текст і дублює всі рядки з вставкою.

void fold_all_lines() 🔗

Згортає всі лінії, які можна згорнути (див. can_fold_line()).

void fold_line(line: int) 🔗

Згортає заданий рядок, якщо це можливо (див. can_fold_line()).

String get_auto_brace_completion_close_key(open_key: String) const 🔗

Отримує відповідний ключ автоматичного закриття дужок для open_key.

PackedInt32Array get_bookmarked_lines() const 🔗

Отримує всі закладені рядки.

PackedInt32Array get_breakpointed_lines() const 🔗

Отримує всі рядки з точками розриву.

Dictionary get_code_completion_option(index: int) const 🔗

Отримує параметр завершення в index. Повернутий Dictionary має такі ключ-значення:

вид: CodeCompletionKind

display_text: Текст, який відображається в меню автозаповнення.

insert_text: текст, який потрібно вставити, коли вибрано цей елемент.

font_color: колір текст в меню автозаповнення.

піктограма: піктограма для малювання в меню автозаповнення.

default_value: значення символу.

Array[Dictionary] get_code_completion_options() const 🔗

Отримує всі параметри завершення, див. get_code_completion_option() для повернення вмісту.

int get_code_completion_selected_index() const 🔗

Отримує індекс поточного вибраного параметра завершення.

String get_code_region_end_tag() const 🔗

Повертає кінцевий тег області коду (без розділювача коментарів).

String get_code_region_start_tag() const 🔗

Повертає початковий тег області коду (без розділювача коментарів).

String get_delimiter_end_key(delimiter_index: int) const 🔗

Отримує кінцевий ключ для рядка або індексу області коментаря.

Vector2 get_delimiter_end_position(line: int, column: int) const 🔗

Якщо line column міститься в рядку або коментарі, повертає кінцеву позицію області. Якщо ні або не знайдено кінця, обидва значення Vector2 будуть -1.

String get_delimiter_start_key(delimiter_index: int) const 🔗

Отримує початковий ключ для рядка або індексу області коментаря.

Vector2 get_delimiter_start_position(line: int, column: int) const 🔗

Якщо line column міститься в рядку або коментарі, повертає початкову позицію області. Якщо ні або не вдалося знайти початок, обидва значення Vector2 будуть -1.

PackedInt32Array get_executing_lines() const 🔗

Отримує всі рядки для виконання.

Array[int] get_folded_lines() const 🔗

Повертає всі рядки, які наразі зігнуті.

String get_text_for_code_completion() const 🔗

Повертає повний текст із символом 0xFFFF у місці вставки.

String get_text_for_symbol_lookup() const 🔗

Повертає повний текст із символом 0xFFFF у місці розташування курсора.

String get_text_with_cursor_char(line: int, column: int) const 🔗

Повернення повного тексту з char 0xFFFF при вказаному місці.

bool has_auto_brace_completion_close_key(close_key: String) const 🔗

true, якщо існує близький ключ close_key.

bool has_auto_brace_completion_open_key(open_key: String) const 🔗

true if open key open_key існує.

bool has_comment_delimiter(start_key: String) const 🔗

true якщо коментар start_key існує.

bool has_string_delimiter(start_key: String) const 🔗

true if string start_key існує.

void indent_lines() 🔗

Робить відступи для всіх виділених рядків або рядків із вставкою. Використовує пробіли або табуляцію залежно від indent_use_spaces. Див. unindent_lines().

int is_in_comment(line: int, column: int = -1) const 🔗

Повертає індекс розділювача, якщо line column міститься в коментарі. Якщо column не надано, поверне індекс роздільника, якщо весь line є коментарем. Інакше -1.

int is_in_string(line: int, column: int = -1) const 🔗

Повертає індекс роздільника, якщо line column міститься в рядку. Якщо column не надано, поверне індекс роздільника, якщо весь line є рядком. Інакше -1.

bool is_line_bookmarked(line: int) const 🔗

Повертає true, якщо даний рядок додано до закладок. Перегляньте set_line_as_bookmarked().

bool is_line_breakpointed(line: int) const 🔗

Повертає true, якщо вказаний рядок має точку зупину. Перегляньте set_line_as_breakpoint().

bool is_line_code_region_end(line: int) const 🔗

Повертає true, якщо вказаний рядок є кінцем області коду. Перегляньте set_code_region_tags().

bool is_line_code_region_start(line: int) const 🔗

Повертає true, якщо вказаний рядок є початком області коду. Перегляньте set_code_region_tags().

bool is_line_executing(line: int) const 🔗

Повертає true, якщо даний рядок позначено як виконуваний. Перегляньте set_line_as_executing().

bool is_line_folded(line: int) const 🔗

Повертає true, якщо заданий рядок зігнуто. Див. fold_line().

void join_lines(line_ending: String = " ") 🔗

Joins all selected lines or lines containing a caret with their next line. Whitespace in between will be removed. If the next line has content, the line_ending will be inserted in between.

void move_lines_down() 🔗

Пересуває всі виділені рядки або рядки, на яких є вставка.

void move_lines_up() 🔗

Пересуває всі виділені рядки або рядки, на яких є вставка.

void remove_comment_delimiter(start_key: String) 🔗

Видаляє розділювач коментарів за допомогою start_key.

void remove_string_delimiter(start_key: String) 🔗

Видаляє роздільник рядка за допомогою start_key.

void request_code_completion(force: bool = false) 🔗

Видає code_completion_requested, якщо force має значення true, обійде всі перевірки. Інакше буде перевірено, чи вставка знаходиться в слові або перед префіксом. Проігнорує запит, якщо всі поточні параметри мають тип шлях до файлу, шлях вузла або сигнал.

void set_code_completion_selected_index(index: int) 🔗

Встановлює поточний вибраний параметр завершення.

void set_code_hint(code_hint: String) 🔗

Встановлює текст підказки коду. Передайте порожній рядок для очищення.

void set_code_hint_draw_below(draw_below: bool) 🔗

Якщо true, підказка коду буде відображатися під основною кареткою. Якщо false, підказка коду відображатиметься над основною кареткою. Перегляньте set_code_hint().

void set_code_region_tags(start: String = "region", end: String = "endregion") 🔗

Встановлює початкові та кінцеві теги області коду (без розділювача коментарів).

void set_line_as_bookmarked(line: int, bookmarked: bool) 🔗

Встановлює заданий рядок як закладений. Якщо true і gutters_draw_bookmarks має значення true, малює піктограму bookmark у канаві для цього рядка. Перегляньте get_bookmarked_lines() і is_line_bookmarked().

void set_line_as_breakpoint(line: int, breakpointed: bool) 🔗

Встановлює заданий рядок як точку зупину. Якщо true і gutters_draw_breakpoints_gutter має значення true, малює піктограму breakpoint у канаві для цього рядка. Перегляньте get_breakpointed_lines() і is_line_breakpointed().

void set_line_as_executing(line: int, executing: bool) 🔗

Встановлює заданий рядок як виконуваний. Якщо true і gutters_draw_executing_lines має значення true, малює піктограму executing_line у канаві для цього рядка. Перегляньте get_executing_lines() і is_line_executing().

void set_symbol_lookup_word_as_valid(valid: bool) 🔗

Встановлює символ, виданий symbol_validate, як дійсний пошук.

void toggle_foldable_line(line: int) 🔗

Увімкнути згортання блоку коду в заданому рядку.

void toggle_foldable_lines_at_carets() 🔗

Увімкніть згортання блоку коду на всіх рядках із введенням.

void unfold_all_lines() 🔗

Розгортає всі складені лінії.

void unfold_line(line: int) 🔗

Розгортає задану лінію, якщо вона зігнута або захована під лінією згину.

void unindent_lines() 🔗

Скасовує відступи в усіх вибраних рядках або рядках, на яких є вставка. Використовує пробіли або табуляцію залежно від indent_use_spaces. Еквівалент дії ProjectSettings.input/ui_text_dedent. Див. indent_lines().

void update_code_completion_options(force: bool) 🔗

Надсилає всі параметри завершення, додані за допомогою add_code_completion_option(). Спробує примусово відкрити спливаюче меню автозаповнення, якщо force має значення true.

Примітка: це замінить усіх поточних кандидатів.

Описи тематичної нерухомості

Color bookmark_color = Color(0.5, 0.64, 1, 0.8) 🔗

Color значка закладки для рядків із закладками.

Color brace_mismatch_color = Color(1, 0.2, 0.2, 1) 🔗

Color тексту для виділення невідповідних дужок.

Color breakpoint_color = Color(0.9, 0.29, 0.3, 1) 🔗

Color піктограми точки розриву для рядків із закладками.

Color code_folding_color = Color(0.8, 0.8, 0.8, 0.8) 🔗

Color для всіх значків, пов’язаних зі згортанням ліній.

Color completion_background_color = Color(0.17, 0.16, 0.2, 1) 🔗

Встановлює Color фону для спливаючого вікна доповнення коду.

Color completion_existing_color = Color(0.87, 0.87, 0.87, 0.13) 🔗

Color підсвічування фону для відповідного тексту в параметрах доповнення коду.

Color completion_scroll_color = Color(1, 1, 1, 0.29) 🔗

Color смуги прокрутки у спливаючому вікні доповнення коду.

Color completion_scroll_hovered_color = Color(1, 1, 1, 0.4) 🔗

Color смуги прокрутки у спливаючому вікні доповнення коду під час наведення.

Color completion_selected_color = Color(0.26, 0.26, 0.27, 1) 🔗

Color підсвічування фону для поточного вибраного елемента опції у спливаючому вікні доповнення коду.

Color executing_line_color = Color(0.98, 0.89, 0.27, 1) 🔗

Color піктограми виконання для виконуємих ліній.

Color folded_code_region_color = Color(0.68, 0.46, 0.77, 0.2) 🔗

Color фонового підсвічування ліній для області згорнутого коду.

Color line_length_guideline_color = Color(0.3, 0.5, 0.8, 0.1) 🔗

Color основної напрямної довжини, додаткові напрямні матимуть 50% альфа-каналу.

Color line_number_color = Color(0.67, 0.67, 0.67, 0.4) 🔗

Встановлює Color номерів рядків.

int completion_lines = 7 🔗

Максимальна кількість параметрів, які можна одночасно відобразити у спливаючому вікні завершення коду.

int completion_max_width = 50 🔗

Максимальна ширина параметрів у спливаючому вікні завершення коду. Опції, довші за цей, буде відрізано.

int completion_scroll_width = 6 🔗

Ширина смуги прокрутки у спливаючому вікні завершення коду.

Texture2D bookmark 🔗

Встановлює настроюваний Texture2D для малювання в області закладок для ліній із закладками.

Texture2D breakpoint 🔗

Встановлює настроюваний Texture2D для малювання межі точок розриву для ліній із точками розриву.

Texture2D can_fold 🔗

Встановлює настроюваний Texture2D для малювання лінії згинання, коли лінію можна скласти.

Texture2D can_fold_code_region 🔗

Встановлює настроюваний Texture2D для малювання лінії згинання, коли область коду можна згорнути.

Texture2D completion_color_bg 🔗

Фонова панель для вікна попереднього перегляду кольору в автозавершенні (видно, коли колір напівпрозорий).

Texture2D executing_line 🔗

Піктограма для малювання у жолобі виконання для виконання ліній.

Texture2D folded 🔗

Встановлює настроюваний Texture2D для малювання лінії згинання, коли лінію згинають і її можна розгорнути.

Texture2D folded_code_region 🔗

Встановлює настроюваний Texture2D для малювання лінії згинання, коли область коду згортається та може бути розгорнута.

Texture2D folded_eol_icon 🔗

Встановлює спеціальний Texture2D для малювання в кінці лінії згину.

StyleBox completion 🔗

StyleBox для спливаючого вікна завершення коду.