2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name= "ScriptEditor" inherits= "PanelContainer" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
2020-03-04 02:21:21 +08:00
Godot editor's script editor.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2020-04-15 04:09:21 +08:00
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_script_editor].
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
2020-07-15 14:43:21 +08:00
<method name= "get_current_editor" qualifiers= "const" >
<return type= "ScriptEditorBase" >
</return>
<description >
2020-10-12 00:07:33 +08:00
Returns the [ScriptEditorBase] object that the user is currently editing.
2020-07-15 14:43:21 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "get_current_script" >
<return type= "Script" >
</return>
<description >
Returns a [Script] that is currently active in editor.
</description>
</method>
2020-07-15 14:43:21 +08:00
<method name= "get_open_script_editors" qualifiers= "const" >
<return type= "Array" >
</return>
<description >
2020-10-12 00:07:33 +08:00
Returns an array with all [ScriptEditorBase] objects which are currently open in editor.
2020-07-15 14:43:21 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "get_open_scripts" qualifiers= "const" >
<return type= "Array" >
</return>
<description >
Returns an array with all [Script] objects which are currently open in editor.
</description>
</method>
2019-04-10 04:07:13 +08:00
<method name= "goto_line" >
<return type= "void" >
</return>
<argument index= "0" name= "line_number" type= "int" >
</argument>
<description >
Goes to the specified line in the current script.
</description>
</method>
2017-12-17 03:34:16 +08:00
<method name= "open_script_create_dialog" >
<return type= "void" >
</return>
<argument index= "0" name= "base_name" type= "String" >
</argument>
<argument index= "1" name= "base_path" type= "String" >
</argument>
<description >
2020-09-19 05:27:40 +08:00
Opens the script create dialog. The script will extend [code]base_name[/code]. The file extension can be omitted from [code]base_path[/code]. It will be added based on the selected scripting language.
2017-12-17 03:34:16 +08:00
</description>
</method>
2020-07-15 14:43:21 +08:00
<method name= "register_syntax_highlighter" >
<return type= "void" >
</return>
<argument index= "0" name= "syntax_highlighter" type= "EditorSyntaxHighlighter" >
</argument>
<description >
2020-10-12 00:07:33 +08:00
Registers the [EditorSyntaxHighlighter] to the editor, the [EditorSyntaxHighlighter] will be available on all open scripts.
[b]Note:[/b] Does not apply to scripts that are already opened.
2020-07-15 14:43:21 +08:00
</description>
</method>
<method name= "unregister_syntax_highlighter" >
<return type= "void" >
</return>
<argument index= "0" name= "syntax_highlighter" type= "EditorSyntaxHighlighter" >
</argument>
<description >
2020-10-12 00:07:33 +08:00
Unregisters the [EditorSyntaxHighlighter] from the editor.
[b]Note:[/b] The [EditorSyntaxHighlighter] will still be applied to scripts that are already opened.
2020-07-15 14:43:21 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
</methods>
<signals >
<signal name= "editor_script_changed" >
2018-09-01 03:12:35 +08:00
<argument index= "0" name= "script" type= "Script" >
2017-09-13 04:42:36 +08:00
</argument>
<description >
Emitted when user changed active script. Argument is a freshly activated [Script].
</description>
</signal>
<signal name= "script_close" >
2018-09-01 03:12:35 +08:00
<argument index= "0" name= "script" type= "Script" >
2017-09-13 04:42:36 +08:00
</argument>
<description >
Emitted when editor is about to close the active script. Argument is a [Script] that is going to be closed.
</description>
</signal>
</signals>
<constants >
</constants>
</class>
