virtualx-engine/doc/classes/ScriptCreateDialog.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ScriptCreateDialog" inherits="ConfirmationDialog" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		The Editor's popup dialog for creating new [Script] files.
	</brief_description>
	<description>
		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.
		[codeblock]
		func _ready():
		    dialog.config("Node", "res://new_node.gd") # For in-engine types
		    dialog.config("\"res://base_node.gd\"", "res://derived_node.gd") # For script types
		    dialog.popup_centered()
		[/codeblock]
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="config">
			<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" />
			<description>
				Prefills required fields to configure the ScriptCreateDialog for use.
			</description>
		</method>
	</methods>
	<members>
		<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;" />
	</members>
	<signals>
		<signal name="script_created">
			<argument index="0" name="script" type="Script" />
			<description>
				Emitted when the user clicks the OK button.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>
Expose ScriptCreateDialog to EditorPlugin 2018-06-30 05:08:28 +02: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-03-16 23:01:02 +01:00			`<class name="ScriptCreateDialog" inherits="ConfirmationDialog" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Expose ScriptCreateDialog to EditorPlugin 2018-06-30 05:08:28 +02: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 23:37:35 +01: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 05:08:28 +02: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-22 01:04:47 +02: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 09:37:19 +01:00			`dialog.popup_centered()`
Expose ScriptCreateDialog to EditorPlugin 2018-06-30 05:08:28 +02: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 15:28:05 +02: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 05:08:28 +02:00			`<description>`
			`Prefills required fields to configure the ScriptCreateDialog for use.`
			`</description>`
			`</method>`
			`</methods>`
Run doctool after overridden properties changes 2019-09-03 12:44:58 +02:00			`<members>`
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com> 2021-12-02 21:15:17 +01: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=""Attach Node Script"" />`
Run doctool after overridden properties changes 2019-09-03 12:44:58 +02:00			`</members>`
Expose ScriptCreateDialog to EditorPlugin 2018-06-30 05:08:28 +02: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 15:28:05 +02:00			`<argument index="0" name="script" type="Script" />`
Expose ScriptCreateDialog to EditorPlugin 2018-06-30 05:08:28 +02:00			`<description>`
			`Emitted when the user clicks the OK button.`
			`</description>`
			`</signal>`
			`</signals>`
			`<constants>`
			`</constants>`
			`</class>`