godot/doc/classes/ScriptEditor.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ScriptEditor" inherits="PanelContainer" version="4.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Godot editor's script editor.
	</brief_description>
	<description>
		Godot editor's script editor.
		[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="get_current_editor" qualifiers="const">
			<return type="ScriptEditorBase" />
			<description>
				Returns the [ScriptEditorBase] object that the user is currently editing.
			</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_open_script_editors" qualifiers="const">
			<return type="ScriptEditorBase[]" />
			<description>
				Returns an array with all [ScriptEditorBase] objects which are currently open in editor.
			</description>
		</method>
		<method name="get_open_scripts" qualifiers="const">
			<return type="Script[]" />
			<description>
				Returns an array with all [Script] objects which are currently open in editor.
			</description>
		</method>
		<method name="goto_line">
			<return type="void" />
			<param 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" />
			<param index="0" name="base_name" type="String" />
			<param index="1" name="base_path" type="String" />
			<description>
				Opens the script create dialog. The script will extend [param base_name]. The file extension can be omitted from [param base_path]. It will be added based on the selected scripting language.
			</description>
		</method>
		<method name="register_syntax_highlighter">
			<return type="void" />
			<param index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter" />
			<description>
				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.
			</description>
		</method>
		<method name="unregister_syntax_highlighter">
			<return type="void" />
			<param index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter" />
			<description>
				Unregisters the [EditorSyntaxHighlighter] from the editor.
				[b]Note:[/b] The [EditorSyntaxHighlighter] will still be applied to scripts that are already opened.
			</description>
		</method>
	</methods>
	<signals>
		<signal name="editor_script_changed">
			<param 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">
			<param 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>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Bump version to 4.2-dev Keep on waitin' 2023-07-06 04:07:03 +08:00			`<class name="ScriptEditor" inherits="PanelContainer" version="4.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<brief_description>`
Add LOTS of missing docs 2020-03-04 02:21:21 +08:00			`Godot editor's script editor.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</brief_description>`
			`<description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 22:26:09 +08:00			`Godot editor's script editor.`
Document how some editor classes should be accessed as singletons only This closes #37687. 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].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<method name="get_current_editor" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="ScriptEditorBase" />`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<description>`
Update SyntaxHighlighter documentation 2020-10-12 00:07:33 +08:00			`Returns the [ScriptEditorBase] object that the user is currently editing.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`</method>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<method name="get_current_script">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="Script" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<description>`
			`Returns a [Script] that is currently active in editor.`
			`</description>`
			`</method>`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<method name="get_open_script_editors" qualifiers="const">`
Replace Array return types with TypedArray 2 2022-08-06 02:35:08 +08:00			`<return type="ScriptEditorBase[]" />`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<description>`
Update SyntaxHighlighter documentation 2020-10-12 00:07:33 +08:00			`Returns an array with all [ScriptEditorBase] objects which are currently open in editor.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`</method>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<method name="get_open_scripts" qualifiers="const">`
Replace Array return types with TypedArray 2 2022-08-06 02:35:08 +08:00			`<return type="Script[]" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<description>`
			`Returns an array with all [Script] objects which are currently open in editor.`
			`</description>`
			`</method>`
Bind goto_line function for Script Editor #9153 - added doc for ScriptEditor:goto_line 2019-04-10 04:07:13 +08:00			`<method name="goto_line">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="line_number" type="int" />`
Bind goto_line function for Script Editor #9153 - added doc for ScriptEditor:goto_line 2019-04-10 04:07:13 +08:00			`<description>`
			`Goes to the specified line in the current script.`
			`</description>`
			`</method>`
Bind TextEdit.deselect and update documentation 2017-12-17 03:34:16 +08:00			`<method name="open_script_create_dialog">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="base_name" type="String" />`
			`<param index="1" name="base_path" type="String" />`
Bind TextEdit.deselect and update documentation 2017-12-17 03:34:16 +08:00			`<description>`
[doc] Use "param" instead of "code" to refer to parameters #3 2022-08-10 10:00:19 +08:00			`Opens the script create dialog. The script will extend [param base_name]. The file extension can be omitted from [param base_path]. It will be added based on the selected scripting language.`
Bind TextEdit.deselect and update documentation 2017-12-17 03:34:16 +08:00			`</description>`
			`</method>`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<method name="register_syntax_highlighter">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter" />`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<description>`
Update SyntaxHighlighter documentation 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.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`</method>`
			`<method name="unregister_syntax_highlighter">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter" />`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`<description>`
Update SyntaxHighlighter documentation 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.`
doc: Sync classref with current source 2020-07-15 14:43:21 +08:00			`</description>`
			`</method>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</methods>`
			`<signals>`
			`<signal name="editor_script_changed">`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="script" type="Script" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<description>`
			`Emitted when user changed active script. Argument is a freshly activated [Script].`
			`</description>`
			`</signal>`
			`<signal name="script_close">`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="script" type="Script" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<description>`
			`Emitted when editor is about to close the active script. Argument is a [Script] that is going to be closed.`
			`</description>`
			`</signal>`
			`</signals>`
			`</class>`