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

47 lines
2.2 KiB
XML
Raw Normal View History

Expose ScriptCreateDialog to EditorPlugin
2018-06-30 03:08:28 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 3.6-beta
2022-08-05 16:51:38 +00:00
<class name="ScriptCreateDialog" inherits="ConfirmationDialog" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Expose ScriptCreateDialog to EditorPlugin
2018-06-30 03:08:28 +00:00
<brief_description>
The Editor's popup dialog for creating new [Script] files.
</brief_description>
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
The [ScriptCreateDialog] creates script files according to a given template for a given scripting language. The standard use is to configure its fields prior to calling one of the [method Popup.popup] methods.
Expose ScriptCreateDialog to EditorPlugin
2018-06-30 03:08:28 +00:00
[codeblock]
func _ready():
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
dialog.config("Node", "res://new_node.gd") # For in-engine types
dialog.config("\"res://base_node.gd\"", "res://derived_node.gd") # For script types
doc: Fix formatting in code blocks
2018-12-14 08:37:19 +00:00
dialog.popup_centered()
Expose ScriptCreateDialog to EditorPlugin
2018-06-30 03:08:28 +00:00
[/codeblock]
</description>
<tutorials>
</tutorials>
<methods>
<method name="config">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="inherits" type="String" />
<argument index="1" name="path" type="String" />
<argument index="2" name="built_in_enabled" type="bool" default="true" />
<argument index="3" name="load_enabled" type="bool" default="true" />
Expose ScriptCreateDialog to EditorPlugin
2018-06-30 03:08:28 +00:00
<description>
Prefills required fields to configure the ScriptCreateDialog for use.
</description>
</method>
</methods>
Run doctool after overridden properties changes
2019-09-03 10:44:58 +00:00
<members>
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 20:15:17 +00:00
<member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok" overrides="AcceptDialog" default="false" />
<member name="margin_bottom" type="float" setter="set_margin" getter="get_margin" overrides="Control" default="258.0" />
<member name="margin_right" type="float" setter="set_margin" getter="get_margin" overrides="Control" default="366.0" />
<member name="rect_size" type="Vector2" setter="_set_size" getter="get_size" overrides="Control" default="Vector2( 366, 258 )" />
<member name="window_title" type="String" setter="set_title" getter="get_title" overrides="WindowDialog" default="&quot;Attach Node Script&quot;" />
Run doctool after overridden properties changes
2019-09-03 10:44:58 +00:00
</members>
Expose ScriptCreateDialog to EditorPlugin
2018-06-30 03:08:28 +00:00
<signals>
<signal name="script_created">
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 13:28:05 +00:00
<argument index="0" name="script" type="Script" />
Expose ScriptCreateDialog to EditorPlugin
2018-06-30 03:08:28 +00:00
<description>
Emitted when the user clicks the OK button.
</description>
</signal>
</signals>
<constants>
</constants>
</class>