ScriptEditorBase
Inherits: VBoxContainer < BoxContainer < Container < Control < CanvasItem < Actor < Object
Base editor for editing scripts in the ScriptEditor.
Description
Section titled “Description”Base editor for editing scripts in the ScriptEditor. This does not include documentation items.
Methods
Section titled “Methods”| Returns | Method |
|---|---|
| void | add_syntax_highlighter(highlighter) |
| Control | get_base_editor() |
Signals
Section titled “Signals”edited_script_changed
Section titled “edited_script_changed”edited_script_changed()Emitted after script validation.
go_to_help
Section titled “go_to_help”go_to_help(what: String)Emitted when the user requests a specific documentation page.
go_to_method
Section titled “go_to_method”go_to_method(script: Object, method: String)Emitted when the user requests to view a specific method of a script, similar to request_open_script_at_line.
name_changed
Section titled “name_changed”name_changed()Emitted after script validation or when the edited resource has changed.
replace_in_files_requested
Section titled “replace_in_files_requested”replace_in_files_requested(text: String)Emitted when the user request to find and replace text in the file system.
request_help
Section titled “request_help”request_help(topic: String)Emitted when the user requests contextual help.
request_open_script_at_line
Section titled “request_open_script_at_line”request_open_script_at_line(script: Object, line: int)Emitted when the user requests to view a specific line of a script, similar to go_to_method.
request_save_history
Section titled “request_save_history”request_save_history()Emitted when the user contextual goto and the item is in the same script.
request_save_previous_state
Section titled “request_save_previous_state”request_save_previous_state(state: Dictionary)Emitted when the user changes current script or moves caret by 10 or more columns within the same script.
search_in_files_requested
Section titled “search_in_files_requested”search_in_files_requested(text: String)Emitted when the user request to search text in the file system.
Method descriptions
Section titled “Method descriptions”add_syntax_highlighter
Section titled “add_syntax_highlighter”void add_syntax_highlighter(highlighter: EditorSyntaxHighlighter)
Adds an EditorSyntaxHighlighter to the open script.
get_base_editor
Section titled “get_base_editor”Control get_base_editor() const
Returns the underlying Control used for editing scripts. For text scripts, this is a CodeEdit.