7adf4cc9b5
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.
56 lines
2.0 KiB
XML
56 lines
2.0 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="ScriptCreateDialog" inherits="ConfirmationDialog" version="4.0">
|
|
<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 Window.popup] methods.
|
|
[codeblocks]
|
|
[gdscript]
|
|
func _ready():
|
|
var dialog = ScriptCreateDialog.new();
|
|
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()
|
|
[/gdscript]
|
|
[csharp]
|
|
public override void _Ready()
|
|
{
|
|
var dialog = new ScriptCreateDialog();
|
|
dialog.Config("Node", "res://NewNode.cs"); // For in-engine types.
|
|
dialog.Config("\"res://BaseNode.cs\"", "res://DerivedNode.cs"); // For script types.
|
|
dialog.PopupCentered();
|
|
}
|
|
[/csharp]
|
|
[/codeblocks]
|
|
</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" override="true" default="false" />
|
|
<member name="title" type="String" setter="set_title" getter="get_title" override="true" default=""Attach Node Script"" />
|
|
</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>
|