A multiline text editor designed for editing code.
CodeEdit is a specialized TextEdit designed for editing plain text code files. It has many features commonly found in code editors such as line numbers, line folding, code completion, indent management, and string/comment management.
Note: Regardless of locale, CodeEdit will by default always use left-to-right text direction to correctly display source code.
If true, uses auto_brace_completion_pairs to automatically insert the closing brace when the opening brace is inserted by typing or autocompletion. Also automatically removes the closing brace when using backspace on the opening brace.
If true, highlights brace pairs when the caret is on either one, using auto_brace_completion_pairs. If matching, the pairs will be underlined. If a brace is unmatched, it is colored with brace_mismatch_color.
Sets the brace pairs to be autocompleted. For each entry in the dictionary, the key is the opening brace and the value is the closing brace that matches it. A brace is a String made of symbols. See auto_brace_completion_enabled and auto_brace_completion_highlight_matching.
If true, the ProjectSettings.input/ui_text_completion_query action requests code completion. To handle it, see _request_code_completion() or code_completion_requested.
Sets the comment delimiters. All existing comment delimiters will be removed.
Sets the string delimiters. All existing string delimiters will be removed.
If true, bookmarks are drawn in the gutter. This gutter is shared with breakpoints and executing lines. See set_line_as_bookmarked().
If true, breakpoints are drawn in the gutter. This gutter is shared with bookmarks and executing lines. Clicking the gutter will toggle the breakpoint for the line, see set_line_as_breakpoint().
If true, executing lines are marked in the gutter. This gutter is shared with breakpoints and bookmarks. See set_line_as_executing().
If true, the fold gutter is drawn. In this gutter, the can_fold_code_region icon is drawn for each foldable line (see can_fold_line()) and the folded_code_region icon is drawn for each folded line (see is_line_folded()). These icons can be clicked to toggle the fold state, see toggle_foldable_line(). line_folding must be true to show icons.
If true, the line number gutter is drawn. Line numbers start at 1 and are incremented for each line of text. Clicking and dragging in the line number gutter will select entire lines of text.
If true, line numbers drawn in the gutter are zero padded based on the total line count. Requires gutters_draw_line_numbers to be set to true.
If true, an extra indent is automatically inserted when a new line is added and a prefix in indent_automatic_prefixes is found. If a brace pair opening key is found, the matching closing brace will be moved to another new line (see auto_brace_completion_pairs).
Prefixes to trigger an automatic indent. Used when indent_automatic is set to true.
Size of the tabulation indent (one Tab press) in characters. If indent_use_spaces is enabled the number of spaces to use.
If true, lines can be folded. Otherwise, line folding methods like fold_line() will not work and can_fold_line() will always return false. See gutters_draw_fold_gutter.
Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is drawn more prominently.
Set when a validated word from symbol_validate is clicked, the symbol_lookup should be emitted.
If true, the symbol_hovered signal is emitted when hovering over a word.
Override this method to define how the selected entry should be inserted. If replace is true, any existing text should be replaced.
Override this method to define what items in candidates should be displayed.
Both candidates and the return is an Array of Dictionary, see get_code_completion_option() for Dictionary content.
Override this method to define what happens when the user requests code completion. If force is true, any checks should be bypassed.
Submits an item to the queue of potential candidates for the autocomplete menu. Call update_code_completion_options() to update the list.
location indicates location of the option relative to the location of the code completion query. See CodeCompletionLocation for how to set this value.
Note: This list will replace all current candidates.
Adds a comment delimiter 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.
Defines a string delimiter 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.
Returns true if the given line is foldable. A line is foldable if it is the start of a valid code region (see get_code_region_start_tag()), if it is the start of a comment or string block, or if the next non-empty line is more indented (see TextEdit.get_indent_level()).
Inserts the selected entry into the text. If replace is true, any existing text is replaced rather than merged.
Converts the indents of lines between from_line and to_line to tabs or spaces as set by indent_use_spaces.
Values of -1 convert the entire text.
Creates a new code region with the selection. At least one single line comment delimiter have to be defined (see add_comment_delimiter()).
A code region is a part of code that is highlighted when folded and can help organize your script.
Code region start and end tags can be customized (see set_code_region_tags()).
Code regions are delimited using start and end tags (respectively region and endregion by default) preceded by one line comment delimiter. (eg. #region and #endregion)
If there is no selection, indentation is inserted at the caret. Otherwise, the selected lines are indented like indent_lines(). Equivalent to the ProjectSettings.input/ui_text_indent action. The indentation characters used depend on indent_use_spaces and indent_size.
Duplicates all lines currently selected with any caret. Duplicates the entire line beneath the current one no matter where the caret is within the line.
Duplicates all selected text and duplicates all lines with a caret on them.
Gets the completion option at index. The return Dictionary has the following key-values:
kind: CodeCompletionKind
display_text: Text that is shown on the autocomplete menu.
insert_text: Text that is to be inserted when this item is selected.
font_color: Color of the text on the autocomplete menu.
icon: Icon to draw on the autocomplete menu.
default_value: Value of the symbol.
Gets all completion options, see get_code_completion_option() for return content.
If line column is in a string or comment, returns the end position of the region. If not or no end could be found, both Vector2 values will be -1.
If line column is in a string or comment, returns the start position of the region. If not or no start could be found, both Vector2 values will be -1.
Indents all lines that are selected or have a caret on them. Uses spaces or a tab depending on indent_use_spaces. See unindent_lines().
Returns delimiter index if line column is in a comment. If column is not provided, will return delimiter index if the entire line is a comment. Otherwise -1.
Returns the delimiter index if line column is in a string. If column is not provided, will return the delimiter index if the entire line is a string. Otherwise -1.
Returns true if the given line is bookmarked. See set_line_as_bookmarked().
Returns true if the given line is breakpointed. See set_line_as_breakpoint().
Returns true if the given line is a code region end. See set_code_region_tags().
Returns true if the given line is a code region start. See set_code_region_tags().
Returns true if the given line is marked as executing. See set_line_as_executing().
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.
Emits code_completion_requested, if force is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path, or signal.
If true, the code hint will draw below the main caret. If false, the code hint will draw above the main caret. See set_code_hint().
Sets the given line as bookmarked. If true and gutters_draw_bookmarks is true, draws the bookmark icon in the gutter for this line. See get_bookmarked_lines() and is_line_bookmarked().
Sets the given line as a breakpoint. If true and gutters_draw_breakpoints_gutter is true, draws the breakpoint icon in the gutter for this line. See get_breakpointed_lines() and is_line_breakpointed().
Sets the given line as executing. If true and gutters_draw_executing_lines is true, draws the executing_line icon in the gutter for this line. See get_executing_lines() and is_line_executing().
Sets the symbol emitted by symbol_validate as a valid lookup.
Toggle the folding of the code block on all lines with a caret on them.
Unindents all lines that are selected or have a caret on them. Uses spaces or a tab depending on indent_use_spaces. Equivalent to the ProjectSettings.input/ui_text_dedent action. See indent_lines().
Submits all completion options added with add_code_completion_option(). Will try to force the autocomplete menu to popup, if force is true.
Note: This will replace all current candidates.
Emitted when a breakpoint is added or removed from a line. If the line is removed via backspace, a signal is emitted at the old line.
Emitted when the user requests code completion. This signal will not be sent if _request_code_completion() is overridden or code_completion_enabled is false.
Emitted when the user hovers over a symbol. Unlike Control.mouse_entered, this signal is not emitted immediately, but when the cursor is over the symbol for ProjectSettings.gui/timers/tooltip_delay_sec seconds.
Note: symbol_tooltip_on_hover must be true for this signal to be emitted.
Emitted when the user hovers over a symbol. The symbol should be validated and responded to, by calling set_symbol_lookup_word_as_valid().
Note: symbol_lookup_on_click must be true for this signal to be emitted.
KIND_CLASS = 0Marks the option as a class.
KIND_FUNCTION = 1Marks the option as a function.
KIND_SIGNAL = 2Marks the option as a Godot signal.
KIND_VARIABLE = 3Marks the option as a variable.
KIND_MEMBER = 4Marks the option as a member.
KIND_ENUM = 5Marks the option as an enum entry.
KIND_CONSTANT = 6Marks the option as a constant.
KIND_NODE_PATH = 7Marks the option as a Godot node path.
KIND_FILE_PATH = 8Marks the option as a file path.
KIND_PLAIN_TEXT = 9Marks the option as unclassified or plain text.
KIND_KEYWORD = 10Marks the option as a keyword.
LOCATION_LOCAL = 0The option is local to the location of the code completion query - e.g. a local variable. Subsequent value of location represent options from the outer class, the exact value represent how far they are (in terms of inner classes).
LOCATION_PARENT_MASK = 256The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. 0 for the local class, 1 for the parent, 2 for the grandparent, etc.) to store the depth of an option in the class or a parent class.
LOCATION_OTHER_USER_CODE = 512The option is from user code which is not local and not in a derived class (e.g. Autoload Singletons).
LOCATION_OTHER = 1024The option is from other engine code, not covered by the other enum constants - e.g. built-in classes.