Files
godot-docs/classes/class_scriptcreatedialog.rst
2018-12-27 11:16:05 +01:00

56 lines
2.2 KiB
ReStructuredText

.. 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.
Methods
-------
+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`config<class_ScriptCreateDialog_config>` **(** :ref:`String<class_String>` inherits, :ref:`String<class_String>` path, :ref:`bool<class_bool>` built_in_enabled=true **)** |
+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_ScriptCreateDialog_script_created:
- **script_created** **(** :ref:`Script<class_Script>` 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()
Method Descriptions
-------------------
.. _class_ScriptCreateDialog_config:
- void **config** **(** :ref:`String<class_String>` inherits, :ref:`String<class_String>` path, :ref:`bool<class_bool>` built_in_enabled=true **)**
Prefills required fields to configure the ScriptCreateDialog for use.