class_editorinterface.rst 9.6 KB

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