class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectNodeCanvasItemControlTextEdit CodeEdit
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.

 Signal breakpoint_toggled<>( int line=, line:int=, ):Signal

Emitted when a breakpoint is added or removed from a line. If the line is moved via backspace a removed is emitted at the old line.

 Signal code_completion_requested<>():Signal

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.

 Signal symbol_hovered<>( String symbol=, symbol:String=, int line=, line:int=, int column=, column:int=, ):Signal

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.

 Signal symbol_lookup<>( String symbol=, symbol:String=, int line=, line:int=, int column=, column:int=, ):Signal

Emitted when the user has clicked on a valid symbol.

 Signal symbol_validate<>( String symbol=, symbol:String=, ):Signal

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.

 Enum CodeCompletionKind<>():Enum

KIND_CLASS = 0

Marks the option as a class.


KIND_FUNCTION = 1

Marks the option as a function.


KIND_SIGNAL = 2

Marks the option as a Godot signal.


KIND_VARIABLE = 3

Marks the option as a variable.


KIND_MEMBER = 4

Marks the option as a member.


KIND_ENUM = 5

Marks the option as an enum entry.


KIND_CONSTANT = 6

Marks the option as a constant.


KIND_NODE_PATH = 7

Marks the option as a Godot node path.


KIND_FILE_PATH = 8

Marks the option as a file path.


KIND_PLAIN_TEXT = 9

Marks the option as unclassified or plain text.

 Enum CodeCompletionLocation<>():Enum

LOCATION_LOCAL = 0

The 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 = 256

The 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 = 512

The option is from user code which is not local and not in a derived class (e.g. Autoload Singletons).


LOCATION_OTHER = 1024

The option is from other engine code, not covered by the other enum constants - e.g. built-in classes.

 bool auto_brace_completion_enabled<>():bool

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.

 bool auto_brace_completion_highlight_matching<>():bool

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.

 Dictionary auto_brace_completion_pairs<>():Dictionary

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.

 bool code_completion_enabled<>():bool

If true, the ProjectSettings.input/ui_text_completion_query action requests code completion. To handle it, see _request_code_completion() or code_completion_requested.

 Array code_completion_prefixes<>():Array

Sets prefixes that will trigger code completion.

 Array delimiter_comments<>():Array

Sets the comment delimiters. All existing comment delimiters will be removed.

 Array delimiter_strings<>():Array

Sets the string delimiters. All existing string delimiters will be removed.

 bool gutters_draw_bookmarks<>():bool

If true, bookmarks are drawn in the gutter. This gutter is shared with breakpoints and executing lines. See set_line_as_bookmarked().

 bool gutters_draw_breakpoints_gutter<>():bool

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

 bool gutters_draw_executing_lines<>():bool

If true, executing lines are marked in the gutter. This gutter is shared with breakpoints and bookmarks. See set_line_as_executing().

 bool gutters_draw_fold_gutter<>():bool

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.

 bool gutters_draw_line_numbers<>():bool

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.

 bool gutters_zero_pad_line_numbers<>():bool

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.

 bool indent_automatic<>():bool

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

 Array indent_automatic_prefixes<>():Array

Prefixes to trigger an automatic indent. Used when indent_automatic is set to true.

 int indent_size<>():int

Size of the tabulation indent (one Tab press) in characters. If indent_use_spaces is enabled the number of spaces to use.

 bool indent_use_spaces<>():bool

Use spaces instead of tabs for indentation.

 bool line_folding<>():bool

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.

 Array line_length_guidelines<>():Array

Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is draw more prominently.

 bool symbol_lookup_on_click<>():bool

Set when a validated word from symbol_validate is clicked, the symbol_lookup should be emitted.

 bool symbol_tooltip_on_hover<>():bool

Set when a word is hovered, the symbol_hovered should be emitted.

 void _confirm_code_completion<>( bool replace=, replace:bool=, ):void

Override this method to define how the selected entry should be inserted. If replace is true, any existing text should be replaced.

 Array _filter_code_completion_candidates<>( =, :=, ):Array

Override this method to define what items in candidates should be displayed.

Both candidates and the return is a Array of Dictionary, see get_code_completion_option() for Dictionary content.

 void _request_code_completion<>( bool force=, force:bool=, ):void

Override this method to define what happens when the user requests code completion. If force is true, any checks should be bypassed.

 void add_auto_brace_completion_pair<>( String start_key=, start_key:String=, String end_key=, end_key:String=, ):void

Adds a brace pair.

Both the start and end keys must be symbols. Only the start key has to be unique.

 void add_code_completion_option<>( =, :=, =, :=, =, :=, =, :=, ):void

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.

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

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.

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

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.

 bool can_fold_line<>( int line=, line:int=, ):bool

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

 void cancel_code_completion<>():void

Cancels the autocomplete menu.

 void clear_bookmarked_lines<>():void

Clears all bookmarked lines.

 void clear_breakpointed_lines<>():void

Clears all breakpointed lines.

 void clear_comment_delimiters<>():void

Removes all comment delimiters.

 void clear_executing_lines<>():void

Clears all executed lines.

 void clear_string_delimiters<>():void

Removes all string delimiters.

 void confirm_code_completion<>( bool replace=false, replace:bool=false, ):void

Inserts the selected entry into the text. If replace is true, any existing text is replaced rather than merged.

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

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.

 void create_code_region<>():void

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)

 void delete_lines<>():void

Deletes all lines that are selected or have a caret on them.

 void do_indent<>():void

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.

 void duplicate_lines<>():void

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.

 void duplicate_selection<>():void

Duplicates all selected text and duplicates all lines with a caret on them.

 void fold_all_lines<>():void

Folds all lines that are possible to be folded (see can_fold_line()).

 void fold_line<>( int line=, line:int=, ):void

Folds the given line, if possible (see can_fold_line()).

 String get_auto_brace_completion_close_key<>( String open_key=, open_key:String=, ):String

Gets the matching auto brace close key for open_key.

 PackedInt32Array get_bookmarked_lines<>():PackedInt32Array

Gets all bookmarked lines.

 PackedInt32Array get_breakpointed_lines<>():PackedInt32Array

Gets all breakpointed lines.

 Dictionary get_code_completion_option<>( int index=, index:int=, ):Dictionary

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.

 Array get_code_completion_options<>():Array

Gets all completion options, see get_code_completion_option() for return content.

 int get_code_completion_selected_index<>():int

Gets the index of the current selected completion option.

 String get_code_region_end_tag<>():String

Returns the code region end tag (without comment delimiter).

 String get_code_region_start_tag<>():String

Returns the code region start tag (without comment delimiter).

 String get_delimiter_end_key<>( int delimiter_index=, delimiter_index:int=, ):String

Gets the end key for a string or comment region index.

 Vector2 get_delimiter_end_position<>( int line=, line:int=, int column=, column:int=, ):Vector2

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.

 String get_delimiter_start_key<>( int delimiter_index=, delimiter_index:int=, ):String

Gets the start key for a string or comment region index.

 Vector2 get_delimiter_start_position<>( int line=, line:int=, int column=, column:int=, ):Vector2

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.

 PackedInt32Array get_executing_lines<>():PackedInt32Array

Gets all executing lines.

 Array get_folded_lines<>():Array

Returns all lines that are currently folded.

 String get_text_for_code_completion<>():String

Returns the full text with char 0xFFFF at the caret location.

 String get_text_for_symbol_lookup<>():String

Returns the full text with char 0xFFFF at the cursor location.

 String get_text_with_cursor_char<>( int line=, line:int=, int column=, column:int=, ):String

Returns the full text with char 0xFFFF at the specified location.

 bool has_auto_brace_completion_close_key<>( String close_key=, close_key:String=, ):bool

Returns true if close key close_key exists.

 bool has_auto_brace_completion_open_key<>( String open_key=, open_key:String=, ):bool

Returns true if open key open_key exists.

 bool has_comment_delimiter<>( String start_key=, start_key:String=, ):bool

Returns true if comment start_key exists.

 bool has_string_delimiter<>( String start_key=, start_key:String=, ):bool

Returns true if string start_key exists.

 void indent_lines<>():void

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

 int is_in_comment<>( int line=, line:int=, int column=-1, column:int=-1, ):int

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.

 int is_in_string<>( int line=, line:int=, int column=-1, column:int=-1, ):int

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.

 bool is_line_bookmarked<>( int line=, line:int=, ):bool

Returns true if the given line is bookmarked. See set_line_as_bookmarked().

 bool is_line_breakpointed<>( int line=, line:int=, ):bool

Returns true if the given line is breakpointed. See set_line_as_breakpoint().

 bool is_line_code_region_end<>( int line=, line:int=, ):bool

Returns true if the given line is a code region end. See set_code_region_tags().

 bool is_line_code_region_start<>( int line=, line:int=, ):bool

Returns true if the given line is a code region start. See set_code_region_tags().

 bool is_line_executing<>( int line=, line:int=, ):bool

Returns true if the given line is marked as executing. See set_line_as_executing().

 bool is_line_folded<>( int line=, line:int=, ):bool

Returns true if the given line is folded. See fold_line().

 void move_lines_down<>():void

Moves all lines down that are selected or have a caret on them.

 void move_lines_up<>():void

Moves all lines up that are selected or have a caret on them.

 void remove_comment_delimiter<>( String start_key=, start_key:String=, ):void

Removes the comment delimiter with start_key.

 void remove_string_delimiter<>( String start_key=, start_key:String=, ):void

Removes the string delimiter with start_key.

 void request_code_completion<>( bool force=false, force:bool=false, ):void

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.

 void set_code_completion_selected_index<>( int index=, index:int=, ):void

Sets the current selected completion option.

 void set_code_hint<>( String code_hint=, code_hint:String=, ):void

Sets the code hint text. Pass an empty string to clear.

 void set_code_hint_draw_below<>( bool draw_below=, draw_below:bool=, ):void

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

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

Sets the code region start and end tags (without comment delimiter).

 void set_line_as_bookmarked<>( int line=, line:int=, bool bookmarked=, bookmarked:bool=, ):void

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

 void set_line_as_breakpoint<>( int line=, line:int=, bool breakpointed=, breakpointed:bool=, ):void

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

 void set_line_as_executing<>( int line=, line:int=, bool executing=, executing:bool=, ):void

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

 void set_symbol_lookup_word_as_valid<>( bool valid=, valid:bool=, ):void

Sets the symbol emitted by symbol_validate as a valid lookup.

 void toggle_foldable_line<>( int line=, line:int=, ):void

Toggle the folding of the code block at the given line.

 void toggle_foldable_lines_at_carets<>():void

Toggle the folding of the code block on all lines with a caret on them.

 void unfold_all_lines<>():void

Unfolds all lines that are folded.

 void unfold_line<>( int line=, line:int=, ):void

Unfolds the given line if it is folded or if it is hidden under a folded line.

 void unindent_lines<>():void

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

 void update_code_completion_options<>( bool force=, force:bool=, ):void

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.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...