mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
classref: Sync with current master branch (2e7fc81)
This commit is contained in:
Godot Organization
@@ -59,109 +59,109 @@ Methods
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`edit_node<class_EditorInterface_method_edit_node>` **(** :ref:`Node<class_Node>` node **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`edit_resource<class_EditorInterface_method_edit_resource>` **(** :ref:`Resource<class_Resource>` resource **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`edit_script<class_EditorInterface_method_edit_script>` **(** :ref:`Script<class_Script>` script, :ref:`int<class_int>` line=-1, :ref:`int<class_int>` column=0, :ref:`bool<class_bool>` grab_focus=true **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Control<class_Control>` | :ref:`get_base_control<class_EditorInterface_method_get_base_control>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorCommandPalette<class_EditorCommandPalette>` | :ref:`get_command_palette<class_EditorInterface_method_get_command_palette>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_current_directory<class_EditorInterface_method_get_current_directory>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_current_feature_profile<class_EditorInterface_method_get_current_feature_profile>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_current_path<class_EditorInterface_method_get_current_path>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_Node>` | :ref:`get_edited_scene_root<class_EditorInterface_method_get_edited_scene_root>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`VBoxContainer<class_VBoxContainer>` | :ref:`get_editor_main_screen<class_EditorInterface_method_get_editor_main_screen>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorPaths<class_EditorPaths>` | :ref:`get_editor_paths<class_EditorInterface_method_get_editor_paths>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_editor_scale<class_EditorInterface_method_get_editor_scale>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorSettings<class_EditorSettings>` | :ref:`get_editor_settings<class_EditorInterface_method_get_editor_settings>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Theme<class_Theme>` | :ref:`get_editor_theme<class_EditorInterface_method_get_editor_theme>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SubViewport<class_SubViewport>` | :ref:`get_editor_viewport_2d<class_EditorInterface_method_get_editor_viewport_2d>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SubViewport<class_SubViewport>` | :ref:`get_editor_viewport_3d<class_EditorInterface_method_get_editor_viewport_3d>` **(** :ref:`int<class_int>` idx=0 **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`FileSystemDock<class_FileSystemDock>` | :ref:`get_file_system_dock<class_EditorInterface_method_get_file_system_dock>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorInspector<class_EditorInspector>` | :ref:`get_inspector<class_EditorInterface_method_get_inspector>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_open_scenes<class_EditorInterface_method_get_open_scenes>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_playing_scene<class_EditorInterface_method_get_playing_scene>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorFileSystem<class_EditorFileSystem>` | :ref:`get_resource_filesystem<class_EditorInterface_method_get_resource_filesystem>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorResourcePreview<class_EditorResourcePreview>` | :ref:`get_resource_previewer<class_EditorInterface_method_get_resource_previewer>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ScriptEditor<class_ScriptEditor>` | :ref:`get_script_editor<class_EditorInterface_method_get_script_editor>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_selected_paths<class_EditorInterface_method_get_selected_paths>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorSelection<class_EditorSelection>` | :ref:`get_selection<class_EditorInterface_method_get_selection>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`inspect_object<class_EditorInterface_method_inspect_object>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` for_property="", :ref:`bool<class_bool>` inspector_only=false **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_multi_window_enabled<class_EditorInterface_method_is_multi_window_enabled>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing_scene<class_EditorInterface_method_is_playing_scene>` **(** **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_plugin_enabled<class_EditorInterface_method_is_plugin_enabled>` **(** :ref:`String<class_String>` plugin **)** |const| |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture2D[]<class_Texture2D>` | :ref:`make_mesh_previews<class_EditorInterface_method_make_mesh_previews>` **(** :ref:`Mesh[]<class_Mesh>` meshes, :ref:`int<class_int>` preview_size **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`mark_scene_as_unsaved<class_EditorInterface_method_mark_scene_as_unsaved>` **(** **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`open_scene_from_path<class_EditorInterface_method_open_scene_from_path>` **(** :ref:`String<class_String>` scene_filepath **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play_current_scene<class_EditorInterface_method_play_current_scene>` **(** **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play_custom_scene<class_EditorInterface_method_play_custom_scene>` **(** :ref:`String<class_String>` scene_filepath **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play_main_scene<class_EditorInterface_method_play_main_scene>` **(** **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`popup_dialog<class_EditorInterface_method_popup_dialog>` **(** :ref:`Window<class_Window>` dialog, :ref:`Rect2i<class_Rect2i>` rect=Rect2i(0, 0, 0, 0) **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`popup_dialog_centered<class_EditorInterface_method_popup_dialog_centered>` **(** :ref:`Window<class_Window>` dialog, :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0) **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`popup_dialog_centered_clamped<class_EditorInterface_method_popup_dialog_centered_clamped>` **(** :ref:`Window<class_Window>` dialog, :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0), :ref:`float<class_float>` fallback_ratio=0.75 **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`popup_dialog_centered_ratio<class_EditorInterface_method_popup_dialog_centered_ratio>` **(** :ref:`Window<class_Window>` dialog, :ref:`float<class_float>` ratio=0.8 **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`popup_node_selector<class_EditorInterface_method_popup_node_selector>` **(** :ref:`Callable<class_Callable>` callback, :ref:`StringName[]<class_StringName>` valid_types=[] **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`popup_property_selector<class_EditorInterface_method_popup_property_selector>` **(** :ref:`Object<class_Object>` object, :ref:`Callable<class_Callable>` callback, :ref:`PackedInt32Array<class_PackedInt32Array>` type_filter=PackedInt32Array() **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reload_scene_from_path<class_EditorInterface_method_reload_scene_from_path>` **(** :ref:`String<class_String>` scene_filepath **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`restart_editor<class_EditorInterface_method_restart_editor>` **(** :ref:`bool<class_bool>` save=true **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`save_all_scenes<class_EditorInterface_method_save_all_scenes>` **(** **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save_scene<class_EditorInterface_method_save_scene>` **(** **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`save_scene_as<class_EditorInterface_method_save_scene_as>` **(** :ref:`String<class_String>` path, :ref:`bool<class_bool>` with_preview=true **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`select_file<class_EditorInterface_method_select_file>` **(** :ref:`String<class_String>` file **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_current_feature_profile<class_EditorInterface_method_set_current_feature_profile>` **(** :ref:`String<class_String>` profile_name **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_main_screen_editor<class_EditorInterface_method_set_main_screen_editor>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_plugin_enabled<class_EditorInterface_method_set_plugin_enabled>` **(** :ref:`String<class_String>` plugin, :ref:`bool<class_bool>` enabled **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop_playing_scene<class_EditorInterface_method_stop_playing_scene>` **(** **)** |
|
||||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`edit_node<class_EditorInterface_method_edit_node>`\ (\ node\: :ref:`Node<class_Node>`\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`edit_resource<class_EditorInterface_method_edit_resource>`\ (\ resource\: :ref:`Resource<class_Resource>`\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`edit_script<class_EditorInterface_method_edit_script>`\ (\ script\: :ref:`Script<class_Script>`, line\: :ref:`int<class_int>` = -1, column\: :ref:`int<class_int>` = 0, grab_focus\: :ref:`bool<class_bool>` = true\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Control<class_Control>` | :ref:`get_base_control<class_EditorInterface_method_get_base_control>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorCommandPalette<class_EditorCommandPalette>` | :ref:`get_command_palette<class_EditorInterface_method_get_command_palette>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_current_directory<class_EditorInterface_method_get_current_directory>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_current_feature_profile<class_EditorInterface_method_get_current_feature_profile>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_current_path<class_EditorInterface_method_get_current_path>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_Node>` | :ref:`get_edited_scene_root<class_EditorInterface_method_get_edited_scene_root>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`VBoxContainer<class_VBoxContainer>` | :ref:`get_editor_main_screen<class_EditorInterface_method_get_editor_main_screen>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorPaths<class_EditorPaths>` | :ref:`get_editor_paths<class_EditorInterface_method_get_editor_paths>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_editor_scale<class_EditorInterface_method_get_editor_scale>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorSettings<class_EditorSettings>` | :ref:`get_editor_settings<class_EditorInterface_method_get_editor_settings>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Theme<class_Theme>` | :ref:`get_editor_theme<class_EditorInterface_method_get_editor_theme>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SubViewport<class_SubViewport>` | :ref:`get_editor_viewport_2d<class_EditorInterface_method_get_editor_viewport_2d>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SubViewport<class_SubViewport>` | :ref:`get_editor_viewport_3d<class_EditorInterface_method_get_editor_viewport_3d>`\ (\ idx\: :ref:`int<class_int>` = 0\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`FileSystemDock<class_FileSystemDock>` | :ref:`get_file_system_dock<class_EditorInterface_method_get_file_system_dock>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorInspector<class_EditorInspector>` | :ref:`get_inspector<class_EditorInterface_method_get_inspector>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_open_scenes<class_EditorInterface_method_get_open_scenes>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_playing_scene<class_EditorInterface_method_get_playing_scene>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorFileSystem<class_EditorFileSystem>` | :ref:`get_resource_filesystem<class_EditorInterface_method_get_resource_filesystem>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorResourcePreview<class_EditorResourcePreview>` | :ref:`get_resource_previewer<class_EditorInterface_method_get_resource_previewer>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ScriptEditor<class_ScriptEditor>` | :ref:`get_script_editor<class_EditorInterface_method_get_script_editor>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_selected_paths<class_EditorInterface_method_get_selected_paths>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorSelection<class_EditorSelection>` | :ref:`get_selection<class_EditorInterface_method_get_selection>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`inspect_object<class_EditorInterface_method_inspect_object>`\ (\ object\: :ref:`Object<class_Object>`, for_property\: :ref:`String<class_String>` = "", inspector_only\: :ref:`bool<class_bool>` = false\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_multi_window_enabled<class_EditorInterface_method_is_multi_window_enabled>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing_scene<class_EditorInterface_method_is_playing_scene>`\ (\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_plugin_enabled<class_EditorInterface_method_is_plugin_enabled>`\ (\ plugin\: :ref:`String<class_String>`\ ) |const| |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>`\[:ref:`Texture2D<class_Texture2D>`\] | :ref:`make_mesh_previews<class_EditorInterface_method_make_mesh_previews>`\ (\ meshes\: :ref:`Array<class_Array>`\[:ref:`Mesh<class_Mesh>`\], preview_size\: :ref:`int<class_int>`\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`mark_scene_as_unsaved<class_EditorInterface_method_mark_scene_as_unsaved>`\ (\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`open_scene_from_path<class_EditorInterface_method_open_scene_from_path>`\ (\ scene_filepath\: :ref:`String<class_String>`\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`play_current_scene<class_EditorInterface_method_play_current_scene>`\ (\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`play_custom_scene<class_EditorInterface_method_play_custom_scene>`\ (\ scene_filepath\: :ref:`String<class_String>`\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`play_main_scene<class_EditorInterface_method_play_main_scene>`\ (\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`popup_dialog<class_EditorInterface_method_popup_dialog>`\ (\ dialog\: :ref:`Window<class_Window>`, rect\: :ref:`Rect2i<class_Rect2i>` = Rect2i(0, 0, 0, 0)\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`popup_dialog_centered<class_EditorInterface_method_popup_dialog_centered>`\ (\ dialog\: :ref:`Window<class_Window>`, minsize\: :ref:`Vector2i<class_Vector2i>` = Vector2i(0, 0)\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`popup_dialog_centered_clamped<class_EditorInterface_method_popup_dialog_centered_clamped>`\ (\ dialog\: :ref:`Window<class_Window>`, minsize\: :ref:`Vector2i<class_Vector2i>` = Vector2i(0, 0), fallback_ratio\: :ref:`float<class_float>` = 0.75\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`popup_dialog_centered_ratio<class_EditorInterface_method_popup_dialog_centered_ratio>`\ (\ dialog\: :ref:`Window<class_Window>`, ratio\: :ref:`float<class_float>` = 0.8\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`popup_node_selector<class_EditorInterface_method_popup_node_selector>`\ (\ callback\: :ref:`Callable<class_Callable>`, valid_types\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] = []\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`popup_property_selector<class_EditorInterface_method_popup_property_selector>`\ (\ object\: :ref:`Object<class_Object>`, callback\: :ref:`Callable<class_Callable>`, type_filter\: :ref:`PackedInt32Array<class_PackedInt32Array>` = PackedInt32Array()\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`reload_scene_from_path<class_EditorInterface_method_reload_scene_from_path>`\ (\ scene_filepath\: :ref:`String<class_String>`\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`restart_editor<class_EditorInterface_method_restart_editor>`\ (\ save\: :ref:`bool<class_bool>` = true\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`save_all_scenes<class_EditorInterface_method_save_all_scenes>`\ (\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save_scene<class_EditorInterface_method_save_scene>`\ (\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`save_scene_as<class_EditorInterface_method_save_scene_as>`\ (\ path\: :ref:`String<class_String>`, with_preview\: :ref:`bool<class_bool>` = true\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`select_file<class_EditorInterface_method_select_file>`\ (\ file\: :ref:`String<class_String>`\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_current_feature_profile<class_EditorInterface_method_set_current_feature_profile>`\ (\ profile_name\: :ref:`String<class_String>`\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_main_screen_editor<class_EditorInterface_method_set_main_screen_editor>`\ (\ name\: :ref:`String<class_String>`\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_plugin_enabled<class_EditorInterface_method_set_plugin_enabled>`\ (\ plugin\: :ref:`String<class_String>`, enabled\: :ref:`bool<class_bool>`\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`stop_playing_scene<class_EditorInterface_method_stop_playing_scene>`\ (\ ) |
|
||||
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
@@ -180,8 +180,8 @@ Property Descriptions
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_distraction_free_mode** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_distraction_free_mode_enabled** **(** **)**
|
||||
- |void| **set_distraction_free_mode**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_bool>` **is_distraction_free_mode_enabled**\ (\ )
|
||||
|
||||
If ``true``, enables distraction-free mode which hides side docks to increase the space available for the main view.
|
||||
|
||||
@@ -197,8 +197,8 @@ If ``true``, enables distraction-free mode which hides side docks to increase th
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_movie_maker_enabled** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_movie_maker_enabled** **(** **)**
|
||||
- |void| **set_movie_maker_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_bool>` **is_movie_maker_enabled**\ (\ )
|
||||
|
||||
If ``true``, the Movie Maker mode is enabled in the editor. See :ref:`MovieWriter<class_MovieWriter>` for more information.
|
||||
|
||||
@@ -215,7 +215,7 @@ Method Descriptions
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **edit_node** **(** :ref:`Node<class_Node>` node **)**
|
||||
|void| **edit_node**\ (\ node\: :ref:`Node<class_Node>`\ )
|
||||
|
||||
Edits the given :ref:`Node<class_Node>`. The node will be also selected if it's inside the scene tree.
|
||||
|
||||
@@ -227,7 +227,7 @@ Edits the given :ref:`Node<class_Node>`. The node will be also selected if it's
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **edit_resource** **(** :ref:`Resource<class_Resource>` resource **)**
|
||||
|void| **edit_resource**\ (\ resource\: :ref:`Resource<class_Resource>`\ )
|
||||
|
||||
Edits the given :ref:`Resource<class_Resource>`. If the resource is a :ref:`Script<class_Script>` you can also edit it with :ref:`edit_script<class_EditorInterface_method_edit_script>` to specify the line and column position.
|
||||
|
||||
@@ -239,7 +239,7 @@ Edits the given :ref:`Resource<class_Resource>`. If the resource is a :ref:`Scri
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **edit_script** **(** :ref:`Script<class_Script>` script, :ref:`int<class_int>` line=-1, :ref:`int<class_int>` column=0, :ref:`bool<class_bool>` grab_focus=true **)**
|
||||
|void| **edit_script**\ (\ script\: :ref:`Script<class_Script>`, line\: :ref:`int<class_int>` = -1, column\: :ref:`int<class_int>` = 0, grab_focus\: :ref:`bool<class_bool>` = true\ )
|
||||
|
||||
Edits the given :ref:`Script<class_Script>`. The line and column on which to open the script can also be specified. The script will be open with the user-configured editor for the script's language which may be an external editor.
|
||||
|
||||
@@ -251,7 +251,7 @@ Edits the given :ref:`Script<class_Script>`. The line and column on which to ope
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Control<class_Control>` **get_base_control** **(** **)** |const|
|
||||
:ref:`Control<class_Control>` **get_base_control**\ (\ ) |const|
|
||||
|
||||
Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly.
|
||||
|
||||
@@ -265,7 +265,7 @@ Returns the main container of Godot editor's window. For example, you can use it
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`EditorCommandPalette<class_EditorCommandPalette>` **get_command_palette** **(** **)** |const|
|
||||
:ref:`EditorCommandPalette<class_EditorCommandPalette>` **get_command_palette**\ (\ ) |const|
|
||||
|
||||
Returns the editor's :ref:`EditorCommandPalette<class_EditorCommandPalette>` instance.
|
||||
|
||||
@@ -279,7 +279,7 @@ Returns the editor's :ref:`EditorCommandPalette<class_EditorCommandPalette>` ins
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`String<class_String>` **get_current_directory** **(** **)** |const|
|
||||
:ref:`String<class_String>` **get_current_directory**\ (\ ) |const|
|
||||
|
||||
Returns the current directory being viewed in the :ref:`FileSystemDock<class_FileSystemDock>`. If a file is selected, its base directory will be returned using :ref:`String.get_base_dir<class_String_method_get_base_dir>` instead.
|
||||
|
||||
@@ -291,7 +291,7 @@ Returns the current directory being viewed in the :ref:`FileSystemDock<class_Fil
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`String<class_String>` **get_current_feature_profile** **(** **)** |const|
|
||||
:ref:`String<class_String>` **get_current_feature_profile**\ (\ ) |const|
|
||||
|
||||
Returns the name of the currently activated feature profile. If the default profile is currently active, an empty string is returned instead.
|
||||
|
||||
@@ -307,7 +307,7 @@ In order to get a reference to the :ref:`EditorFeatureProfile<class_EditorFeatur
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`String<class_String>` **get_current_path** **(** **)** |const|
|
||||
:ref:`String<class_String>` **get_current_path**\ (\ ) |const|
|
||||
|
||||
Returns the current path being viewed in the :ref:`FileSystemDock<class_FileSystemDock>`.
|
||||
|
||||
@@ -319,7 +319,7 @@ Returns the current path being viewed in the :ref:`FileSystemDock<class_FileSyst
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Node<class_Node>` **get_edited_scene_root** **(** **)** |const|
|
||||
:ref:`Node<class_Node>` **get_edited_scene_root**\ (\ ) |const|
|
||||
|
||||
Returns the edited (current) scene's root :ref:`Node<class_Node>`.
|
||||
|
||||
@@ -331,7 +331,7 @@ Returns the edited (current) scene's root :ref:`Node<class_Node>`.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`VBoxContainer<class_VBoxContainer>` **get_editor_main_screen** **(** **)** |const|
|
||||
:ref:`VBoxContainer<class_VBoxContainer>` **get_editor_main_screen**\ (\ ) |const|
|
||||
|
||||
Returns the editor control responsible for main screen plugins and tools. Use it with plugins that implement :ref:`EditorPlugin._has_main_screen<class_EditorPlugin_private_method__has_main_screen>`.
|
||||
|
||||
@@ -347,7 +347,7 @@ Returns the editor control responsible for main screen plugins and tools. Use it
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`EditorPaths<class_EditorPaths>` **get_editor_paths** **(** **)** |const|
|
||||
:ref:`EditorPaths<class_EditorPaths>` **get_editor_paths**\ (\ ) |const|
|
||||
|
||||
Returns the :ref:`EditorPaths<class_EditorPaths>` singleton.
|
||||
|
||||
@@ -359,7 +359,7 @@ Returns the :ref:`EditorPaths<class_EditorPaths>` singleton.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`float<class_float>` **get_editor_scale** **(** **)** |const|
|
||||
:ref:`float<class_float>` **get_editor_scale**\ (\ ) |const|
|
||||
|
||||
Returns the actual scale of the editor UI (``1.0`` being 100% scale). This can be used to adjust position and dimensions of the UI added by plugins.
|
||||
|
||||
@@ -373,7 +373,7 @@ Returns the actual scale of the editor UI (``1.0`` being 100% scale). This can b
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`EditorSettings<class_EditorSettings>` **get_editor_settings** **(** **)** |const|
|
||||
:ref:`EditorSettings<class_EditorSettings>` **get_editor_settings**\ (\ ) |const|
|
||||
|
||||
Returns the editor's :ref:`EditorSettings<class_EditorSettings>` instance.
|
||||
|
||||
@@ -385,7 +385,7 @@ Returns the editor's :ref:`EditorSettings<class_EditorSettings>` instance.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Theme<class_Theme>` **get_editor_theme** **(** **)** |const|
|
||||
:ref:`Theme<class_Theme>` **get_editor_theme**\ (\ ) |const|
|
||||
|
||||
Returns the editor's :ref:`Theme<class_Theme>`.
|
||||
|
||||
@@ -399,7 +399,7 @@ Returns the editor's :ref:`Theme<class_Theme>`.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`SubViewport<class_SubViewport>` **get_editor_viewport_2d** **(** **)** |const|
|
||||
:ref:`SubViewport<class_SubViewport>` **get_editor_viewport_2d**\ (\ ) |const|
|
||||
|
||||
Returns the 2D editor :ref:`SubViewport<class_SubViewport>`. It does not have a camera. Instead, the view transforms are done directly and can be accessed with :ref:`Viewport.global_canvas_transform<class_Viewport_property_global_canvas_transform>`.
|
||||
|
||||
@@ -411,7 +411,7 @@ Returns the 2D editor :ref:`SubViewport<class_SubViewport>`. It does not have a
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`SubViewport<class_SubViewport>` **get_editor_viewport_3d** **(** :ref:`int<class_int>` idx=0 **)** |const|
|
||||
:ref:`SubViewport<class_SubViewport>` **get_editor_viewport_3d**\ (\ idx\: :ref:`int<class_int>` = 0\ ) |const|
|
||||
|
||||
Returns the specified 3D editor :ref:`SubViewport<class_SubViewport>`, from ``0`` to ``3``. The viewport can be used to access the active editor cameras with :ref:`Viewport.get_camera_3d<class_Viewport_method_get_camera_3d>`.
|
||||
|
||||
@@ -423,7 +423,7 @@ Returns the specified 3D editor :ref:`SubViewport<class_SubViewport>`, from ``0`
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`FileSystemDock<class_FileSystemDock>` **get_file_system_dock** **(** **)** |const|
|
||||
:ref:`FileSystemDock<class_FileSystemDock>` **get_file_system_dock**\ (\ ) |const|
|
||||
|
||||
Returns the editor's :ref:`FileSystemDock<class_FileSystemDock>` instance.
|
||||
|
||||
@@ -437,7 +437,7 @@ Returns the editor's :ref:`FileSystemDock<class_FileSystemDock>` instance.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`EditorInspector<class_EditorInspector>` **get_inspector** **(** **)** |const|
|
||||
:ref:`EditorInspector<class_EditorInspector>` **get_inspector**\ (\ ) |const|
|
||||
|
||||
Returns the editor's :ref:`EditorInspector<class_EditorInspector>` instance.
|
||||
|
||||
@@ -451,7 +451,7 @@ Returns the editor's :ref:`EditorInspector<class_EditorInspector>` instance.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`PackedStringArray<class_PackedStringArray>` **get_open_scenes** **(** **)** |const|
|
||||
:ref:`PackedStringArray<class_PackedStringArray>` **get_open_scenes**\ (\ ) |const|
|
||||
|
||||
Returns an :ref:`Array<class_Array>` with the file paths of the currently opened scenes.
|
||||
|
||||
@@ -463,7 +463,7 @@ Returns an :ref:`Array<class_Array>` with the file paths of the currently opened
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`String<class_String>` **get_playing_scene** **(** **)** |const|
|
||||
:ref:`String<class_String>` **get_playing_scene**\ (\ ) |const|
|
||||
|
||||
Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string.
|
||||
|
||||
@@ -475,7 +475,7 @@ Returns the name of the scene that is being played. If no scene is currently bei
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`EditorFileSystem<class_EditorFileSystem>` **get_resource_filesystem** **(** **)** |const|
|
||||
:ref:`EditorFileSystem<class_EditorFileSystem>` **get_resource_filesystem**\ (\ ) |const|
|
||||
|
||||
Returns the editor's :ref:`EditorFileSystem<class_EditorFileSystem>` instance.
|
||||
|
||||
@@ -487,7 +487,7 @@ Returns the editor's :ref:`EditorFileSystem<class_EditorFileSystem>` instance.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`EditorResourcePreview<class_EditorResourcePreview>` **get_resource_previewer** **(** **)** |const|
|
||||
:ref:`EditorResourcePreview<class_EditorResourcePreview>` **get_resource_previewer**\ (\ ) |const|
|
||||
|
||||
Returns the editor's :ref:`EditorResourcePreview<class_EditorResourcePreview>` instance.
|
||||
|
||||
@@ -499,7 +499,7 @@ Returns the editor's :ref:`EditorResourcePreview<class_EditorResourcePreview>` i
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`ScriptEditor<class_ScriptEditor>` **get_script_editor** **(** **)** |const|
|
||||
:ref:`ScriptEditor<class_ScriptEditor>` **get_script_editor**\ (\ ) |const|
|
||||
|
||||
Returns the editor's :ref:`ScriptEditor<class_ScriptEditor>` instance.
|
||||
|
||||
@@ -513,7 +513,7 @@ Returns the editor's :ref:`ScriptEditor<class_ScriptEditor>` instance.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`PackedStringArray<class_PackedStringArray>` **get_selected_paths** **(** **)** |const|
|
||||
:ref:`PackedStringArray<class_PackedStringArray>` **get_selected_paths**\ (\ ) |const|
|
||||
|
||||
Returns an array containing the paths of the currently selected files (and directories) in the :ref:`FileSystemDock<class_FileSystemDock>`.
|
||||
|
||||
@@ -525,7 +525,7 @@ Returns an array containing the paths of the currently selected files (and direc
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`EditorSelection<class_EditorSelection>` **get_selection** **(** **)** |const|
|
||||
:ref:`EditorSelection<class_EditorSelection>` **get_selection**\ (\ ) |const|
|
||||
|
||||
Returns the editor's :ref:`EditorSelection<class_EditorSelection>` instance.
|
||||
|
||||
@@ -537,7 +537,7 @@ Returns the editor's :ref:`EditorSelection<class_EditorSelection>` instance.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **inspect_object** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` for_property="", :ref:`bool<class_bool>` inspector_only=false **)**
|
||||
|void| **inspect_object**\ (\ object\: :ref:`Object<class_Object>`, for_property\: :ref:`String<class_String>` = "", inspector_only\: :ref:`bool<class_bool>` = false\ )
|
||||
|
||||
Shows the given property on the given ``object`` in the editor's Inspector dock. If ``inspector_only`` is ``true``, plugins will not attempt to edit ``object``.
|
||||
|
||||
@@ -549,7 +549,7 @@ Shows the given property on the given ``object`` in the editor's Inspector dock.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **is_multi_window_enabled** **(** **)** |const|
|
||||
:ref:`bool<class_bool>` **is_multi_window_enabled**\ (\ ) |const|
|
||||
|
||||
Returns ``true`` if multiple window support is enabled in the editor. Multiple window support is enabled if *all* of these statements are true:
|
||||
|
||||
@@ -567,7 +567,7 @@ Returns ``true`` if multiple window support is enabled in the editor. Multiple w
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **is_playing_scene** **(** **)** |const|
|
||||
:ref:`bool<class_bool>` **is_playing_scene**\ (\ ) |const|
|
||||
|
||||
Returns ``true`` if a scene is currently being played, ``false`` otherwise. Paused scenes are considered as being played.
|
||||
|
||||
@@ -579,7 +579,7 @@ Returns ``true`` if a scene is currently being played, ``false`` otherwise. Paus
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **is_plugin_enabled** **(** :ref:`String<class_String>` plugin **)** |const|
|
||||
:ref:`bool<class_bool>` **is_plugin_enabled**\ (\ plugin\: :ref:`String<class_String>`\ ) |const|
|
||||
|
||||
Returns ``true`` if the specified ``plugin`` is enabled. The plugin name is the same as its directory name.
|
||||
|
||||
@@ -591,7 +591,7 @@ Returns ``true`` if the specified ``plugin`` is enabled. The plugin name is the
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Texture2D[]<class_Texture2D>` **make_mesh_previews** **(** :ref:`Mesh[]<class_Mesh>` meshes, :ref:`int<class_int>` preview_size **)**
|
||||
:ref:`Array<class_Array>`\[:ref:`Texture2D<class_Texture2D>`\] **make_mesh_previews**\ (\ meshes\: :ref:`Array<class_Array>`\[:ref:`Mesh<class_Mesh>`\], preview_size\: :ref:`int<class_int>`\ )
|
||||
|
||||
Returns mesh previews rendered at the given size as an :ref:`Array<class_Array>` of :ref:`Texture2D<class_Texture2D>`\ s.
|
||||
|
||||
@@ -603,7 +603,7 @@ Returns mesh previews rendered at the given size as an :ref:`Array<class_Array>`
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **mark_scene_as_unsaved** **(** **)**
|
||||
|void| **mark_scene_as_unsaved**\ (\ )
|
||||
|
||||
Marks the current scene tab as unsaved.
|
||||
|
||||
@@ -615,7 +615,7 @@ Marks the current scene tab as unsaved.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **open_scene_from_path** **(** :ref:`String<class_String>` scene_filepath **)**
|
||||
|void| **open_scene_from_path**\ (\ scene_filepath\: :ref:`String<class_String>`\ )
|
||||
|
||||
Opens the scene at the given path.
|
||||
|
||||
@@ -627,7 +627,7 @@ Opens the scene at the given path.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **play_current_scene** **(** **)**
|
||||
|void| **play_current_scene**\ (\ )
|
||||
|
||||
Plays the currently active scene.
|
||||
|
||||
@@ -639,7 +639,7 @@ Plays the currently active scene.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **play_custom_scene** **(** :ref:`String<class_String>` scene_filepath **)**
|
||||
|void| **play_custom_scene**\ (\ scene_filepath\: :ref:`String<class_String>`\ )
|
||||
|
||||
Plays the scene specified by its filepath.
|
||||
|
||||
@@ -651,7 +651,7 @@ Plays the scene specified by its filepath.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **play_main_scene** **(** **)**
|
||||
|void| **play_main_scene**\ (\ )
|
||||
|
||||
Plays the main scene.
|
||||
|
||||
@@ -663,7 +663,7 @@ Plays the main scene.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **popup_dialog** **(** :ref:`Window<class_Window>` dialog, :ref:`Rect2i<class_Rect2i>` rect=Rect2i(0, 0, 0, 0) **)**
|
||||
|void| **popup_dialog**\ (\ dialog\: :ref:`Window<class_Window>`, rect\: :ref:`Rect2i<class_Rect2i>` = Rect2i(0, 0, 0, 0)\ )
|
||||
|
||||
Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive<class_Window_method_popup_exclusive>`. The dialog must have no current parent, otherwise the method fails.
|
||||
|
||||
@@ -677,7 +677,7 @@ See also :ref:`Window.set_unparent_when_invisible<class_Window_method_set_unpare
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **popup_dialog_centered** **(** :ref:`Window<class_Window>` dialog, :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0) **)**
|
||||
|void| **popup_dialog_centered**\ (\ dialog\: :ref:`Window<class_Window>`, minsize\: :ref:`Vector2i<class_Vector2i>` = Vector2i(0, 0)\ )
|
||||
|
||||
Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive_centered<class_Window_method_popup_exclusive_centered>`. The dialog must have no current parent, otherwise the method fails.
|
||||
|
||||
@@ -691,7 +691,7 @@ See also :ref:`Window.set_unparent_when_invisible<class_Window_method_set_unpare
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **popup_dialog_centered_clamped** **(** :ref:`Window<class_Window>` dialog, :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0), :ref:`float<class_float>` fallback_ratio=0.75 **)**
|
||||
|void| **popup_dialog_centered_clamped**\ (\ dialog\: :ref:`Window<class_Window>`, minsize\: :ref:`Vector2i<class_Vector2i>` = Vector2i(0, 0), fallback_ratio\: :ref:`float<class_float>` = 0.75\ )
|
||||
|
||||
Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive_centered_clamped<class_Window_method_popup_exclusive_centered_clamped>`. The dialog must have no current parent, otherwise the method fails.
|
||||
|
||||
@@ -705,7 +705,7 @@ See also :ref:`Window.set_unparent_when_invisible<class_Window_method_set_unpare
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **popup_dialog_centered_ratio** **(** :ref:`Window<class_Window>` dialog, :ref:`float<class_float>` ratio=0.8 **)**
|
||||
|void| **popup_dialog_centered_ratio**\ (\ dialog\: :ref:`Window<class_Window>`, ratio\: :ref:`float<class_float>` = 0.8\ )
|
||||
|
||||
Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive_centered_ratio<class_Window_method_popup_exclusive_centered_ratio>`. The dialog must have no current parent, otherwise the method fails.
|
||||
|
||||
@@ -719,7 +719,7 @@ See also :ref:`Window.set_unparent_when_invisible<class_Window_method_set_unpare
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **popup_node_selector** **(** :ref:`Callable<class_Callable>` callback, :ref:`StringName[]<class_StringName>` valid_types=[] **)**
|
||||
|void| **popup_node_selector**\ (\ callback\: :ref:`Callable<class_Callable>`, valid_types\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] = []\ )
|
||||
|
||||
Pops up an editor dialog for selecting a :ref:`Node<class_Node>` from the edited scene. The ``callback`` must take a single argument of type :ref:`NodePath<class_NodePath>`. It is called on the selected :ref:`NodePath<class_NodePath>` or the empty path ``^""`` if the dialog is canceled. If ``valid_types`` is provided, the dialog will only show Nodes that match one of the listed Node types.
|
||||
|
||||
@@ -745,7 +745,7 @@ Pops up an editor dialog for selecting a :ref:`Node<class_Node>` from the edited
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **popup_property_selector** **(** :ref:`Object<class_Object>` object, :ref:`Callable<class_Callable>` callback, :ref:`PackedInt32Array<class_PackedInt32Array>` type_filter=PackedInt32Array() **)**
|
||||
|void| **popup_property_selector**\ (\ object\: :ref:`Object<class_Object>`, callback\: :ref:`Callable<class_Callable>`, type_filter\: :ref:`PackedInt32Array<class_PackedInt32Array>` = PackedInt32Array()\ )
|
||||
|
||||
Pops up an editor dialog for selecting properties from ``object``. The ``callback`` must take a single argument of type :ref:`NodePath<class_NodePath>`. It is called on the selected property path (see :ref:`NodePath.get_as_property_path<class_NodePath_method_get_as_property_path>`) or the empty path ``^""`` if the dialog is canceled. If ``type_filter`` is provided, the dialog will only show properties that match one of the listed :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` values.
|
||||
|
||||
@@ -771,7 +771,7 @@ Pops up an editor dialog for selecting properties from ``object``. The ``callbac
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **reload_scene_from_path** **(** :ref:`String<class_String>` scene_filepath **)**
|
||||
|void| **reload_scene_from_path**\ (\ scene_filepath\: :ref:`String<class_String>`\ )
|
||||
|
||||
Reloads the scene at the given path.
|
||||
|
||||
@@ -783,7 +783,7 @@ Reloads the scene at the given path.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **restart_editor** **(** :ref:`bool<class_bool>` save=true **)**
|
||||
|void| **restart_editor**\ (\ save\: :ref:`bool<class_bool>` = true\ )
|
||||
|
||||
Restarts the editor. This closes the editor and then opens the same project. If ``save`` is ``true``, the project will be saved before restarting.
|
||||
|
||||
@@ -795,7 +795,7 @@ Restarts the editor. This closes the editor and then opens the same project. If
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **save_all_scenes** **(** **)**
|
||||
|void| **save_all_scenes**\ (\ )
|
||||
|
||||
Saves all opened scenes in the editor.
|
||||
|
||||
@@ -807,7 +807,7 @@ Saves all opened scenes in the editor.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Error<enum_@GlobalScope_Error>` **save_scene** **(** **)**
|
||||
:ref:`Error<enum_@GlobalScope_Error>` **save_scene**\ (\ )
|
||||
|
||||
Saves the currently active scene. Returns either :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` or :ref:`@GlobalScope.ERR_CANT_CREATE<class_@GlobalScope_constant_ERR_CANT_CREATE>`.
|
||||
|
||||
@@ -819,7 +819,7 @@ Saves the currently active scene. Returns either :ref:`@GlobalScope.OK<class_@Gl
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **save_scene_as** **(** :ref:`String<class_String>` path, :ref:`bool<class_bool>` with_preview=true **)**
|
||||
|void| **save_scene_as**\ (\ path\: :ref:`String<class_String>`, with_preview\: :ref:`bool<class_bool>` = true\ )
|
||||
|
||||
Saves the currently active scene as a file at ``path``.
|
||||
|
||||
@@ -831,7 +831,7 @@ Saves the currently active scene as a file at ``path``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **select_file** **(** :ref:`String<class_String>` file **)**
|
||||
|void| **select_file**\ (\ file\: :ref:`String<class_String>`\ )
|
||||
|
||||
Selects the file, with the path provided by ``file``, in the FileSystem dock.
|
||||
|
||||
@@ -843,7 +843,7 @@ Selects the file, with the path provided by ``file``, in the FileSystem dock.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_current_feature_profile** **(** :ref:`String<class_String>` profile_name **)**
|
||||
|void| **set_current_feature_profile**\ (\ profile_name\: :ref:`String<class_String>`\ )
|
||||
|
||||
Selects and activates the specified feature profile with the given ``profile_name``. Set ``profile_name`` to an empty string to reset to the default feature profile.
|
||||
|
||||
@@ -859,7 +859,7 @@ A feature profile can be created programmatically using the :ref:`EditorFeatureP
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_main_screen_editor** **(** :ref:`String<class_String>` name **)**
|
||||
|void| **set_main_screen_editor**\ (\ name\: :ref:`String<class_String>`\ )
|
||||
|
||||
Sets the editor's current main screen to the one specified in ``name``. ``name`` must match the title of the tab in question exactly (e.g. ``2D``, ``3D``, ``Script``, or ``AssetLib`` for default tabs).
|
||||
|
||||
@@ -871,7 +871,7 @@ Sets the editor's current main screen to the one specified in ``name``. ``name``
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_plugin_enabled** **(** :ref:`String<class_String>` plugin, :ref:`bool<class_bool>` enabled **)**
|
||||
|void| **set_plugin_enabled**\ (\ plugin\: :ref:`String<class_String>`, enabled\: :ref:`bool<class_bool>`\ )
|
||||
|
||||
Sets the enabled status of a plugin. The plugin name is the same as its directory name.
|
||||
|
||||
@@ -883,7 +883,7 @@ Sets the enabled status of a plugin. The plugin name is the same as its director
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **stop_playing_scene** **(** **)**
|
||||
|void| **stop_playing_scene**\ (\ )
|
||||
|
||||
Stops the scene that is currently playing.
|
||||
|
||||
@@ -894,3 +894,4 @@ Stops the scene that is currently playing.
|
||||
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
||||
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
||||
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
||||
.. |void| replace:: :abbr:`void (No return value.)`
|
||||
|
||||
Reference in New Issue
Block a user