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