summaryrefslogtreecommitdiff
path: root/doc/classes/ScriptCreateDialog.xml
blob: 402c11677a8e48b1cd710d32a1d76c48a94e1a15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ScriptCreateDialog" inherits="ConfirmationDialog" category="Core" version="3.2">
	<brief_description>
		The Editor's popup dialog for creating new [Script] files.
	</brief_description>
	<description>
		The [code]ScriptCreateDialog[/code] 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>
	<demos>
	</demos>
	<methods>
		<method name="config">
			<return type="void">
			</return>
			<argument index="0" name="inherits" type="String">
			</argument>
			<argument index="1" name="path" type="String">
			</argument>
			<argument index="2" name="built_in_enabled" type="bool" default="true">
			</argument>
			<description>
				Prefills required fields to configure the ScriptCreateDialog for use.
			</description>
		</method>
	</methods>
	<signals>
		<signal name="script_created">
			<argument index="0" name="script" type="Script">
			</argument>
			<description>
				Emitted when the user clicks the OK button.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>