class_scripteditor.rst 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  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. Methods
  10. -------
  11. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  12. | :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 |
  13. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | 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 **)** |
  15. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`Script<class_Script>` | :ref:`get_current_script<class_ScriptEditor_method_get_current_script>` **(** **)** |
  17. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :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 **)** |
  19. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`Array<class_Array>` | :ref:`get_open_scripts<class_ScriptEditor_method_get_open_scripts>` **(** **)** const |
  21. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`goto_line<class_ScriptEditor_method_goto_line>` **(** :ref:`int<class_int>` line_number **)** |
  23. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | 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 **)** |
  25. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. Signals
  27. -------
  28. .. _class_ScriptEditor_signal_editor_script_changed:
  29. - **editor_script_changed** **(** :ref:`Script<class_Script>` script **)**
  30. Emitted when user changed active script. Argument is a freshly activated :ref:`Script<class_Script>`.
  31. ----
  32. .. _class_ScriptEditor_signal_script_close:
  33. - **script_close** **(** :ref:`Script<class_Script>` script **)**
  34. Emitted when editor is about to close the active script. Argument is a :ref:`Script<class_Script>` that is going to be closed.
  35. Method Descriptions
  36. -------------------
  37. .. _class_ScriptEditor_method_can_drop_data_fw:
  38. - :ref:`bool<class_bool>` **can_drop_data_fw** **(** :ref:`Vector2<class_Vector2>` point, :ref:`Variant<class_Variant>` data, :ref:`Control<class_Control>` from **)** const
  39. ----
  40. .. _class_ScriptEditor_method_drop_data_fw:
  41. - void **drop_data_fw** **(** :ref:`Vector2<class_Vector2>` point, :ref:`Variant<class_Variant>` data, :ref:`Control<class_Control>` from **)**
  42. ----
  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. ----
  47. .. _class_ScriptEditor_method_get_drag_data_fw:
  48. - :ref:`Variant<class_Variant>` **get_drag_data_fw** **(** :ref:`Vector2<class_Vector2>` point, :ref:`Control<class_Control>` from **)**
  49. ----
  50. .. _class_ScriptEditor_method_get_open_scripts:
  51. - :ref:`Array<class_Array>` **get_open_scripts** **(** **)** const
  52. Returns an array with all :ref:`Script<class_Script>` objects which are currently open in editor.
  53. ----
  54. .. _class_ScriptEditor_method_goto_line:
  55. - void **goto_line** **(** :ref:`int<class_int>` line_number **)**
  56. Goes to the specified line in the current script.
  57. ----
  58. .. _class_ScriptEditor_method_open_script_create_dialog:
  59. - void **open_script_create_dialog** **(** :ref:`String<class_String>` base_name, :ref:`String<class_String>` base_path **)**