Files
godot-docs/classes/class_scripteditor.rst
2020-01-21 09:28:25 +01:00

96 lines
5.2 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ScriptEditor.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ScriptEditor:
ScriptEditor
============
**Inherits:** :ref:`PanelContainer<class_PanelContainer>` **<** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Methods
-------
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_drop_data_fw<class_ScriptEditor_method_can_drop_data_fw>` **(** :ref:`Vector2<class_Vector2>` point, :ref:`Variant<class_Variant>` data, :ref:`Control<class_Control>` from **)** const |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`drop_data_fw<class_ScriptEditor_method_drop_data_fw>` **(** :ref:`Vector2<class_Vector2>` point, :ref:`Variant<class_Variant>` data, :ref:`Control<class_Control>` from **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Script<class_Script>` | :ref:`get_current_script<class_ScriptEditor_method_get_current_script>` **(** **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`get_drag_data_fw<class_ScriptEditor_method_get_drag_data_fw>` **(** :ref:`Vector2<class_Vector2>` point, :ref:`Control<class_Control>` from **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_open_scripts<class_ScriptEditor_method_get_open_scripts>` **(** **)** const |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`open_script_create_dialog<class_ScriptEditor_method_open_script_create_dialog>` **(** :ref:`String<class_String>` base_name, :ref:`String<class_String>` base_path **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_ScriptEditor_signal_editor_script_changed:
- **editor_script_changed** **(** :ref:`Script<class_Script>` script **)**
Emitted when user changed active script. Argument is a freshly activated :ref:`Script<class_Script>`.
----
.. _class_ScriptEditor_signal_script_close:
- **script_close** **(** :ref:`Script<class_Script>` script **)**
Emitted when editor is about to close the active script. Argument is a :ref:`Script<class_Script>` that is going to be closed.
Method Descriptions
-------------------
.. _class_ScriptEditor_method_can_drop_data_fw:
- :ref:`bool<class_bool>` **can_drop_data_fw** **(** :ref:`Vector2<class_Vector2>` point, :ref:`Variant<class_Variant>` data, :ref:`Control<class_Control>` from **)** const
----
.. _class_ScriptEditor_method_drop_data_fw:
- void **drop_data_fw** **(** :ref:`Vector2<class_Vector2>` point, :ref:`Variant<class_Variant>` data, :ref:`Control<class_Control>` from **)**
----
.. _class_ScriptEditor_method_get_current_script:
- :ref:`Script<class_Script>` **get_current_script** **(** **)**
Returns a :ref:`Script<class_Script>` that is currently active in editor.
----
.. _class_ScriptEditor_method_get_drag_data_fw:
- :ref:`Variant<class_Variant>` **get_drag_data_fw** **(** :ref:`Vector2<class_Vector2>` point, :ref:`Control<class_Control>` from **)**
----
.. _class_ScriptEditor_method_get_open_scripts:
- :ref:`Array<class_Array>` **get_open_scripts** **(** **)** const
Returns an array with all :ref:`Script<class_Script>` objects which are currently open in editor.
----
.. _class_ScriptEditor_method_open_script_create_dialog:
- void **open_script_create_dialog** **(** :ref:`String<class_String>` base_name, :ref:`String<class_String>` base_path **)**