class_scripteditor.rst 5.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the ScriptEditor.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ScriptEditor:
  6. ScriptEditor
  7. ============
  8. **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>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Methods
  13. -------
  14. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :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 |
  16. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | 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 **)** |
  18. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`Script<class_Script>` | :ref:`get_current_script<class_ScriptEditor_method_get_current_script>` **(** **)** |
  20. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :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 **)** |
  22. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`Array<class_Array>` | :ref:`get_open_scripts<class_ScriptEditor_method_get_open_scripts>` **(** **)** const |
  24. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`goto_line<class_ScriptEditor_method_goto_line>` **(** :ref:`int<class_int>` line_number **)** |
  26. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | 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 **)** |
  28. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. Signals
  30. -------
  31. .. _class_ScriptEditor_signal_editor_script_changed:
  32. - **editor_script_changed** **(** :ref:`Script<class_Script>` script **)**
  33. Emitted when user changed active script. Argument is a freshly activated :ref:`Script<class_Script>`.
  34. .. _class_ScriptEditor_signal_script_close:
  35. - **script_close** **(** :ref:`Script<class_Script>` script **)**
  36. Emitted when editor is about to close the active script. Argument is a :ref:`Script<class_Script>` that is going to be closed.
  37. Method Descriptions
  38. -------------------
  39. .. _class_ScriptEditor_method_can_drop_data_fw:
  40. - :ref:`bool<class_bool>` **can_drop_data_fw** **(** :ref:`Vector2<class_Vector2>` point, :ref:`Variant<class_Variant>` data, :ref:`Control<class_Control>` from **)** const
  41. .. _class_ScriptEditor_method_drop_data_fw:
  42. - void **drop_data_fw** **(** :ref:`Vector2<class_Vector2>` point, :ref:`Variant<class_Variant>` data, :ref:`Control<class_Control>` from **)**
  43. .. _class_ScriptEditor_method_get_current_script:
  44. - :ref:`Script<class_Script>` **get_current_script** **(** **)**
  45. Returns a :ref:`Script<class_Script>` that is currently active in editor.
  46. .. _class_ScriptEditor_method_get_drag_data_fw:
  47. - :ref:`Variant<class_Variant>` **get_drag_data_fw** **(** :ref:`Vector2<class_Vector2>` point, :ref:`Control<class_Control>` from **)**
  48. .. _class_ScriptEditor_method_get_open_scripts:
  49. - :ref:`Array<class_Array>` **get_open_scripts** **(** **)** const
  50. Returns an array with all :ref:`Script<class_Script>` objects which are currently open in editor.
  51. .. _class_ScriptEditor_method_goto_line:
  52. - void **goto_line** **(** :ref:`int<class_int>` line_number **)**
  53. Goes to the specified line in the current script.
  54. .. _class_ScriptEditor_method_open_script_create_dialog:
  55. - void **open_script_create_dialog** **(** :ref:`String<class_String>` base_name, :ref:`String<class_String>` base_path **)**