Sync classref with current source

This commit is contained in:
Rémi Verschelde
2018-08-21 00:37:52 +02:00
parent a438389c1f
commit 0ce22eb52b
249 changed files with 10123 additions and 1540 deletions

View File

@@ -0,0 +1,57 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ScriptCreateDialog.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ScriptCreateDialog:
ScriptCreateDialog
==================
**Inherits:** :ref:`ConfirmationDialog<class_confirmationdialog>` **<** :ref:`AcceptDialog<class_acceptdialog>` **<** :ref:`WindowDialog<class_windowdialog>` **<** :ref:`Popup<class_popup>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
The Editor's popup dialog for creating new :ref:`Script<class_script>` files.
Member Functions
----------------
+-------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`config<class_ScriptCreateDialog_config>` **(** :ref:`String<class_string>` inherits, :ref:`String<class_string>` path **)** |
+-------+-----------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_ScriptCreateDialog_script_created:
- **script_created** **(** :ref:`Object<class_object>` script **)**
Emitted when the user clicks the OK button.
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 a :ref:`popup<class_ScriptCreateDialog_popup>`() method.
::
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()
Member Function Description
---------------------------
.. _class_ScriptCreateDialog_config:
- void **config** **(** :ref:`String<class_string>` inherits, :ref:`String<class_string>` path **)**
Prefills required fields to configure the ScriptCreateDialog for use.