godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/ScriptEditor.xml

83 lines
3.2 KiB
XML
Raw Normal View History

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-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="ScriptEditor" inherits="PanelContainer" version="4.0" 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-12 20:42:36 +00:00
<brief_description>
Add LOTS of missing docs
2020-03-03 18:21:21 +00: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-12 20:42:36 +00:00
</brief_description>
<description>
Document how some editor classes should be accessed as singletons only This closes #37687.
2020-04-14 20:09:21 +00: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-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
doc: Sync classref with current source
2020-07-15 06:43:21 +00: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 13:28:05 +00:00
<return type="ScriptEditorBase" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Returns the [ScriptEditorBase] object that the user is currently editing.
doc: Sync classref with current source
2020-07-15 06:43:21 +00: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-12 20:42:36 +00: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 13:28:05 +00: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-12 20:42:36 +00:00
<description>
Returns a [Script] that is currently active in editor.
</description>
</method>
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<method name="get_open_script_editors" qualifiers="const">
Replace Array return types with TypedArray 2
2022-08-05 18:35:08 +00:00
<return type="ScriptEditorBase[]" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Returns an array with all [ScriptEditorBase] objects which are currently open in editor.
doc: Sync classref with current source
2020-07-15 06:43:21 +00: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-12 20:42:36 +00:00
<method name="get_open_scripts" qualifiers="const">
Replace Array return types with TypedArray 2
2022-08-05 18:35:08 +00: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-12 20:42:36 +00: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-09 20:07:13 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00: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-09 20:07:13 +00:00
<description>
Goes to the specified line in the current script.
</description>
</method>
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00: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-16 19:34:16 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 02:00:19 +00: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-16 19:34:16 +00:00
</description>
</method>
doc: Sync classref with current source
2020-07-15 06:43:21 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00: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 06:43:21 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00: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 06:43:21 +00: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-12 20:42:36 +00:00
</methods>
<signals>
<signal name="editor_script_changed">
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00: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-12 20:42:36 +00: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-06 18:11:48 +00: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-12 20:42:36 +00: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>