asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/ScriptEditor.xml

92 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 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 3.6-beta
2022-08-05 18:51:38 +02:00
<class name="ScriptEditor" inherits="PanelContainer" version="3.6" 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 22:42:36 +02:00
<brief_description>
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01: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 22:42:36 +02:00
</brief_description>
<description>
Document how some editor classes should be accessed as singletons only This closes #37687. (cherry picked from commit a225265b0a7308f0856c953f57168c490d54995e)
2020-04-14 22:09:21 +02: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 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<methods>
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
<method name="can_drop_data_fw" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="point" type="Vector2" />
<argument index="1" name="data" type="Variant" />
<argument index="2" name="from" type="Control" />
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
<description>
</description>
</method>
<method name="drop_data_fw">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="point" type="Vector2" />
<argument index="1" name="data" type="Variant" />
<argument index="2" name="from" type="Control" />
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
<description>
</description>
</method>
Expose the TextEdit control of the script editor Refactor ScriptEditor and ScriptTextEditor with added method to retrieve the script editor's TextEdit control. Update doc/classes/ScriptEditor.xml script_editor_plugin.cpp script_editor_plugin.h script_text_editor.cpp script_text_editor.h
2023-06-09 15:07:38 +02:00
<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>
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 22:42:36 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02: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 22:42:36 +02:00
<description>
Returns a [Script] that is currently active in editor.
</description>
</method>
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
<method name="get_drag_data_fw">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Variant" />
<argument index="0" name="point" type="Vector2" />
<argument index="1" name="from" type="Control" />
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
<description>
</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 22:42:36 +02:00
<method name="get_open_scripts" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
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 22:42:36 +02: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 22:07:13 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="line_number" type="int" />
Bind goto_line function for Script Editor #9153 - added doc for ScriptEditor:goto_line
2019-04-09 22:07:13 +02:00
<description>
Goes to the specified line in the current script.
</description>
</method>
Bind TextEdit.deselect and update documentation
2017-12-16 20:34:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="base_name" type="String" />
<argument index="1" name="base_path" type="String" />
Bind TextEdit.deselect and update documentation
2017-12-16 20:34:16 +01:00
<description>
add description for ScriptEditor.open_script_create_dialog() (cherry picked from commit adb205a15094b8c4d0ee1f3d105e7d221ccd64bd)
2020-09-18 23:27:40 +02: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.
Bind TextEdit.deselect and update documentation
2017-12-16 20:34:16 +01:00
</description>
</method>
VCS: Add push, pull, fetch and improved diff view to VCS UI This commit was created by merging the commits presented in #39255 for the GSoC 2020 VCS Improvement project VCS: Make EditorVCSInterface store less amount of internal state VCS: Add force push checkbox + more frequent VCS updates Add force push checkbox in the Commit dock. Also add some missing opportunities for checking the VCS state again on from UI inputs VCS: Fix script contents not being updated on merge conflict VCS: Add branch creation VCS interface calls VCS: Add VCS remote creation and remote selection menus VCS: Show more commit information + Fix truncated commit offsets VCS: Make VCS less noisy + Fix diff view refreshes VCS: Fix mismatched argument names in VCS helpers VCS: Add SSH transport support for remote operations Also, moves the editor's VCS settings registrations to project_settings.cpp and editor_settings.cpp VCS: Change TTR() to vformat() for branch and remote removal text VCS: Add VCS branch icon instead of using Tree node icon Co-authored-by: @ChronicallySerious
2020-06-25 11:59:31 +02:00
<method name="reload_scripts">
<return type="void" />
<description>
Reload all currently opened scripts from disk in case the file contents are newer.
</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 22:42:36 +02:00
</methods>
<signals>
<signal name="editor_script_changed">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<argument 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 22:42:36 +02:00
<description>
Emitted when user changed active script. Argument is a freshly activated [Script].
</description>
</signal>
<signal name="script_close">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<argument 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 22:42:36 +02: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>
<constants>
</constants>
</class>
Reference in a new issue Copy permalink