Table of Contents

Class ScriptEditorBase

Base editor for editing scripts in the ScriptEditor.

Inheritance
ScriptEditorBase

Remarks

Base editor for editing scripts in the ScriptEditor. This does not include documentation items.

Methods

add_syntax_highlighter(EditorSyntaxHighlighter)

Adds a EditorSyntaxHighlighter to the open script.

void add_syntax_highlighter(EditorSyntaxHighlighter highlighter)

Parameters

highlighter EditorSyntaxHighlighter

get_base_editor

Qualifiers: const

Returns the underlying Control used for editing scripts. For text scripts, this is a CodeEdit.

Control get_base_editor

Events

edited_script_changed

Emitted after script validation.

signal edited_script_changed

go_to_help(String)

Emitted when the user requests a specific documentation page.

signal go_to_help(String what)

Parameters

what String

go_to_method(Object, String)

Emitted when the user requests to view a specific method of a script, similar to ScriptEditorBase.request_open_script_at_line.

signal go_to_method(Object script, String method)

Parameters

script Object
method String

name_changed

Emitted after script validation or when the edited resource has changed.

signal name_changed

replace_in_files_requested(String)

Emitted when the user request to find and replace text in the file system.

signal replace_in_files_requested(String text)

Parameters

text String

request_help(String)

Emitted when the user requests contextual help.

signal request_help(String topic)

Parameters

topic String

request_open_script_at_line(Object, int)

Emitted when the user requests to view a specific line of a script, similar to ScriptEditorBase.go_to_method.

signal request_open_script_at_line(Object script, int line)

Parameters

script Object
line int

request_save_history

Emitted when the user contextual goto and the item is in the same script.

signal request_save_history

request_save_previous_state(Dictionary)

Emitted when the user changes current script or moves caret by 10 or more columns within the same script.

signal request_save_previous_state(Dictionary state)

Parameters

state Dictionary

search_in_files_requested(String)

Emitted when the user request to search text in the file system.

signal search_in_files_requested(String text)

Parameters

text String