1
0
mirror of https://github.com/godotengine/godot.git synced 2025-11-18 14:21:41 +00:00
Files
godot/doc/classes/ScriptEditor.xml
Rémi Verschelde 32ddd4f4e0 Doctool: Remove version attribute from XML header
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).

(cherry picked from commit 81064cc239)
2024-09-11 12:41:48 +02:00

92 lines
3.2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ScriptEditor" inherits="PanelContainer" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
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>
<method name="can_drop_data_fw" qualifiers="const">
<return type="bool" />
<argument index="0" name="point" type="Vector2" />
<argument index="1" name="data" type="Variant" />
<argument index="2" name="from" type="Control" />
<description>
</description>
</method>
<method name="drop_data_fw">
<return type="void" />
<argument index="0" name="point" type="Vector2" />
<argument index="1" name="data" type="Variant" />
<argument index="2" name="from" type="Control" />
<description>
</description>
</method>
<method name="get_base_editor" qualifiers="const">
<return type="Control" />
<description>
Returns the underlying [Control] used for editing scripts. For text scripts, this is a [TextEdit].
</description>
</method>
<method name="get_current_script">
<return type="Script" />
<description>
Returns a [Script] that is currently active in editor.
</description>
</method>
<method name="get_drag_data_fw">
<return type="Variant" />
<argument index="0" name="point" type="Vector2" />
<argument index="1" name="from" type="Control" />
<description>
</description>
</method>
<method name="get_open_scripts" qualifiers="const">
<return type="Array" />
<description>
Returns an array with all [Script] objects which are currently open in editor.
</description>
</method>
<method name="goto_line">
<return type="void" />
<argument index="0" name="line_number" type="int" />
<description>
Goes to the specified line in the current script.
</description>
</method>
<method name="open_script_create_dialog">
<return type="void" />
<argument index="0" name="base_name" type="String" />
<argument index="1" name="base_path" type="String" />
<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>
<method name="reload_scripts">
<return type="void" />
<description>
Reload all currently opened scripts from disk in case the file contents are newer.
</description>
</method>
</methods>
<signals>
<signal name="editor_script_changed">
<argument index="0" name="script" type="Script" />
<description>
Emitted when user changed active script. Argument is a freshly activated [Script].
</description>
</signal>
<signal name="script_close">
<argument index="0" name="script" type="Script" />
<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>