diff --git a/classes/class_compositoreffect.rst b/classes/class_compositoreffect.rst index a72da698208..005d19cb172 100644 --- a/classes/class_compositoreffect.rst +++ b/classes/class_compositoreffect.rst @@ -264,6 +264,19 @@ If ``true`` this triggers normal and roughness data to be output during our dept var render_scene_buffers : RenderSceneBuffersRD = render_data.get_render_scene_buffers() var roughness_buffer = render_scene_buffers.get_texture("forward_clustered", "normal_roughness") +The raw normal and roughness buffer is stored in an optimized format, different than the one available in Spatial shaders. When sampling the buffer, a conversion function must be applied. Use this function, copied from `here `__: + +:: + + vec4 normal_roughness_compatibility(vec4 p_normal_roughness) { + float roughness = p_normal_roughness.w; + if (roughness > 0.5) { + roughness = 1.0 - roughness; + } + roughness /= (127.0 / 255.0); + return vec4(normalize(p_normal_roughness.xyz * 2.0 - 1.0) * 0.5 + 0.5, roughness); + } + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorcontextmenuplugin.rst b/classes/class_editorcontextmenuplugin.rst index 10f12b6e5c6..40ad945dc15 100644 --- a/classes/class_editorcontextmenuplugin.rst +++ b/classes/class_editorcontextmenuplugin.rst @@ -31,13 +31,62 @@ Methods .. table:: :widths: auto - +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_popup_menu`\ (\ paths\: :ref:`PackedStringArray`\ ) |virtual| | - +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_context_menu_item`\ (\ name\: :ref:`String`, callback\: :ref:`Callable`, icon\: :ref:`Texture2D` = null, shortcut\: :ref:`Shortcut` = null\ ) | - +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_menu_shortcut`\ (\ shortcut\: :ref:`Shortcut`, callback\: :ref:`Callable`\ ) | - +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_popup_menu`\ (\ paths\: :ref:`PackedStringArray`\ ) |virtual| | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_context_menu_item`\ (\ name\: :ref:`String`, callback\: :ref:`Callable`, icon\: :ref:`Texture2D` = null\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_context_menu_item_from_shortcut`\ (\ name\: :ref:`String`, shortcut\: :ref:`Shortcut`, icon\: :ref:`Texture2D` = null\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_menu_shortcut`\ (\ shortcut\: :ref:`Shortcut`, callback\: :ref:`Callable`\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_EditorContextMenuPlugin_ContextMenuSlot: + +.. rst-class:: classref-enumeration + +enum **ContextMenuSlot**: :ref:`🔗` + +.. _class_EditorContextMenuPlugin_constant_CONTEXT_SLOT_SCENE_TREE: + +.. rst-class:: classref-enumeration-constant + +:ref:`ContextMenuSlot` **CONTEXT_SLOT_SCENE_TREE** = ``0`` + +Context menu of Scene dock. :ref:`_popup_menu` will be called with a list of paths to currently selected nodes, while option callback will receive the list of currently selected nodes. + +.. _class_EditorContextMenuPlugin_constant_CONTEXT_SLOT_FILESYSTEM: + +.. rst-class:: classref-enumeration-constant + +:ref:`ContextMenuSlot` **CONTEXT_SLOT_FILESYSTEM** = ``1`` + +Context menu of FileSystem dock. :ref:`_popup_menu` and option callback will be called with list of paths of the currently selected files. + +.. _class_EditorContextMenuPlugin_constant_CONTEXT_SLOT_FILESYSTEM_CREATE: + +.. rst-class:: classref-enumeration-constant + +:ref:`ContextMenuSlot` **CONTEXT_SLOT_FILESYSTEM_CREATE** = ``3`` + +The "Create..." submenu of FileSystem dock's context menu. :ref:`_popup_menu` and option callback will be called with list of paths of the currently selected files. + +.. _class_EditorContextMenuPlugin_constant_CONTEXT_SLOT_SCRIPT_EDITOR: + +.. rst-class:: classref-enumeration-constant + +:ref:`ContextMenuSlot` **CONTEXT_SLOT_SCRIPT_EDITOR** = ``2`` + +Context menu of Scene dock. :ref:`_popup_menu` will be called with the path to the currently edited script, while option callback will receive reference to that script. .. rst-class:: classref-section-separator @@ -54,7 +103,7 @@ Method Descriptions |void| **_popup_menu**\ (\ paths\: :ref:`PackedStringArray`\ ) |virtual| :ref:`🔗` -Called when creating a context menu, custom options can be added by using the :ref:`add_context_menu_item` function. +Called when creating a context menu, custom options can be added by using the :ref:`add_context_menu_item` or :ref:`add_context_menu_item_from_shortcut` functions. ``paths`` contains currently selected paths (depending on menu), which can be used to conditionally add options. .. rst-class:: classref-item-separator @@ -64,17 +113,37 @@ Called when creating a context menu, custom options can be added by using the :r .. rst-class:: classref-method -|void| **add_context_menu_item**\ (\ name\: :ref:`String`, callback\: :ref:`Callable`, icon\: :ref:`Texture2D` = null, shortcut\: :ref:`Shortcut` = null\ ) :ref:`🔗` - -Add custom options to the context menu of the currently specified slot. +|void| **add_context_menu_item**\ (\ name\: :ref:`String`, callback\: :ref:`Callable`, icon\: :ref:`Texture2D` = null\ ) :ref:`🔗` -To trigger a ``shortcut`` before the context menu is created, please additionally call the :ref:`add_menu_shortcut` function. +Add custom option to the context menu of the plugin's specified slot. When the option is activated, ``callback`` will be called. Callback should take single :ref:`Array` argument; array contents depend on context menu slot. :: func _popup_menu(paths): add_context_menu_item("File Custom options", handle, ICON) +If you want to assign shortcut to the menu item, use :ref:`add_context_menu_item_from_shortcut` instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorContextMenuPlugin_method_add_context_menu_item_from_shortcut: + +.. rst-class:: classref-method + +|void| **add_context_menu_item_from_shortcut**\ (\ name\: :ref:`String`, shortcut\: :ref:`Shortcut`, icon\: :ref:`Texture2D` = null\ ) :ref:`🔗` + +Add custom option to the context menu of the plugin's specified slot. The option will have the ``shortcut`` assigned and reuse its callback. The shortcut has to be registered beforehand with :ref:`add_menu_shortcut`. + +:: + + func _init(): + add_menu_shortcut(SHORTCUT, handle) + + func _popup_menu(paths): + add_context_menu_item_from_shortcut("File Custom options", SHORTCUT, ICON) + .. rst-class:: classref-item-separator ---- @@ -85,14 +154,12 @@ To trigger a ``shortcut`` before the context menu is created, please additionall |void| **add_menu_shortcut**\ (\ shortcut\: :ref:`Shortcut`, callback\: :ref:`Callable`\ ) :ref:`🔗` -To register the shortcut for the context menu, call this function within the :ref:`Object._init` function, even if the context menu has not been created yet. - -Note that this method should only be invoked from :ref:`Object._init`; otherwise, the shortcut will not be registered correctly. +Registers a shortcut associated with the plugin's context menu. This method should be called once (e.g. in plugin's :ref:`Object._init`). ``callback`` will be called when user presses the specified ``shortcut`` while the menu's context is in effect (e.g. FileSystem dock is focused). Callback should take single :ref:`Array` argument; array contents depend on context menu slot. :: func _init(): - add_menu_shortcut(SHORTCUT, handle); + add_menu_shortcut(SHORTCUT, handle) .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 3ff2efec755..3de1f7578b0 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -89,7 +89,7 @@ Methods +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_autoload_singleton`\ (\ name\: :ref:`String`, path\: :ref:`String`\ ) | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_context_menu_plugin`\ (\ slot\: :ref:`ContextMenuSlot`, plugin\: :ref:`EditorContextMenuPlugin`\ ) | + | |void| | :ref:`add_context_menu_plugin`\ (\ slot\: :ref:`ContextMenuSlot`, plugin\: :ref:`EditorContextMenuPlugin`\ ) | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Button` | :ref:`add_control_to_bottom_panel`\ (\ control\: :ref:`Control`, title\: :ref:`String`, shortcut\: :ref:`Shortcut` = null\ ) | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -143,7 +143,7 @@ Methods +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_autoload_singleton`\ (\ name\: :ref:`String`\ ) | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_context_menu_plugin`\ (\ slot\: :ref:`ContextMenuSlot`, plugin\: :ref:`EditorContextMenuPlugin`\ ) | + | |void| | :ref:`remove_context_menu_plugin`\ (\ plugin\: :ref:`EditorContextMenuPlugin`\ ) | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_control_from_bottom_panel`\ (\ control\: :ref:`Control`\ ) | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -492,48 +492,6 @@ Prevents the :ref:`InputEvent` from reaching other Editor clas Pass the :ref:`InputEvent` to other editor plugins except the main :ref:`Node3D` one. This can be used to prevent node selection changes and work with sub-gizmos instead. -.. rst-class:: classref-item-separator - ----- - -.. _enum_EditorPlugin_ContextMenuSlot: - -.. rst-class:: classref-enumeration - -enum **ContextMenuSlot**: :ref:`🔗` - -.. _class_EditorPlugin_constant_CONTEXT_SLOT_SCENE_TREE: - -.. rst-class:: classref-enumeration-constant - -:ref:`ContextMenuSlot` **CONTEXT_SLOT_SCENE_TREE** = ``0`` - -Context menu slot for the SceneTree. - -.. _class_EditorPlugin_constant_CONTEXT_SLOT_FILESYSTEM: - -.. rst-class:: classref-enumeration-constant - -:ref:`ContextMenuSlot` **CONTEXT_SLOT_FILESYSTEM** = ``1`` - -Context menu slot for the FileSystem. - -.. _class_EditorPlugin_constant_CONTEXT_SLOT_SCRIPT_EDITOR: - -.. rst-class:: classref-enumeration-constant - -:ref:`ContextMenuSlot` **CONTEXT_SLOT_SCRIPT_EDITOR** = ``2`` - -Context menu slot for the ScriptEditor file list. - -.. _class_EditorPlugin_constant_CONTEXT_SUBMENU_SLOT_FILESYSTEM_CREATE: - -.. rst-class:: classref-enumeration-constant - -:ref:`ContextMenuSlot` **CONTEXT_SUBMENU_SLOT_FILESYSTEM_CREATE** = ``3`` - -Context menu slot for the FileSystem create submenu. - .. rst-class:: classref-section-separator ---- @@ -1135,11 +1093,11 @@ Adds a script at ``path`` to the Autoload list as ``name``. .. rst-class:: classref-method -|void| **add_context_menu_plugin**\ (\ slot\: :ref:`ContextMenuSlot`, plugin\: :ref:`EditorContextMenuPlugin`\ ) :ref:`🔗` +|void| **add_context_menu_plugin**\ (\ slot\: :ref:`ContextMenuSlot`, plugin\: :ref:`EditorContextMenuPlugin`\ ) :ref:`🔗` -Adds a plugin to the context menu. ``slot`` is the position in the context menu where the plugin will be added. +Adds a plugin to the context menu. ``slot`` is the context menu where the plugin will be added. -Context menus are supported for three commonly used areas: the file system, scene tree, and editor script list panel. +See :ref:`ContextMenuSlot` for available context menus. A plugin instance can belong only to a single context menu slot. .. rst-class:: classref-item-separator @@ -1525,9 +1483,9 @@ Removes an Autoload ``name`` from the list. .. rst-class:: classref-method -|void| **remove_context_menu_plugin**\ (\ slot\: :ref:`ContextMenuSlot`, plugin\: :ref:`EditorContextMenuPlugin`\ ) :ref:`🔗` +|void| **remove_context_menu_plugin**\ (\ plugin\: :ref:`EditorContextMenuPlugin`\ ) :ref:`🔗` -Removes a context menu plugin from the specified slot. +Removes the specified context menu plugin. .. rst-class:: classref-item-separator diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index aaeae5118c6..a00087a19f0 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -58,6 +58,8 @@ Properties .. table:: :widths: auto + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`asset_library/use_threads` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debugger/auto_switch_to_remote_scene_tree` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -85,6 +87,10 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`docks/property_editor/subresource_hue_tint` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/scene_tree/ask_before_deleting_related_animation_tracks` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/scene_tree/ask_before_revoking_unique_name` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`docks/scene_tree/auto_expand_to_selected` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`docks/scene_tree/center_node_on_reparent` | @@ -149,6 +155,10 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/3d/grid_yz_plane` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/manipulator_gizmo_opacity` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/manipulator_gizmo_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/3d/navigation/emulate_3_button_mouse` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/3d/navigation/emulate_numpad` | @@ -163,6 +173,10 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`editors/3d/navigation/pan_mouse_button` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/navigation/show_viewport_navigation_gizmo` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/navigation/show_viewport_rotation_gizmo` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/3d/navigation/warped_mouse_panning` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`editors/3d/navigation/zoom_mouse_button` | @@ -187,10 +201,54 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/aabb` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/camera` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/csg` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/decal` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/fog_volume` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/instantiated` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/joint` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/joint_body_a` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/joint_body_b` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/lightmap_lines` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/lightprobe_lines` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/occluder` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/particle_attractor` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/particle_collision` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/particles` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/path_tilt` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/reflection_probe` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/selected_bone` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/skeleton` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/stream_player_3d` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/visibility_notifier` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/voxel_gi` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d_gizmos/gizmo_settings/bone_axis_length` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d_gizmos/gizmo_settings/bone_shape` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d_gizmos/gizmo_settings/path3d_tilt_disk_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/animation/autorename_animation_tracks` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/animation/confirm_insert_track` | @@ -203,8 +261,22 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/animation/onion_layers_past_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/bone_mapper/handle_colors/error` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/bone_mapper/handle_colors/missing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/bone_mapper/handle_colors/set` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/bone_mapper/handle_colors/unset` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/grid_map/editor_side` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/grid_map/palette_min_width` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`editors/grid_map/pick_distance` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/grid_map/preview_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`editors/panning/2d_editor_pan_speed` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`editors/panning/2d_editor_panning_scheme` | @@ -277,6 +349,10 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`editors/visual_editors/visual_shader/port_preview_size` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`export/ssh/scp` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`export/ssh/ssh` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`filesystem/directories/autoscan_project_path` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`filesystem/directories/default_project_path` | @@ -299,6 +375,10 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`filesystem/file_dialog/thumbnail_size` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/file_server/password` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`filesystem/file_server/port` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`filesystem/import/blender/blender_path` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`filesystem/import/blender/rpc_port` | @@ -397,6 +477,10 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/vsync_mode` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editors/derive_script_globals_by_name` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editors/show_scene_tree_root_selection` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/inspector/auto_unfold_foreign_scenes` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/inspector/default_color_picker_mode` | @@ -567,12 +651,16 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`text_editor/appearance/whitespace/line_spacing` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/auto_reload_and_parse_scripts_on_save` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/files/auto_reload_scripts_on_external_change` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`text_editor/behavior/files/autosave_interval_secs` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/files/convert_indent_on_save` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/open_dominant_script_on_scene_change` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/files/restore_scripts_on_load` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/files/trim_final_newlines_on_save` | @@ -629,6 +717,12 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/completion/use_single_quotes` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`text_editor/external/exec_flags` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`text_editor/external/exec_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/external/use_external_editor` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`text_editor/help/class_reference_examples` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`text_editor/help/help_font_size` | @@ -639,10 +733,22 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/help/show_help_index` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/help/sort_functions_alphabetically` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/script_list/group_help_pages` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/script_list/list_script_names_as` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/script_list/script_temperature_enabled` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/script_list/script_temperature_history_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/script_list/show_members_overview` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/script_list/sort_members_outline_alphabetically` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/script_list/sort_scripts_by` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`text_editor/theme/color_theme` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/background_color` | @@ -721,6 +827,14 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/word_highlighted_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/theme/line_spacing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`version_control/ssh_private_key_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`version_control/ssh_public_key_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`version_control/username` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -807,6 +921,18 @@ Emitted after any editor setting has changed. It's used by various editor plugin Property Descriptions --------------------- +.. _class_EditorSettings_property_asset_library/use_threads: + +.. rst-class:: classref-property + +:ref:`bool` **asset_library/use_threads** :ref:`🔗` + +If ``true``, the Asset Library uses multiple threads for its HTTP requests. This prevents the Asset Library from blocking the main thread for every loaded asset. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_debugger/auto_switch_to_remote_scene_tree: .. rst-class:: classref-property @@ -967,6 +1093,30 @@ The tint intensity to use for the subresources background in the Inspector dock. ---- +.. _class_EditorSettings_property_docks/scene_tree/ask_before_deleting_related_animation_tracks: + +.. rst-class:: classref-property + +:ref:`bool` **docks/scene_tree/ask_before_deleting_related_animation_tracks** :ref:`🔗` + +If ``true``, when a node is deleted with animation tracks referencing it, a confirmation dialog appears before the tracks are deleted. The dialog will appear even when using the "Delete (No Confirm)" shortcut. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_docks/scene_tree/ask_before_revoking_unique_name: + +.. rst-class:: classref-property + +:ref:`bool` **docks/scene_tree/ask_before_revoking_unique_name** :ref:`🔗` + +If ``true``, displays a confirmation dialog before left-clicking the "percent" icon next to a node name in the Scene tree dock. When clicked, this icon revokes the node's scene-unique name, which can impact the behavior of scripts that rely on this scene-unique name due to identifiers not being found anymore. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_docks/scene_tree/auto_expand_to_selected: .. rst-class:: classref-property @@ -1369,6 +1519,30 @@ If ``true``, renders the grid on the YZ plane in perspective view. This can be u ---- +.. _class_EditorSettings_property_editors/3d/manipulator_gizmo_opacity: + +.. rst-class:: classref-property + +:ref:`float` **editors/3d/manipulator_gizmo_opacity** :ref:`🔗` + +Opacity of the default gizmo for moving, rotating, and scaling 3D nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d/manipulator_gizmo_size: + +.. rst-class:: classref-property + +:ref:`int` **editors/3d/manipulator_gizmo_size** :ref:`🔗` + +Size of the default gizmo for moving, rotating, and scaling 3D nodes. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/3d/navigation/emulate_3_button_mouse: .. rst-class:: classref-property @@ -1467,6 +1641,30 @@ The mouse button that needs to be held down to pan in the 3D editor viewport. ---- +.. _class_EditorSettings_property_editors/3d/navigation/show_viewport_navigation_gizmo: + +.. rst-class:: classref-property + +:ref:`bool` **editors/3d/navigation/show_viewport_navigation_gizmo** :ref:`🔗` + +If ``true``, shows gizmos for moving and rotating the camera in the bottom corners of the 3D editor's viewport. Useful for devices that use touch screen. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d/navigation/show_viewport_rotation_gizmo: + +.. rst-class:: classref-property + +:ref:`bool` **editors/3d/navigation/show_viewport_rotation_gizmo** :ref:`🔗` + +If ``true``, shows a small orientation gizmo in the top-right corner of the 3D editor's viewports. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/3d/navigation/warped_mouse_panning: .. rst-class:: classref-property @@ -1557,165 +1755,521 @@ The inertia to use when zooming in the 3D editor. Higher values make the camera :ref:`Color` **editors/3d/primary_grid_color** :ref:`🔗` -The color to use for the primary 3D grid. The color's alpha channel affects the grid's opacity. +The color to use for the primary 3D grid. The color's alpha channel affects the grid's opacity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d/primary_grid_steps: + +.. rst-class:: classref-property + +:ref:`int` **editors/3d/primary_grid_steps** :ref:`🔗` + +If set above 0, where a primary grid line should be drawn. By default, primary lines are configured to be more visible than secondary lines. This helps with measurements in the 3D editor. See also :ref:`editors/3d/primary_grid_color` and :ref:`editors/3d/secondary_grid_color`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d/secondary_grid_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d/secondary_grid_color** :ref:`🔗` + +The color to use for the secondary 3D grid. This is generally a less visible color than :ref:`editors/3d/primary_grid_color`. The color's alpha channel affects the grid's opacity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d/selection_box_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d/selection_box_color** :ref:`🔗` + +The color to use for the selection box that surrounds selected nodes in the 3D editor viewport. The color's alpha channel influences the selection box's opacity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/aabb: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/aabb** :ref:`🔗` + +The color to use for the AABB gizmo that displays the :ref:`GeometryInstance3D`'s custom :ref:`AABB`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/camera: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/camera** :ref:`🔗` + +The 3D editor gizmo color for :ref:`Camera3D`\ s. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/csg: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/csg** :ref:`🔗` + +The 3D editor gizmo color for CSG nodes (such as :ref:`CSGShape3D` or :ref:`CSGBox3D`). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/decal: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/decal** :ref:`🔗` + +The 3D editor gizmo color for :ref:`Decal` nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/fog_volume: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/fog_volume** :ref:`🔗` + +The 3D editor gizmo color for :ref:`FogVolume` nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/instantiated: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/instantiated** :ref:`🔗` + +The color override to use for 3D editor gizmos if the :ref:`Node3D` in question is part of an instantiated scene file (from the perspective of the current scene). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/joint: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/joint** :ref:`🔗` + +The 3D editor gizmo color for :ref:`Joint3D`\ s and :ref:`PhysicalBone3D`\ s. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/joint_body_a: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/joint_body_a** :ref:`🔗` + +Color for representing :ref:`Joint3D.node_a` for some :ref:`Joint3D` types. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/joint_body_b: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/joint_body_b** :ref:`🔗` + +Color for representing :ref:`Joint3D.node_b` for some :ref:`Joint3D` types. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/lightmap_lines: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/lightmap_lines** :ref:`🔗` + +Color of lines displayed in baked :ref:`LightmapGI` node's grid. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/lightprobe_lines: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/lightprobe_lines** :ref:`🔗` + +The 3D editor gizmo color used for :ref:`LightmapProbe` nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/occluder: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/occluder** :ref:`🔗` + +The 3D editor gizmo color used for :ref:`OccluderInstance3D` nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/particle_attractor: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/particle_attractor** :ref:`🔗` + +The 3D editor gizmo color used for :ref:`GPUParticlesAttractor3D` nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/particle_collision: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/particle_collision** :ref:`🔗` + +The 3D editor gizmo color used for :ref:`GPUParticlesCollision3D` nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/particles: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/particles** :ref:`🔗` + +The 3D editor gizmo color used for :ref:`CPUParticles3D` and :ref:`GPUParticles3D` nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/path_tilt: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/path_tilt** :ref:`🔗` + +The 3D editor gizmo color used for :ref:`Path3D` tilt circles, which indicate the direction the :ref:`Curve3D` is tilted towards. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/reflection_probe: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/reflection_probe** :ref:`🔗` + +The 3D editor gizmo color used for :ref:`ReflectionProbe` nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/selected_bone: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/selected_bone** :ref:`🔗` + +The 3D editor gizmo color used for the currently selected :ref:`Skeleton3D` bone. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/skeleton: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/skeleton** :ref:`🔗` + +The 3D editor gizmo color used for :ref:`Skeleton3D` nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/stream_player_3d: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/stream_player_3d** :ref:`🔗` + +The 3D editor gizmo color used for :ref:`AudioStreamPlayer3D`'s emission angle. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/visibility_notifier: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/visibility_notifier** :ref:`🔗` + +The 3D editor gizmo color used for :ref:`VisibleOnScreenNotifier3D` and :ref:`VisibleOnScreenEnabler3D` nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/voxel_gi: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/voxel_gi** :ref:`🔗` + +The 3D editor gizmo color used for :ref:`VoxelGI` nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_settings/bone_axis_length: + +.. rst-class:: classref-property + +:ref:`float` **editors/3d_gizmos/gizmo_settings/bone_axis_length** :ref:`🔗` + +The length of :ref:`Skeleton3D` bone gizmos in the 3D editor. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_settings/bone_shape: + +.. rst-class:: classref-property + +:ref:`int` **editors/3d_gizmos/gizmo_settings/bone_shape** :ref:`🔗` + +The shape of :ref:`Skeleton3D` bone gizmos in the 3D editor. **Wire** is a thin line, while **Octahedron** is a set of lines that represent a thicker hollow line pointing in a specific direction (similar to most 3D animation software). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_settings/path3d_tilt_disk_size: + +.. rst-class:: classref-property + +:ref:`float` **editors/3d_gizmos/gizmo_settings/path3d_tilt_disk_size** :ref:`🔗` + +Size of the disk gizmo displayed when editing :ref:`Path3D`'s tilt handles. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/animation/autorename_animation_tracks: + +.. rst-class:: classref-property + +:ref:`bool` **editors/animation/autorename_animation_tracks** :ref:`🔗` + +If ``true``, automatically updates animation tracks' target paths when renaming or reparenting nodes in the Scene tree dock. .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/3d/primary_grid_steps: +.. _class_EditorSettings_property_editors/animation/confirm_insert_track: .. rst-class:: classref-property -:ref:`int` **editors/3d/primary_grid_steps** :ref:`🔗` +:ref:`bool` **editors/animation/confirm_insert_track** :ref:`🔗` -If set above 0, where a primary grid line should be drawn. By default, primary lines are configured to be more visible than secondary lines. This helps with measurements in the 3D editor. See also :ref:`editors/3d/primary_grid_color` and :ref:`editors/3d/secondary_grid_color`. +If ``true``, display a confirmation dialog when adding a new track to an animation by pressing the "key" icon next to a property. Holding Shift will bypass the dialog. + +If ``false``, the behavior is reversed, i.e. the dialog only appears when Shift is held. .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/3d/secondary_grid_color: +.. _class_EditorSettings_property_editors/animation/default_create_bezier_tracks: .. rst-class:: classref-property -:ref:`Color` **editors/3d/secondary_grid_color** :ref:`🔗` +:ref:`bool` **editors/animation/default_create_bezier_tracks** :ref:`🔗` -The color to use for the secondary 3D grid. This is generally a less visible color than :ref:`editors/3d/primary_grid_color`. The color's alpha channel affects the grid's opacity. +If ``true``, create a Bezier track instead of a standard track when pressing the "key" icon next to a property. Bezier tracks provide more control over animation curves, but are more difficult to adjust quickly. .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/3d/selection_box_color: +.. _class_EditorSettings_property_editors/animation/default_create_reset_tracks: .. rst-class:: classref-property -:ref:`Color` **editors/3d/selection_box_color** :ref:`🔗` +:ref:`bool` **editors/animation/default_create_reset_tracks** :ref:`🔗` -The color to use for the selection box that surrounds selected nodes in the 3D editor viewport. The color's alpha channel influences the selection box's opacity. +If ``true``, create a ``RESET`` track when creating a new animation track. This track can be used to restore the animation to a "default" state. .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/aabb: +.. _class_EditorSettings_property_editors/animation/onion_layers_future_color: .. rst-class:: classref-property -:ref:`Color` **editors/3d_gizmos/gizmo_colors/aabb** :ref:`🔗` +:ref:`Color` **editors/animation/onion_layers_future_color** :ref:`🔗` -The color to use for the AABB gizmo that displays the :ref:`GeometryInstance3D`'s custom :ref:`AABB`. +The modulate color to use for "future" frames displayed in the animation editor's onion skinning feature. .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/instantiated: +.. _class_EditorSettings_property_editors/animation/onion_layers_past_color: .. rst-class:: classref-property -:ref:`Color` **editors/3d_gizmos/gizmo_colors/instantiated** :ref:`🔗` +:ref:`Color` **editors/animation/onion_layers_past_color** :ref:`🔗` -The color override to use for 3D editor gizmos if the :ref:`Node3D` in question is part of an instantiated scene file (from the perspective of the current scene). +The modulate color to use for "past" frames displayed in the animation editor's onion skinning feature. .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/joint: +.. _class_EditorSettings_property_editors/bone_mapper/handle_colors/error: .. rst-class:: classref-property -:ref:`Color` **editors/3d_gizmos/gizmo_colors/joint** :ref:`🔗` +:ref:`Color` **editors/bone_mapper/handle_colors/error** :ref:`🔗` -The 3D editor gizmo color for :ref:`Joint3D`\ s and :ref:`PhysicalBone3D`\ s. +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/animation/autorename_animation_tracks: +.. _class_EditorSettings_property_editors/bone_mapper/handle_colors/missing: .. rst-class:: classref-property -:ref:`bool` **editors/animation/autorename_animation_tracks** :ref:`🔗` +:ref:`Color` **editors/bone_mapper/handle_colors/missing** :ref:`🔗` -If ``true``, automatically updates animation tracks' target paths when renaming or reparenting nodes in the Scene tree dock. +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/animation/confirm_insert_track: +.. _class_EditorSettings_property_editors/bone_mapper/handle_colors/set: .. rst-class:: classref-property -:ref:`bool` **editors/animation/confirm_insert_track** :ref:`🔗` +:ref:`Color` **editors/bone_mapper/handle_colors/set** :ref:`🔗` -If ``true``, display a confirmation dialog when adding a new track to an animation by pressing the "key" icon next to a property. Holding Shift will bypass the dialog. +.. container:: contribute -If ``false``, the behavior is reversed, i.e. the dialog only appears when Shift is held. + There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/animation/default_create_bezier_tracks: +.. _class_EditorSettings_property_editors/bone_mapper/handle_colors/unset: .. rst-class:: classref-property -:ref:`bool` **editors/animation/default_create_bezier_tracks** :ref:`🔗` +:ref:`Color` **editors/bone_mapper/handle_colors/unset** :ref:`🔗` -If ``true``, create a Bezier track instead of a standard track when pressing the "key" icon next to a property. Bezier tracks provide more control over animation curves, but are more difficult to adjust quickly. +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/animation/default_create_reset_tracks: +.. _class_EditorSettings_property_editors/grid_map/editor_side: .. rst-class:: classref-property -:ref:`bool` **editors/animation/default_create_reset_tracks** :ref:`🔗` +:ref:`int` **editors/grid_map/editor_side** :ref:`🔗` -If ``true``, create a ``RESET`` track when creating a new animation track. This track can be used to restore the animation to a "default" state. +Specifies the side of 3D editor's viewport where GridMap's mesh palette will appear. .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/animation/onion_layers_future_color: +.. _class_EditorSettings_property_editors/grid_map/palette_min_width: .. rst-class:: classref-property -:ref:`Color` **editors/animation/onion_layers_future_color** :ref:`🔗` +:ref:`int` **editors/grid_map/palette_min_width** :ref:`🔗` -The modulate color to use for "future" frames displayed in the animation editor's onion skinning feature. +Minimum width of GridMap's mesh palette side panel. .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/animation/onion_layers_past_color: +.. _class_EditorSettings_property_editors/grid_map/pick_distance: .. rst-class:: classref-property -:ref:`Color` **editors/animation/onion_layers_past_color** :ref:`🔗` +:ref:`float` **editors/grid_map/pick_distance** :ref:`🔗` -The modulate color to use for "past" frames displayed in the animation editor's onion skinning feature. +The maximum distance at which tiles can be placed on a GridMap, relative to the camera position (in 3D units). .. rst-class:: classref-item-separator ---- -.. _class_EditorSettings_property_editors/grid_map/pick_distance: +.. _class_EditorSettings_property_editors/grid_map/preview_size: .. rst-class:: classref-property -:ref:`float` **editors/grid_map/pick_distance** :ref:`🔗` +:ref:`int` **editors/grid_map/preview_size** :ref:`🔗` -The maximum distance at which tiles can be placed on a GridMap, relative to the camera position (in 3D units). +Texture size of mesh previews generated for GridMap's MeshLibrary. .. rst-class:: classref-item-separator @@ -2155,6 +2709,32 @@ The size to use for port previews in the visual shader uniforms (toggled by clic ---- +.. _class_EditorSettings_property_export/ssh/scp: + +.. rst-class:: classref-property + +:ref:`String` **export/ssh/scp** :ref:`🔗` + +Path to the SCP (secure copy) executable (used for remote deploy to desktop platforms). If left empty, the editor will attempt to run ``scp`` from ``PATH``. + +\ **Note:** SCP is not the same as SFTP. Specifying the SFTP executable here will not work. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_export/ssh/ssh: + +.. rst-class:: classref-property + +:ref:`String` **export/ssh/ssh** :ref:`🔗` + +Path to the SSH executable (used for remote deploy to desktop platforms). If left empty, the editor will attempt to run ``ssh`` from ``PATH``. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_filesystem/directories/autoscan_project_path: .. rst-class:: classref-property @@ -2311,6 +2891,30 @@ The thumbnail size to use in the editor's file dialogs (in pixels). See also :re ---- +.. _class_EditorSettings_property_filesystem/file_server/password: + +.. rst-class:: classref-property + +:ref:`String` **filesystem/file_server/password** :ref:`🔗` + +Password used for file server when exporting project with remote file system. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_filesystem/file_server/port: + +.. rst-class:: classref-property + +:ref:`int` **filesystem/file_server/port** :ref:`🔗` + +Port used for file server when exporting project with remote file system. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_filesystem/import/blender/blender_path: .. rst-class:: classref-property @@ -2977,6 +3581,30 @@ Depending on the platform and used renderer, the engine will fall back to **Enab ---- +.. _class_EditorSettings_property_interface/editors/derive_script_globals_by_name: + +.. rst-class:: classref-property + +:ref:`bool` **interface/editors/derive_script_globals_by_name** :ref:`🔗` + +If ``true``, when extending a script, the global class name of the script is inserted in the script creation dialog, if it exists. If ``false``, the script's file path is always inserted. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/editors/show_scene_tree_root_selection: + +.. rst-class:: classref-property + +:ref:`bool` **interface/editors/show_scene_tree_root_selection** :ref:`🔗` + +If ``true``, the Scene dock will display buttons to quickly add a root node to a newly created scene. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/inspector/auto_unfold_foreign_scenes: .. rst-class:: classref-property @@ -4075,6 +4703,18 @@ The space to add between lines (in pixels). Greater line spacing can help improv ---- +.. _class_EditorSettings_property_text_editor/behavior/files/auto_reload_and_parse_scripts_on_save: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/behavior/files/auto_reload_and_parse_scripts_on_save** :ref:`🔗` + +If ``true``, tool scripts will be automatically soft-reloaded after they are saved. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/behavior/files/auto_reload_scripts_on_external_change: .. rst-class:: classref-property @@ -4111,6 +4751,18 @@ If ``true``, converts indentation to match the script editor's indentation setti ---- +.. _class_EditorSettings_property_text_editor/behavior/files/open_dominant_script_on_scene_change: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/behavior/files/open_dominant_script_on_scene_change** :ref:`🔗` + +If ``true``, opening a scene automatically opens the script attached to the root node, or the topmost node if the root has no script. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/behavior/files/restore_scripts_on_load: .. rst-class:: classref-property @@ -4453,6 +5105,42 @@ If ``true``, performs string autocompletion with single quotes. If ``false``, pe ---- +.. _class_EditorSettings_property_text_editor/external/exec_flags: + +.. rst-class:: classref-property + +:ref:`String` **text_editor/external/exec_flags** :ref:`🔗` + +The command-line arguments to pass to the external text editor that is run when :ref:`text_editor/external/use_external_editor` is ``true``. See also :ref:`text_editor/external/exec_path`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/external/exec_path: + +.. rst-class:: classref-property + +:ref:`String` **text_editor/external/exec_path** :ref:`🔗` + +The path to the text editor executable used to edit text files if :ref:`text_editor/external/use_external_editor` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/external/use_external_editor: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/external/use_external_editor** :ref:`🔗` + +If ``true``, uses an external editor instead of the built-in Script Editor. See also :ref:`text_editor/external/exec_path` and :ref:`text_editor/external/exec_flags`. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/help/class_reference_examples: .. rst-class:: classref-property @@ -4513,6 +5201,66 @@ If ``true``, displays a table of contents at the left of the editor help (at the ---- +.. _class_EditorSettings_property_text_editor/help/sort_functions_alphabetically: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/help/sort_functions_alphabetically** :ref:`🔗` + +If ``true``, the script's method list in the Script Editor is sorted alphabetically. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/script_list/group_help_pages: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/script_list/group_help_pages** :ref:`🔗` + +If ``true``, class reference pages are grouped together at the bottom of the Script Editor's script list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/script_list/list_script_names_as: + +.. rst-class:: classref-property + +:ref:`int` **text_editor/script_list/list_script_names_as** :ref:`🔗` + +Specifies how script paths should be displayed in Script Editor's script list. If using the "Name" option and some scripts share the same file name, more parts of their paths are revealed to avoid conflicts. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/script_list/script_temperature_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/script_list/script_temperature_enabled** :ref:`🔗` + +If ``true``, the names of recently opened scripts in the Script Editor are highlighted with the accent color, with its intensity based on how recently they were opened. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/script_list/script_temperature_history_size: + +.. rst-class:: classref-property + +:ref:`int` **text_editor/script_list/script_temperature_history_size** :ref:`🔗` + +How many script names can be highlighted at most, if :ref:`text_editor/script_list/script_temperature_enabled` is ``true``. Scripts older than this value use the default font color. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/script_list/show_members_overview: .. rst-class:: classref-property @@ -4539,6 +5287,18 @@ If ``true``, sorts the members outline (located at the left of the script editor ---- +.. _class_EditorSettings_property_text_editor/script_list/sort_scripts_by: + +.. rst-class:: classref-property + +:ref:`int` **text_editor/script_list/sort_scripts_by** :ref:`🔗` + +Specifies sorting used for Script Editor's open script list. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/theme/color_theme: .. rst-class:: classref-property @@ -5017,6 +5777,54 @@ The script editor's color for user-defined types (using ``class_name``). The script editor's color for words highlighted by selecting them. Only visible if :ref:`text_editor/appearance/caret/highlight_all_occurrences` is ``true``. +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_text_editor/theme/line_spacing: + +.. rst-class:: classref-property + +:ref:`int` **text_editor/theme/line_spacing** :ref:`🔗` + +The vertical line separation used in text editors, in pixels. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_version_control/ssh_private_key_path: + +.. rst-class:: classref-property + +:ref:`String` **version_control/ssh_private_key_path** :ref:`🔗` + +Path to private SSH key file for the editor's Version Control integration credentials. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_version_control/ssh_public_key_path: + +.. rst-class:: classref-property + +:ref:`String` **version_control/ssh_public_key_path** :ref:`🔗` + +Path to public SSH key file for the editor's Version Control integration credentials. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_version_control/username: + +.. rst-class:: classref-property + +:ref:`String` **version_control/username** :ref:`🔗` + +Default username for editor's Version Control integration. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 7dde88ddf5a..48fbe89c19b 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -22,7 +22,21 @@ An input field for single-line text. Description ----------- -**LineEdit** provides an input field for editing a single line of text. It features many built-in shortcuts that are always available (:kbd:`Ctrl` here maps to :kbd:`Cmd` on macOS): +**LineEdit** provides an input field for editing a single line of text. + +- When the **LineEdit** control is focused using the keyboard arrow keys, it will only gain focus and not enter edit mode. + +- To enter edit mode, click on the control with the mouse or press the "ui_text_submit" action (default: :kbd:`Enter` or :kbd:`Kp Enter`). + +- To exit edit mode, press "ui_text_submit" or "ui_cancel" (default: :kbd:`Escape`) actions. + +- Check :ref:`is_editing` and :ref:`editing_toggled` for more information. + +\ **Important:**\ + +- Focusing the **LineEdit** with "ui_focus_next" (default: :kbd:`Tab`) or "ui_focus_prev" (default: :kbd:`Shift + Tab`) or :ref:`Control.grab_focus` still enters edit mode (for compatibility). + +\ **LineEdit** features many built-in shortcuts that are always available (:kbd:`Ctrl` here maps to :kbd:`Cmd` on macOS): - :kbd:`Ctrl + C`: Copy @@ -148,6 +162,10 @@ Methods .. table:: :widths: auto + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_ime`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cancel_ime`\ (\ ) | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear`\ (\ ) | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ @@ -167,10 +185,14 @@ Methods +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selection_to_column`\ (\ ) |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_ime_text`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_selection`\ (\ ) |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`insert_text_at_caret`\ (\ text\: :ref:`String`\ ) | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_editing`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_menu_visible`\ (\ ) |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`menu_option`\ (\ option\: :ref:`int`\ ) | @@ -235,6 +257,18 @@ Theme Properties Signals ------- +.. _class_LineEdit_signal_editing_toggled: + +.. rst-class:: classref-signal + +**editing_toggled**\ (\ toggled_on\: :ref:`bool`\ ) :ref:`🔗` + +Emitted when the **LineEdit** switches in or out of edit mode. + +.. rst-class:: classref-item-separator + +---- + .. _class_LineEdit_signal_text_change_rejected: .. rst-class:: classref-signal @@ -1167,6 +1201,30 @@ Specifies the type of virtual keyboard to show. Method Descriptions ------------------- +.. _class_LineEdit_method_apply_ime: + +.. rst-class:: classref-method + +|void| **apply_ime**\ (\ ) :ref:`🔗` + +Applies text from the `Input Method Editor `__ (IME) and closes the IME if it is open. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LineEdit_method_cancel_ime: + +.. rst-class:: classref-method + +|void| **cancel_ime**\ (\ ) :ref:`🔗` + +Closes the `Input Method Editor `__ (IME) if it is open. Any text in the IME will be lost. + +.. rst-class:: classref-item-separator + +---- + .. _class_LineEdit_method_clear: .. rst-class:: classref-method @@ -1322,6 +1380,18 @@ Returns the selection end column. ---- +.. _class_LineEdit_method_has_ime_text: + +.. rst-class:: classref-method + +:ref:`bool` **has_ime_text**\ (\ ) |const| :ref:`🔗` + +Returns ``true`` if the user has text in the `Input Method Editor `__ (IME). + +.. rst-class:: classref-item-separator + +---- + .. _class_LineEdit_method_has_selection: .. rst-class:: classref-method @@ -1346,6 +1416,18 @@ Inserts ``text`` at the caret. If the resulting value is longer than :ref:`max_l ---- +.. _class_LineEdit_method_is_editing: + +.. rst-class:: classref-method + +:ref:`bool` **is_editing**\ (\ ) |const| :ref:`🔗` + +Returns whether the **LineEdit** is being edited. + +.. rst-class:: classref-item-separator + +---- + .. _class_LineEdit_method_is_menu_visible: .. rst-class:: classref-method diff --git a/classes/class_navigationserver2d.rst b/classes/class_navigationserver2d.rst index d0b2b4c41ad..62b3f76245f 100644 --- a/classes/class_navigationserver2d.rst +++ b/classes/class_navigationserver2d.rst @@ -253,6 +253,8 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`region_create`\ (\ ) | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`region_get_closest_point`\ (\ region\: :ref:`RID`, to_point\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`region_get_connection_pathway_end`\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`region_get_connection_pathway_start`\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| | @@ -1104,7 +1106,7 @@ Returns the map cell size used to rasterize the navigation mesh vertices. :ref:`Vector2` **map_get_closest_point**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` -Returns the point closest to the provided ``to_point`` on the navigation mesh surface. +Returns the navigation mesh surface point closest to the provided ``to_point`` on the navigation ``map``. .. rst-class:: classref-item-separator @@ -1116,7 +1118,7 @@ Returns the point closest to the provided ``to_point`` on the navigation mesh su :ref:`RID` **map_get_closest_point_owner**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` -Returns the owner region RID for the point returned by :ref:`map_get_closest_point`. +Returns the owner region RID for the navigation mesh surface point closest to the provided ``to_point`` on the navigation ``map``. .. rst-class:: classref-item-separator @@ -1552,6 +1554,18 @@ Creates a new region. ---- +.. _class_NavigationServer2D_method_region_get_closest_point: + +.. rst-class:: classref-method + +:ref:`Vector2` **region_get_closest_point**\ (\ region\: :ref:`RID`, to_point\: :ref:`Vector2`\ ) |const| :ref:`🔗` + +Returns the navigation mesh surface point closest to the provided ``to_point`` on the navigation ``region``. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_region_get_connection_pathway_end: .. rst-class:: classref-method diff --git a/classes/class_navigationserver3d.rst b/classes/class_navigationserver3d.rst index d6462951ddb..c9fdd9b7207 100644 --- a/classes/class_navigationserver3d.rst +++ b/classes/class_navigationserver3d.rst @@ -289,6 +289,12 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`region_create`\ (\ ) | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`region_get_closest_point`\ (\ region\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`region_get_closest_point_normal`\ (\ region\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`region_get_closest_point_to_segment`\ (\ region\: :ref:`RID`, start\: :ref:`Vector3`, end\: :ref:`Vector3`, use_collision\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`region_get_connection_pathway_end`\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`region_get_connection_pathway_start`\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| | @@ -1325,7 +1331,7 @@ Returns the map cell size used to rasterize the navigation mesh vertices on the :ref:`Vector3` **map_get_closest_point**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` -Returns the point closest to the provided ``to_point`` on the navigation mesh surface. +Returns the navigation mesh surface point closest to the provided ``to_point`` on the navigation ``map``. .. rst-class:: classref-item-separator @@ -1337,7 +1343,7 @@ Returns the point closest to the provided ``to_point`` on the navigation mesh su :ref:`Vector3` **map_get_closest_point_normal**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` -Returns the normal for the point returned by :ref:`map_get_closest_point`. +Returns the navigation mesh surface normal closest to the provided ``to_point`` on the navigation ``map``. .. rst-class:: classref-item-separator @@ -1349,7 +1355,7 @@ Returns the normal for the point returned by :ref:`map_get_closest_point` **map_get_closest_point_owner**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` -Returns the owner region RID for the point returned by :ref:`map_get_closest_point`. +Returns the owner region RID for the navigation mesh surface point closest to the provided ``to_point`` on the navigation ``map``. .. rst-class:: classref-item-separator @@ -1361,7 +1367,9 @@ Returns the owner region RID for the point returned by :ref:`map_get_closest_poi :ref:`Vector3` **map_get_closest_point_to_segment**\ (\ map\: :ref:`RID`, start\: :ref:`Vector3`, end\: :ref:`Vector3`, use_collision\: :ref:`bool` = false\ ) |const| :ref:`🔗` -Returns the closest point between the navigation surface and the segment. +Returns the navigation mesh surface point closest to the provided ``start`` and ``end`` segment on the navigation ``map``. + +If ``use_collision`` is ``true``, a closest point test is only done when the segment intersects with the navigation mesh surface. .. rst-class:: classref-item-separator @@ -1919,6 +1927,44 @@ Creates a new region. ---- +.. _class_NavigationServer3D_method_region_get_closest_point: + +.. rst-class:: classref-method + +:ref:`Vector3` **region_get_closest_point**\ (\ region\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` + +Returns the navigation mesh surface point closest to the provided ``to_point`` on the navigation ``region``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationServer3D_method_region_get_closest_point_normal: + +.. rst-class:: classref-method + +:ref:`Vector3` **region_get_closest_point_normal**\ (\ region\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` + +Returns the navigation mesh surface normal closest to the provided ``to_point`` on the navigation ``region``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationServer3D_method_region_get_closest_point_to_segment: + +.. rst-class:: classref-method + +:ref:`Vector3` **region_get_closest_point_to_segment**\ (\ region\: :ref:`RID`, start\: :ref:`Vector3`, end\: :ref:`Vector3`, use_collision\: :ref:`bool` = false\ ) |const| :ref:`🔗` + +Returns the navigation mesh surface point closest to the provided ``start`` and ``end`` segment on the navigation ``region``. + +If ``use_collision`` is ``true``, a closest point test is only done when the segment intersects with the navigation mesh surface. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer3D_method_region_get_connection_pathway_end: .. rst-class:: classref-method diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index a48128eb7cc..97b8fc04d79 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -118,7 +118,7 @@ Property Descriptions - |void| **set_global_position**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_global_position**\ (\ ) -Global position. +Global position. See also :ref:`position`. .. rst-class:: classref-item-separator @@ -135,7 +135,7 @@ Global position. - |void| **set_global_rotation**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_global_rotation**\ (\ ) -Global rotation in radians. +Global rotation in radians. See also :ref:`rotation`. .. rst-class:: classref-item-separator @@ -152,7 +152,7 @@ Global rotation in radians. - |void| **set_global_rotation_degrees**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_global_rotation_degrees**\ (\ ) -Helper property to access :ref:`global_rotation` in degrees instead of radians. +Helper property to access :ref:`global_rotation` in degrees instead of radians. See also :ref:`rotation_degrees`. .. rst-class:: classref-item-separator @@ -169,7 +169,7 @@ Helper property to access :ref:`global_rotation`\ ) - :ref:`Vector2` **get_global_scale**\ (\ ) -Global scale. +Global scale. See also :ref:`scale`. .. rst-class:: classref-item-separator @@ -186,7 +186,7 @@ Global scale. - |void| **set_global_skew**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_global_skew**\ (\ ) -Global skew in radians. +Global skew in radians. See also :ref:`skew`. .. rst-class:: classref-item-separator @@ -203,7 +203,7 @@ Global skew in radians. - |void| **set_global_transform**\ (\ value\: :ref:`Transform2D`\ ) - :ref:`Transform2D` **get_global_transform**\ (\ ) -Global :ref:`Transform2D`. +Global :ref:`Transform2D`. See also :ref:`transform`. .. rst-class:: classref-item-separator @@ -220,7 +220,7 @@ Global :ref:`Transform2D`. - |void| **set_position**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_position**\ (\ ) -Position, relative to the node's parent. +Position, relative to the node's parent. See also :ref:`global_position`. .. rst-class:: classref-item-separator @@ -237,7 +237,7 @@ Position, relative to the node's parent. - |void| **set_rotation**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_rotation**\ (\ ) -Rotation in radians, relative to the node's parent. +Rotation in radians, relative to the node's parent. See also :ref:`global_rotation`. \ **Note:** This property is edited in the inspector in degrees. If you want to use degrees in a script, use :ref:`rotation_degrees`. @@ -256,7 +256,7 @@ Rotation in radians, relative to the node's parent. - |void| **set_rotation_degrees**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_rotation_degrees**\ (\ ) -Helper property to access :ref:`rotation` in degrees instead of radians. +Helper property to access :ref:`rotation` in degrees instead of radians. See also :ref:`global_rotation_degrees`. .. rst-class:: classref-item-separator @@ -273,7 +273,7 @@ Helper property to access :ref:`rotation` in deg - |void| **set_scale**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_scale**\ (\ ) -The node's scale. Unscaled value: ``(1, 1)``. +The node's scale, relative to the node's parent. Unscaled value: ``(1, 1)``. See also :ref:`global_scale`. \ **Note:** Negative X scales in 2D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, negative scales on the X axis will be changed to negative scales on the Y axis and a rotation of 180 degrees when decomposed. @@ -292,9 +292,11 @@ The node's scale. Unscaled value: ``(1, 1)``. - |void| **set_skew**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_skew**\ (\ ) -Slants the node. +If set to a non-zero value, slants the node in one direction or another. This can be used for pseudo-3D effects. See also :ref:`global_skew`. -\ **Note:** Skew is X axis only. +\ **Note:** Skew is performed on the X axis only, and *between* rotation and scaling. + +\ **Note:** This property is edited in the inspector in degrees. If you want to use degrees in a script, use ``skew = deg_to_rad(value_in_degrees)``. .. rst-class:: classref-item-separator @@ -311,7 +313,7 @@ Slants the node. - |void| **set_transform**\ (\ value\: :ref:`Transform2D`\ ) - :ref:`Transform2D` **get_transform**\ (\ ) -Local :ref:`Transform2D`. +The node's :ref:`Transform2D`, relative to the node's parent. See also :ref:`global_transform`. .. rst-class:: classref-section-separator diff --git a/classes/class_openxrcompositionlayer.rst b/classes/class_openxrcompositionlayer.rst index 751e86fabe5..9d2e46260fc 100644 --- a/classes/class_openxrcompositionlayer.rst +++ b/classes/class_openxrcompositionlayer.rst @@ -35,15 +35,19 @@ Properties .. table:: :widths: auto - +---------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`alpha_blend` | ``false`` | - +---------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`enable_hole_punch` | ``false`` | - +---------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`SubViewport` | :ref:`layer_viewport` | | - +---------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`sort_order` | ``1`` | - +---------------------------------------+-----------------------------------------------------------------------------------+-----------+ + +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`alpha_blend` | ``false`` | + +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Vector2i` | :ref:`android_surface_size` | ``Vector2i(1024, 1024)`` | + +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`enable_hole_punch` | ``false`` | + +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ + | :ref:`SubViewport` | :ref:`layer_viewport` | | + +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`sort_order` | ``1`` | + +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`use_android_surface` | ``false`` | + +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ .. rst-class:: classref-reftable-group @@ -53,11 +57,13 @@ Methods .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`intersects_ray`\ (\ origin\: :ref:`Vector3`, direction\: :ref:`Vector3`\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_natively_supported`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`JavaObject` | :ref:`get_android_surface`\ (\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`intersects_ray`\ (\ origin\: :ref:`Vector3`, direction\: :ref:`Vector3`\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_natively_supported`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -87,6 +93,23 @@ Can be combined with :ref:`Viewport.transparent_bg` **android_surface_size** = ``Vector2i(1024, 1024)`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_android_surface_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_android_surface_size**\ (\ ) + +The size of the Android surface to create if :ref:`use_android_surface` is enabled. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRCompositionLayer_property_enable_hole_punch: .. rst-class:: classref-property @@ -138,6 +161,27 @@ The sort order for this composition layer. Higher numbers will be shown in front \ **Note:** This will have no effect if a fallback mesh is being used. +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_use_android_surface: + +.. rst-class:: classref-property + +:ref:`bool` **use_android_surface** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_use_android_surface**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_android_surface**\ (\ ) + +If enabled, an Android surface will be created (with the dimensions from :ref:`android_surface_size`) which will provide the 2D content for the composition layer, rather than using :ref:`layer_viewport`. + +See :ref:`get_android_surface` for information about how to get the surface so that your application can draw to it. + +\ **Note:** This will only work in Android builds. + .. rst-class:: classref-section-separator ---- @@ -147,6 +191,20 @@ The sort order for this composition layer. Higher numbers will be shown in front Method Descriptions ------------------- +.. _class_OpenXRCompositionLayer_method_get_android_surface: + +.. rst-class:: classref-method + +:ref:`JavaObject` **get_android_surface**\ (\ ) :ref:`🔗` + +Returns a :ref:`JavaObject` representing an ``android.view.Surface`` if :ref:`use_android_surface` is enabled and OpenXR has created the surface. Otherwise, this will return ``null``. + +\ **Note:** The surface can only be created during an active OpenXR session. So, if :ref:`use_android_surface` is enabled outside of an OpenXR session, it won't be created until a new session fully starts. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRCompositionLayer_method_intersects_ray: .. rst-class:: classref-method diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 72101831437..c1e32050b11 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -705,6 +705,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_undo` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_unicode_start` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_up` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`input_devices/buffering/agile_event_flushing` | ``false`` | @@ -1283,6 +1285,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`physics/common/physics_ticks_per_second` | ``60`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/2d/batching/item_buffer_size` | ``16384`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/2d/sdf/oversize` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/2d/sdf/scale` | ``1`` | @@ -6036,6 +6040,20 @@ Default :ref:`InputEventAction` to undo the most recent ---- +.. _class_ProjectSettings_property_input/ui_unicode_start: + +.. rst-class:: classref-property + +:ref:`Dictionary` **input/ui_unicode_start** :ref:`🔗` + +Default :ref:`InputEventAction` to start Unicode character hexadecimal code input in a text field. + +\ **Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input/ui_up: .. rst-class:: classref-property @@ -9660,6 +9678,18 @@ The number of fixed iterations per second. This controls how often physics simul ---- +.. _class_ProjectSettings_property_rendering/2d/batching/item_buffer_size: + +.. rst-class:: classref-property + +:ref:`int` **rendering/2d/batching/item_buffer_size** = ``16384`` :ref:`🔗` + +Maximum number of canvas item commands that can be batched into a single draw call. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/2d/sdf/oversize: .. rst-class:: classref-property diff --git a/classes/class_rdshadersource.rst b/classes/class_rdshadersource.rst index a0110a34cce..08a64d99c1c 100644 --- a/classes/class_rdshadersource.rst +++ b/classes/class_rdshadersource.rst @@ -195,6 +195,8 @@ Returns source code for the specified shader ``stage``. Equivalent to getting on Sets ``source`` code for the specified shader ``stage``. Equivalent to setting one of :ref:`source_compute`, :ref:`source_fragment`, :ref:`source_tesselation_control`, :ref:`source_tesselation_evaluation` or :ref:`source_vertex`. +\ **Note:** If you set the compute shader source code using this method directly, remember to remove the Godot-specific hint ``#[compute]``. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_resourceimporterdynamicfont.rst b/classes/class_resourceimporterdynamicfont.rst index 9cacce548df..65f38724cdd 100644 --- a/classes/class_resourceimporterdynamicfont.rst +++ b/classes/class_resourceimporterdynamicfont.rst @@ -239,7 +239,7 @@ Source font size used to generate MSDF textures. Higher values allow for more pr :ref:`bool` **multichannel_signed_distance_field** = ``false`` :ref:`🔗` -If set to ``true``, the default font will use multichannel signed distance field (MSDF) for crisp rendering at any size. Since this approach does not rely on rasterizing the font every time its size changes, this allows for resizing the font in real-time without any performance penalty. Text will also not look grainy for :ref:`Control`\ s that are scaled down (or for :ref:`Label3D`\ s viewed from a long distance). +If set to ``true``, the font will use multichannel signed distance field (MSDF) for crisp rendering at any size. Since this approach does not rely on rasterizing the font every time its size changes, this allows for resizing the font in real-time without any performance penalty. Text will also not look grainy for :ref:`Control`\ s that are scaled down (or for :ref:`Label3D`\ s viewed from a long distance). MSDF font rendering can be combined with :ref:`generate_mipmaps` to further improve font rendering quality when scaled down. diff --git a/classes/class_resourceimporterscene.rst b/classes/class_resourceimporterscene.rst index f7414151688..2ec10e2bf72 100644 --- a/classes/class_resourceimporterscene.rst +++ b/classes/class_resourceimporterscene.rst @@ -77,6 +77,8 @@ Properties +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`nodes/root_type` | ``""`` | +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`nodes/use_node_type_suffixes` | ``true`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`skins/use_named_skins` | ``true`` | +-------------------------------------+------------------------------------------------------------------------------------------------------------------+-----------+ @@ -309,6 +311,18 @@ Override for the root node type. If empty, the root node will use what the scene ---- +.. _class_ResourceImporterScene_property_nodes/use_node_type_suffixes: + +.. rst-class:: classref-property + +:ref:`bool` **nodes/use_node_type_suffixes** = ``true`` :ref:`🔗` + +If ``true``, use suffixes in the node names to determine the node type, such as ``-col`` for collision shapes. Disabling this makes editor-imported files more similar to the original files, and more similar to importing files at runtime. See :doc:`Node type customization using name suffixes <../tutorials/assets_pipeline/importing_3d_scenes/node_type_customization>` for more information. + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceImporterScene_property_skins/use_named_skins: .. rst-class:: classref-property diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 554d9de0ea1..81f899c43ba 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -52,6 +52,8 @@ Methods +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`unregister_syntax_highlighter`\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_docs_from_script`\ (\ script\: :ref:`Script`\ ) | + +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -234,6 +236,20 @@ Unregisters the :ref:`EditorSyntaxHighlighter` fr \ **Note:** The :ref:`EditorSyntaxHighlighter` will still be applied to scripts that are already opened. +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptEditor_method_update_docs_from_script: + +.. rst-class:: classref-method + +|void| **update_docs_from_script**\ (\ script\: :ref:`Script`\ ) :ref:`🔗` + +Updates the documentation for the given ``script`` if the script's documentation is currently open. + +\ **Note:** This should be called whenever the script is changed to keep the open documentation state up to date. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 12a38369b00..e9c5589bd79 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -315,7 +315,7 @@ Use :ref:`has_default_font` to check if thi The default font size of this theme resource. Used as the default value when trying to fetch a font size value that doesn't exist in this theme or is in invalid state. If the default font size is also missing or invalid, the engine fallback value is used (see :ref:`ThemeDB.fallback_font_size`). -Values below ``0`` are invalid and can be used to unset the property. Use :ref:`has_default_font_size` to check if this value is valid. +Values below ``1`` are invalid and can be used to unset the property. Use :ref:`has_default_font_size` to check if this value is valid. .. rst-class:: classref-section-separator diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 7fbbf384983..1f6e7049ea8 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -110,6 +110,8 @@ Methods +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_icon_modulate`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_icon_overlay`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_icon_region`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_index`\ (\ ) | @@ -226,6 +228,8 @@ Methods +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_icon_modulate`\ (\ column\: :ref:`int`, modulate\: :ref:`Color`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon_overlay`\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_icon_region`\ (\ column\: :ref:`int`, region\: :ref:`Rect2`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_indeterminate`\ (\ column\: :ref:`int`, indeterminate\: :ref:`bool`\ ) | @@ -280,7 +284,7 @@ enum **TreeCellMode**: :ref:`🔗` :ref:`TreeCellMode` **CELL_MODE_STRING** = ``0`` -Cell shows a string label. When editable, the text can be edited using a :ref:`LineEdit`, or a :ref:`TextEdit` popup if :ref:`set_edit_multiline` is used. +Cell shows a string label, optionally with an icon. When editable, the text can be edited using a :ref:`LineEdit`, or a :ref:`TextEdit` popup if :ref:`set_edit_multiline` is used. .. _class_TreeItem_constant_CELL_MODE_CHECK: @@ -288,7 +292,7 @@ Cell shows a string label. When editable, the text can be edited using a :ref:`L :ref:`TreeCellMode` **CELL_MODE_CHECK** = ``1`` -Cell shows a checkbox, optionally with text. The checkbox can be pressed, released, or indeterminate (via :ref:`set_indeterminate`). The checkbox can't be clicked unless the cell is editable. +Cell shows a checkbox, optionally with text and an icon. The checkbox can be pressed, released, or indeterminate (via :ref:`set_indeterminate`). The checkbox can't be clicked unless the cell is editable. .. _class_TreeItem_constant_CELL_MODE_RANGE: @@ -306,7 +310,7 @@ This cell can also be used in a text dropdown mode when you assign a text with : :ref:`TreeCellMode` **CELL_MODE_ICON** = ``3`` -Cell shows an icon. It can't be edited nor display text. +Cell shows an icon. It can't be edited nor display text. The icon is always centered within the cell. .. _class_TreeItem_constant_CELL_MODE_CUSTOM: @@ -408,7 +412,7 @@ Method Descriptions |void| **add_button**\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = ""\ ) :ref:`🔗` -Adds a button with :ref:`Texture2D` ``button`` at column ``column``. The ``id`` is used to identify the button in the according :ref:`Tree.button_clicked` signal and can be different from the buttons index. If not specified, the next available index is used, which may be retrieved by calling :ref:`get_button_count` immediately before this method. Optionally, the button can be ``disabled`` and have a ``tooltip_text``. +Adds a button with :ref:`Texture2D` ``button`` to the end of the cell at column ``column``. The ``id`` is used to identify the button in the according :ref:`Tree.button_clicked` signal and can be different from the buttons index. If not specified, the next available index is used, which may be retrieved by calling :ref:`get_button_count` immediately before this method. Optionally, the button can be ``disabled`` and have a ``tooltip_text``. .. rst-class:: classref-item-separator @@ -754,6 +758,18 @@ Returns the :ref:`Color` modulating the column's icon. ---- +.. _class_TreeItem_method_get_icon_overlay: + +.. rst-class:: classref-method + +:ref:`Texture2D` **get_icon_overlay**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the given column's icon overlay :ref:`Texture2D`. + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_get_icon_region: .. rst-class:: classref-method @@ -1444,7 +1460,7 @@ If ``enable`` is ``true``, the given ``column`` is expanded to the right. |void| **set_icon**\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` -Sets the given cell's icon :ref:`Texture2D`. The cell has to be in :ref:`CELL_MODE_ICON` mode. +Sets the given cell's icon :ref:`Texture2D`. If the cell is in :ref:`CELL_MODE_ICON` mode, the icon is displayed in the center of the cell. Otherwise, the icon is displayed before the cell's text. :ref:`CELL_MODE_RANGE` does not display an icon. .. rst-class:: classref-item-separator @@ -1474,6 +1490,18 @@ Modulates the given column's icon with ``modulate``. ---- +.. _class_TreeItem_method_set_icon_overlay: + +.. rst-class:: classref-method + +|void| **set_icon_overlay**\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` + +Sets the given cell's icon overlay :ref:`Texture2D`. The cell has to be in :ref:`CELL_MODE_ICON` mode, and icon has to be set. Overlay is drawn on top of icon, in the bottom left corner. + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_set_icon_region: .. rst-class:: classref-method