virtualx-engine/doc/classes/ScriptEditor.xml

128 lines
3.6 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 02:03:48 +01:00
<class name="ScriptEditor" inherits="PanelContainer" version="4.0">
<brief_description>
2020-03-03 19:21:21 +01:00
Godot editor's script editor.
</brief_description>
<description>
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_script_editor].
</description>
<tutorials>
</tutorials>
<methods>
2017-11-15 20:35:18 +01:00
<method name="can_drop_data_fw" qualifiers="const">
<return type="bool">
</return>
2018-01-03 13:45:03 +01:00
<argument index="0" name="point" type="Vector2">
2017-11-15 20:35:18 +01:00
</argument>
2018-01-03 13:45:03 +01:00
<argument index="1" name="data" type="Variant">
2017-11-15 20:35:18 +01:00
</argument>
2018-01-03 13:45:03 +01:00
<argument index="2" name="from" type="Control">
2017-11-15 20:35:18 +01:00
</argument>
<description>
</description>
</method>
<method name="drop_data_fw">
<return type="void">
</return>
2018-01-03 13:45:03 +01:00
<argument index="0" name="point" type="Vector2">
2017-11-15 20:35:18 +01:00
</argument>
2018-01-03 13:45:03 +01:00
<argument index="1" name="data" type="Variant">
2017-11-15 20:35:18 +01:00
</argument>
2018-01-03 13:45:03 +01:00
<argument index="2" name="from" type="Control">
2017-11-15 20:35:18 +01:00
</argument>
<description>
</description>
</method>
2020-07-15 08:43:21 +02:00
<method name="get_current_editor" qualifiers="const">
<return type="ScriptEditorBase">
</return>
<description>
</description>
</method>
<method name="get_current_script">
<return type="Script">
</return>
<description>
Returns a [Script] that is currently active in editor.
</description>
</method>
2017-11-15 20:35:18 +01:00
<method name="get_drag_data_fw">
<return type="Variant">
</return>
2018-01-03 13:45:03 +01:00
<argument index="0" name="point" type="Vector2">
2017-11-15 20:35:18 +01:00
</argument>
2018-01-03 13:45:03 +01:00
<argument index="1" name="from" type="Control">
2017-11-15 20:35:18 +01:00
</argument>
<description>
</description>
</method>
2020-07-15 08:43:21 +02:00
<method name="get_open_script_editors" qualifiers="const">
<return type="Array">
</return>
<description>
</description>
</method>
<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>
<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>
<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>
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.
</description>
</method>
2020-07-15 08:43:21 +02:00
<method name="register_syntax_highlighter">
<return type="void">
</return>
<argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter">
</argument>
<description>
</description>
</method>
<method name="unregister_syntax_highlighter">
<return type="void">
</return>
<argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter">
</argument>
<description>
</description>
</method>
</methods>
<signals>
<signal name="editor_script_changed">
2018-08-31 21:12:35 +02:00
<argument index="0" name="script" type="Script">
</argument>
<description>
Emitted when user changed active script. Argument is a freshly activated [Script].
</description>
</signal>
<signal name="script_close">
2018-08-31 21:12:35 +02:00
<argument index="0" name="script" type="Script">
</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>