| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071 |
- :github_url: hide
- .. 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>`
- The Editor's popup dialog for creating new :ref:`Script<class_Script>` files.
- 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 :ref:`Popup.popup<class_Popup_method_popup>` methods.
- ::
- 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()
- Properties
- ----------
- +-------------------------------+-------------------+----------------------------------------------+
- | :ref:`bool<class_bool>` | dialog_hide_on_ok | ``false`` *(parent override)* |
- +-------------------------------+-------------------+----------------------------------------------+
- | :ref:`float<class_float>` | margin_bottom | ``232.0`` *(parent override)* |
- +-------------------------------+-------------------+----------------------------------------------+
- | :ref:`float<class_float>` | margin_right | ``361.0`` *(parent override)* |
- +-------------------------------+-------------------+----------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | rect_size | ``Vector2( 361, 232 )`` *(parent override)* |
- +-------------------------------+-------------------+----------------------------------------------+
- | :ref:`String<class_String>` | window_title | ``"Attach Node Script"`` *(parent override)* |
- +-------------------------------+-------------------+----------------------------------------------+
- Methods
- -------
- +------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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, :ref:`bool<class_bool>` load_enabled=true **)** |
- +------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Signals
- -------
- .. _class_ScriptCreateDialog_signal_script_created:
- - **script_created** **(** :ref:`Script<class_Script>` script **)**
- Emitted when the user clicks the OK button.
- Method Descriptions
- -------------------
- .. _class_ScriptCreateDialog_method_config:
- - void **config** **(** :ref:`String<class_String>` inherits, :ref:`String<class_String>` path, :ref:`bool<class_bool>` built_in_enabled=true, :ref:`bool<class_bool>` load_enabled=true **)**
- Prefills required fields to configure the ScriptCreateDialog for use.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
