2020-07-15 14:43:21 +08:00
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
2023-07-06 04:07:03 +08:00
|
|
|
<class name="ScriptEditorBase" inherits="VBoxContainer" version="4.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
2020-07-15 14:43:21 +08:00
|
|
|
<brief_description>
|
2020-10-12 00:07:33 +08:00
|
|
|
Base editor for editing scripts in the [ScriptEditor].
|
2020-07-15 14:43:21 +08:00
|
|
|
</brief_description>
|
|
|
|
<description>
|
2023-04-30 22:26:09 +08:00
|
|
|
Base editor for editing scripts in the [ScriptEditor]. This does not include documentation items.
|
2020-07-15 14:43:21 +08:00
|
|
|
</description>
|
|
|
|
<tutorials>
|
|
|
|
</tutorials>
|
|
|
|
<methods>
|
2021-10-12 01:13:31 +08:00
|
|
|
<method name="add_syntax_highlighter">
|
|
|
|
<return type="void" />
|
2022-08-07 02:11:48 +08:00
|
|
|
<param index="0" name="highlighter" type="EditorSyntaxHighlighter" />
|
2021-10-12 01:13:31 +08:00
|
|
|
<description>
|
|
|
|
Adds a [EditorSyntaxHighlighter] to the open script.
|
|
|
|
</description>
|
|
|
|
</method>
|
2021-05-14 03:50:25 +08:00
|
|
|
<method name="get_base_editor" qualifiers="const">
|
2021-07-30 21:28:05 +08:00
|
|
|
<return type="Control" />
|
2021-05-14 03:50:25 +08:00
|
|
|
<description>
|
2022-09-20 01:28:11 +08:00
|
|
|
Returns the underlying [Control] used for editing scripts. For text scripts, this is a [CodeEdit].
|
2021-05-14 03:50:25 +08:00
|
|
|
</description>
|
|
|
|
</method>
|
2020-07-15 14:43:21 +08:00
|
|
|
</methods>
|
|
|
|
<signals>
|
|
|
|
<signal name="edited_script_changed">
|
|
|
|
<description>
|
2022-09-20 01:28:11 +08:00
|
|
|
Emitted after script validation.
|
2020-07-15 14:43:21 +08:00
|
|
|
</description>
|
|
|
|
</signal>
|
|
|
|
<signal name="go_to_help">
|
2022-08-07 02:11:48 +08:00
|
|
|
<param index="0" name="what" type="String" />
|
2020-07-15 14:43:21 +08:00
|
|
|
<description>
|
2020-10-12 00:07:33 +08:00
|
|
|
Emitted when the user requests a specific documentation page.
|
2020-07-15 14:43:21 +08:00
|
|
|
</description>
|
|
|
|
</signal>
|
2022-09-09 22:36:07 +08:00
|
|
|
<signal name="go_to_method">
|
|
|
|
<param index="0" name="script" type="Object" />
|
|
|
|
<param index="1" name="method" type="String" />
|
|
|
|
<description>
|
|
|
|
Emitted when the user requests to view a specific method of a script, similar to [signal request_open_script_at_line].
|
|
|
|
</description>
|
|
|
|
</signal>
|
2020-07-15 14:43:21 +08:00
|
|
|
<signal name="name_changed">
|
|
|
|
<description>
|
2022-09-20 01:28:11 +08:00
|
|
|
Emitted after script validation or when the edited resource has changed.
|
2020-07-15 14:43:21 +08:00
|
|
|
</description>
|
|
|
|
</signal>
|
|
|
|
<signal name="replace_in_files_requested">
|
2022-08-07 02:11:48 +08:00
|
|
|
<param index="0" name="text" type="String" />
|
2020-07-15 14:43:21 +08:00
|
|
|
<description>
|
2022-09-20 01:28:11 +08:00
|
|
|
Emitted when the user request to find and replace text in the file system.
|
2020-07-15 14:43:21 +08:00
|
|
|
</description>
|
|
|
|
</signal>
|
|
|
|
<signal name="request_help">
|
2022-08-07 02:11:48 +08:00
|
|
|
<param index="0" name="topic" type="String" />
|
2020-07-15 14:43:21 +08:00
|
|
|
<description>
|
2020-10-12 00:07:33 +08:00
|
|
|
Emitted when the user requests contextual help.
|
2020-07-15 14:43:21 +08:00
|
|
|
</description>
|
|
|
|
</signal>
|
|
|
|
<signal name="request_open_script_at_line">
|
2022-08-07 02:11:48 +08:00
|
|
|
<param index="0" name="script" type="Object" />
|
|
|
|
<param index="1" name="line" type="int" />
|
2020-07-15 14:43:21 +08:00
|
|
|
<description>
|
2022-09-09 22:36:07 +08:00
|
|
|
Emitted when the user requests to view a specific line of a script, similar to [signal go_to_method].
|
2020-07-15 14:43:21 +08:00
|
|
|
</description>
|
|
|
|
</signal>
|
|
|
|
<signal name="request_save_history">
|
|
|
|
<description>
|
2020-10-12 00:07:33 +08:00
|
|
|
Emitted when the user contextual goto and the item is in the same script.
|
2020-07-15 14:43:21 +08:00
|
|
|
</description>
|
|
|
|
</signal>
|
|
|
|
<signal name="search_in_files_requested">
|
2022-08-07 02:11:48 +08:00
|
|
|
<param index="0" name="text" type="String" />
|
2020-07-15 14:43:21 +08:00
|
|
|
<description>
|
2022-09-20 01:28:11 +08:00
|
|
|
Emitted when the user request to search text in the file system.
|
2020-07-15 14:43:21 +08:00
|
|
|
</description>
|
|
|
|
</signal>
|
|
|
|
</signals>
|
|
|
|
</class>
|