class_editorinterface.rst 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_EditorInterface:
  4. EditorInterface
  5. ===============
  6. **Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | void | :ref:`edit_resource<class_EditorInterface_edit_resource>` **(** :ref:`Resource<class_resource>` resource **)** |
  14. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`Control<class_control>` | :ref:`get_base_control<class_EditorInterface_get_base_control>` **(** **)** |
  16. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`Node<class_node>` | :ref:`get_edited_scene_root<class_EditorInterface_get_edited_scene_root>` **(** **)** |
  18. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`EditorSettings<class_editorsettings>` | :ref:`get_editor_settings<class_EditorInterface_get_editor_settings>` **(** **)** |
  20. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`Control<class_control>` | :ref:`get_editor_viewport<class_EditorInterface_get_editor_viewport>` **(** **)** |
  22. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`Array<class_array>` | :ref:`get_open_scenes<class_EditorInterface_get_open_scenes>` **(** **)** const |
  24. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`EditorFileSystem<class_editorfilesystem>` | :ref:`get_resource_filesystem<class_EditorInterface_get_resource_filesystem>` **(** **)** |
  26. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`EditorResourcePreview<class_editorresourcepreview>` | :ref:`get_resource_previewer<class_EditorInterface_get_resource_previewer>` **(** **)** |
  28. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`ScriptEditor<class_scripteditor>` | :ref:`get_script_editor<class_EditorInterface_get_script_editor>` **(** **)** |
  30. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`EditorSelection<class_editorselection>` | :ref:`get_selection<class_EditorInterface_get_selection>` **(** **)** |
  32. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | void | :ref:`inspect_object<class_EditorInterface_inspect_object>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` for_property="" **)** |
  34. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`Array<class_array>` | :ref:`make_mesh_previews<class_EditorInterface_make_mesh_previews>` **(** :ref:`Array<class_array>` arg0, :ref:`int<class_int>` arg1 **)** |
  36. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | void | :ref:`open_scene_from_path<class_EditorInterface_open_scene_from_path>` **(** :ref:`String<class_string>` scene_filepath **)** |
  38. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | void | :ref:`reload_scene_from_path<class_EditorInterface_reload_scene_from_path>` **(** :ref:`String<class_string>` scene_filepath **)** |
  40. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`int<class_int>` | :ref:`save_scene<class_EditorInterface_save_scene>` **(** **)** |
  42. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | void | :ref:`save_scene_as<class_EditorInterface_save_scene_as>` **(** :ref:`String<class_string>` path, :ref:`bool<class_bool>` with_preview=true **)** |
  44. +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. Member Function Description
  46. ---------------------------
  47. .. _class_EditorInterface_edit_resource:
  48. - void **edit_resource** **(** :ref:`Resource<class_resource>` resource **)**
  49. .. _class_EditorInterface_get_base_control:
  50. - :ref:`Control<class_control>` **get_base_control** **(** **)**
  51. .. _class_EditorInterface_get_edited_scene_root:
  52. - :ref:`Node<class_node>` **get_edited_scene_root** **(** **)**
  53. .. _class_EditorInterface_get_editor_settings:
  54. - :ref:`EditorSettings<class_editorsettings>` **get_editor_settings** **(** **)**
  55. .. _class_EditorInterface_get_editor_viewport:
  56. - :ref:`Control<class_control>` **get_editor_viewport** **(** **)**
  57. .. _class_EditorInterface_get_open_scenes:
  58. - :ref:`Array<class_array>` **get_open_scenes** **(** **)** const
  59. .. _class_EditorInterface_get_resource_filesystem:
  60. - :ref:`EditorFileSystem<class_editorfilesystem>` **get_resource_filesystem** **(** **)**
  61. .. _class_EditorInterface_get_resource_previewer:
  62. - :ref:`EditorResourcePreview<class_editorresourcepreview>` **get_resource_previewer** **(** **)**
  63. .. _class_EditorInterface_get_script_editor:
  64. - :ref:`ScriptEditor<class_scripteditor>` **get_script_editor** **(** **)**
  65. .. _class_EditorInterface_get_selection:
  66. - :ref:`EditorSelection<class_editorselection>` **get_selection** **(** **)**
  67. .. _class_EditorInterface_inspect_object:
  68. - void **inspect_object** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` for_property="" **)**
  69. .. _class_EditorInterface_make_mesh_previews:
  70. - :ref:`Array<class_array>` **make_mesh_previews** **(** :ref:`Array<class_array>` arg0, :ref:`int<class_int>` arg1 **)**
  71. .. _class_EditorInterface_open_scene_from_path:
  72. - void **open_scene_from_path** **(** :ref:`String<class_string>` scene_filepath **)**
  73. .. _class_EditorInterface_reload_scene_from_path:
  74. - void **reload_scene_from_path** **(** :ref:`String<class_string>` scene_filepath **)**
  75. .. _class_EditorInterface_save_scene:
  76. - :ref:`int<class_int>` **save_scene** **(** **)**
  77. .. _class_EditorInterface_save_scene_as:
  78. - void **save_scene_as** **(** :ref:`String<class_string>` path, :ref:`bool<class_bool>` with_preview=true **)**