class_scriptcreatedialog.rst 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the ScriptCreateDialog.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_ScriptCreateDialog:
  5. ScriptCreateDialog
  6. ==================
  7. **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>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. The Editor's popup dialog for creating new :ref:`Script<class_Script>` files.
  12. Methods
  13. -------
  14. +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`config<class_ScriptCreateDialog_method_config>` **(** :ref:`String<class_String>` inherits, :ref:`String<class_String>` path, :ref:`bool<class_bool>` built_in_enabled=true **)** |
  16. +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. Signals
  18. -------
  19. .. _class_ScriptCreateDialog_signal_script_created:
  20. - **script_created** **(** :ref:`Script<class_Script>` script **)**
  21. Emitted when the user clicks the OK button.
  22. Description
  23. -----------
  24. 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 :ref:`Popup.popup<class_Popup_method_popup>` methods.
  25. ::
  26. func _ready():
  27. dialog.config("Node", "res://new_node.gd") # for in-engine types
  28. dialog.config("\"res://base_node.gd\"", "res://derived_node.gd") # for script types
  29. dialog.popup_centered()
  30. Method Descriptions
  31. -------------------
  32. .. _class_ScriptCreateDialog_method_config:
  33. - void **config** **(** :ref:`String<class_String>` inherits, :ref:`String<class_String>` path, :ref:`bool<class_bool>` built_in_enabled=true **)**
  34. Prefills required fields to configure the ScriptCreateDialog for use.