mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
6840 lines
605 KiB
ReStructuredText
6840 lines
605 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. _class_DisplayServer:
|
||
|
||
DisplayServer
|
||
=============
|
||
|
||
**Hereda:** :ref:`Object<class_Object>`
|
||
|
||
Una interfaz de servidor para la gestión de ventanas de bajo nivel.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Descripción
|
||
----------------------
|
||
|
||
**DisplayServer** handles everything related to window management. It is separated from :ref:`OS<class_OS>` as a single operating system may support multiple display servers.
|
||
|
||
\ **Headless mode:** Starting the engine with the ``--headless`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>` disables all rendering and window management functions. Most functions from **DisplayServer** will return dummy values in this case.
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Métodos
|
||
--------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`accessibility_create_element<class_DisplayServer_method_accessibility_create_element>`\ (\ window_id\: :ref:`int<class_int>`, role\: :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`accessibility_create_sub_element<class_DisplayServer_method_accessibility_create_sub_element>`\ (\ parent_rid\: :ref:`RID<class_RID>`, role\: :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>`, insert_pos\: :ref:`int<class_int>` = -1\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`accessibility_create_sub_text_edit_elements<class_DisplayServer_method_accessibility_create_sub_text_edit_elements>`\ (\ parent_rid\: :ref:`RID<class_RID>`, shaped_text\: :ref:`RID<class_RID>`, min_height\: :ref:`float<class_float>`, insert_pos\: :ref:`int<class_int>` = -1, is_last_line\: :ref:`bool<class_bool>` = false\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Variant<class_Variant>` | :ref:`accessibility_element_get_meta<class_DisplayServer_method_accessibility_element_get_meta>`\ (\ id\: :ref:`RID<class_RID>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_element_set_meta<class_DisplayServer_method_accessibility_element_set_meta>`\ (\ id\: :ref:`RID<class_RID>`, meta\: :ref:`Variant<class_Variant>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_free_element<class_DisplayServer_method_accessibility_free_element>`\ (\ id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`accessibility_get_window_root<class_DisplayServer_method_accessibility_get_window_root>`\ (\ window_id\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`accessibility_has_element<class_DisplayServer_method_accessibility_has_element>`\ (\ id\: :ref:`RID<class_RID>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`accessibility_screen_reader_active<class_DisplayServer_method_accessibility_screen_reader_active>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_set_window_focused<class_DisplayServer_method_accessibility_set_window_focused>`\ (\ window_id\: :ref:`int<class_int>`, focused\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_set_window_rect<class_DisplayServer_method_accessibility_set_window_rect>`\ (\ window_id\: :ref:`int<class_int>`, rect_out\: :ref:`Rect2<class_Rect2>`, rect_in\: :ref:`Rect2<class_Rect2>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`accessibility_should_increase_contrast<class_DisplayServer_method_accessibility_should_increase_contrast>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`accessibility_should_reduce_animation<class_DisplayServer_method_accessibility_should_reduce_animation>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`accessibility_should_reduce_transparency<class_DisplayServer_method_accessibility_should_reduce_transparency>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_add_action<class_DisplayServer_method_accessibility_update_add_action>`\ (\ id\: :ref:`RID<class_RID>`, action\: :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>`, callable\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_add_child<class_DisplayServer_method_accessibility_update_add_child>`\ (\ id\: :ref:`RID<class_RID>`, child_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_add_custom_action<class_DisplayServer_method_accessibility_update_add_custom_action>`\ (\ id\: :ref:`RID<class_RID>`, action_id\: :ref:`int<class_int>`, action_description\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_add_related_controls<class_DisplayServer_method_accessibility_update_add_related_controls>`\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_add_related_described_by<class_DisplayServer_method_accessibility_update_add_related_described_by>`\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_add_related_details<class_DisplayServer_method_accessibility_update_add_related_details>`\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_add_related_flow_to<class_DisplayServer_method_accessibility_update_add_related_flow_to>`\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_add_related_labeled_by<class_DisplayServer_method_accessibility_update_add_related_labeled_by>`\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_add_related_radio_group<class_DisplayServer_method_accessibility_update_add_related_radio_group>`\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_active_descendant<class_DisplayServer_method_accessibility_update_set_active_descendant>`\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_background_color<class_DisplayServer_method_accessibility_update_set_background_color>`\ (\ id\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_bounds<class_DisplayServer_method_accessibility_update_set_bounds>`\ (\ id\: :ref:`RID<class_RID>`, p_rect\: :ref:`Rect2<class_Rect2>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_checked<class_DisplayServer_method_accessibility_update_set_checked>`\ (\ id\: :ref:`RID<class_RID>`, checekd\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_classname<class_DisplayServer_method_accessibility_update_set_classname>`\ (\ id\: :ref:`RID<class_RID>`, classname\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_color_value<class_DisplayServer_method_accessibility_update_set_color_value>`\ (\ id\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_description<class_DisplayServer_method_accessibility_update_set_description>`\ (\ id\: :ref:`RID<class_RID>`, description\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_error_message<class_DisplayServer_method_accessibility_update_set_error_message>`\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_extra_info<class_DisplayServer_method_accessibility_update_set_extra_info>`\ (\ id\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_flag<class_DisplayServer_method_accessibility_update_set_flag>`\ (\ id\: :ref:`RID<class_RID>`, flag\: :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>`, value\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_focus<class_DisplayServer_method_accessibility_update_set_focus>`\ (\ id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_foreground_color<class_DisplayServer_method_accessibility_update_set_foreground_color>`\ (\ id\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_in_page_link_target<class_DisplayServer_method_accessibility_update_set_in_page_link_target>`\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_language<class_DisplayServer_method_accessibility_update_set_language>`\ (\ id\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_list_item_count<class_DisplayServer_method_accessibility_update_set_list_item_count>`\ (\ id\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_list_item_expanded<class_DisplayServer_method_accessibility_update_set_list_item_expanded>`\ (\ id\: :ref:`RID<class_RID>`, expanded\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_list_item_index<class_DisplayServer_method_accessibility_update_set_list_item_index>`\ (\ id\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_list_item_level<class_DisplayServer_method_accessibility_update_set_list_item_level>`\ (\ id\: :ref:`RID<class_RID>`, level\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_list_item_selected<class_DisplayServer_method_accessibility_update_set_list_item_selected>`\ (\ id\: :ref:`RID<class_RID>`, selected\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_list_orientation<class_DisplayServer_method_accessibility_update_set_list_orientation>`\ (\ id\: :ref:`RID<class_RID>`, vertical\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_live<class_DisplayServer_method_accessibility_update_set_live>`\ (\ id\: :ref:`RID<class_RID>`, live\: :ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_member_of<class_DisplayServer_method_accessibility_update_set_member_of>`\ (\ id\: :ref:`RID<class_RID>`, group_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_name<class_DisplayServer_method_accessibility_update_set_name>`\ (\ id\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_next_on_line<class_DisplayServer_method_accessibility_update_set_next_on_line>`\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_num_jump<class_DisplayServer_method_accessibility_update_set_num_jump>`\ (\ id\: :ref:`RID<class_RID>`, jump\: :ref:`float<class_float>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_num_range<class_DisplayServer_method_accessibility_update_set_num_range>`\ (\ id\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_num_step<class_DisplayServer_method_accessibility_update_set_num_step>`\ (\ id\: :ref:`RID<class_RID>`, step\: :ref:`float<class_float>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_num_value<class_DisplayServer_method_accessibility_update_set_num_value>`\ (\ id\: :ref:`RID<class_RID>`, position\: :ref:`float<class_float>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_placeholder<class_DisplayServer_method_accessibility_update_set_placeholder>`\ (\ id\: :ref:`RID<class_RID>`, placeholder\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_popup_type<class_DisplayServer_method_accessibility_update_set_popup_type>`\ (\ id\: :ref:`RID<class_RID>`, popup\: :ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_previous_on_line<class_DisplayServer_method_accessibility_update_set_previous_on_line>`\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_role<class_DisplayServer_method_accessibility_update_set_role>`\ (\ id\: :ref:`RID<class_RID>`, role\: :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_role_description<class_DisplayServer_method_accessibility_update_set_role_description>`\ (\ id\: :ref:`RID<class_RID>`, description\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_scroll_x<class_DisplayServer_method_accessibility_update_set_scroll_x>`\ (\ id\: :ref:`RID<class_RID>`, position\: :ref:`float<class_float>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_scroll_x_range<class_DisplayServer_method_accessibility_update_set_scroll_x_range>`\ (\ id\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_scroll_y<class_DisplayServer_method_accessibility_update_set_scroll_y>`\ (\ id\: :ref:`RID<class_RID>`, position\: :ref:`float<class_float>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_scroll_y_range<class_DisplayServer_method_accessibility_update_set_scroll_y_range>`\ (\ id\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_shortcut<class_DisplayServer_method_accessibility_update_set_shortcut>`\ (\ id\: :ref:`RID<class_RID>`, shortcut\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_state_description<class_DisplayServer_method_accessibility_update_set_state_description>`\ (\ id\: :ref:`RID<class_RID>`, description\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_table_cell_position<class_DisplayServer_method_accessibility_update_set_table_cell_position>`\ (\ id\: :ref:`RID<class_RID>`, row_index\: :ref:`int<class_int>`, column_index\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_table_cell_span<class_DisplayServer_method_accessibility_update_set_table_cell_span>`\ (\ id\: :ref:`RID<class_RID>`, row_span\: :ref:`int<class_int>`, column_span\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_table_column_count<class_DisplayServer_method_accessibility_update_set_table_column_count>`\ (\ id\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_table_column_index<class_DisplayServer_method_accessibility_update_set_table_column_index>`\ (\ id\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_table_row_count<class_DisplayServer_method_accessibility_update_set_table_row_count>`\ (\ id\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_table_row_index<class_DisplayServer_method_accessibility_update_set_table_row_index>`\ (\ id\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_text_align<class_DisplayServer_method_accessibility_update_set_text_align>`\ (\ id\: :ref:`RID<class_RID>`, align\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_text_decorations<class_DisplayServer_method_accessibility_update_set_text_decorations>`\ (\ id\: :ref:`RID<class_RID>`, underline\: :ref:`bool<class_bool>`, strikethrough\: :ref:`bool<class_bool>`, overline\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_text_orientation<class_DisplayServer_method_accessibility_update_set_text_orientation>`\ (\ id\: :ref:`RID<class_RID>`, vertical\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_text_selection<class_DisplayServer_method_accessibility_update_set_text_selection>`\ (\ id\: :ref:`RID<class_RID>`, text_start_id\: :ref:`RID<class_RID>`, start_char\: :ref:`int<class_int>`, text_end_id\: :ref:`RID<class_RID>`, end_char\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_tooltip<class_DisplayServer_method_accessibility_update_set_tooltip>`\ (\ id\: :ref:`RID<class_RID>`, tooltip\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_transform<class_DisplayServer_method_accessibility_update_set_transform>`\ (\ id\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_url<class_DisplayServer_method_accessibility_update_set_url>`\ (\ id\: :ref:`RID<class_RID>`, url\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`accessibility_update_set_value<class_DisplayServer_method_accessibility_update_set_value>`\ (\ id\: :ref:`RID<class_RID>`, value\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`beep<class_DisplayServer_method_beep>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`clipboard_get<class_DisplayServer_method_clipboard_get>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Image<class_Image>` | :ref:`clipboard_get_image<class_DisplayServer_method_clipboard_get_image>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`clipboard_get_primary<class_DisplayServer_method_clipboard_get_primary>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`clipboard_has<class_DisplayServer_method_clipboard_has>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`clipboard_has_image<class_DisplayServer_method_clipboard_has_image>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`clipboard_set<class_DisplayServer_method_clipboard_set>`\ (\ clipboard\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`clipboard_set_primary<class_DisplayServer_method_clipboard_set_primary>`\ (\ clipboard_primary\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`color_picker<class_DisplayServer_method_color_picker>`\ (\ callback\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`create_status_indicator<class_DisplayServer_method_create_status_indicator>`\ (\ icon\: :ref:`Texture2D<class_Texture2D>`, tooltip\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`CursorShape<enum_DisplayServer_CursorShape>` | :ref:`cursor_get_shape<class_DisplayServer_method_cursor_get_shape>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`cursor_set_custom_image<class_DisplayServer_method_cursor_set_custom_image>`\ (\ cursor\: :ref:`Resource<class_Resource>`, shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>` = 0, hotspot\: :ref:`Vector2<class_Vector2>` = Vector2(0, 0)\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`cursor_set_shape<class_DisplayServer_method_cursor_set_shape>`\ (\ shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`delete_status_indicator<class_DisplayServer_method_delete_status_indicator>`\ (\ id\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`dialog_input_text<class_DisplayServer_method_dialog_input_text>`\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, existing_text\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`dialog_show<class_DisplayServer_method_dialog_show>`\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, buttons\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`enable_for_stealing_focus<class_DisplayServer_method_enable_for_stealing_focus>`\ (\ process_id\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`file_dialog_show<class_DisplayServer_method_file_dialog_show>`\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`, parent_window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`file_dialog_with_options_show<class_DisplayServer_method_file_dialog_with_options_show>`\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, root\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, options\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], callback\: :ref:`Callable<class_Callable>`, parent_window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`force_process_and_drop_events<class_DisplayServer_method_force_process_and_drop_events>`\ (\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Color<class_Color>` | :ref:`get_accent_color<class_DisplayServer_method_get_accent_color>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Color<class_Color>` | :ref:`get_base_color<class_DisplayServer_method_get_base_color>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Array<class_Array>`\[:ref:`Rect2<class_Rect2>`\] | :ref:`get_display_cutouts<class_DisplayServer_method_get_display_cutouts>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Rect2i<class_Rect2i>` | :ref:`get_display_safe_area<class_DisplayServer_method_get_display_safe_area>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`get_keyboard_focus_screen<class_DisplayServer_method_get_keyboard_focus_screen>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`get_name<class_DisplayServer_method_get_name>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`get_primary_screen<class_DisplayServer_method_get_primary_screen>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`get_screen_count<class_DisplayServer_method_get_screen_count>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`get_screen_from_rect<class_DisplayServer_method_get_screen_from_rect>`\ (\ rect\: :ref:`Rect2<class_Rect2>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`get_swap_cancel_ok<class_DisplayServer_method_get_swap_cancel_ok>`\ (\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`get_window_at_screen_position<class_DisplayServer_method_get_window_at_screen_position>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_window_list<class_DisplayServer_method_get_window_list>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_add_check_item<class_DisplayServer_method_global_menu_add_check_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_add_icon_check_item<class_DisplayServer_method_global_menu_add_icon_check_item>`\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_add_icon_item<class_DisplayServer_method_global_menu_add_icon_item>`\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_add_icon_radio_check_item<class_DisplayServer_method_global_menu_add_icon_radio_check_item>`\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_add_item<class_DisplayServer_method_global_menu_add_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, max_states\: :ref:`int<class_int>`, default_state\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_add_radio_check_item<class_DisplayServer_method_global_menu_add_radio_check_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_add_separator<class_DisplayServer_method_global_menu_add_separator>`\ (\ menu_root\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_add_submenu_item<class_DisplayServer_method_global_menu_add_submenu_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, submenu\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_clear<class_DisplayServer_method_global_menu_clear>`\ (\ menu_root\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Key<enum_@GlobalScope_Key>` | :ref:`global_menu_get_item_accelerator<class_DisplayServer_method_global_menu_get_item_accelerator>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Callable<class_Callable>` | :ref:`global_menu_get_item_callback<class_DisplayServer_method_global_menu_get_item_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_get_item_count<class_DisplayServer_method_global_menu_get_item_count>`\ (\ menu_root\: :ref:`String<class_String>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Texture2D<class_Texture2D>` | :ref:`global_menu_get_item_icon<class_DisplayServer_method_global_menu_get_item_icon>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_get_item_indentation_level<class_DisplayServer_method_global_menu_get_item_indentation_level>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_get_item_index_from_tag<class_DisplayServer_method_global_menu_get_item_index_from_tag>`\ (\ menu_root\: :ref:`String<class_String>`, tag\: :ref:`Variant<class_Variant>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_get_item_index_from_text<class_DisplayServer_method_global_menu_get_item_index_from_text>`\ (\ menu_root\: :ref:`String<class_String>`, text\: :ref:`String<class_String>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Callable<class_Callable>` | :ref:`global_menu_get_item_key_callback<class_DisplayServer_method_global_menu_get_item_key_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_get_item_max_states<class_DisplayServer_method_global_menu_get_item_max_states>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`global_menu_get_item_state<class_DisplayServer_method_global_menu_get_item_state>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`global_menu_get_item_submenu<class_DisplayServer_method_global_menu_get_item_submenu>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Variant<class_Variant>` | :ref:`global_menu_get_item_tag<class_DisplayServer_method_global_menu_get_item_tag>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`global_menu_get_item_text<class_DisplayServer_method_global_menu_get_item_text>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`global_menu_get_item_tooltip<class_DisplayServer_method_global_menu_get_item_tooltip>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Dictionary<class_Dictionary>` | :ref:`global_menu_get_system_menu_roots<class_DisplayServer_method_global_menu_get_system_menu_roots>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`global_menu_is_item_checkable<class_DisplayServer_method_global_menu_is_item_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`global_menu_is_item_checked<class_DisplayServer_method_global_menu_is_item_checked>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`global_menu_is_item_disabled<class_DisplayServer_method_global_menu_is_item_disabled>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`global_menu_is_item_hidden<class_DisplayServer_method_global_menu_is_item_hidden>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`global_menu_is_item_radio_checkable<class_DisplayServer_method_global_menu_is_item_radio_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_remove_item<class_DisplayServer_method_global_menu_remove_item>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_accelerator<class_DisplayServer_method_global_menu_set_item_accelerator>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_callback<class_DisplayServer_method_global_menu_set_item_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_checkable<class_DisplayServer_method_global_menu_set_item_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_checked<class_DisplayServer_method_global_menu_set_item_checked>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checked\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_hidden<class_DisplayServer_method_global_menu_set_item_hidden>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, hidden\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_hover_callbacks<class_DisplayServer_method_global_menu_set_item_hover_callbacks>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_icon<class_DisplayServer_method_global_menu_set_item_icon>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_indentation_level<class_DisplayServer_method_global_menu_set_item_indentation_level>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, level\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_key_callback<class_DisplayServer_method_global_menu_set_item_key_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, key_callback\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_max_states<class_DisplayServer_method_global_menu_set_item_max_states>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, max_states\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_radio_checkable<class_DisplayServer_method_global_menu_set_item_radio_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_state<class_DisplayServer_method_global_menu_set_item_state>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, state\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_submenu<class_DisplayServer_method_global_menu_set_item_submenu>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, submenu\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_tag<class_DisplayServer_method_global_menu_set_item_tag>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tag\: :ref:`Variant<class_Variant>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_text<class_DisplayServer_method_global_menu_set_item_text>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, text\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_item_tooltip<class_DisplayServer_method_global_menu_set_item_tooltip>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`global_menu_set_popup_callbacks<class_DisplayServer_method_global_menu_set_popup_callbacks>`\ (\ menu_root\: :ref:`String<class_String>`, open_callback\: :ref:`Callable<class_Callable>`, close_callback\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`has_additional_outputs<class_DisplayServer_method_has_additional_outputs>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`has_feature<class_DisplayServer_method_has_feature>`\ (\ feature\: :ref:`Feature<enum_DisplayServer_Feature>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`has_hardware_keyboard<class_DisplayServer_method_has_hardware_keyboard>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`help_set_search_callbacks<class_DisplayServer_method_help_set_search_callbacks>`\ (\ search_callback\: :ref:`Callable<class_Callable>`, action_callback\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2i<class_Vector2i>` | :ref:`ime_get_selection<class_DisplayServer_method_ime_get_selection>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`ime_get_text<class_DisplayServer_method_ime_get_text>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_dark_mode<class_DisplayServer_method_is_dark_mode>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_dark_mode_supported<class_DisplayServer_method_is_dark_mode_supported>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_touchscreen_available<class_DisplayServer_method_is_touchscreen_available>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_window_transparency_available<class_DisplayServer_method_is_window_transparency_available>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`keyboard_get_current_layout<class_DisplayServer_method_keyboard_get_current_layout>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Key<enum_@GlobalScope_Key>` | :ref:`keyboard_get_keycode_from_physical<class_DisplayServer_method_keyboard_get_keycode_from_physical>`\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Key<enum_@GlobalScope_Key>` | :ref:`keyboard_get_label_from_physical<class_DisplayServer_method_keyboard_get_label_from_physical>`\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`keyboard_get_layout_count<class_DisplayServer_method_keyboard_get_layout_count>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`keyboard_get_layout_language<class_DisplayServer_method_keyboard_get_layout_language>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`keyboard_get_layout_name<class_DisplayServer_method_keyboard_get_layout_name>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`keyboard_set_current_layout<class_DisplayServer_method_keyboard_set_current_layout>`\ (\ index\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |bitfield|\[:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\] | :ref:`mouse_get_button_state<class_DisplayServer_method_mouse_get_button_state>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`MouseMode<enum_DisplayServer_MouseMode>` | :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2i<class_Vector2i>` | :ref:`mouse_get_position<class_DisplayServer_method_mouse_get_position>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>`\ (\ mouse_mode\: :ref:`MouseMode<enum_DisplayServer_MouseMode>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`process_events<class_DisplayServer_method_process_events>`\ (\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`register_additional_output<class_DisplayServer_method_register_additional_output>`\ (\ object\: :ref:`Object<class_Object>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`screen_get_dpi<class_DisplayServer_method_screen_get_dpi>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Image<class_Image>` | :ref:`screen_get_image<class_DisplayServer_method_screen_get_image>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Image<class_Image>` | :ref:`screen_get_image_rect<class_DisplayServer_method_screen_get_image_rect>`\ (\ rect\: :ref:`Rect2i<class_Rect2i>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`screen_get_max_scale<class_DisplayServer_method_screen_get_max_scale>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` | :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Color<class_Color>` | :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2i<class_Vector2i>` | :ref:`screen_get_position<class_DisplayServer_method_screen_get_position>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`screen_get_refresh_rate<class_DisplayServer_method_screen_get_refresh_rate>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`screen_get_scale<class_DisplayServer_method_screen_get_scale>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2i<class_Vector2i>` | :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Rect2i<class_Rect2i>` | :ref:`screen_get_usable_rect<class_DisplayServer_method_screen_get_usable_rect>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`screen_is_kept_on<class_DisplayServer_method_screen_is_kept_on>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`screen_set_keep_on<class_DisplayServer_method_screen_set_keep_on>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>`\ (\ orientation\: :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>`, screen\: :ref:`int<class_int>` = -1\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_hardware_keyboard_connection_change_callback<class_DisplayServer_method_set_hardware_keyboard_connection_change_callback>`\ (\ callable\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_icon<class_DisplayServer_method_set_icon>`\ (\ image\: :ref:`Image<class_Image>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_native_icon<class_DisplayServer_method_set_native_icon>`\ (\ filename\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_system_theme_change_callback<class_DisplayServer_method_set_system_theme_change_callback>`\ (\ callable\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`show_emoji_and_symbol_picker<class_DisplayServer_method_show_emoji_and_symbol_picker>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Rect2<class_Rect2>` | :ref:`status_indicator_get_rect<class_DisplayServer_method_status_indicator_get_rect>`\ (\ id\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`status_indicator_set_callback<class_DisplayServer_method_status_indicator_set_callback>`\ (\ id\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`status_indicator_set_icon<class_DisplayServer_method_status_indicator_set_icon>`\ (\ id\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`status_indicator_set_menu<class_DisplayServer_method_status_indicator_set_menu>`\ (\ id\: :ref:`int<class_int>`, menu_rid\: :ref:`RID<class_RID>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`status_indicator_set_tooltip<class_DisplayServer_method_status_indicator_set_tooltip>`\ (\ id\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`tablet_get_current_driver<class_DisplayServer_method_tablet_get_current_driver>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`tablet_get_driver_count<class_DisplayServer_method_tablet_get_driver_count>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`tablet_get_driver_name<class_DisplayServer_method_tablet_get_driver_name>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`tablet_set_current_driver<class_DisplayServer_method_tablet_set_current_driver>`\ (\ name\: :ref:`String<class_String>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`tts_get_voices<class_DisplayServer_method_tts_get_voices>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`tts_get_voices_for_language<class_DisplayServer_method_tts_get_voices_for_language>`\ (\ language\: :ref:`String<class_String>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`tts_is_paused<class_DisplayServer_method_tts_is_paused>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`tts_is_speaking<class_DisplayServer_method_tts_is_speaking>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`tts_pause<class_DisplayServer_method_tts_pause>`\ (\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`tts_resume<class_DisplayServer_method_tts_resume>`\ (\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`tts_set_utterance_callback<class_DisplayServer_method_tts_set_utterance_callback>`\ (\ event\: :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>`, callable\: :ref:`Callable<class_Callable>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`tts_speak<class_DisplayServer_method_tts_speak>`\ (\ text\: :ref:`String<class_String>`, voice\: :ref:`String<class_String>`, volume\: :ref:`int<class_int>` = 50, pitch\: :ref:`float<class_float>` = 1.0, rate\: :ref:`float<class_float>` = 1.0, utterance_id\: :ref:`int<class_int>` = 0, interrupt\: :ref:`bool<class_bool>` = false\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`tts_stop<class_DisplayServer_method_tts_stop>`\ (\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`unregister_additional_output<class_DisplayServer_method_unregister_additional_output>`\ (\ object\: :ref:`Object<class_Object>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`virtual_keyboard_get_height<class_DisplayServer_method_virtual_keyboard_get_height>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`virtual_keyboard_hide<class_DisplayServer_method_virtual_keyboard_hide>`\ (\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`virtual_keyboard_show<class_DisplayServer_method_virtual_keyboard_show>`\ (\ existing_text\: :ref:`String<class_String>`, position\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` = 0, max_length\: :ref:`int<class_int>` = -1, cursor_start\: :ref:`int<class_int>` = -1, cursor_end\: :ref:`int<class_int>` = -1\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`window_can_draw<class_DisplayServer_method_window_can_draw>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`window_get_active_popup<class_DisplayServer_method_window_get_active_popup>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`window_get_attached_instance_id<class_DisplayServer_method_window_get_attached_instance_id>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`window_get_current_screen<class_DisplayServer_method_window_get_current_screen>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`window_get_flag<class_DisplayServer_method_window_get_flag>`\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_max_size<class_DisplayServer_method_window_get_max_size>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_min_size<class_DisplayServer_method_window_get_min_size>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`WindowMode<enum_DisplayServer_WindowMode>` | :ref:`window_get_mode<class_DisplayServer_method_window_get_mode>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`window_get_native_handle<class_DisplayServer_method_window_get_native_handle>`\ (\ handle_type\: :ref:`HandleType<enum_DisplayServer_HandleType>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Rect2i<class_Rect2i>` | :ref:`window_get_popup_safe_rect<class_DisplayServer_method_window_get_popup_safe_rect>`\ (\ window\: :ref:`int<class_int>`\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_position<class_DisplayServer_method_window_get_position>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_position_with_decorations<class_DisplayServer_method_window_get_position_with_decorations>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector3i<class_Vector3i>` | :ref:`window_get_safe_title_margins<class_DisplayServer_method_window_get_safe_title_margins>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_size<class_DisplayServer_method_window_get_size>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_size_with_decorations<class_DisplayServer_method_window_get_size_with_decorations>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_title_size<class_DisplayServer_method_window_get_title_size>`\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` | :ref:`window_get_vsync_mode<class_DisplayServer_method_window_get_vsync_mode>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`window_is_focused<class_DisplayServer_method_window_is_focused>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`window_is_maximize_allowed<class_DisplayServer_method_window_is_maximize_allowed>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`window_maximize_on_title_dbl_click<class_DisplayServer_method_window_maximize_on_title_dbl_click>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`window_minimize_on_title_dbl_click<class_DisplayServer_method_window_minimize_on_title_dbl_click>`\ (\ ) |const| |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_move_to_foreground<class_DisplayServer_method_window_move_to_foreground>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_request_attention<class_DisplayServer_method_window_request_attention>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_color<class_DisplayServer_method_window_set_color>`\ (\ color\: :ref:`Color<class_Color>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_current_screen<class_DisplayServer_method_window_set_current_screen>`\ (\ screen\: :ref:`int<class_int>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_drop_files_callback<class_DisplayServer_method_window_set_drop_files_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_exclusive<class_DisplayServer_method_window_set_exclusive>`\ (\ window_id\: :ref:`int<class_int>`, exclusive\: :ref:`bool<class_bool>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_flag<class_DisplayServer_method_window_set_flag>`\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, enabled\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_ime_active<class_DisplayServer_method_window_set_ime_active>`\ (\ active\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_ime_position<class_DisplayServer_method_window_set_ime_position>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_input_event_callback<class_DisplayServer_method_window_set_input_event_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_input_text_callback<class_DisplayServer_method_window_set_input_text_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>`\ (\ max_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>`\ (\ min_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_mode<class_DisplayServer_method_window_set_mode>`\ (\ mode\: :ref:`WindowMode<enum_DisplayServer_WindowMode>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_mouse_passthrough<class_DisplayServer_method_window_set_mouse_passthrough>`\ (\ region\: :ref:`PackedVector2Array<class_PackedVector2Array>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_popup_safe_rect<class_DisplayServer_method_window_set_popup_safe_rect>`\ (\ window\: :ref:`int<class_int>`, rect\: :ref:`Rect2i<class_Rect2i>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_position<class_DisplayServer_method_window_set_position>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_rect_changed_callback<class_DisplayServer_method_window_set_rect_changed_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_size<class_DisplayServer_method_window_set_size>`\ (\ size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_title<class_DisplayServer_method_window_set_title>`\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_transient<class_DisplayServer_method_window_set_transient>`\ (\ window_id\: :ref:`int<class_int>`, parent_window_id\: :ref:`int<class_int>`\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_vsync_mode<class_DisplayServer_method_window_set_vsync_mode>`\ (\ vsync_mode\: :ref:`VSyncMode<enum_DisplayServer_VSyncMode>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_window_buttons_offset<class_DisplayServer_method_window_set_window_buttons_offset>`\ (\ offset\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_start_drag<class_DisplayServer_method_window_start_drag>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`window_start_resize<class_DisplayServer_method_window_start_resize>`\ (\ edge\: :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>`, window_id\: :ref:`int<class_int>` = 0\ ) |
|
||
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Enumeraciones
|
||
--------------------------
|
||
|
||
.. _enum_DisplayServer_Feature:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **Feature**: :ref:`🔗<enum_DisplayServer_Feature>`
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_GLOBAL_MENU:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_GLOBAL_MENU** = ``0``
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Display server supports global menu. This allows the application to display its menu items in the operating system's top bar. **macOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_SUBWINDOWS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SUBWINDOWS** = ``1``
|
||
|
||
Display server supports multiple windows that can be moved outside of the main window. **Windows, macOS, Linux (X11)**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_TOUCHSCREEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TOUCHSCREEN** = ``2``
|
||
|
||
Display server supports touchscreen input. **Windows, Linux (X11), Android, iOS, Web**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_MOUSE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE** = ``3``
|
||
|
||
Display server supports mouse input. **Windows, macOS, Linux (X11/Wayland), Android, Web**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_MOUSE_WARP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE_WARP** = ``4``
|
||
|
||
Display server supports warping mouse coordinates to keep the mouse cursor constrained within an area, but looping when one of the edges is reached. **Windows, macOS, Linux (X11/Wayland)**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_CLIPBOARD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD** = ``5``
|
||
|
||
Display server supports setting and getting clipboard data. See also :ref:`FEATURE_CLIPBOARD_PRIMARY<class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY>`. **Windows, macOS, Linux (X11/Wayland), Android, iOS, Web**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_VIRTUAL_KEYBOARD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_VIRTUAL_KEYBOARD** = ``6``
|
||
|
||
Display server supports popping up a virtual keyboard when requested to input text without a physical keyboard. **Android, iOS, Web**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_CURSOR_SHAPE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CURSOR_SHAPE** = ``7``
|
||
|
||
Display server supports setting the mouse cursor shape to be different from the default. **Windows, macOS, Linux (X11/Wayland), Android, Web**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_CUSTOM_CURSOR_SHAPE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CUSTOM_CURSOR_SHAPE** = ``8``
|
||
|
||
Display server supports setting the mouse cursor shape to a custom image. **Windows, macOS, Linux (X11/Wayland), Web**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG** = ``9``
|
||
|
||
Display server supports spawning text dialogs using the operating system's native look-and-feel. See :ref:`dialog_show()<class_DisplayServer_method_dialog_show>`. **Windows, macOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_IME:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_IME** = ``10``
|
||
|
||
Display server supports `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__, which is commonly used for inputting Chinese/Japanese/Korean text. This is handled by the operating system, rather than by Godot. **Windows, macOS, Linux (X11)**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_WINDOW_TRANSPARENCY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_TRANSPARENCY** = ``11``
|
||
|
||
Display server supports windows can use per-pixel transparency to make windows behind them partially or fully visible. **Windows, macOS, Linux (X11/Wayland), Android**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_HIDPI:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_HIDPI** = ``12``
|
||
|
||
Display server supports querying the operating system's display scale factor. This allows automatically detecting the hiDPI display *reliably*, instead of guessing based on the screen resolution and the display's reported DPI (which might be unreliable due to broken monitor EDID). **Windows, Linux (Wayland), macOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_ICON:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ICON** = ``13``
|
||
|
||
Display server supports changing the window icon (usually displayed in the top-left corner). **Windows, macOS, Linux (X11/Wayland)**\
|
||
|
||
\ **Note:** Use on Wayland requires the compositor to implement the `xdg_toplevel_icon_v1 <https://wayland.app/protocols/xdg-toplevel-icon-v1#xdg_toplevel_icon_v1>`__ protocol, which not all compositors do. See `xdg_toplevel_icon_v1#compositor-support <https://wayland.app/protocols/xdg-toplevel-icon-v1#compositor-support>`__ for more information on individual compositor support.
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_NATIVE_ICON:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_ICON** = ``14``
|
||
|
||
Display server supports changing the window icon (usually displayed in the top-left corner). **Windows, macOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_ORIENTATION:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ORIENTATION** = ``15``
|
||
|
||
Display server supports changing the screen orientation. **Android, iOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_SWAP_BUFFERS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SWAP_BUFFERS** = ``16``
|
||
|
||
Display server supports V-Sync status can be changed from the default (which is forced to be enabled platforms not supporting this feature). **Windows, macOS, Linux (X11/Wayland)**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD_PRIMARY** = ``18``
|
||
|
||
Display server supports Primary clipboard can be used. This is a different clipboard from :ref:`FEATURE_CLIPBOARD<class_DisplayServer_constant_FEATURE_CLIPBOARD>`. **Linux (X11/Wayland)**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_TEXT_TO_SPEECH:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TEXT_TO_SPEECH** = ``19``
|
||
|
||
Display server supports text-to-speech. See ``tts_*`` methods. **Windows, macOS, Linux (X11/Wayland), Android, iOS, Web**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_EXTEND_TO_TITLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EXTEND_TO_TITLE** = ``20``
|
||
|
||
Display server supports expanding window content to the title. See :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>`. **macOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_SCREEN_CAPTURE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_CAPTURE** = ``21``
|
||
|
||
Display server supports reading screen pixels. See :ref:`screen_get_pixel()<class_DisplayServer_method_screen_get_pixel>`.
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_STATUS_INDICATOR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_STATUS_INDICATOR** = ``22``
|
||
|
||
Display server supports application status indicators.
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_NATIVE_HELP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_HELP** = ``23``
|
||
|
||
El servidor de visualización admite devoluciones de llamada de búsqueda del sistema de ayuda nativo. Véase :ref:`help_set_search_callbacks()<class_DisplayServer_method_help_set_search_callbacks>`.
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_INPUT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_INPUT** = ``24``
|
||
|
||
Display server supports spawning text input dialogs using the operating system's native look-and-feel. See :ref:`dialog_input_text()<class_DisplayServer_method_dialog_input_text>`. **Windows, macOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE** = ``25``
|
||
|
||
Display server supports spawning dialogs for selecting files or directories using the operating system's native look-and-feel. See :ref:`file_dialog_show()<class_DisplayServer_method_file_dialog_show>`. **Windows, macOS, Linux (X11/Wayland), Android**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_EXTRA:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE_EXTRA** = ``26``
|
||
|
||
The display server supports all features of :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>`, with the added functionality of Options and native dialog file access to ``res://`` and ``user://`` paths. See :ref:`file_dialog_show()<class_DisplayServer_method_file_dialog_show>` and :ref:`file_dialog_with_options_show()<class_DisplayServer_method_file_dialog_with_options_show>`. **Windows, macOS, Linux (X11/Wayland)**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_WINDOW_DRAG:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_DRAG** = ``27``
|
||
|
||
El servidor de visualización admite el inicio de operaciones de arrastre y redimensionamiento de ventanas bajo demanda. Véase :ref:`window_start_drag()<class_DisplayServer_method_window_start_drag>` y :ref:`window_start_resize()<class_DisplayServer_method_window_start_resize>`.
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE** = ``28``
|
||
|
||
El servidor de visualización admite la bandera de ventana :ref:`WINDOW_FLAG_EXCLUDE_FROM_CAPTURE<class_DisplayServer_constant_WINDOW_FLAG_EXCLUDE_FROM_CAPTURE>`. **Windows, macOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_WINDOW_EMBEDDING:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_EMBEDDING** = ``29``
|
||
|
||
El servidor de visualización permite incrustar una ventana de otro proceso. **Windows, Linux (X11), macOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_MIME:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE_MIME** = ``30``
|
||
|
||
El diálogo nativo de selección de archivos admite tipos MIME como filtros.
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_EMOJI_AND_SYMBOL_PICKER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EMOJI_AND_SYMBOL_PICKER** = ``31``
|
||
|
||
El servidor de visualización es compatible con el selector de emojis y símbolos del sistema. **Windows, macOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_NATIVE_COLOR_PICKER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_COLOR_PICKER** = ``32``
|
||
|
||
El servidor de visualización es compatible con el selector de color nativo. **Linux (X11/Wayland)**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_SELF_FITTING_WINDOWS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SELF_FITTING_WINDOWS** = ``33``
|
||
|
||
El servidor de visualización ajusta automáticamente las ventanas emergentes de acuerdo con los límites de la pantalla. Los nodos de la ventana no deben intentar hacerlo ellos mismos.
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_ACCESSIBILITY_SCREEN_READER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ACCESSIBILITY_SCREEN_READER** = ``34``
|
||
|
||
El servidor de visualización admite la interacción con el lector de pantalla o la pantalla Braille. **Linux (X11/Wayland), macOS, Windows**
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_AccessibilityRole:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **AccessibilityRole**: :ref:`🔗<enum_DisplayServer_AccessibilityRole>`
|
||
|
||
.. _class_DisplayServer_constant_ROLE_UNKNOWN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_UNKNOWN** = ``0``
|
||
|
||
Rol desconocido o personalizado.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_DEFAULT_BUTTON:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_DEFAULT_BUTTON** = ``1``
|
||
|
||
Elemento de botón de diálogo por defecto.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_AUDIO:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_AUDIO** = ``2``
|
||
|
||
Elemento de reproductor de audio.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_VIDEO:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_VIDEO** = ``3``
|
||
|
||
Elemento de reproductor de vídeo.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_STATIC_TEXT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_STATIC_TEXT** = ``4``
|
||
|
||
Etiqueta de texto no editable.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_CONTAINER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_CONTAINER** = ``5``
|
||
|
||
Elemento contenedor. Los elementos con este rol se utilizan para la estructura interna y son ignorados por los lectores de pantalla.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_PANEL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_PANEL** = ``6``
|
||
|
||
Elemento contenedor de panel.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_BUTTON:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_BUTTON** = ``7``
|
||
|
||
Elemento de botón.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_LINK:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LINK** = ``8``
|
||
|
||
Elemento de enlace.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_CHECK_BOX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_CHECK_BOX** = ``9``
|
||
|
||
Elemento de casilla de verificación.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_RADIO_BUTTON:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_RADIO_BUTTON** = ``10``
|
||
|
||
Elemento de botón de opción.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_CHECK_BUTTON:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_CHECK_BUTTON** = ``11``
|
||
|
||
Elemento de botón de verificación.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_SCROLL_BAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SCROLL_BAR** = ``12``
|
||
|
||
Elemento de barra de desplazamiento.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_SCROLL_VIEW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SCROLL_VIEW** = ``13``
|
||
|
||
Elemento contenedor de desplazamiento.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_SPLITTER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SPLITTER** = ``14``
|
||
|
||
Elemento de manejador de divisor de contenedor.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_SLIDER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SLIDER** = ``15``
|
||
|
||
Elemento deslizador.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_SPIN_BUTTON:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SPIN_BUTTON** = ``16``
|
||
|
||
Elemento de cuadro de giro.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_PROGRESS_INDICATOR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_PROGRESS_INDICATOR** = ``17``
|
||
|
||
Elemento indicador de progreso.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TEXT_FIELD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TEXT_FIELD** = ``18``
|
||
|
||
Elemento de campo de texto editable.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_MULTILINE_TEXT_FIELD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MULTILINE_TEXT_FIELD** = ``19``
|
||
|
||
Elemento de campo de texto editable multilínea.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_COLOR_PICKER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_COLOR_PICKER** = ``20``
|
||
|
||
Elemento selector de color.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TABLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TABLE** = ``21``
|
||
|
||
Elemento de tabla.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_CELL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_CELL** = ``22``
|
||
|
||
Elemento de celda de tabla/árbol.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_ROW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_ROW** = ``23``
|
||
|
||
Elemento de fila de tabla/árbol.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_ROW_GROUP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_ROW_GROUP** = ``24``
|
||
|
||
Elemento de grupo de filas de tabla/árbol.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_ROW_HEADER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_ROW_HEADER** = ``25``
|
||
|
||
Elemento de encabezado de fila de tabla/árbol.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_COLUMN_HEADER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_COLUMN_HEADER** = ``26``
|
||
|
||
Elemento de encabezado de columna de tabla/árbol.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TREE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TREE** = ``27``
|
||
|
||
Elemento de vista de árbol.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TREE_ITEM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TREE_ITEM** = ``28``
|
||
|
||
Elemento de ítem de vista de árbol.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_LIST:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LIST** = ``29``
|
||
|
||
Elemento de lista.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_LIST_ITEM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LIST_ITEM** = ``30``
|
||
|
||
Elemento de ítem de lista.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_LIST_BOX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LIST_BOX** = ``31``
|
||
|
||
Elemento de vista de lista.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_LIST_BOX_OPTION:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LIST_BOX_OPTION** = ``32``
|
||
|
||
Elemento de ítem de vista de lista.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TAB_BAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TAB_BAR** = ``33``
|
||
|
||
Elemento de barra de pestañas.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TAB:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TAB** = ``34``
|
||
|
||
Elemento de ítem de barra de pestañas.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TAB_PANEL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TAB_PANEL** = ``35``
|
||
|
||
Elemento del panel de pestañas.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_MENU_BAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU_BAR** = ``36``
|
||
|
||
Elemento de barra de menú.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_MENU:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU** = ``37``
|
||
|
||
Elemento de menú emergente.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_MENU_ITEM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU_ITEM** = ``38``
|
||
|
||
Elemento de menú emergente.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_MENU_ITEM_CHECK_BOX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU_ITEM_CHECK_BOX** = ``39``
|
||
|
||
Elemento de ítem de botón de verificación de menú emergente.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_MENU_ITEM_RADIO:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU_ITEM_RADIO** = ``40``
|
||
|
||
Elemento de ítem de botón de opción de menú emergente.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_IMAGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_IMAGE** = ``41``
|
||
|
||
Elemento de Imágen.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_WINDOW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_WINDOW** = ``42``
|
||
|
||
Elemento de ventana.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TITLE_BAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TITLE_BAR** = ``43``
|
||
|
||
Elemento de barra de título de ventana incrustado.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_DIALOG:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_DIALOG** = ``44``
|
||
|
||
Elemento de ventana de diálogo.
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TOOLTIP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TOOLTIP** = ``45``
|
||
|
||
Tooltip element.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_AccessibilityPopupType:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **AccessibilityPopupType**: :ref:`🔗<enum_DisplayServer_AccessibilityPopupType>`
|
||
|
||
.. _class_DisplayServer_constant_POPUP_MENU:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>` **POPUP_MENU** = ``0``
|
||
|
||
Menú de popup.
|
||
|
||
.. _class_DisplayServer_constant_POPUP_LIST:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>` **POPUP_LIST** = ``1``
|
||
|
||
Lista de popup.
|
||
|
||
.. _class_DisplayServer_constant_POPUP_TREE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>` **POPUP_TREE** = ``2``
|
||
|
||
Vista de árbol de popup.
|
||
|
||
.. _class_DisplayServer_constant_POPUP_DIALOG:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>` **POPUP_DIALOG** = ``3``
|
||
|
||
Diálogo de popup.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_AccessibilityFlags:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **AccessibilityFlags**: :ref:`🔗<enum_DisplayServer_AccessibilityFlags>`
|
||
|
||
.. _class_DisplayServer_constant_FLAG_HIDDEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_HIDDEN** = ``0``
|
||
|
||
El elemento está oculto para las herramientas de accesibilidad.
|
||
|
||
.. _class_DisplayServer_constant_FLAG_MULTISELECTABLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_MULTISELECTABLE** = ``1``
|
||
|
||
Element supports multiple item selection.
|
||
|
||
.. _class_DisplayServer_constant_FLAG_REQUIRED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_REQUIRED** = ``2``
|
||
|
||
El elemento requiere la entrada del usuario.
|
||
|
||
.. _class_DisplayServer_constant_FLAG_VISITED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_VISITED** = ``3``
|
||
|
||
El elemento es un enlace visitado.
|
||
|
||
.. _class_DisplayServer_constant_FLAG_BUSY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_BUSY** = ``4``
|
||
|
||
El contenido del elemento no está listo (p. ej., cargando).
|
||
|
||
.. _class_DisplayServer_constant_FLAG_MODAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_MODAL** = ``5``
|
||
|
||
El elemento es una ventana modal.
|
||
|
||
.. _class_DisplayServer_constant_FLAG_TOUCH_PASSTHROUGH:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_TOUCH_PASSTHROUGH** = ``6``
|
||
|
||
El elemento permite realizar toques cuando un lector de pantalla está en modo de exploración táctil.
|
||
|
||
.. _class_DisplayServer_constant_FLAG_READONLY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_READONLY** = ``7``
|
||
|
||
El elemento es un campo de texto con texto seleccionable pero de solo lectura.
|
||
|
||
.. _class_DisplayServer_constant_FLAG_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_DISABLED** = ``8``
|
||
|
||
El elemento está deshabilitado.
|
||
|
||
.. _class_DisplayServer_constant_FLAG_CLIPS_CHILDREN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_CLIPS_CHILDREN** = ``9``
|
||
|
||
El elemento recorta los hijos.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_AccessibilityAction:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **AccessibilityAction**: :ref:`🔗<enum_DisplayServer_AccessibilityAction>`
|
||
|
||
.. _class_DisplayServer_constant_ACTION_CLICK:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_CLICK** = ``0``
|
||
|
||
Acción de clic único, el argumento de callback no está establecido.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_FOCUS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_FOCUS** = ``1``
|
||
|
||
Acción de enfocar, el argumento de callback no está establecido.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_BLUR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_BLUR** = ``2``
|
||
|
||
Acción de desenfocar, el argumento de callback no está establecido.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_COLLAPSE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_COLLAPSE** = ``3``
|
||
|
||
Acción de contraer, el argumento de callback no está establecido.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_EXPAND:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_EXPAND** = ``4``
|
||
|
||
Acción de expandir, el argumento de callback no está establecido.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_DECREMENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_DECREMENT** = ``5``
|
||
|
||
Acción de decrementar, el argumento de callback no está establecido.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_INCREMENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_INCREMENT** = ``6``
|
||
|
||
Acción de incrementar, el argumento de callback no está establecido.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_HIDE_TOOLTIP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_HIDE_TOOLTIP** = ``7``
|
||
|
||
Acción de ocultar tooltip, el argumento de callback no está establecido.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SHOW_TOOLTIP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SHOW_TOOLTIP** = ``8``
|
||
|
||
Acción de mostrar tooltip, el argumento de callback no está establecido.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SET_TEXT_SELECTION:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SET_TEXT_SELECTION** = ``9``
|
||
|
||
Set text selection action, callback argument is set to :ref:`Dictionary<class_Dictionary>` with the following keys:
|
||
|
||
- ``"start_element"`` accessibility element of the selection start.
|
||
|
||
- ``"start_char"`` character offset relative to the accessibility element of the selection start.
|
||
|
||
- ``"end_element"`` accessibility element of the selection end.
|
||
|
||
- ``"end_char"`` character offset relative to the accessibility element of the selection end.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_REPLACE_SELECTED_TEXT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_REPLACE_SELECTED_TEXT** = ``10``
|
||
|
||
Acción de reemplazar texto, el argumento de callback se establece en :ref:`String<class_String>` con el texto de reemplazo.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SCROLL_BACKWARD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_BACKWARD** = ``11``
|
||
|
||
Acción de desplazamiento hacia atrás, el argumento de callback no está establecido.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SCROLL_DOWN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_DOWN** = ``12``
|
||
|
||
Scroll down action, callback argument is set to :ref:`AccessibilityScrollUnit<enum_DisplayServer_AccessibilityScrollUnit>`.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SCROLL_FORWARD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_FORWARD** = ``13``
|
||
|
||
Acción de desplazamiento hacia adelante, el argumento de callback no está establecido.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SCROLL_LEFT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_LEFT** = ``14``
|
||
|
||
Scroll left action, callback argument is set to :ref:`AccessibilityScrollUnit<enum_DisplayServer_AccessibilityScrollUnit>`.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SCROLL_RIGHT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_RIGHT** = ``15``
|
||
|
||
Scroll right action, callback argument is set to :ref:`AccessibilityScrollUnit<enum_DisplayServer_AccessibilityScrollUnit>`.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SCROLL_UP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_UP** = ``16``
|
||
|
||
Scroll up action, callback argument is set to :ref:`AccessibilityScrollUnit<enum_DisplayServer_AccessibilityScrollUnit>`.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SCROLL_INTO_VIEW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_INTO_VIEW** = ``17``
|
||
|
||
Scroll into view action, callback argument is set to :ref:`AccessibilityScrollHint<enum_DisplayServer_AccessibilityScrollHint>`.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SCROLL_TO_POINT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_TO_POINT** = ``18``
|
||
|
||
Acción de desplazamiento a un punto, el argumento de callback se establece en :ref:`Vector2<class_Vector2>` con las coordenadas del punto relativo.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SET_SCROLL_OFFSET:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SET_SCROLL_OFFSET** = ``19``
|
||
|
||
Acción de establecer el desplazamiento, el argumento de callback se establece en :ref:`Vector2<class_Vector2>` con el desplazamiento.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SET_VALUE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SET_VALUE** = ``20``
|
||
|
||
Set value action, callback argument is set to :ref:`String<class_String>` or number with the new value.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SHOW_CONTEXT_MENU:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SHOW_CONTEXT_MENU** = ``21``
|
||
|
||
Acción de mostrar menú contextual, el argumento de callback no está establecido.
|
||
|
||
.. _class_DisplayServer_constant_ACTION_CUSTOM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_CUSTOM** = ``22``
|
||
|
||
Custom action, callback argument is set to the integer action ID.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_AccessibilityLiveMode:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **AccessibilityLiveMode**: :ref:`🔗<enum_DisplayServer_AccessibilityLiveMode>`
|
||
|
||
.. _class_DisplayServer_constant_LIVE_OFF:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>` **LIVE_OFF** = ``0``
|
||
|
||
Indica que las actualizaciones de la región activa no deben presentarse.
|
||
|
||
.. _class_DisplayServer_constant_LIVE_POLITE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>` **LIVE_POLITE** = ``1``
|
||
|
||
Indica que las actualizaciones de la región activa deben presentarse en la siguiente oportunidad (por ejemplo, al final de la frase actual).
|
||
|
||
.. _class_DisplayServer_constant_LIVE_ASSERTIVE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>` **LIVE_ASSERTIVE** = ``2``
|
||
|
||
Indica que las actualizaciones de la región activa tienen la máxima prioridad y deben presentarse inmediatamente.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_AccessibilityScrollUnit:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **AccessibilityScrollUnit**: :ref:`🔗<enum_DisplayServer_AccessibilityScrollUnit>`
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_UNIT_ITEM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollUnit<enum_DisplayServer_AccessibilityScrollUnit>` **SCROLL_UNIT_ITEM** = ``0``
|
||
|
||
The amount by which to scroll. A single item of a list, line of text.
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_UNIT_PAGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollUnit<enum_DisplayServer_AccessibilityScrollUnit>` **SCROLL_UNIT_PAGE** = ``1``
|
||
|
||
The amount by which to scroll. A single page.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_AccessibilityScrollHint:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **AccessibilityScrollHint**: :ref:`🔗<enum_DisplayServer_AccessibilityScrollHint>`
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_HINT_TOP_LEFT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollHint<enum_DisplayServer_AccessibilityScrollHint>` **SCROLL_HINT_TOP_LEFT** = ``0``
|
||
|
||
A preferred position for the node scrolled into view. Top-left edge of the scroll container.
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_HINT_BOTTOM_RIGHT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollHint<enum_DisplayServer_AccessibilityScrollHint>` **SCROLL_HINT_BOTTOM_RIGHT** = ``1``
|
||
|
||
A preferred position for the node scrolled into view. Bottom-right edge of the scroll container.
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_HINT_TOP_EDGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollHint<enum_DisplayServer_AccessibilityScrollHint>` **SCROLL_HINT_TOP_EDGE** = ``2``
|
||
|
||
A preferred position for the node scrolled into view. Top edge of the scroll container.
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_HINT_BOTTOM_EDGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollHint<enum_DisplayServer_AccessibilityScrollHint>` **SCROLL_HINT_BOTTOM_EDGE** = ``3``
|
||
|
||
A preferred position for the node scrolled into view. Bottom edge of the scroll container.
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_HINT_LEFT_EDGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollHint<enum_DisplayServer_AccessibilityScrollHint>` **SCROLL_HINT_LEFT_EDGE** = ``4``
|
||
|
||
A preferred position for the node scrolled into view. Left edge of the scroll container.
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_HINT_RIGHT_EDGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollHint<enum_DisplayServer_AccessibilityScrollHint>` **SCROLL_HINT_RIGHT_EDGE** = ``5``
|
||
|
||
A preferred position for the node scrolled into view. Right edge of the scroll container.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_MouseMode:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **MouseMode**: :ref:`🔗<enum_DisplayServer_MouseMode>`
|
||
|
||
.. _class_DisplayServer_constant_MOUSE_MODE_VISIBLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_VISIBLE** = ``0``
|
||
|
||
Hace que el cursor del ratón sea visible si está oculto.
|
||
|
||
.. _class_DisplayServer_constant_MOUSE_MODE_HIDDEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_HIDDEN** = ``1``
|
||
|
||
Hace que el cursor del ratón se oculte si es visible.
|
||
|
||
.. _class_DisplayServer_constant_MOUSE_MODE_CAPTURED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CAPTURED** = ``2``
|
||
|
||
Captura el ratón. El ratón se ocultará y su posición se bloqueará en el centro de la ventana del gestor de ventanas.
|
||
|
||
\ **Nota:** Si quieres procesar el movimiento del ratón en este modo, necesitas usar :ref:`InputEventMouseMotion.relative<class_InputEventMouseMotion_property_relative>`.
|
||
|
||
.. _class_DisplayServer_constant_MOUSE_MODE_CONFINED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED** = ``3``
|
||
|
||
Limita el cursor del ratón a la ventana del juego y lo hace visible.
|
||
|
||
.. _class_DisplayServer_constant_MOUSE_MODE_CONFINED_HIDDEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED_HIDDEN** = ``4``
|
||
|
||
Limita el cursor del ratón a la ventana del juego y lo oculta.
|
||
|
||
.. _class_DisplayServer_constant_MOUSE_MODE_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_MAX** = ``5``
|
||
|
||
Valor máximo de :ref:`MouseMode<enum_DisplayServer_MouseMode>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_ScreenOrientation:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **ScreenOrientation**: :ref:`🔗<enum_DisplayServer_ScreenOrientation>`
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_LANDSCAPE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_LANDSCAPE** = ``0``
|
||
|
||
Orientación horizontal predeterminada.
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_PORTRAIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_PORTRAIT** = ``1``
|
||
|
||
Orientación vertical predeterminada.
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_LANDSCAPE** = ``2``
|
||
|
||
Orientación horizontal inversa (boca abajo).
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_REVERSE_PORTRAIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_PORTRAIT** = ``3``
|
||
|
||
Orientación vertical inversa (boca abajo).
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_SENSOR_LANDSCAPE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_LANDSCAPE** = ``4``
|
||
|
||
Orientación horizontal automática (por defecto o inversa dependiendo del sensor).
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_SENSOR_PORTRAIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_PORTRAIT** = ``5``
|
||
|
||
Orientación vertical automática (por defecto o inversa dependiendo del sensor).
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_SENSOR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR** = ``6``
|
||
|
||
Orientación horizontal o vertical automática (por defecto o inversa dependiendo del sensor).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_VirtualKeyboardType:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **VirtualKeyboardType**: :ref:`🔗<enum_DisplayServer_VirtualKeyboardType>`
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_DEFAULT** = ``0``
|
||
|
||
Teclado virtual de texto por defecto.
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_MULTILINE** = ``1``
|
||
|
||
Teclado virtual multilínea.
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER** = ``2``
|
||
|
||
Teclado numérico virtual, útil para ingresar pines.
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER_DECIMAL** = ``3``
|
||
|
||
Teclado numérico virtual, útil para introducir números fraccionarios.
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PHONE** = ``4``
|
||
|
||
Teclado numérico de teléfono virtual.
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_EMAIL_ADDRESS** = ``5``
|
||
|
||
Teclado virtual con teclas adicionales para ayudar a escribir direcciones de correo electrónico.
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PASSWORD** = ``6``
|
||
|
||
Teclado virtual para introducir una contraseña. En la mayoría de las plataformas, esto debería desactivar el autocompletado y la autocapitalización.
|
||
|
||
\ **Nota:** Esto no es compatible en la Web. En su lugar, se comporta de forma idéntica a :ref:`KEYBOARD_TYPE_DEFAULT<class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT>`.
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_URL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_URL** = ``7``
|
||
|
||
Teclado virtual con teclas adicionales para ayudar a escribir URLs.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_CursorShape:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **CursorShape**: :ref:`🔗<enum_DisplayServer_CursorShape>`
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_ARROW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_ARROW** = ``0``
|
||
|
||
Forma de cursor de flecha. Este es el predeterminado cuando no se apunta a nada que sobrescriba el cursor del ratón, como un :ref:`LineEdit<class_LineEdit>` o :ref:`TextEdit<class_TextEdit>`.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_IBEAM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_IBEAM** = ``1``
|
||
|
||
I-beam cursor shape. This is used by default when hovering a control that accepts text input, such as :ref:`LineEdit<class_LineEdit>` or :ref:`TextEdit<class_TextEdit>`.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_POINTING_HAND:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_POINTING_HAND** = ``2``
|
||
|
||
Forma de cursor de mano apuntando. Se utiliza por defecto al pasar el ratón por encima de un :ref:`LinkButton<class_LinkButton>` o una etiqueta URL en un :ref:`RichTextLabel<class_RichTextLabel>`.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_CROSS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CROSS** = ``3``
|
||
|
||
Cursor en forma de cruz. Se pretende que se muestre cuando el usuario necesita apuntar con precisión sobre un elemento, como una herramienta de selección rectangular o un selector de color.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_WAIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_WAIT** = ``4``
|
||
|
||
Cursor de espera. En la mayoría de los temas de cursor, esto muestra un icono giratorio *junto a* la flecha. Destinado a ser utilizado para operaciones sin bloqueo (cuando el usuario puede hacer otra cosa en ese momento). Véase también :ref:`CURSOR_BUSY<class_DisplayServer_constant_CURSOR_BUSY>`.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_BUSY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BUSY** = ``5``
|
||
|
||
Cursor de espera. En la mayoría de los temas de cursor, esto *reemplaza* la flecha con un icono giratorio. Destinado a ser utilizado para operaciones de bloqueo (cuando el usuario no puede hacer nada más en ese momento). Véase también :ref:`CURSOR_WAIT<class_DisplayServer_constant_CURSOR_WAIT>`.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_DRAG:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_DRAG** = ``6``
|
||
|
||
Cursor de mano arrastrando. Se muestra durante las operaciones de arrastrar y soltar. Véase también :ref:`CURSOR_CAN_DROP<class_DisplayServer_constant_CURSOR_CAN_DROP>`.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_CAN_DROP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CAN_DROP** = ``7``
|
||
|
||
"Can drop" cursor. This is displayed during drag-and-drop operations if hovering over a :ref:`Control<class_Control>` that can accept the drag-and-drop event. On most cursor themes, this displays a dragging hand with an arrow symbol besides it. See also :ref:`CURSOR_DRAG<class_DisplayServer_constant_CURSOR_DRAG>`.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_FORBIDDEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FORBIDDEN** = ``8``
|
||
|
||
Cursor prohibido. Se muestra durante las operaciones de arrastrar y soltar si el :ref:`Control<class_Control>` sobre el que se pasa el ratón no puede aceptar el evento de arrastrar y soltar.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_VSIZE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSIZE** = ``9``
|
||
|
||
Cursor de redimensionamiento vertical. Se pretende que se muestre cuando el :ref:`Control<class_Control>` sobre el que se pasa el ratón puede ser redimensionado verticalmente usando el ratón. Véase también :ref:`CURSOR_VSPLIT<class_DisplayServer_constant_CURSOR_VSPLIT>`.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_HSIZE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSIZE** = ``10``
|
||
|
||
Cursor de redimensionamiento horizontal. Se pretende que se muestre cuando el :ref:`Control<class_Control>` sobre el que se pasa el ratón puede ser redimensionado horizontalmente usando el ratón. Véase también :ref:`CURSOR_HSPLIT<class_DisplayServer_constant_CURSOR_HSPLIT>`.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_BDIAGSIZE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BDIAGSIZE** = ``11``
|
||
|
||
Cursor de redimensionamiento diagonal secundario (arriba-derecha/abajo-izquierda). Se pretende que se muestre cuando el :ref:`Control<class_Control>` sobre el que se pasa el ratón puede ser redimensionado en ambos ejes a la vez usando el ratón.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_FDIAGSIZE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FDIAGSIZE** = ``12``
|
||
|
||
Cursor de redimensionamiento diagonal principal (arriba-izquierda/abajo-derecha). Se pretende que se muestre cuando el :ref:`Control<class_Control>` sobre el que se pasa el ratón puede ser redimensionado en ambos ejes a la vez usando el ratón.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_MOVE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MOVE** = ``13``
|
||
|
||
Cursor de movimiento. Se pretende que se muestre cuando el :ref:`Control<class_Control>` sobre el que se pasa el ratón puede ser movido usando el ratón.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_VSPLIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSPLIT** = ``14``
|
||
|
||
Cursor de división vertical. Se muestra al pasar el ratón por encima de un :ref:`Control<class_Control>` con divisiones que pueden ser redimensionadas verticalmente usando el ratón, como :ref:`VSplitContainer<class_VSplitContainer>`. En algunos temas de cursor, este cursor puede tener la misma apariencia que :ref:`CURSOR_VSIZE<class_DisplayServer_constant_CURSOR_VSIZE>`.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_HSPLIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSPLIT** = ``15``
|
||
|
||
Cursor de división horizontal. Se muestra al pasar el ratón por encima de un :ref:`Control<class_Control>` con divisiones que pueden ser redimensionadas horizontalmente usando el ratón, como :ref:`HSplitContainer<class_HSplitContainer>`. En algunos temas de cursor, este cursor puede tener la misma apariencia que :ref:`CURSOR_HSIZE<class_DisplayServer_constant_CURSOR_HSIZE>`.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_HELP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HELP** = ``16``
|
||
|
||
Cursor de ayuda. En la mayoría de los temas de cursor, esto muestra un icono de signo de interrogación en lugar del cursor del ratón. Destinado a ser utilizado cuando el usuario ha solicitado ayuda sobre el siguiente elemento que será pulsado.
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MAX** = ``17``
|
||
|
||
Representa el tamaño del enum :ref:`CursorShape<enum_DisplayServer_CursorShape>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_FileDialogMode:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **FileDialogMode**: :ref:`🔗<enum_DisplayServer_FileDialogMode>`
|
||
|
||
.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILE** = ``0``
|
||
|
||
El cuadro de diálogo de archivo nativo permite seleccionar uno, y solo un, archivo.
|
||
|
||
.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILES:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILES** = ``1``
|
||
|
||
El cuadro de diálogo de archivo nativo permite seleccionar varios archivos.
|
||
|
||
.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_DIR** = ``2``
|
||
|
||
El cuadro de diálogo de archivo nativo solo permite seleccionar un directorio y no permite la selección de ningún archivo.
|
||
|
||
.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_ANY** = ``3``
|
||
|
||
El cuadro de diálogo de archivo nativo permite seleccionar un archivo o directorio.
|
||
|
||
.. _class_DisplayServer_constant_FILE_DIALOG_MODE_SAVE_FILE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_SAVE_FILE** = ``4``
|
||
|
||
El cuadro de diálogo del archivo nativo avisará cuando exista un archivo.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_WindowMode:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **WindowMode**: :ref:`🔗<enum_DisplayServer_WindowMode>`
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_MODE_WINDOWED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_WINDOWED** = ``0``
|
||
|
||
Modo de ventana, es decir, :ref:`Window<class_Window>` no ocupa toda la pantalla (a menos que se establezca el tamaño de la pantalla).
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_MODE_MINIMIZED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MINIMIZED** = ``1``
|
||
|
||
Modo de ventana minimizada, es decir, :ref:`Window<class_Window>` no es visible y está disponible en la lista de ventanas del gestor de ventanas. Normalmente ocurre cuando se pulsa el botón de minimizar.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_MODE_MAXIMIZED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MAXIMIZED** = ``2``
|
||
|
||
Modo de ventana maximizada, es decir, :ref:`Window<class_Window>` ocupará toda el área de la pantalla excepto la barra de tareas y seguirá mostrando sus bordes. Normalmente ocurre cuando se pulsa el botón de maximizar.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_FULLSCREEN** = ``3``
|
||
|
||
Modo de pantalla completa con soporte completo para múltiples ventanas.
|
||
|
||
La ventana de pantalla completa cubre toda el área de visualización de una pantalla y no tiene decoraciones. El modo de vídeo de la pantalla no se cambia.
|
||
|
||
\ **En Android:** Esto habilita el modo inmersivo.
|
||
|
||
\ **En macOS:** Se utiliza un nuevo escritorio para mostrar el proyecto en ejecución.
|
||
|
||
\ **Nota:** Independientemente de la plataforma, habilitar la pantalla completa cambiará el tamaño de la ventana para que coincida con el tamaño del monitor. Por lo tanto, asegúrate de que tu proyecto admita :doc:`múltiples resoluciones <../tutorials/rendering/multiple_resolutions>` al habilitar el modo de pantalla completa.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = ``4``
|
||
|
||
A single window full screen mode. This mode has less overhead, but only one window can be open on a given screen at a time (opening a child window or application switching will trigger a full screen transition).
|
||
|
||
Full screen window covers the entire display area of a screen and has no border or decorations. The display's video mode is not changed.
|
||
|
||
\ **Note:** This mode might not work with screen recording software.
|
||
|
||
\ **On Android:** This enables immersive mode.
|
||
|
||
\ **On Windows:** Depending on video driver, full screen transition might cause screens to go black for a moment.
|
||
|
||
\ **On macOS:** A new desktop is used to display the running project. Exclusive full screen mode prevents Dock and Menu from showing up when the mouse pointer is hovering the edge of the screen.
|
||
|
||
\ **On Linux (X11):** Exclusive full screen mode bypasses compositor.
|
||
|
||
\ **On Linux (Wayland):** Equivalent to :ref:`WINDOW_MODE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN>`.
|
||
|
||
\ **Note:** Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` when enabling full screen mode.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_WindowFlags:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **WindowFlags**: :ref:`🔗<enum_DisplayServer_WindowFlags>`
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_RESIZE_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_RESIZE_DISABLED** = ``0``
|
||
|
||
La ventana no puede ser redimensionada arrastrando su agarre de redimensionamiento. Todavía es posible redimensionar la ventana usando :ref:`window_set_size()<class_DisplayServer_method_window_set_size>`. Esta bandera es ignorada para las ventanas en pantalla completa.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_BORDERLESS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_BORDERLESS** = ``1``
|
||
|
||
La ventana no tiene barra de título nativa ni otras decoraciones. Esta bandera es ignorada para las ventanas en pantalla completa.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_ALWAYS_ON_TOP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_ALWAYS_ON_TOP** = ``2``
|
||
|
||
La ventana está flotando sobre todas las demás ventanas. Esta bandera es ignorada para las ventanas en pantalla completa.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_TRANSPARENT** = ``3``
|
||
|
||
The window background can be transparent.
|
||
|
||
\ **Note:** This flag has no effect if :ref:`is_window_transparency_available()<class_DisplayServer_method_is_window_transparency_available>` returns ``false``.
|
||
|
||
\ **Note:** Transparency support is implemented on Linux (X11/Wayland), macOS, and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities.
|
||
|
||
\ **Note:** Transparency support is implemented on Android, but can only be enabled via :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>`. This flag has no effect on Android.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_NO_FOCUS** = ``4``
|
||
|
||
La ventana no puede enfocarse. Una ventana sin foco ignorará todas las entradas, excepto los clics del ratón.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_POPUP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP** = ``5``
|
||
|
||
La ventana es parte de un menú o desplegable de :ref:`OptionButton<class_OptionButton>`. Esta bandera no puede ser cambiado cuando la ventana está visible. Una ventana emergente activa recibirá exclusivamente toda la entrada, sin robar el foco de su padre. Las ventanas emergentes se cierran automáticamente cuando el usuario hace clic fuera de ella, o cuando se cambia de aplicación. La ventana emergente debe tener un padre transitorio establecido (véase :ref:`window_set_transient()<class_DisplayServer_method_window_set_transient>`).
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXTEND_TO_TITLE** = ``6``
|
||
|
||
El contenido de la ventana se expande al tamaño completo de la ventana. A diferencia de la ventana sin bordes, el marco se mantiene intacto y puede usarse para cambiar el tamaño de la ventana, la barra de título es transparente pero tiene botones de minimizar/maximizar/cerrar.
|
||
|
||
Usa :ref:`window_set_window_buttons_offset()<class_DisplayServer_method_window_set_window_buttons_offset>` para ajustar el desplazamiento de los botones minimizar/maximizar/cerrar.
|
||
|
||
Usa :ref:`window_get_safe_title_margins()<class_DisplayServer_method_window_get_safe_title_margins>` para determinar el área bajo la barra de título que no está cubierta por las decoraciones.
|
||
|
||
\ **Nota:** Esta bandera solo se implementa en macOS.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_MOUSE_PASSTHROUGH:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MOUSE_PASSTHROUGH** = ``7``
|
||
|
||
Todos los eventos del ratón se pasan a la ventana subyacente de la misma aplicación.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_SHARP_CORNERS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_SHARP_CORNERS** = ``8``
|
||
|
||
El estilo de ventana se sobrescribe, forzando las esquinas afiladas.
|
||
|
||
\ **Nota:** Esta opción solo está implementada en Windows (11).
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_EXCLUDE_FROM_CAPTURE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXCLUDE_FROM_CAPTURE** = ``9``
|
||
|
||
Window is excluded from screenshots taken by :ref:`screen_get_image()<class_DisplayServer_method_screen_get_image>`, :ref:`screen_get_image_rect()<class_DisplayServer_method_screen_get_image_rect>`, and :ref:`screen_get_pixel()<class_DisplayServer_method_screen_get_pixel>`.
|
||
|
||
\ **Note:** This flag is implemented on macOS and Windows (10, 20H1).
|
||
|
||
\ **Note:** Setting this flag will prevent standard screenshot methods from capturing a window image, but does **NOT** guarantee that other apps won't be able to capture an image. It should not be used as a DRM or security measure.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_POPUP_WM_HINT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP_WM_HINT** = ``10``
|
||
|
||
Señala al gestor de ventanas que se supone que esta ventana es un "popup" definido por la implementación (normalmente una ventana hija flotante, sin bordes, no tileable e inamovible).
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_MINIMIZE_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MINIMIZE_DISABLED** = ``11``
|
||
|
||
El botón para minimizar la ventana se deshabilita.
|
||
|
||
\ **Nota:** Esta opción está implementada en macOS y Windows.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_MAXIMIZE_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MAXIMIZE_DISABLED** = ``12``
|
||
|
||
El botón para maximizar la ventana se deshabilita.
|
||
|
||
\ **Nota:** Esta opción está implementada en macOS y Windows.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MAX** = ``13``
|
||
|
||
Represents the size of the :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` enum.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_WindowEvent:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **WindowEvent**: :ref:`🔗<enum_DisplayServer_WindowEvent>`
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_ENTER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_ENTER** = ``0``
|
||
|
||
Se envía cuando el puntero del ratón ingresa a la ventana.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_EXIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_EXIT** = ``1``
|
||
|
||
Se envía cuando el puntero del ratón sale de la ventana.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_IN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_IN** = ``2``
|
||
|
||
Se envía cuando la ventana toma el foco.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_OUT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_OUT** = ``3``
|
||
|
||
Se envía cuando la ventana pierde el foco.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_CLOSE_REQUEST:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_CLOSE_REQUEST** = ``4``
|
||
|
||
Se envía cuando el usuario ha intentado cerrar la ventana (por ejemplo, se presiona el botón de cerrar).
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_GO_BACK_REQUEST:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_GO_BACK_REQUEST** = ``5``
|
||
|
||
Se envía al presionar el botón "Atrás" del dispositivo.
|
||
|
||
\ **Nota:** Este evento solo está implementado en Android.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_DPI_CHANGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_DPI_CHANGE** = ``6``
|
||
|
||
Se envía cuando la ventana se mueve a una pantalla con un DPI diferente o cuando se cambia el DPI de la pantalla.
|
||
|
||
\ **Nota:** Esta opción solo se implementa en macOS y Linux (Wayland).
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_TITLEBAR_CHANGE** = ``7``
|
||
|
||
Enviado cuando la decoración de la barra de título de la ventana es cambiada (p. ej. :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>` está activada o la ventana entra/sale del modo de pantalla completa).
|
||
|
||
\ **Nota:** Esta bandera solo está implementada en macOS.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_FORCE_CLOSE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FORCE_CLOSE** = ``8``
|
||
|
||
Sent when the window has been forcibly closed by the display server. The window will immediately hide and clean any internal rendering references.
|
||
|
||
\ **Note:** This flag is implemented only on Linux (Wayland).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_WindowResizeEdge:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **WindowResizeEdge**: :ref:`🔗<enum_DisplayServer_WindowResizeEdge>`
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_TOP_LEFT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_TOP_LEFT** = ``0``
|
||
|
||
Borde superior izquierdo de una ventana.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_TOP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_TOP** = ``1``
|
||
|
||
Borde superior de una ventana.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_TOP_RIGHT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_TOP_RIGHT** = ``2``
|
||
|
||
Borde superior derecho de una ventana.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_LEFT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_LEFT** = ``3``
|
||
|
||
Borde izquierdo de una ventana.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_RIGHT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_RIGHT** = ``4``
|
||
|
||
Borde derecho de una ventana.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_LEFT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_BOTTOM_LEFT** = ``5``
|
||
|
||
Borde inferior izquierdo de una ventana.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_BOTTOM** = ``6``
|
||
|
||
Borde inferior de una ventana.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_RIGHT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_BOTTOM_RIGHT** = ``7``
|
||
|
||
Borde inferior derecho de una ventana.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_MAX** = ``8``
|
||
|
||
Representa el tamaño del enum :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_VSyncMode:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **VSyncMode**: :ref:`🔗<enum_DisplayServer_VSyncMode>`
|
||
|
||
.. _class_DisplayServer_constant_VSYNC_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_DISABLED** = ``0``
|
||
|
||
Sin sincronización vertical, lo que significa que el motor mostrará los fotogramas lo más rápido posible (el tearing puede ser visible). La velocidad de fotogramas es ilimitada (independientemente de :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
|
||
|
||
.. _class_DisplayServer_constant_VSYNC_ENABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ENABLED** = ``1``
|
||
|
||
Modo de sincronización vertical por defecto, la imagen sólo se muestra en los intervalos de borrado vertical (no hay tearing visible). La velocidad de fotogramas está limitada por la frecuencia de actualización del monitor (independientemente de :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
|
||
|
||
.. _class_DisplayServer_constant_VSYNC_ADAPTIVE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ADAPTIVE** = ``2``
|
||
|
||
Behaves like :ref:`VSYNC_DISABLED<class_DisplayServer_constant_VSYNC_DISABLED>` when the framerate drops below the screen's refresh rate to reduce stuttering (tearing may be visible). Otherwise, vertical synchronization is enabled to avoid tearing. Framerate is limited by the monitor refresh rate (regardless of :ref:`Engine.max_fps<class_Engine_property_max_fps>`). Behaves like :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` when using the Compatibility rendering method.
|
||
|
||
.. _class_DisplayServer_constant_VSYNC_MAILBOX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_MAILBOX** = ``3``
|
||
|
||
Displays the most recent image in the queue on vertical blanking intervals, while rendering to the other images (no tearing is visible). Framerate is unlimited (regardless of :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
|
||
|
||
Although not guaranteed, the images can be rendered as fast as possible, which may reduce input lag (also called "Fast" V-Sync mode). :ref:`VSYNC_MAILBOX<class_DisplayServer_constant_VSYNC_MAILBOX>` works best when at least twice as many frames as the display refresh rate are rendered. Behaves like :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` when using the Compatibility rendering method.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_HandleType:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **HandleType**: :ref:`🔗<enum_DisplayServer_HandleType>`
|
||
|
||
.. _class_DisplayServer_constant_DISPLAY_HANDLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandleType<enum_DisplayServer_HandleType>` **DISPLAY_HANDLE** = ``0``
|
||
|
||
Display handle:
|
||
|
||
- Linux (X11): ``X11::Display*`` for the display.
|
||
|
||
- Linux (Wayland): ``wl_display`` for the display.
|
||
|
||
- Android: ``EGLDisplay`` for the display.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_HANDLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_HANDLE** = ``1``
|
||
|
||
Window handle:
|
||
|
||
- Windows: ``HWND`` for the window.
|
||
|
||
- Linux (X11): ``X11::Window*`` for the window.
|
||
|
||
- Linux (Wayland): ``wl_surface`` for the window.
|
||
|
||
- macOS: ``NSWindow*`` for the window.
|
||
|
||
- iOS: ``UIViewController*`` for the view controller.
|
||
|
||
- Android: ``jObject`` for the activity.
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_VIEW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_VIEW** = ``2``
|
||
|
||
Window view:
|
||
|
||
- Windows: ``HDC`` for the window (only with the Compatibility renderer).
|
||
|
||
- macOS: ``NSView*`` for the window main view.
|
||
|
||
- iOS: ``UIView*`` for the window main view.
|
||
|
||
.. _class_DisplayServer_constant_OPENGL_CONTEXT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandleType<enum_DisplayServer_HandleType>` **OPENGL_CONTEXT** = ``3``
|
||
|
||
OpenGL context (only with the Compatibility renderer):
|
||
|
||
- Windows: ``HGLRC`` for the window (native GL), or ``EGLContext`` for the window (ANGLE).
|
||
|
||
- Linux (X11): ``GLXContext*`` for the window.
|
||
|
||
- Linux (Wayland): ``EGLContext`` for the window.
|
||
|
||
- macOS: ``NSOpenGLContext*`` for the window (native GL), or ``EGLContext`` for the window (ANGLE).
|
||
|
||
- Android: ``EGLContext`` for the window.
|
||
|
||
.. _class_DisplayServer_constant_EGL_DISPLAY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandleType<enum_DisplayServer_HandleType>` **EGL_DISPLAY** = ``4``
|
||
|
||
- Windows: ``EGLDisplay`` for the window (ANGLE).
|
||
|
||
- macOS: ``EGLDisplay`` for the window (ANGLE).
|
||
|
||
- Linux (Wayland): ``EGLDisplay`` for the window.
|
||
|
||
.. _class_DisplayServer_constant_EGL_CONFIG:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandleType<enum_DisplayServer_HandleType>` **EGL_CONFIG** = ``5``
|
||
|
||
- Windows: ``EGLConfig`` for the window (ANGLE).
|
||
|
||
- macOS: ``EGLConfig`` for the window (ANGLE).
|
||
|
||
- Linux (Wayland): ``EGLConfig`` for the window.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_DisplayServer_TTSUtteranceEvent:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **TTSUtteranceEvent**: :ref:`🔗<enum_DisplayServer_TTSUtteranceEvent>`
|
||
|
||
.. _class_DisplayServer_constant_TTS_UTTERANCE_STARTED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_STARTED** = ``0``
|
||
|
||
Utterance has begun to be spoken.
|
||
|
||
.. _class_DisplayServer_constant_TTS_UTTERANCE_ENDED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_ENDED** = ``1``
|
||
|
||
La expresión se completó con éxito.
|
||
|
||
.. _class_DisplayServer_constant_TTS_UTTERANCE_CANCELED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_CANCELED** = ``2``
|
||
|
||
Utterance was canceled, or TTS service was unable to process it.
|
||
|
||
.. _class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_BOUNDARY** = ``3``
|
||
|
||
Utterance reached a word or sentence boundary.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Constantes
|
||
--------------------
|
||
|
||
.. _class_DisplayServer_constant_INVALID_SCREEN:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**INVALID_SCREEN** = ``-1`` :ref:`🔗<class_DisplayServer_constant_INVALID_SCREEN>`
|
||
|
||
El ID que se refiere a una pantalla que no existe. Algunos métodos de **DisplayServer** lo devuelven si ninguna pantalla coincide con el resultado solicitado.
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**SCREEN_WITH_MOUSE_FOCUS** = ``-4`` :ref:`🔗<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`
|
||
|
||
Representa la pantalla que contiene el puntero del ratón.
|
||
|
||
\ **Nota:** En Android, iOS, Web y Linux (Wayland), esta constante siempre representa la pantalla en el índice ``0``.
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**SCREEN_WITH_KEYBOARD_FOCUS** = ``-3`` :ref:`🔗<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`
|
||
|
||
Representa la pantalla que contiene la ventana con el foco del teclado.
|
||
|
||
\ **Nota:** En Android, iOS, Web y Linux (Wayland), esta constante siempre representa la pantalla en el índice ``0``.
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_PRIMARY:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**SCREEN_PRIMARY** = ``-2`` :ref:`🔗<class_DisplayServer_constant_SCREEN_PRIMARY>`
|
||
|
||
Representa la pantalla principal.
|
||
|
||
\ **Nota:** En Android, iOS, Web y Linux (Wayland), esta constante siempre representa la pantalla en el índice ``0``.
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**SCREEN_OF_MAIN_WINDOW** = ``-1`` :ref:`🔗<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`
|
||
|
||
Representa la pantalla donde se encuentra la ventana principal. Este es generalmente el valor por defecto en las funciones que permiten especificar una de varias pantallas.
|
||
|
||
\ **Nota:** En Android, iOS, Web y Linux (Wayland), esta constante siempre representa la pantalla en el índice ``0``.
|
||
|
||
.. _class_DisplayServer_constant_MAIN_WINDOW_ID:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**MAIN_WINDOW_ID** = ``0`` :ref:`🔗<class_DisplayServer_constant_MAIN_WINDOW_ID>`
|
||
|
||
El ID de la ventana principal generada por el motor, que puede ser pasado a los métodos que esperan un ``window_id``.
|
||
|
||
.. _class_DisplayServer_constant_INVALID_WINDOW_ID:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**INVALID_WINDOW_ID** = ``-1`` :ref:`🔗<class_DisplayServer_constant_INVALID_WINDOW_ID>`
|
||
|
||
El ID que se refiere a una ventana inexistente. Algunos métodos de **DisplayServer** lo devuelven si ninguna ventana coincide con el resultado solicitado.
|
||
|
||
.. _class_DisplayServer_constant_INVALID_INDICATOR_ID:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**INVALID_INDICATOR_ID** = ``-1`` :ref:`🔗<class_DisplayServer_constant_INVALID_INDICATOR_ID>`
|
||
|
||
El ID que se refiere a un indicador de estado de la aplicación inexistente.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Descripciones de Métodos
|
||
------------------------------------------------
|
||
|
||
.. _class_DisplayServer_method_accessibility_create_element:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`RID<class_RID>` **accessibility_create_element**\ (\ window_id\: :ref:`int<class_int>`, role\: :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_create_element>`
|
||
|
||
Creates a new, empty accessibility element resource.
|
||
|
||
\ **Note:** An accessibility element is created and freed automatically for each :ref:`Node<class_Node>`. In general, this function should not be called manually.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_create_sub_element:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`RID<class_RID>` **accessibility_create_sub_element**\ (\ parent_rid\: :ref:`RID<class_RID>`, role\: :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>`, insert_pos\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_accessibility_create_sub_element>`
|
||
|
||
Creates a new, empty accessibility sub-element resource. Sub-elements can be used to provide accessibility information for objects which are not :ref:`Node<class_Node>`\ s, such as list items, table cells, or menu items. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the :ref:`accessibility_free_element()<class_DisplayServer_method_accessibility_free_element>` method.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_create_sub_text_edit_elements:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`RID<class_RID>` **accessibility_create_sub_text_edit_elements**\ (\ parent_rid\: :ref:`RID<class_RID>`, shaped_text\: :ref:`RID<class_RID>`, min_height\: :ref:`float<class_float>`, insert_pos\: :ref:`int<class_int>` = -1, is_last_line\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_DisplayServer_method_accessibility_create_sub_text_edit_elements>`
|
||
|
||
Creates a new, empty accessibility sub-element from the shaped text buffer. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the :ref:`accessibility_free_element()<class_DisplayServer_method_accessibility_free_element>` method.
|
||
|
||
If ``is_last_line`` is ``true``, no trailing newline is appended to the text content. Set to ``true`` for the last line in multi-line text fields and for single-line text fields.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_element_get_meta:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Variant<class_Variant>` **accessibility_element_get_meta**\ (\ id\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_DisplayServer_method_accessibility_element_get_meta>`
|
||
|
||
Returns the metadata of the accessibility element ``id``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_element_set_meta:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_element_set_meta**\ (\ id\: :ref:`RID<class_RID>`, meta\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_element_set_meta>`
|
||
|
||
Sets the metadata of the accessibility element ``id`` to ``meta``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_free_element:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_free_element**\ (\ id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_free_element>`
|
||
|
||
Frees the accessibility element ``id`` created by :ref:`accessibility_create_element()<class_DisplayServer_method_accessibility_create_element>`, :ref:`accessibility_create_sub_element()<class_DisplayServer_method_accessibility_create_sub_element>`, or :ref:`accessibility_create_sub_text_edit_elements()<class_DisplayServer_method_accessibility_create_sub_text_edit_elements>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_get_window_root:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`RID<class_RID>` **accessibility_get_window_root**\ (\ window_id\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_accessibility_get_window_root>`
|
||
|
||
Devuelve el elemento de accesibilidad principal de la ventana nativa del sistema operativo.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_has_element:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **accessibility_has_element**\ (\ id\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_DisplayServer_method_accessibility_has_element>`
|
||
|
||
Returns ``true`` if ``id`` is a valid accessibility element.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_screen_reader_active:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **accessibility_screen_reader_active**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_accessibility_screen_reader_active>`
|
||
|
||
Returns ``1`` if a screen reader, Braille display or other assistive app is active, ``0`` otherwise. Returns ``-1`` if status is unknown.
|
||
|
||
\ **Note:** This method is implemented on Linux, macOS, and Windows.
|
||
|
||
\ **Note:** Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD), do not count as assistive apps and will not affect this value. To test your project with these tools, set :ref:`ProjectSettings.accessibility/general/accessibility_support<class_ProjectSettings_property_accessibility/general/accessibility_support>` to ``1``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_set_window_focused:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_set_window_focused**\ (\ window_id\: :ref:`int<class_int>`, focused\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_set_window_focused>`
|
||
|
||
Sets the window focused state for assistive apps.
|
||
|
||
\ **Note:** This method is implemented on Linux, macOS, and Windows.
|
||
|
||
\ **Note:** Advanced users only! :ref:`Window<class_Window>` objects call this method automatically.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_set_window_rect:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_set_window_rect**\ (\ window_id\: :ref:`int<class_int>`, rect_out\: :ref:`Rect2<class_Rect2>`, rect_in\: :ref:`Rect2<class_Rect2>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_set_window_rect>`
|
||
|
||
Sets window outer (with decorations) and inner (without decorations) bounds for assistive apps.
|
||
|
||
\ **Note:** This method is implemented on Linux, macOS, and Windows.
|
||
|
||
\ **Note:** Advanced users only! :ref:`Window<class_Window>` objects call this method automatically.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_should_increase_contrast:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **accessibility_should_increase_contrast**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_accessibility_should_increase_contrast>`
|
||
|
||
Returns ``1`` if a high-contrast user interface theme should be used, ``0`` otherwise. Returns ``-1`` if status is unknown.
|
||
|
||
\ **Note:** This method is implemented on Linux (X11/Wayland, GNOME), macOS, and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_should_reduce_animation:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **accessibility_should_reduce_animation**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_accessibility_should_reduce_animation>`
|
||
|
||
Returns ``1`` if flashing, blinking, and other moving content that can cause seizures in users with photosensitive epilepsy should be disabled, ``0`` otherwise. Returns ``-1`` if status is unknown.
|
||
|
||
\ **Note:** This method is implemented on macOS and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_should_reduce_transparency:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **accessibility_should_reduce_transparency**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_accessibility_should_reduce_transparency>`
|
||
|
||
Returns ``1`` if background images, transparency, and other features that can reduce the contrast between the foreground and background should be disabled, ``0`` otherwise. Returns ``-1`` if status is unknown.
|
||
|
||
\ **Note:** This method is implemented on macOS and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_add_action:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_add_action**\ (\ id\: :ref:`RID<class_RID>`, action\: :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>`, callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_add_action>`
|
||
|
||
Adds a callback for the accessibility action (action which can be performed by using a special screen reader command or buttons on the Braille display), and marks this action as supported. The action callback receives one :ref:`Variant<class_Variant>` argument, which value depends on action type.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_add_child:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_add_child**\ (\ id\: :ref:`RID<class_RID>`, child_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_add_child>`
|
||
|
||
Adds a child accessibility element.
|
||
|
||
\ **Note:** :ref:`Node<class_Node>` children and sub-elements are added to the child list automatically.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_add_custom_action:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_add_custom_action**\ (\ id\: :ref:`RID<class_RID>`, action_id\: :ref:`int<class_int>`, action_description\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_add_custom_action>`
|
||
|
||
Adds support for a custom accessibility action. ``action_id`` is passed as an argument to the callback of :ref:`ACTION_CUSTOM<class_DisplayServer_constant_ACTION_CUSTOM>` action.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_add_related_controls:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_add_related_controls**\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_add_related_controls>`
|
||
|
||
Adds an element that is controlled by this element.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_add_related_described_by:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_add_related_described_by**\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_add_related_described_by>`
|
||
|
||
Adds an element that describes this element.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_add_related_details:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_add_related_details**\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_add_related_details>`
|
||
|
||
Adds an element that details this element.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_add_related_flow_to:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_add_related_flow_to**\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_add_related_flow_to>`
|
||
|
||
Agrega un elemento hacia el cual fluye este elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_add_related_labeled_by:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_add_related_labeled_by**\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_add_related_labeled_by>`
|
||
|
||
Adds an element that labels this element.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_add_related_radio_group:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_add_related_radio_group**\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_add_related_radio_group>`
|
||
|
||
Adds an element that is part of the same radio group.
|
||
|
||
\ **Note:** This method should be called on each element of the group, using all other elements as ``related_id``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_active_descendant:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_active_descendant**\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_active_descendant>`
|
||
|
||
Agrega un elemento que es un descendiente activo de este elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_background_color:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_background_color**\ (\ id\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_background_color>`
|
||
|
||
Establece el color de fondo del elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_bounds:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_bounds**\ (\ id\: :ref:`RID<class_RID>`, p_rect\: :ref:`Rect2<class_Rect2>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_bounds>`
|
||
|
||
Establece el cuadro delimitador del elemento, en relación con la posición del nodo.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_checked:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_checked**\ (\ id\: :ref:`RID<class_RID>`, checekd\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_checked>`
|
||
|
||
Establece el estado del elemento marcado.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_classname:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_classname**\ (\ id\: :ref:`RID<class_RID>`, classname\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_classname>`
|
||
|
||
Establece el nombre de la clase del elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_color_value:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_color_value**\ (\ id\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_color_value>`
|
||
|
||
Establece el valor del color del elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_description:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_description**\ (\ id\: :ref:`RID<class_RID>`, description\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_description>`
|
||
|
||
Sets element accessibility description.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_error_message:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_error_message**\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_error_message>`
|
||
|
||
Sets an element which contains an error message for this element.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_extra_info:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_extra_info**\ (\ id\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_extra_info>`
|
||
|
||
Sets element accessibility extra information added to the element name.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_flag:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_flag**\ (\ id\: :ref:`RID<class_RID>`, flag\: :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>`, value\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_flag>`
|
||
|
||
Establece la bandera del elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_focus:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_focus**\ (\ id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_focus>`
|
||
|
||
Establece el elemento enfocado actualmente.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_foreground_color:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_foreground_color**\ (\ id\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_foreground_color>`
|
||
|
||
Establece el color de primer plano del elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_in_page_link_target:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_in_page_link_target**\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_in_page_link_target>`
|
||
|
||
Establece el elemento de destino para el enlace.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_language:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_language**\ (\ id\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_language>`
|
||
|
||
Establece el idioma del texto del elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_list_item_count:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_list_item_count**\ (\ id\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_list_item_count>`
|
||
|
||
Establece el número de elementos en la lista.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_list_item_expanded:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_list_item_expanded**\ (\ id\: :ref:`RID<class_RID>`, expanded\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_list_item_expanded>`
|
||
|
||
Establece el estado de expandido de un elemento de lista/árbol.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_list_item_index:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_list_item_index**\ (\ id\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_list_item_index>`
|
||
|
||
Establece la posición del elemento en la lista.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_list_item_level:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_list_item_level**\ (\ id\: :ref:`RID<class_RID>`, level\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_list_item_level>`
|
||
|
||
Establece el nivel jerárquico del elemento en la lista.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_list_item_selected:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_list_item_selected**\ (\ id\: :ref:`RID<class_RID>`, selected\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_list_item_selected>`
|
||
|
||
Establece el estado seleccionado del elemento de lista/árbol.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_list_orientation:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_list_orientation**\ (\ id\: :ref:`RID<class_RID>`, vertical\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_list_orientation>`
|
||
|
||
Establece la orientación de los elementos de la lista.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_live:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_live**\ (\ id\: :ref:`RID<class_RID>`, live\: :ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_live>`
|
||
|
||
Establece la prioridad de las actualizaciones de la región en vivo.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_member_of:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_member_of**\ (\ id\: :ref:`RID<class_RID>`, group_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_member_of>`
|
||
|
||
Establece el elemento para que sea miembro del grupo.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_name:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_name**\ (\ id\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_name>`
|
||
|
||
Establece el nombre de accesibilidad del elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_next_on_line:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_next_on_line**\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_next_on_line>`
|
||
|
||
Establece el siguiente elemento en la línea.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_num_jump:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_num_jump**\ (\ id\: :ref:`RID<class_RID>`, jump\: :ref:`float<class_float>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_num_jump>`
|
||
|
||
Establece el salto del valor numérico.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_num_range:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_num_range**\ (\ id\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_num_range>`
|
||
|
||
Establece un rango de valores numéricos.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_num_step:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_num_step**\ (\ id\: :ref:`RID<class_RID>`, step\: :ref:`float<class_float>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_num_step>`
|
||
|
||
Establece el paso del valor numérico.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_num_value:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_num_value**\ (\ id\: :ref:`RID<class_RID>`, position\: :ref:`float<class_float>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_num_value>`
|
||
|
||
Establece el valor numérico.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_placeholder:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_placeholder**\ (\ id\: :ref:`RID<class_RID>`, placeholder\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_placeholder>`
|
||
|
||
Establece el texto de marcador de posición.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_popup_type:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_popup_type**\ (\ id\: :ref:`RID<class_RID>`, popup\: :ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_popup_type>`
|
||
|
||
Establece el tipo de popup para los botones emergentes.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_previous_on_line:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_previous_on_line**\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_previous_on_line>`
|
||
|
||
Establece el elemento anterior en la línea.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_role:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_role**\ (\ id\: :ref:`RID<class_RID>`, role\: :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_role>`
|
||
|
||
Modifica el rol de accesibilidad del elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_role_description:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_role_description**\ (\ id\: :ref:`RID<class_RID>`, description\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_role_description>`
|
||
|
||
Establece el texto de descripción del rol de accesibilidad del elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_scroll_x:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_scroll_x**\ (\ id\: :ref:`RID<class_RID>`, position\: :ref:`float<class_float>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_scroll_x>`
|
||
|
||
Establece la posición x de la barra de desplazamiento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_scroll_x_range:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_scroll_x_range**\ (\ id\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_scroll_x_range>`
|
||
|
||
Sets scroll bar x range.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_scroll_y:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_scroll_y**\ (\ id\: :ref:`RID<class_RID>`, position\: :ref:`float<class_float>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_scroll_y>`
|
||
|
||
Establece la posición y de la barra de desplazamiento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_scroll_y_range:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_scroll_y_range**\ (\ id\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_scroll_y_range>`
|
||
|
||
Sets scroll bar y range.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_shortcut:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_shortcut**\ (\ id\: :ref:`RID<class_RID>`, shortcut\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_shortcut>`
|
||
|
||
Establece la lista de atajos de teclado utilizados por elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_state_description:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_state_description**\ (\ id\: :ref:`RID<class_RID>`, description\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_state_description>`
|
||
|
||
Establece una descripción legible por humanos del estado actual marcado.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_table_cell_position:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_table_cell_position**\ (\ id\: :ref:`RID<class_RID>`, row_index\: :ref:`int<class_int>`, column_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_table_cell_position>`
|
||
|
||
Establece la posición de la celda en la tabla.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_table_cell_span:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_table_cell_span**\ (\ id\: :ref:`RID<class_RID>`, row_span\: :ref:`int<class_int>`, column_span\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_table_cell_span>`
|
||
|
||
Establece el espacio entre filas y columnas de celdas.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_table_column_count:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_table_column_count**\ (\ id\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_table_column_count>`
|
||
|
||
Establece el número de columnas en la tabla.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_table_column_index:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_table_column_index**\ (\ id\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_table_column_index>`
|
||
|
||
Establece la posición de la columna.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_table_row_count:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_table_row_count**\ (\ id\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_table_row_count>`
|
||
|
||
Establece el número de filas en la tabla.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_table_row_index:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_table_row_index**\ (\ id\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_table_row_index>`
|
||
|
||
Establece la posición de la fila en la tabla.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_text_align:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_text_align**\ (\ id\: :ref:`RID<class_RID>`, align\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_text_align>`
|
||
|
||
Establece la alineación del texto del elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_text_decorations:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_text_decorations**\ (\ id\: :ref:`RID<class_RID>`, underline\: :ref:`bool<class_bool>`, strikethrough\: :ref:`bool<class_bool>`, overline\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_text_decorations>`
|
||
|
||
Establece el subrayado/sobrelineado/tachado del texto.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_text_orientation:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_text_orientation**\ (\ id\: :ref:`RID<class_RID>`, vertical\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_text_orientation>`
|
||
|
||
Establece la orientación del texto.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_text_selection:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_text_selection**\ (\ id\: :ref:`RID<class_RID>`, text_start_id\: :ref:`RID<class_RID>`, start_char\: :ref:`int<class_int>`, text_end_id\: :ref:`RID<class_RID>`, end_char\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_text_selection>`
|
||
|
||
Establece la selección de texto en el campo de texto. ``text_start_id`` y ``text_end_id`` deberían ser elementos creados por :ref:`accessibility_create_sub_text_edit_elements()<class_DisplayServer_method_accessibility_create_sub_text_edit_elements>`. Los desplazamientos de caracteres son relativos al elemento correspondiente.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_tooltip:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_tooltip**\ (\ id\: :ref:`RID<class_RID>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_tooltip>`
|
||
|
||
Establece el texto de la información sobre herramientas.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_transform:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_transform**\ (\ id\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_transform>`
|
||
|
||
Establece la transformación 2D del elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_url:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_url**\ (\ id\: :ref:`RID<class_RID>`, url\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_url>`
|
||
|
||
Establece la URL del enlace.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_accessibility_update_set_value:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **accessibility_update_set_value**\ (\ id\: :ref:`RID<class_RID>`, value\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_accessibility_update_set_value>`
|
||
|
||
Establece el valor del texto del elemento.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_beep:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **beep**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_beep>`
|
||
|
||
Reproduce el sonido de pitido del sistema operativo, si es posible. Debido a que proviene del sistema operativo, el sonido de pitido será audible incluso si la aplicación está silenciada. También puede ser deshabilitado para todo el sistema operativo por el usuario.
|
||
|
||
\ **Nota:** Este método está implementado en macOS, Linux (X11/Wayland) y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_clipboard_get:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`String<class_String>` **clipboard_get**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_clipboard_get>`
|
||
|
||
Devuelve el portapapeles del usuario como una string si es posible.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_clipboard_get_image:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Image<class_Image>` **clipboard_get_image**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_clipboard_get_image>`
|
||
|
||
Devuelve el portapapeles del usuario como una imagen si es posible.
|
||
|
||
\ **Nota:** Este método utiliza los datos de píxeles copiados, p. ej. de un software de edición de imágenes o un navegador web, no un archivo de imagen copiado desde el explorador de archivos.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_clipboard_get_primary:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`String<class_String>` **clipboard_get_primary**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_clipboard_get_primary>`
|
||
|
||
Devuelve el portapapeles `primario <https://unix.stackexchange.com/questions/139191/whats-the-difference-between-primary-selection-and-clipboard-buffer>`__ del usuario como una string, si es posible. Este es el portapapeles que se establece cuando el usuario selecciona texto en cualquier aplicación, en lugar de cuando presiona :kbd:`Ctrl + C`. Los datos del portapapeles se pueden pegar haciendo clic con el botón central del ratón en cualquier aplicación que admita el mecanismo del portapapeles primario.
|
||
|
||
\ **Nota:** Este método sólo está implementado en Linux (X11/Wayland).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_clipboard_has:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **clipboard_has**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_clipboard_has>`
|
||
|
||
Devuelve ``true`` si hay un contenido de texto en el portapapeles del usuario.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_clipboard_has_image:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **clipboard_has_image**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_clipboard_has_image>`
|
||
|
||
Devuelve ``true`` si hay un contenido de imagen en el portapapeles del usuario.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_clipboard_set:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **clipboard_set**\ (\ clipboard\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_clipboard_set>`
|
||
|
||
Establece el contenido del portapapeles del usuario en la string dada.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_clipboard_set_primary:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **clipboard_set_primary**\ (\ clipboard_primary\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_clipboard_set_primary>`
|
||
|
||
Establece el contenido del portapapeles `primario <https://unix.stackexchange.com/questions/139191/whats-the-difference-between-primary-selection-and-clipboard-buffer>`__ del usuario a la string dada. Este es el portapapeles que se establece cuando el usuario selecciona texto en cualquier aplicación, en lugar de cuando presiona :kbd:`Ctrl + C`. Los datos del portapapeles se pueden pegar haciendo clic con el botón central del ratón en cualquier aplicación que admita el mecanismo del portapapeles primario.
|
||
|
||
\ **Nota:** Este método sólo está implementado en Linux (X11/Wayland).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_color_picker:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **color_picker**\ (\ callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_color_picker>`
|
||
|
||
Muestra el selector de color nativo del sistema operativo.
|
||
|
||
Las retrollamadas tienen los siguientes argumentos: ``status: bool, color: Color``.
|
||
|
||
\ **Nota:** Este método se implementa si el servidor de visualización tiene la función :ref:`FEATURE_NATIVE_COLOR_PICKER<class_DisplayServer_constant_FEATURE_NATIVE_COLOR_PICKER>`.
|
||
|
||
\ **Nota:** Este método sólo está implementado en Linux (X11/Wayland).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_create_status_indicator:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **create_status_indicator**\ (\ icon\: :ref:`Texture2D<class_Texture2D>`, tooltip\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_create_status_indicator>`
|
||
|
||
Creates a new application status indicator with the specified icon, tooltip, and activation callback.
|
||
|
||
\ ``callback`` should take two arguments: the pressed mouse button (one of the :ref:`MouseButton<enum_@GlobalScope_MouseButton>` constants) and the click position in screen coordinates (a :ref:`Vector2i<class_Vector2i>`).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_cursor_get_shape:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **cursor_get_shape**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_cursor_get_shape>`
|
||
|
||
Devuelve la forma predeterminada del cursor del mouse establecida por :ref:`cursor_set_shape()<class_DisplayServer_method_cursor_set_shape>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_cursor_set_custom_image:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **cursor_set_custom_image**\ (\ cursor\: :ref:`Resource<class_Resource>`, shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>` = 0, hotspot\: :ref:`Vector2<class_Vector2>` = Vector2(0, 0)\ ) :ref:`🔗<class_DisplayServer_method_cursor_set_custom_image>`
|
||
|
||
Establece una imagen de cursor de ratón personalizada para la ``shape`` dada. Esto significa que el sistema operativo del usuario y el tema del cursor del ratón ya no influirán en la apariencia del cursor del ratón.
|
||
|
||
\ ``cursor`` puede ser un :ref:`Texture2D<class_Texture2D>` o una :ref:`Image<class_Image>`, y no debe ser mayor de 256×256 para que se muestre correctamente. Opcionalmente, ``hotspot`` se puede establecer para desplazar la posición de la imagen con respecto al punto de clic. Por defecto, ``hotspot`` se establece en la esquina superior izquierda de la imagen. Véase también :ref:`cursor_set_shape()<class_DisplayServer_method_cursor_set_shape>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_cursor_set_shape:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **cursor_set_shape**\ (\ shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>`\ ) :ref:`🔗<class_DisplayServer_method_cursor_set_shape>`
|
||
|
||
Establece la forma predeterminada del cursor del ratón. La apariencia del cursor variará dependiendo del sistema operativo del usuario y del tema del cursor del ratón. Véase también :ref:`cursor_get_shape()<class_DisplayServer_method_cursor_get_shape>` y :ref:`cursor_set_custom_image()<class_DisplayServer_method_cursor_set_custom_image>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_delete_status_indicator:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **delete_status_indicator**\ (\ id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_delete_status_indicator>`
|
||
|
||
Elimina el indicador de estado de la aplicación.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_dialog_input_text:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Error<enum_@GlobalScope_Error>` **dialog_input_text**\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, existing_text\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_dialog_input_text>`
|
||
|
||
Muestra un diálogo de entrada de texto que utiliza la apariencia nativa del sistema operativo. ``callback`` debería aceptar un único parámetro :ref:`String<class_String>` que contenga el contenido del campo de texto.
|
||
|
||
\ **Nota:** Este método se implementa si el servidor de visualización tiene la función :ref:`FEATURE_NATIVE_DIALOG_INPUT<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_INPUT>`. Las plataformas soportadas incluyen macOS, Windows y Android.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_dialog_show:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Error<enum_@GlobalScope_Error>` **dialog_show**\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, buttons\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_dialog_show>`
|
||
|
||
Muestra un diálogo de texto que utiliza la apariencia nativa del sistema operativo. ``callback`` debería aceptar un único parámetro :ref:`int<class_int>` que corresponda al índice del botón pulsado.
|
||
|
||
\ **Nota:** Este método se implementa si el servidor de visualización tiene la función :ref:`FEATURE_NATIVE_DIALOG<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG>`. Las plataformas soportadas incluyen macOS, Windows y Android.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_enable_for_stealing_focus:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **enable_for_stealing_focus**\ (\ process_id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_enable_for_stealing_focus>`
|
||
|
||
Permite que el PID ``process_id`` robe el foco de esta ventana. En otras palabras, esto desactiva la protección contra el robo de foco del sistema operativo para el PID especificado.
|
||
|
||
\ **Nota:** Este método sólo se implementa en Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_file_dialog_show:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Error<enum_@GlobalScope_Error>` **file_dialog_show**\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`, parent_window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_file_dialog_show>`
|
||
|
||
Displays OS native dialog for selecting files or directories in the file system.
|
||
|
||
Each filter string in the ``filters`` array should be formatted like this: ``*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg``. The description text of the filter is optional and can be omitted. It is recommended to set both file extension and MIME type. See also :ref:`FileDialog.filters<class_FileDialog_property_filters>`.
|
||
|
||
Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``. **On Android,** the third callback argument (``selected_filter_index``) is always ``0``.
|
||
|
||
\ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>` feature. Supported platforms include Linux (X11/Wayland), Windows, macOS, and Android (API level 29+).
|
||
|
||
\ **Note:** ``current_directory`` might be ignored.
|
||
|
||
\ **Note:** Embedded file dialogs and Windows file dialogs support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
|
||
|
||
\ **Note:** On Android and Linux, ``show_hidden`` is ignored.
|
||
|
||
\ **Note:** On Android and macOS, native file dialogs have no title.
|
||
|
||
\ **Note:** On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use :ref:`OS.get_granted_permissions()<class_OS_method_get_granted_permissions>` to get a list of saved bookmarks.
|
||
|
||
\ **Note:** On Android, this method uses the Android Storage Access Framework (SAF).
|
||
|
||
The file picker returns a URI instead of a filesystem path. This URI can be passed directly to :ref:`FileAccess<class_FileAccess>` to perform read/write operations.
|
||
|
||
When using :ref:`FILE_DIALOG_MODE_OPEN_DIR<class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR>`, it returns a tree URI that grants full access to the selected directory. File operations inside this directory can be performed by passing a path on the form ``treeUri#relative/path/to/file`` to :ref:`FileAccess<class_FileAccess>`.
|
||
|
||
To avoid opening the file picker again after each app restart, you can take persistable URI permission as follows:
|
||
|
||
|
||
.. tabs::
|
||
|
||
.. code-tab:: gdscript
|
||
|
||
val uri = "content://com.android..." # URI of the selected file or folder.
|
||
val persist = true # Set to false to release the persistable permission.
|
||
var android_runtime = Engine.get_singleton("AndroidRuntime")
|
||
android_runtime.updatePersistableUriPermission(uri, persist)
|
||
|
||
|
||
|
||
The persistable URI permission remains valid across app restarts as long as the directory is not moved, renamed, or deleted.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_file_dialog_with_options_show:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Error<enum_@GlobalScope_Error>` **file_dialog_with_options_show**\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, root\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, options\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], callback\: :ref:`Callable<class_Callable>`, parent_window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_file_dialog_with_options_show>`
|
||
|
||
Displays OS native dialog for selecting files or directories in the file system with additional user selectable options.
|
||
|
||
Each filter string in the ``filters`` array should be formatted like this: ``*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg``. The description text of the filter is optional and can be omitted. It is recommended to set both file extension and MIME type. See also :ref:`FileDialog.filters<class_FileDialog_property_filters>`.
|
||
|
||
\ ``options`` is array of :ref:`Dictionary<class_Dictionary>`\ s with the following keys:
|
||
|
||
- ``"name"`` - option's name :ref:`String<class_String>`.
|
||
|
||
- ``"values"`` - :ref:`PackedStringArray<class_PackedStringArray>` of values. If empty, boolean option (check box) is used.
|
||
|
||
- ``"default"`` - default selected option index (:ref:`int<class_int>`) or default boolean value (:ref:`bool<class_bool>`).
|
||
|
||
Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary``.
|
||
|
||
\ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE_EXTRA<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_EXTRA>` feature. Supported platforms include Linux (X11/Wayland), Windows, and macOS.
|
||
|
||
\ **Note:** ``current_directory`` might be ignored.
|
||
|
||
\ **Note:** Embedded file dialogs and Windows file dialogs support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
|
||
|
||
\ **Note:** On Linux (X11), ``show_hidden`` is ignored.
|
||
|
||
\ **Note:** On macOS, native file dialogs have no title.
|
||
|
||
\ **Note:** On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use :ref:`OS.get_granted_permissions()<class_OS_method_get_granted_permissions>` to get a list of saved bookmarks.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_force_process_and_drop_events:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **force_process_and_drop_events**\ (\ ) :ref:`🔗<class_DisplayServer_method_force_process_and_drop_events>`
|
||
|
||
Forces window manager processing while ignoring all :ref:`InputEvent<class_InputEvent>`\ s. See also :ref:`process_events()<class_DisplayServer_method_process_events>`.
|
||
|
||
\ **Note:** This method is implemented on Windows and macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_get_accent_color:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Color<class_Color>` **get_accent_color**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_accent_color>`
|
||
|
||
Devuelve el color de énfasis del tema del sistema operativo. Devuelve ``Color(0, 0, 0, 0)`` si se desconoce el color de énfasis.
|
||
|
||
\ **Nota:** Este método está implementado en macOS, Windows, Android y Linux (X11/Wayland).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_get_base_color:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Color<class_Color>` **get_base_color**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_base_color>`
|
||
|
||
Devuelve el color base del tema del sistema operativo (fondo de control predeterminado). Devuelve ``Color(0, 0, 0, 0)`` si se desconoce el color base.
|
||
|
||
\ **Nota:** Este método está implementado en macOS, Windows y Android.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_get_display_cutouts:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Array<class_Array>`\[:ref:`Rect2<class_Rect2>`\] **get_display_cutouts**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_display_cutouts>`
|
||
|
||
Returns an :ref:`Array<class_Array>` of :ref:`Rect2<class_Rect2>`, each of which is the bounding rectangle for a display cutout or notch. These are non-functional areas on edge-to-edge screens used by cameras and sensors. Returns an empty array if the device does not have cutouts. See also :ref:`get_display_safe_area()<class_DisplayServer_method_get_display_safe_area>`.
|
||
|
||
\ **Note:** Currently only implemented on Android. Other platforms will return an empty array even if they do have display cutouts or notches.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_get_display_safe_area:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Rect2i<class_Rect2i>` **get_display_safe_area**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_display_safe_area>`
|
||
|
||
Returns the unobscured area of the display where interactive controls should be rendered. See also :ref:`get_display_cutouts()<class_DisplayServer_method_get_display_cutouts>`.
|
||
|
||
\ **Note:** Currently only implemented on Android and iOS. On other platforms, ``screen_get_usable_rect(SCREEN_OF_MAIN_WINDOW)`` will be returned as a fallback. See also :ref:`screen_get_usable_rect()<class_DisplayServer_method_screen_get_usable_rect>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_get_keyboard_focus_screen:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **get_keyboard_focus_screen**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_keyboard_focus_screen>`
|
||
|
||
Devuelve el índice de la pantalla que contiene la ventana con el foco del teclado, o la pantalla principal si no hay ninguna ventana enfocada.
|
||
|
||
\ **Nota:** Este método está implementado en Linux/X11, macOS y Windows. En otras plataformas, este método siempre devuelve la pantalla principal.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_get_name:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`String<class_String>` **get_name**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_name>`
|
||
|
||
Returns the name of the **DisplayServer** currently in use. Most operating systems only have a single **DisplayServer**, but Linux has access to more than one **DisplayServer** (currently X11 and Wayland).
|
||
|
||
The names of built-in display servers are ``Windows``, ``macOS``, ``X11`` (Linux), ``Wayland`` (Linux), ``Android``, ``iOS``, ``web`` (HTML5), and ``headless`` (when started with the ``--headless`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_get_primary_screen:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **get_primary_screen**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_primary_screen>`
|
||
|
||
Returns the index of the primary screen.
|
||
|
||
\ **Note:** This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns ``0``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_get_screen_count:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **get_screen_count**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_screen_count>`
|
||
|
||
Devuelve el número de pantallas disponibles.
|
||
|
||
\ **Nota:** Este método está implementado en Linux (X11 y Wayland), macOS y Windows. En otras plataformas, este método siempre devuelve ``1``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_get_screen_from_rect:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **get_screen_from_rect**\ (\ rect\: :ref:`Rect2<class_Rect2>`\ ) |const| :ref:`🔗<class_DisplayServer_method_get_screen_from_rect>`
|
||
|
||
Devuelve el índice de la pantalla que más se superpone con el rectángulo dado. Devuelve :ref:`INVALID_SCREEN<class_DisplayServer_constant_INVALID_SCREEN>` si el rectángulo no se superpone con ninguna pantalla o no tiene área.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_get_swap_cancel_ok:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **get_swap_cancel_ok**\ (\ ) :ref:`🔗<class_DisplayServer_method_get_swap_cancel_ok>`
|
||
|
||
Returns ``true`` if positions of **OK** and **Cancel** buttons are swapped in dialogs. This is enabled by default on Windows to follow interface conventions, and be toggled by changing :ref:`ProjectSettings.gui/common/swap_cancel_ok<class_ProjectSettings_property_gui/common/swap_cancel_ok>`.
|
||
|
||
\ **Note:** This doesn't affect native dialogs such as the ones spawned by :ref:`dialog_show()<class_DisplayServer_method_dialog_show>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_get_window_at_screen_position:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **get_window_at_screen_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`🔗<class_DisplayServer_method_get_window_at_screen_position>`
|
||
|
||
Returns the ID of the window at the specified screen ``position`` (in pixels). On multi-monitor setups, the screen position is relative to the virtual desktop area. On multi-monitor setups with different screen resolutions or orientations, the origin may be located outside any display like this:
|
||
|
||
.. code:: text
|
||
|
||
* (0, 0) +-------+
|
||
| |
|
||
+-------------+ | |
|
||
| | | |
|
||
| | | |
|
||
+-------------+ +-------+
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_get_window_list:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`PackedInt32Array<class_PackedInt32Array>` **get_window_list**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_window_list>`
|
||
|
||
Devuelve la lista de IDs de ventana de Godot que pertenecen a este proceso.
|
||
|
||
\ **Nota:** Los diálogos nativos no se incluyen en esta lista.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_add_check_item:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_add_check_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_global_menu_add_check_item>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Adds a new checkable item with text ``label`` to the global menu with ID ``menu_root``.
|
||
|
||
Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
||
|
||
An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
|
||
|
||
\ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
\ **Supported system menu IDs:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - Main menu (macOS).
|
||
"_dock" - Dock popup menu (macOS).
|
||
"_apple" - Apple menu (macOS, custom items added before "Services").
|
||
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
|
||
"_help" - Help menu (macOS).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_add_icon_check_item:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_add_icon_check_item**\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_global_menu_add_icon_check_item>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Adds a new checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
|
||
|
||
Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
||
|
||
An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
|
||
|
||
\ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
\ **Supported system menu IDs:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - Main menu (macOS).
|
||
"_dock" - Dock popup menu (macOS).
|
||
"_apple" - Apple menu (macOS, custom items added before "Services").
|
||
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
|
||
"_help" - Help menu (macOS).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_add_icon_item:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_add_icon_item**\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_global_menu_add_icon_item>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Adds a new item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
|
||
|
||
Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
||
|
||
An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
|
||
|
||
\ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
\ **Supported system menu IDs:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - Main menu (macOS).
|
||
"_dock" - Dock popup menu (macOS).
|
||
"_apple" - Apple menu (macOS, custom items added before "Services").
|
||
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
|
||
"_help" - Help menu (macOS).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_add_icon_radio_check_item:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_add_icon_radio_check_item**\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_global_menu_add_icon_radio_check_item>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
|
||
|
||
Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
||
|
||
An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
|
||
|
||
\ **Note:** Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`global_menu_set_item_checked()<class_DisplayServer_method_global_menu_set_item_checked>` for more info on how to control it.
|
||
|
||
\ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
\ **Supported system menu IDs:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - Main menu (macOS).
|
||
"_dock" - Dock popup menu (macOS).
|
||
"_apple" - Apple menu (macOS, custom items added before "Services").
|
||
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
|
||
"_help" - Help menu (macOS).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_add_item:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_add_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_global_menu_add_item>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
|
||
|
||
Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
||
|
||
An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
|
||
|
||
\ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
\ **Supported system menu IDs:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - Main menu (macOS).
|
||
"_dock" - Dock popup menu (macOS).
|
||
"_apple" - Apple menu (macOS, custom items added before "Services").
|
||
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
|
||
"_help" - Help menu (macOS).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_add_multistate_item:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_add_multistate_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, max_states\: :ref:`int<class_int>`, default_state\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_global_menu_add_multistate_item>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
|
||
|
||
Contrarily to normal binary items, multistate items can have more than two states, as defined by ``max_states``. Each press or activate of the item will increase the state by one. The default value is defined by ``default_state``.
|
||
|
||
Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
||
|
||
An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
|
||
|
||
\ **Note:** By default, there's no indication of the current item state, it should be changed manually.
|
||
|
||
\ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
\ **Supported system menu IDs:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - Main menu (macOS).
|
||
"_dock" - Dock popup menu (macOS).
|
||
"_apple" - Apple menu (macOS, custom items added before "Services").
|
||
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
|
||
"_help" - Help menu (macOS).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_add_radio_check_item:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_add_radio_check_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_global_menu_add_radio_check_item>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Adds a new radio-checkable item with text ``label`` to the global menu with ID ``menu_root``.
|
||
|
||
Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
||
|
||
An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
|
||
|
||
\ **Note:** Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`global_menu_set_item_checked()<class_DisplayServer_method_global_menu_set_item_checked>` for more info on how to control it.
|
||
|
||
\ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
\ **Supported system menu IDs:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - Main menu (macOS).
|
||
"_dock" - Dock popup menu (macOS).
|
||
"_apple" - Apple menu (macOS, custom items added before "Services").
|
||
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
|
||
"_help" - Help menu (macOS).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_add_separator:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_add_separator**\ (\ menu_root\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_global_menu_add_separator>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Adds a separator between items to the global menu with ID ``menu_root``. Separators also occupy an index.
|
||
|
||
Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
\ **Supported system menu IDs:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - Main menu (macOS).
|
||
"_dock" - Dock popup menu (macOS).
|
||
"_apple" - Apple menu (macOS, custom items added before "Services").
|
||
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
|
||
"_help" - Help menu (macOS).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_add_submenu_item:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_add_submenu_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, submenu\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_global_menu_add_submenu_item>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Adds an item that will act as a submenu of the global menu ``menu_root``. The ``submenu`` argument is the ID of the global menu root that will be shown when the item is clicked.
|
||
|
||
Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
\ **Supported system menu IDs:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - Main menu (macOS).
|
||
"_dock" - Dock popup menu (macOS).
|
||
"_apple" - Apple menu (macOS, custom items added before "Services").
|
||
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
|
||
"_help" - Help menu (macOS).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_clear:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_clear**\ (\ menu_root\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_clear>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Removes all items from the global menu with ID ``menu_root``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
\ **Supported system menu IDs:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - Main menu (macOS).
|
||
"_dock" - Dock popup menu (macOS).
|
||
"_apple" - Apple menu (macOS, custom items added before "Services").
|
||
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
|
||
"_help" - Help menu (macOS).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_accelerator:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Key<enum_@GlobalScope_Key>` **global_menu_get_item_accelerator**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_accelerator>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Devuelve el acelerador del elemento en el índice ``idx``. Los aceleradores son combinaciones especiales de teclas que activan el elemento, independientemente del control que tenga el foco.
|
||
|
||
\ **Nota:** Este método solo se implementa en macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Callable<class_Callable>` **global_menu_get_item_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_callback>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Devuelve la devolución de llamada del elemento en el índice ``idx``.
|
||
|
||
\ **Nota:** Este método solo se implementa en macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_count:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_get_item_count**\ (\ menu_root\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_count>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Devuelve el número de elementos del menú global con ID ``menu_root``.
|
||
|
||
\ **Nota:** Este método solo se implementa en macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_icon:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Texture2D<class_Texture2D>` **global_menu_get_item_icon**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_icon>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Devuelve el icono del elemento en el índice ``idx``.
|
||
|
||
\ **Nota:** Este método solo se implementa en macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_indentation_level:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_get_item_indentation_level**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_indentation_level>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Devuelve el desplazamiento horizontal del elemento en el ``idx`` dado.
|
||
|
||
\ **Nota:** Este método solo se implementa en macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_index_from_tag:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_get_item_index_from_tag**\ (\ menu_root\: :ref:`String<class_String>`, tag\: :ref:`Variant<class_Variant>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_index_from_tag>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns the index of the item with the specified ``tag``. Indices are automatically assigned to each item by the engine, and cannot be set manually.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_index_from_text:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_get_item_index_from_text**\ (\ menu_root\: :ref:`String<class_String>`, text\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_index_from_text>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns the index of the item with the specified ``text``. Indices are automatically assigned to each item by the engine, and cannot be set manually.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_key_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Callable<class_Callable>` **global_menu_get_item_key_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_key_callback>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns the callback of the item accelerator at index ``idx``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_max_states:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_get_item_max_states**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_max_states>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns number of states of a multistate item. See :ref:`global_menu_add_multistate_item()<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_state:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **global_menu_get_item_state**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_state>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns the state of a multistate item. See :ref:`global_menu_add_multistate_item()<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_submenu:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`String<class_String>` **global_menu_get_item_submenu**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_submenu>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns the submenu ID of the item at index ``idx``. See :ref:`global_menu_add_submenu_item()<class_DisplayServer_method_global_menu_add_submenu_item>` for more info on how to add a submenu.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_tag:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Variant<class_Variant>` **global_menu_get_item_tag**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_tag>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns the metadata of the specified item, which might be of any type. You can set it with :ref:`global_menu_set_item_tag()<class_DisplayServer_method_global_menu_set_item_tag>`, which provides a simple way of assigning context data to items.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_text:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`String<class_String>` **global_menu_get_item_text**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_text>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns the text of the item at index ``idx``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_item_tooltip:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`String<class_String>` **global_menu_get_item_tooltip**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_item_tooltip>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns the tooltip associated with the specified index ``idx``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_get_system_menu_roots:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Dictionary<class_Dictionary>` **global_menu_get_system_menu_roots**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_system_menu_roots>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns Dictionary of supported system menu IDs and names.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_is_item_checkable:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **global_menu_is_item_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_is_item_checkable>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_is_item_checked:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **global_menu_is_item_checked**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_is_item_checked>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns ``true`` if the item at index ``idx`` is checked.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_is_item_disabled:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **global_menu_is_item_disabled**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_is_item_disabled>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked.
|
||
|
||
See :ref:`global_menu_set_item_disabled()<class_DisplayServer_method_global_menu_set_item_disabled>` for more info on how to disable an item.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_is_item_hidden:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **global_menu_is_item_hidden**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_is_item_hidden>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns ``true`` if the item at index ``idx`` is hidden.
|
||
|
||
See :ref:`global_menu_set_item_hidden()<class_DisplayServer_method_global_menu_set_item_hidden>` for more info on how to hide an item.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_is_item_radio_checkable:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **global_menu_is_item_radio_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_is_item_radio_checkable>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Returns ``true`` if the item at index ``idx`` has radio button-style checkability.
|
||
|
||
\ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_remove_item:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_remove_item**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_remove_item>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Removes the item at index ``idx`` from the global menu ``menu_root``.
|
||
|
||
\ **Note:** The indices of items after the removed item will be shifted by one.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_accelerator:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_accelerator**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_accelerator>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Sets the accelerator of the item at index ``idx``. ``keycode`` can be a single :ref:`Key<enum_@GlobalScope_Key>`, or a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_callback>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed.
|
||
|
||
\ **Note:** The ``callback`` Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the ``tag`` parameter when the menu item was created.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_checkable:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_checkable>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_checked:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_checked**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checked\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_checked>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Sets the checkstate status of the item at index ``idx``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_disabled:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_disabled**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_disabled>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_hidden:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_hidden**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, hidden\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_hidden>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Hides/shows the item at index ``idx``. When it is hidden, an item does not appear in a menu and its action cannot be invoked.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_hover_callbacks:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_hover_callbacks**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_hover_callbacks>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Sets the callback of the item at index ``idx``. The callback is emitted when an item is hovered.
|
||
|
||
\ **Note:** The ``callback`` Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the ``tag`` parameter when the menu item was created.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_icon:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_icon**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_icon>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Replaces the :ref:`Texture2D<class_Texture2D>` icon of the specified ``idx``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
\ **Note:** This method is not supported by macOS "_dock" menu items.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_indentation_level:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_indentation_level**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, level\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_indentation_level>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Sets the horizontal offset of the item at the given ``idx``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_key_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_key_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, key_callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_key_callback>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated.
|
||
|
||
\ **Note:** The ``key_callback`` Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the ``tag`` parameter when the menu item was created.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_max_states:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_max_states**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, max_states\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_max_states>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Sets number of state of a multistate item. See :ref:`global_menu_add_multistate_item()<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_radio_checkable:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_radio_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_radio_checkable>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Sets the type of the item at the specified index ``idx`` to radio button. If ``false``, sets the type of the item to plain text.
|
||
|
||
\ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_state:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_state**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, state\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_state>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Establece el estado de un elemento multiestado. Véase :ref:`global_menu_add_multistate_item()<class_DisplayServer_method_global_menu_add_multistate_item>` para obtener más detalles.
|
||
|
||
\ **Nota:** Este método solo está implementado en macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_submenu:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_submenu**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, submenu\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_submenu>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Establece el submenú del elemento en el índice ``idx``. El submenú es el ID de una raíz de menú global que se mostraría cuando se hace clic en el elemento.
|
||
|
||
\ **Nota:** Este método solo está implementado en macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_tag:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_tag**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tag\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_tag>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Establece los metadatos de un elemento, que pueden ser de cualquier tipo. Puedes obtenerlo más tarde con :ref:`global_menu_get_item_tag()<class_DisplayServer_method_global_menu_get_item_tag>`, que proporciona una forma sencilla de asignar datos de contexto a los elementos.
|
||
|
||
\ **Nota:** Este método solo está implementado en macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_text:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_text**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, text\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_text>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Establece el texto del elemento en el índice ``idx``.
|
||
|
||
\ **Nota:** Este método solo está implementado en macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_item_tooltip:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_item_tooltip**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_item_tooltip>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Sets the :ref:`String<class_String>` tooltip of the item at the specified index ``idx``.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_global_menu_set_popup_callbacks:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **global_menu_set_popup_callbacks**\ (\ menu_root\: :ref:`String<class_String>`, open_callback\: :ref:`Callable<class_Callable>`, close_callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_set_popup_callbacks>`
|
||
|
||
**Obsoleto:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
Registra callables para emitir cuando el menú está a punto de mostrarse o cerrarse, respectivamente. Los métodos de callback no deben tener argumentos.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_has_additional_outputs:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **has_additional_outputs**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_has_additional_outputs>`
|
||
|
||
Devuelve ``true`` si se han registrado salidas adicionales a través de :ref:`register_additional_output()<class_DisplayServer_method_register_additional_output>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_has_feature:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Feature<enum_DisplayServer_Feature>`\ ) |const| :ref:`🔗<class_DisplayServer_method_has_feature>`
|
||
|
||
Devuelve ``true`` si la ``feature`` especificada es compatible con el **DisplayServer** actual, ``false`` en caso contrario.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_has_hardware_keyboard:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **has_hardware_keyboard**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_has_hardware_keyboard>`
|
||
|
||
Devuelve ``true`` si un teclado físico está conectado.
|
||
|
||
\ **Nota:** Este método está implementado en Android e iOS. En otras plataformas, este método siempre devuelve ``true``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_help_set_search_callbacks:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **help_set_search_callbacks**\ (\ search_callback\: :ref:`Callable<class_Callable>`, action_callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_help_set_search_callbacks>`
|
||
|
||
Sets native help system search callbacks.
|
||
|
||
\ ``search_callback`` has the following arguments: ``String search_string, int result_limit`` and return a :ref:`Dictionary<class_Dictionary>` with "key, display name" pairs for the search results. Called when the user enters search terms in the ``Help`` menu.
|
||
|
||
\ ``action_callback`` has the following arguments: ``String key``. Called when the user selects a search result in the ``Help`` menu.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_ime_get_selection:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **ime_get_selection**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_ime_get_selection>`
|
||
|
||
Returns the text selection in the `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ composition string, with the :ref:`Vector2i<class_Vector2i>`'s ``x`` component being the caret position and ``y`` being the length of the selection.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_ime_get_text:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`String<class_String>` **ime_get_text**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_ime_get_text>`
|
||
|
||
Returns the composition string contained within the `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ window.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_is_dark_mode:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **is_dark_mode**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_is_dark_mode>`
|
||
|
||
Devuelve ``true`` si el sistema operativo está usando el modo oscuro.
|
||
|
||
\ **Nota:** Este método solo está implementado en Android, iOS, macOS, Windows y Linux (X11/Wayland).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_is_dark_mode_supported:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **is_dark_mode_supported**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_is_dark_mode_supported>`
|
||
|
||
Devuelve ``true`` si el sistema operativo usa el modo oscuro.
|
||
|
||
\ **Nota:** Este método está implementado en Android, iOS, macOS, Windows y Linux (X11/Wayland).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_is_touchscreen_available:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **is_touchscreen_available**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_is_touchscreen_available>`
|
||
|
||
Devuelve ``true`` si los eventos táctiles están disponibles (Android o iOS), la capacidad se detecta en la plataforma web o si :ref:`ProjectSettings.input_devices/pointing/emulate_touch_from_mouse<class_ProjectSettings_property_input_devices/pointing/emulate_touch_from_mouse>` es ``true``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_is_window_transparency_available:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **is_window_transparency_available**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_is_window_transparency_available>`
|
||
|
||
Devuelve ``true`` si el fondo de la ventana puede ser transparente. Este método devuelve ``false`` si :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>` está establecido a ``false``, o si la transparencia no es compatible con el renderizador o el compositor del sistema operativo.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_keyboard_get_current_layout:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **keyboard_get_current_layout**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_keyboard_get_current_layout>`
|
||
|
||
Devuelve el índice de la disposición del teclado activa.
|
||
|
||
\ **Nota:** Este método está implementado en Linux (X11/Wayland), macOS y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_keyboard_get_keycode_from_physical:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_keycode_from_physical**\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| :ref:`🔗<class_DisplayServer_method_keyboard_get_keycode_from_physical>`
|
||
|
||
Convierte un ``keycode`` físico (US QWERTY) a uno en la disposición del teclado activa.
|
||
|
||
\ **Nota:** Este método está implementado en Linux (X11/Wayland), macOS y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_keyboard_get_label_from_physical:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_label_from_physical**\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| :ref:`🔗<class_DisplayServer_method_keyboard_get_label_from_physical>`
|
||
|
||
Convierte un ``keycode`` físico (US QWERTY) a la etiqueta localizada impresa en la tecla en la disposición del teclado activa.
|
||
|
||
\ **Nota:** Este método está implementado en Linux (X11/Wayland), macOS y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_keyboard_get_layout_count:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **keyboard_get_layout_count**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_keyboard_get_layout_count>`
|
||
|
||
Devuelve el número de distribuciones de teclado.
|
||
|
||
\ **Nota:** Este método está implementado en Linux (X11/Wayland), macOS y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_keyboard_get_layout_language:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`String<class_String>` **keyboard_get_layout_language**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_keyboard_get_layout_language>`
|
||
|
||
Devuelve el código de idioma ISO-639/BCP-47 de la distribución de teclado en la posición ``index``.
|
||
|
||
\ **Nota:** Este método está implementado en Linux (X11/Wayland), macOS y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_keyboard_get_layout_name:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`String<class_String>` **keyboard_get_layout_name**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_keyboard_get_layout_name>`
|
||
|
||
Devuelve el nombre localizado de la distribución de teclado en la posición ``index``.
|
||
|
||
\ **Note:** Este método está implementado en Linux (X11/Wayland), macOS y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_keyboard_set_current_layout:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **keyboard_set_current_layout**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_keyboard_set_current_layout>`
|
||
|
||
Establece la distribución de teclado activa.
|
||
|
||
\ **Nota:** Este método está implementado en Linux (X11/Wayland), macOS y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_mouse_get_button_state:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|bitfield|\[:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\] **mouse_get_button_state**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_mouse_get_button_state>`
|
||
|
||
Devuelve el estado actual de los botones del ratón (si cada botón está presionado) como una máscara de bits. Si se presionan varios botones del ratón al mismo tiempo, los bits se suman. Equivalente a :ref:`Input.get_mouse_button_mask()<class_Input_method_get_mouse_button_mask>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_mouse_get_mode:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`MouseMode<enum_DisplayServer_MouseMode>` **mouse_get_mode**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_mouse_get_mode>`
|
||
|
||
Devuelve el modo actual del ratón. Véase también :ref:`mouse_set_mode()<class_DisplayServer_method_mouse_set_mode>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_mouse_get_position:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **mouse_get_position**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_mouse_get_position>`
|
||
|
||
Devuelve la posición actual del cursor del ratón en coordenadas de pantalla.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_mouse_set_mode:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **mouse_set_mode**\ (\ mouse_mode\: :ref:`MouseMode<enum_DisplayServer_MouseMode>`\ ) :ref:`🔗<class_DisplayServer_method_mouse_set_mode>`
|
||
|
||
Establece el modo actual del ratón. Véase también :ref:`mouse_get_mode()<class_DisplayServer_method_mouse_get_mode>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_process_events:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **process_events**\ (\ ) :ref:`🔗<class_DisplayServer_method_process_events>`
|
||
|
||
Realiza el procesamiento del administrador de ventanas, incluyendo el vaciado de entrada. Véase también :ref:`force_process_and_drop_events()<class_DisplayServer_method_force_process_and_drop_events>`, :ref:`Input.flush_buffered_events()<class_Input_method_flush_buffered_events>` y :ref:`Input.use_accumulated_input<class_Input_property_use_accumulated_input>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_register_additional_output:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **register_additional_output**\ (\ object\: :ref:`Object<class_Object>`\ ) :ref:`🔗<class_DisplayServer_method_register_additional_output>`
|
||
|
||
Registra un :ref:`Object<class_Object>` que representa una salida adicional que también se renderizará, más allá de las ventanas normales. El :ref:`Object<class_Object>` solo se utiliza como un identificador, que puede ser pasado más tarde a :ref:`unregister_additional_output()<class_DisplayServer_method_unregister_additional_output>`.
|
||
|
||
Esto se puede usar para evitar que Godot omita el renderizado cuando no hay ventanas normales visibles.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_get_dpi:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **screen_get_dpi**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_dpi>`
|
||
|
||
Returns the dots per inch density of the specified screen. Returns platform specific default value if ``screen`` is invalid.
|
||
|
||
\ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
|
||
|
||
\ **Note:** On macOS, returned value is inaccurate if fractional display scaling mode is used.
|
||
|
||
\ **Note:** On Android devices, the actual screen densities are grouped into six generalized densities:
|
||
|
||
.. code:: text
|
||
|
||
ldpi - 120 dpi
|
||
mdpi - 160 dpi
|
||
hdpi - 240 dpi
|
||
xhdpi - 320 dpi
|
||
xxhdpi - 480 dpi
|
||
xxxhdpi - 640 dpi
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, Linux (X11/Wayland), macOS, Web, and Windows. On other platforms, this method always returns ``72``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_get_image:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Image<class_Image>` **screen_get_image**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_image>`
|
||
|
||
Returns a screenshot of the ``screen``. Returns ``null`` if ``screen`` is invalid or the **DisplayServer** fails to capture screenshot.
|
||
|
||
\ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
|
||
|
||
\ **Note:** This method is implemented on Linux (X11, excluding XWayland), macOS, and Windows. On other platforms, this method always returns ``null``.
|
||
|
||
\ **Note:** On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a screenshot that will not include other application windows or OS elements not related to the application.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_get_image_rect:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Image<class_Image>` **screen_get_image_rect**\ (\ rect\: :ref:`Rect2i<class_Rect2i>`\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_image_rect>`
|
||
|
||
Returns a screenshot of the screen region defined by ``rect``. Returns ``null`` if ``rect`` is outside screen bounds or the **DisplayServer** fails to capture screenshot.
|
||
|
||
\ **Note:** This method is implemented on macOS and Windows. On other platforms, this method always returns ``null``.
|
||
|
||
\ **Note:** On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a screenshot that will not include other application windows or OS elements not related to the application.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_get_max_scale:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`float<class_float>` **screen_get_max_scale**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_max_scale>`
|
||
|
||
Returns the greatest scale factor of all screens.
|
||
|
||
\ **Note:** On macOS returned value is ``2.0`` if there is at least one hiDPI (Retina) screen in the system, and ``1.0`` in all other cases.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_get_orientation:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **screen_get_orientation**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_orientation>`
|
||
|
||
Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientation()<class_DisplayServer_method_screen_set_orientation>`. Returns :ref:`SCREEN_LANDSCAPE<class_DisplayServer_constant_SCREEN_LANDSCAPE>` if ``screen`` is invalid.
|
||
|
||
\ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
|
||
|
||
\ **Note:** This method is implemented on Android and iOS. On other platforms, this method always returns :ref:`SCREEN_LANDSCAPE<class_DisplayServer_constant_SCREEN_LANDSCAPE>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_get_pixel:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Color<class_Color>` **screen_get_pixel**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_pixel>`
|
||
|
||
Returns the color of the pixel at the given screen ``position``. On multi-monitor setups, the screen position is relative to the virtual desktop area.
|
||
|
||
\ **Note:** This method is implemented on Linux (X11, excluding XWayland), macOS, and Windows. On other platforms, this method always returns ``Color(0, 0, 0, 1)``.
|
||
|
||
\ **Note:** On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a color from a screenshot that will not include other application windows or OS elements not related to the application.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_get_position:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **screen_get_position**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_position>`
|
||
|
||
Returns the screen's top-left corner position in pixels. Returns :ref:`Vector2i.ZERO<class_Vector2i_constant_ZERO>` if ``screen`` is invalid. On multi-monitor setups, the screen position is relative to the virtual desktop area. On multi-monitor setups with different screen resolutions or orientations, the origin might be located outside any display like this:
|
||
|
||
.. code:: text
|
||
|
||
* (0, 0) +-------+
|
||
| |
|
||
+-------------+ | |
|
||
| | | |
|
||
| | | |
|
||
+-------------+ +-------+
|
||
|
||
See also :ref:`screen_get_size()<class_DisplayServer_method_screen_get_size>`.
|
||
|
||
\ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_get_refresh_rate:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`float<class_float>` **screen_get_refresh_rate**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_refresh_rate>`
|
||
|
||
Returns the current refresh rate of the specified screen. When V-Sync is enabled, this returns the maximum framerate the project can effectively reach. Returns ``-1.0`` if ``screen`` is invalid or the **DisplayServer** fails to find the refresh rate for the specified screen.
|
||
|
||
To fallback to a default refresh rate if the method fails, try:
|
||
|
||
::
|
||
|
||
var refresh_rate = DisplayServer.screen_get_refresh_rate()
|
||
if refresh_rate < 0:
|
||
refresh_rate = 60.0
|
||
|
||
\ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, macOS, Linux (X11 and Wayland), and Windows. On other platforms, this method always returns ``-1.0``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_get_scale:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`float<class_float>` **screen_get_scale**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_scale>`
|
||
|
||
Returns the scale factor of the specified screen by index. Returns ``1.0`` if ``screen`` is invalid.
|
||
|
||
\ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
|
||
|
||
\ **Note:** On macOS, the returned value is ``2.0`` for hiDPI (Retina) screens, and ``1.0`` for all other cases.
|
||
|
||
\ **Note:** On Linux (Wayland), the returned value is accurate only when ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`. Due to API limitations, passing a direct index will return a rounded-up integer, if the screen has a fractional scale (e.g. ``1.25`` would get rounded up to ``2.0``).
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, Web, macOS, and Linux (Wayland). On other platforms, this method always returns ``1.0``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_get_size:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **screen_get_size**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_size>`
|
||
|
||
Returns the screen's size in pixels. See also :ref:`screen_get_position()<class_DisplayServer_method_screen_get_position>` and :ref:`screen_get_usable_rect()<class_DisplayServer_method_screen_get_usable_rect>`. Returns :ref:`Vector2i.ZERO<class_Vector2i_constant_ZERO>` if ``screen`` is invalid.
|
||
|
||
\ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_get_usable_rect:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Rect2i<class_Rect2i>` **screen_get_usable_rect**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_usable_rect>`
|
||
|
||
Returns the portion of the screen that is not obstructed by a status bar in pixels. See also :ref:`screen_get_size()<class_DisplayServer_method_screen_get_size>`.
|
||
|
||
\ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
|
||
|
||
\ **Note:** This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns ``Rect2i(screen_get_position(screen), screen_get_size(screen))``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_is_kept_on:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **screen_is_kept_on**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_is_kept_on>`
|
||
|
||
Returns ``true`` if the screen should never be turned off by the operating system's power-saving measures. See also :ref:`screen_set_keep_on()<class_DisplayServer_method_screen_set_keep_on>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_set_keep_on:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **screen_set_keep_on**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_screen_set_keep_on>`
|
||
|
||
Sets whether the screen should never be turned off by the operating system's power-saving measures. See also :ref:`screen_is_kept_on()<class_DisplayServer_method_screen_is_kept_on>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_screen_set_orientation:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **screen_set_orientation**\ (\ orientation\: :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>`, screen\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_screen_set_orientation>`
|
||
|
||
Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation()<class_DisplayServer_method_screen_get_orientation>`.
|
||
|
||
\ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
|
||
|
||
\ **Note:** This method is implemented on Android and iOS.
|
||
|
||
\ **Note:** On iOS, this method has no effect if :ref:`ProjectSettings.display/window/handheld/orientation<class_ProjectSettings_property_display/window/handheld/orientation>` is not set to :ref:`SCREEN_SENSOR<class_DisplayServer_constant_SCREEN_SENSOR>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_set_hardware_keyboard_connection_change_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_hardware_keyboard_connection_change_callback**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_set_hardware_keyboard_connection_change_callback>`
|
||
|
||
Sets the callback that should be called when a hardware keyboard is connected or disconnected. ``callable`` should accept a single :ref:`bool<class_bool>` argument indicating whether the keyboard has been connected (``true``) or disconnected (``false``).
|
||
|
||
\ **Note:** This method is only implemented on Android.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_set_icon:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_icon**\ (\ image\: :ref:`Image<class_Image>`\ ) :ref:`🔗<class_DisplayServer_method_set_icon>`
|
||
|
||
Sets the window icon (usually displayed in the top-left corner) with an :ref:`Image<class_Image>`. To use icons in the operating system's native format, use :ref:`set_native_icon()<class_DisplayServer_method_set_native_icon>` instead.
|
||
|
||
\ **Note:** Requires support for :ref:`FEATURE_ICON<class_DisplayServer_constant_FEATURE_ICON>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_set_native_icon:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_native_icon**\ (\ filename\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_set_native_icon>`
|
||
|
||
Sets the window icon (usually displayed in the top-left corner) in the operating system's *native* format. The file at ``filename`` must be in ``.ico`` format on Windows or ``.icns`` on macOS. By using specially crafted ``.ico`` or ``.icns`` icons, :ref:`set_native_icon()<class_DisplayServer_method_set_native_icon>` allows specifying different icons depending on the size the icon is displayed at. This size is determined by the operating system and user preferences (including the display scale factor). To use icons in other formats, use :ref:`set_icon()<class_DisplayServer_method_set_icon>` instead.
|
||
|
||
\ **Note:** Requires support for :ref:`FEATURE_NATIVE_ICON<class_DisplayServer_constant_FEATURE_NATIVE_ICON>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_set_system_theme_change_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_system_theme_change_callback**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_set_system_theme_change_callback>`
|
||
|
||
Sets the callback that should be called when the system's theme settings are changed. ``callable`` should accept zero arguments.
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_show_emoji_and_symbol_picker:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **show_emoji_and_symbol_picker**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_show_emoji_and_symbol_picker>`
|
||
|
||
Opens system emoji and symbol picker.
|
||
|
||
\ **Note:** This method is implemented on macOS and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_status_indicator_get_rect:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Rect2<class_Rect2>` **status_indicator_get_rect**\ (\ id\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_status_indicator_get_rect>`
|
||
|
||
Returns the rectangle for the given status indicator ``id`` in screen coordinates. If the status indicator is not visible, returns an empty :ref:`Rect2<class_Rect2>`.
|
||
|
||
\ **Note:** This method is implemented on macOS and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_status_indicator_set_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **status_indicator_set_callback**\ (\ id\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_status_indicator_set_callback>`
|
||
|
||
Sets the application status indicator activation callback. ``callback`` should take two arguments: :ref:`int<class_int>` mouse button index (one of :ref:`MouseButton<enum_@GlobalScope_MouseButton>` values) and :ref:`Vector2i<class_Vector2i>` click position in screen coordinates.
|
||
|
||
\ **Note:** This method is implemented on macOS and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_status_indicator_set_icon:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **status_indicator_set_icon**\ (\ id\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`🔗<class_DisplayServer_method_status_indicator_set_icon>`
|
||
|
||
Sets the application status indicator icon.
|
||
|
||
\ **Note:** This method is implemented on macOS and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_status_indicator_set_menu:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **status_indicator_set_menu**\ (\ id\: :ref:`int<class_int>`, menu_rid\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_status_indicator_set_menu>`
|
||
|
||
Sets the application status indicator native popup menu.
|
||
|
||
\ **Note:** On macOS, the menu is activated by any mouse button. Its activation callback is *not* triggered.
|
||
|
||
\ **Note:** On Windows, the menu is activated by the right mouse button, selecting the status icon and pressing :kbd:`Shift + F10`, or the applications key. The menu's activation callback for the other mouse buttons is still triggered.
|
||
|
||
\ **Note:** Native popup is only supported if :ref:`NativeMenu<class_NativeMenu>` supports the :ref:`NativeMenu.FEATURE_POPUP_MENU<class_NativeMenu_constant_FEATURE_POPUP_MENU>` feature.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_status_indicator_set_tooltip:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **status_indicator_set_tooltip**\ (\ id\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_status_indicator_set_tooltip>`
|
||
|
||
Sets the application status indicator tooltip.
|
||
|
||
\ **Note:** This method is implemented on macOS and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tablet_get_current_driver:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`String<class_String>` **tablet_get_current_driver**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_tablet_get_current_driver>`
|
||
|
||
Returns current active tablet driver name.
|
||
|
||
\ **Note:** This method is implemented only on Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tablet_get_driver_count:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **tablet_get_driver_count**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_tablet_get_driver_count>`
|
||
|
||
Returns the total number of available tablet drivers.
|
||
|
||
\ **Note:** This method is implemented only on Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tablet_get_driver_name:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`String<class_String>` **tablet_get_driver_name**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_tablet_get_driver_name>`
|
||
|
||
Returns the tablet driver name for the given index.
|
||
|
||
\ **Note:** This method is implemented only on Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tablet_set_current_driver:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **tablet_set_current_driver**\ (\ name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_tablet_set_current_driver>`
|
||
|
||
Set active tablet driver name.
|
||
|
||
Supported drivers:
|
||
|
||
- ``winink``: Windows Ink API, default.
|
||
|
||
- ``wintab``: Wacom Wintab API (compatible device driver required).
|
||
|
||
- ``dummy``: Dummy driver, tablet input is disabled.
|
||
|
||
\ **Note:** This method is implemented only on Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tts_get_voices:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **tts_get_voices**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_tts_get_voices>`
|
||
|
||
Returns an :ref:`Array<class_Array>` of voice information dictionaries.
|
||
|
||
Each :ref:`Dictionary<class_Dictionary>` contains two :ref:`String<class_String>` entries:
|
||
|
||
- ``name`` is voice name.
|
||
|
||
- ``id`` is voice identifier.
|
||
|
||
- ``language`` is language code in ``lang_Variant`` format. The ``lang`` part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. The ``Variant`` part is an engine-dependent string describing country, region or/and dialect.
|
||
|
||
Note that Godot depends on system libraries for text-to-speech functionality. These libraries are installed by default on Windows and macOS, but not on all Linux distributions. If they are not present, this method will return an empty list. This applies to both Godot users on Linux, as well as end-users on Linux running Godot games that use text-to-speech.
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tts_get_voices_for_language:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`PackedStringArray<class_PackedStringArray>` **tts_get_voices_for_language**\ (\ language\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_DisplayServer_method_tts_get_voices_for_language>`
|
||
|
||
Returns a :ref:`PackedStringArray<class_PackedStringArray>` of voice identifiers for the ``language``.
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tts_is_paused:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **tts_is_paused**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_tts_is_paused>`
|
||
|
||
Returns ``true`` if the synthesizer is in a paused state.
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tts_is_speaking:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **tts_is_speaking**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_tts_is_speaking>`
|
||
|
||
Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue.
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tts_pause:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **tts_pause**\ (\ ) :ref:`🔗<class_DisplayServer_method_tts_pause>`
|
||
|
||
Puts the synthesizer into a paused state.
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tts_resume:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **tts_resume**\ (\ ) :ref:`🔗<class_DisplayServer_method_tts_resume>`
|
||
|
||
Resumes the synthesizer if it was paused.
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tts_set_utterance_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **tts_set_utterance_callback**\ (\ event\: :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>`, callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_tts_set_utterance_callback>`
|
||
|
||
Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary.
|
||
|
||
- :ref:`TTS_UTTERANCE_STARTED<class_DisplayServer_constant_TTS_UTTERANCE_STARTED>`, :ref:`TTS_UTTERANCE_ENDED<class_DisplayServer_constant_TTS_UTTERANCE_ENDED>`, and :ref:`TTS_UTTERANCE_CANCELED<class_DisplayServer_constant_TTS_UTTERANCE_CANCELED>` callable's method should take one :ref:`int<class_int>` parameter, the utterance ID.
|
||
|
||
- :ref:`TTS_UTTERANCE_BOUNDARY<class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY>` callable's method should take two :ref:`int<class_int>` parameters, the index of the character and the utterance ID.
|
||
|
||
\ **Note:** The granularity of the boundary callbacks is engine dependent.
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tts_speak:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **tts_speak**\ (\ text\: :ref:`String<class_String>`, voice\: :ref:`String<class_String>`, volume\: :ref:`int<class_int>` = 50, pitch\: :ref:`float<class_float>` = 1.0, rate\: :ref:`float<class_float>` = 1.0, utterance_id\: :ref:`int<class_int>` = 0, interrupt\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_DisplayServer_method_tts_speak>`
|
||
|
||
Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is cleared first.
|
||
|
||
- ``voice`` identifier is one of the ``"id"`` values returned by :ref:`tts_get_voices()<class_DisplayServer_method_tts_get_voices>` or one of the values returned by :ref:`tts_get_voices_for_language()<class_DisplayServer_method_tts_get_voices_for_language>`.
|
||
|
||
- ``volume`` ranges from ``0`` (lowest) to ``100`` (highest).
|
||
|
||
- ``pitch`` ranges from ``0.0`` (lowest) to ``2.0`` (highest), ``1.0`` is default pitch for the current voice.
|
||
|
||
- ``rate`` ranges from ``0.1`` (lowest) to ``10.0`` (highest), ``1.0`` is a normal speaking rate. Other values act as a percentage relative.
|
||
|
||
- ``utterance_id`` is passed as a parameter to the callback functions.
|
||
|
||
\ **Note:** On Windows and Linux (X11/Wayland), utterance ``text`` can use SSML markup. SSML support is engine and voice dependent. If the engine does not support SSML, you should strip out all XML markup before calling :ref:`tts_speak()<class_DisplayServer_method_tts_speak>`.
|
||
|
||
\ **Note:** The granularity of pitch, rate, and volume is engine and voice dependent. Values may be truncated.
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tts_stop:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **tts_stop**\ (\ ) :ref:`🔗<class_DisplayServer_method_tts_stop>`
|
||
|
||
Stops synthesis in progress and removes all utterances from the queue.
|
||
|
||
\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_unregister_additional_output:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **unregister_additional_output**\ (\ object\: :ref:`Object<class_Object>`\ ) :ref:`🔗<class_DisplayServer_method_unregister_additional_output>`
|
||
|
||
Unregisters an :ref:`Object<class_Object>` representing an additional output, that was registered via :ref:`register_additional_output()<class_DisplayServer_method_register_additional_output>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_virtual_keyboard_get_height:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **virtual_keyboard_get_height**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_virtual_keyboard_get_height>`
|
||
|
||
Returns the on-screen keyboard's height in pixels. Returns ``0`` if there is no keyboard or if it is currently hidden.
|
||
|
||
\ **Note:** On Android 7 and 8, the keyboard height may return ``0`` the first time the keyboard is opened in non-immersive mode. This behavior does not occur in immersive mode.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_virtual_keyboard_hide:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **virtual_keyboard_hide**\ (\ ) :ref:`🔗<class_DisplayServer_method_virtual_keyboard_hide>`
|
||
|
||
Oculta el teclado virtual si se muestra, no hace nada más.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_virtual_keyboard_show:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **virtual_keyboard_show**\ (\ existing_text\: :ref:`String<class_String>`, position\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` = 0, max_length\: :ref:`int<class_int>` = -1, cursor_start\: :ref:`int<class_int>` = -1, cursor_end\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_virtual_keyboard_show>`
|
||
|
||
Shows the virtual keyboard if the platform has one.
|
||
|
||
\ ``existing_text`` parameter is useful for implementing your own :ref:`LineEdit<class_LineEdit>` or :ref:`TextEdit<class_TextEdit>`, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions).
|
||
|
||
\ ``position`` parameter is the screen space :ref:`Rect2<class_Rect2>` of the edited text.
|
||
|
||
\ ``type`` parameter allows configuring which type of virtual keyboard to show.
|
||
|
||
\ ``max_length`` limits the number of characters that can be entered if different from ``-1``.
|
||
|
||
\ ``cursor_start`` can optionally define the current text cursor position if ``cursor_end`` is not set.
|
||
|
||
\ ``cursor_start`` and ``cursor_end`` can optionally define the current text selection.
|
||
|
||
\ **Note:** This method is implemented on Android, iOS and Web.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_warp_mouse:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **warp_mouse**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_DisplayServer_method_warp_mouse>`
|
||
|
||
Sets the mouse cursor position to the given ``position`` relative to an origin at the upper left corner of the currently focused game Window Manager window.
|
||
|
||
\ **Note:** :ref:`warp_mouse()<class_DisplayServer_method_warp_mouse>` is only supported on Windows, macOS, and Linux (X11/Wayland). It has no effect on Android, iOS, and Web.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_can_draw:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **window_can_draw**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_can_draw>`
|
||
|
||
Devuelve ``true`` si se puede dibujar algo en la ventana especificada ``window_id``, ``false`` en caso contrario. Usar el argumento línea de comandos ``--disable-render-loop`` o una compilación devolverá ``false``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_active_popup:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **window_get_active_popup**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_active_popup>`
|
||
|
||
Devuelve el ID de la ventana emergente activa, o :ref:`INVALID_WINDOW_ID<class_DisplayServer_constant_INVALID_WINDOW_ID>` si no hay ninguna.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_attached_instance_id:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **window_get_attached_instance_id**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_attached_instance_id>`
|
||
|
||
Devuelve el :ref:`Object.get_instance_id()<class_Object_method_get_instance_id>` de la :ref:`Window<class_Window>` al que está adjunto ``window_id``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_current_screen:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **window_get_current_screen**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_current_screen>`
|
||
|
||
Devuelve la pantalla en la que se encuentra actualmente la ventana especificada por ``window_id``. Si la pantalla se superpone a varias pantallas, se devuelve la pantalla en la que se encuentra el centro de la ventana. Véase también :ref:`window_set_current_screen()<class_DisplayServer_method_window_set_current_screen>`. Devuelve :ref:`INVALID_SCREEN<class_DisplayServer_constant_INVALID_SCREEN>` si ``window_id`` no es válido.
|
||
|
||
\ **Nota:** Este método está implementado en Linux/X11, macOS y Windows. En otras plataformas, este método siempre devuelve ``0``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_flag:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **window_get_flag**\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_flag>`
|
||
|
||
Devuelve el valor actual del ``flag`` de la ventana dada.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_max_size:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **window_get_max_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_max_size>`
|
||
|
||
Devuelve el tamaño máximo de la ventana (en píxeles). Véase también :ref:`window_set_max_size()<class_DisplayServer_method_window_set_max_size>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_min_size:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **window_get_min_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_min_size>`
|
||
|
||
Devuelve el tamaño mínimo de la ventana (en píxeles). Véase también :ref:`window_set_min_size()<class_DisplayServer_method_window_set_min_size>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_mode:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`WindowMode<enum_DisplayServer_WindowMode>` **window_get_mode**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_mode>`
|
||
|
||
Devuelve el modo de la ventana dada.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_native_handle:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **window_get_native_handle**\ (\ handle_type\: :ref:`HandleType<enum_DisplayServer_HandleType>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_native_handle>`
|
||
|
||
Devuelve punteros a la estructura interna para su uso en plugins.
|
||
|
||
\ **Nota:** Este método está implementado en Android, Linux (X11/Wayland), macOS y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_popup_safe_rect:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Rect2i<class_Rect2i>` **window_get_popup_safe_rect**\ (\ window\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_popup_safe_rect>`
|
||
|
||
Devuelve el cuadro delimitador del control, o el elemento del menú que se utilizó para abrir la ventana emergente, en el sistema de coordenadas de la pantalla.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_position:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **window_get_position**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_position>`
|
||
|
||
Devuelve la posición del área del cliente de la ventana dada en la pantalla.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_position_with_decorations:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **window_get_position_with_decorations**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_position_with_decorations>`
|
||
|
||
Devuelve la posición de la ventana dada en la pantalla, incluyendo los bordes dibujados por el sistema operativo. Véase también :ref:`window_get_position()<class_DisplayServer_method_window_get_position>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_safe_title_margins:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector3i<class_Vector3i>` **window_get_safe_title_margins**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_safe_title_margins>`
|
||
|
||
Devuelve los márgenes izquierdos (``x``), los márgenes derechos (``y``) y la altura (``z``) del título que son seguros de usar (no contiene botones u otros elementos) cuando la bandera :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>` está establecida.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_size:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **window_get_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_size>`
|
||
|
||
Devuelve el tamaño de la ventana especificada por ``window_id`` (en píxeles), excluyendo los bordes dibujados por el sistema operativo. Esto también se llama el "área del cliente". Véase también :ref:`window_get_size_with_decorations()<class_DisplayServer_method_window_get_size_with_decorations>`, :ref:`window_set_size()<class_DisplayServer_method_window_set_size>` y :ref:`window_get_position()<class_DisplayServer_method_window_get_position>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_size_with_decorations:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **window_get_size_with_decorations**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_size_with_decorations>`
|
||
|
||
Devuelve el tamaño de la ventana especificada por ``window_id`` (en píxeles), incluyendo los bordes dibujados por el sistema operativo. Véase también :ref:`window_get_size()<class_DisplayServer_method_window_get_size>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_title_size:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **window_get_title_size**\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_title_size>`
|
||
|
||
Devuelve el tamaño estimado de la barra de título de la ventana (incluyendo el texto y los botones de la ventana) para la ventana especificada por ``window_id`` (en píxeles). Este método no cambia el título de la ventana.
|
||
|
||
\ **Nota:** Este método está implementado en macOS y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_get_vsync_mode:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **window_get_vsync_mode**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_vsync_mode>`
|
||
|
||
Devuelve el modo V-Sync de la ventana dada.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_is_focused:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **window_is_focused**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_is_focused>`
|
||
|
||
Devuelve ``true`` si la ventana especificada por ``window_id`` está enfocada.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_is_maximize_allowed:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **window_is_maximize_allowed**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_is_maximize_allowed>`
|
||
|
||
Devuelve ``true`` si la ventana dada puede ser maximizada (el botón de maximizar está habilitado).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_maximize_on_title_dbl_click:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **window_maximize_on_title_dbl_click**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_window_maximize_on_title_dbl_click>`
|
||
|
||
Returns ``true`` if double-clicking on a window's title should maximize it.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_minimize_on_title_dbl_click:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **window_minimize_on_title_dbl_click**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_window_minimize_on_title_dbl_click>`
|
||
|
||
Returns ``true`` if double-clicking on a window's title should minimize it.
|
||
|
||
\ **Note:** This method is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_move_to_foreground:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_move_to_foreground**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_move_to_foreground>`
|
||
|
||
Mueve la ventana especificada por ``window_id`` al frente, de forma que sea visible sobre otras ventanas.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_request_attention:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_request_attention**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_request_attention>`
|
||
|
||
Hace que la ventana especificada por ``window_id`` solicite atención, lo que se materializa mediante el parpadeo del título de la ventana y la entrada de la barra de tareas hasta que la ventana esté enfocada. Esto normalmente no tiene un efecto visible si la ventana está actualmente enfocada. El comportamiento exacto varía según el sistema operativo.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_color:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_color**\ (\ color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_DisplayServer_method_window_set_color>`
|
||
|
||
Sets the background color of the root window.
|
||
|
||
\ **Note:** This method is implemented only on Android.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_current_screen:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_current_screen**\ (\ screen\: :ref:`int<class_int>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_current_screen>`
|
||
|
||
Mueve la ventana especificada por ``window_id`` a la ``screen`` especificada. Véase también :ref:`window_get_current_screen()<class_DisplayServer_method_window_get_current_screen>`.
|
||
|
||
\ **Nota:** Se puede utilizar una de las siguientes constantes como ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>` o :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
|
||
|
||
\ **Nota:** Este método está implementado en Linux/X11, macOS y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_drop_files_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_drop_files_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_drop_files_callback>`
|
||
|
||
Establece la ``callback`` que debe llamarse cuando se sueltan archivos desde el administrador de archivos del sistema operativo en la ventana especificada por ``window_id``. ``callback`` debe tomar un argumento :ref:`PackedStringArray<class_PackedStringArray>`, que es la lista de archivos soltados.
|
||
|
||
\ **Advertencia:** ¡Solo para usuarios avanzados! Agregar tal callback a un nodo :ref:`Window<class_Window>` anulará su implementación por defecto, lo que puede introducir errores.
|
||
|
||
\ **Nota:** Este método está implementado en Windows, macOS, Linux (X11/Wayland) y Web.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_exclusive:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_exclusive**\ (\ window_id\: :ref:`int<class_int>`, exclusive\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_window_set_exclusive>`
|
||
|
||
Si se establece en ``true``, esta ventana siempre permanecerá encima de su ventana padre, la ventana padre ignorará la entrada mientras esta ventana esté abierta.
|
||
|
||
\ **Nota:** En macOS, las ventanas exclusivas están confinadas al mismo espacio (escritorio virtual o pantalla) que la ventana padre.
|
||
|
||
\ **Nota:** Este método está implementado en macOS y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_flag:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_flag**\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, enabled\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_flag>`
|
||
|
||
Activa o desactiva la ``flag`` dado de la ventana dada.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_ime_active:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_ime_active**\ (\ active\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_ime_active>`
|
||
|
||
Establece si el `Editor de Método de Entrada <https://en.wikipedia.org/wiki/Input_method>`__ debe estar habilitado para la ventana especificada por ``window_id``. Véase también :ref:`window_set_ime_position()<class_DisplayServer_method_window_set_ime_position>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_ime_position:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_ime_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_ime_position>`
|
||
|
||
Establece la posición de la ventana emergente del `Editor de Método de Entrada <https://en.wikipedia.org/wiki/ Input_method>`__ para el ``window_id`` especificado. Solo es efectivo si :ref:`window_set_ime_active()<class_DisplayServer_method_window_set_ime_active>` se estableció en ``true`` para el ``window_id`` especificado.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_input_event_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_input_event_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_input_event_callback>`
|
||
|
||
Establece la ``callback`` que debe llamarse cuando cualquier :ref:`InputEvent<class_InputEvent>` se envíe a la ventana especificada por ``window_id``.
|
||
|
||
\ **Advertencia:** ¡Solo para usuarios avanzados! Agregar tal callback a un nodo :ref:`Window<class_Window>` anulará su implementación por defecto, lo que puede introducir errores.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_input_text_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_input_text_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_input_text_callback>`
|
||
|
||
Establece la ``callback`` que debe llamarse cuando se introduce texto utilizando el teclado virtual en la ventana especificada por ``window_id``.
|
||
|
||
\ **Advertencia:** ¡Solo para usuarios avanzados! Agregar tal callback a un nodo :ref:`Window<class_Window>` anulará su implementación por defecto, lo que puede introducir errores.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_max_size:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_max_size**\ (\ max_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_max_size>`
|
||
|
||
Establece el tamaño máximo de la ventana especificada por ``window_id`` en píxeles. Normalmente, el usuario no podrá arrastrar la ventana para hacerla más grande que el tamaño especificado. Véase también :ref:`window_get_max_size()<class_DisplayServer_method_window_get_max_size>`.
|
||
|
||
\ **Nota:** Se recomienda cambiar este valor utilizando :ref:`Window.max_size<class_Window_property_max_size>` en su lugar.
|
||
|
||
\ **Nota:** Utilizando herramientas de terceros, es posible que los usuarios deshabiliten las restricciones de geometría de la ventana y, por lo tanto, eviten este límite.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_min_size:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_min_size**\ (\ min_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_min_size>`
|
||
|
||
Establece el tamaño mínimo para la ventana dada a ``min_size`` en píxeles. Normalmente, el usuario no podrá arrastrar la ventana para hacerla más pequeña que el tamaño especificado. Véase también :ref:`window_get_min_size()<class_DisplayServer_method_window_get_min_size>`.
|
||
|
||
\ **Nota:** Se recomienda cambiar este valor usando :ref:`Window.min_size<class_Window_property_min_size>` en su lugar.
|
||
|
||
\ **Nota:** Por defecto, la ventana principal tiene un tamaño mínimo de ``Vector2i(64, 64)``. Esto evita problemas que pueden surgir cuando la ventana se redimensiona a un tamaño cercano a cero.
|
||
|
||
\ **Nota:** Usando herramientas de terceros, es posible que los usuarios deshabiliten las restricciones de geometría de la ventana y por lo tanto eviten este límite.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_mode:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_mode**\ (\ mode\: :ref:`WindowMode<enum_DisplayServer_WindowMode>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_mode>`
|
||
|
||
Establece el modo de ventana para la ventana dada a ``mode``.
|
||
|
||
\ **Nota:** En Android, establecerlo en :ref:`WINDOW_MODE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN>` o :ref:`WINDOW_MODE_EXCLUSIVE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN>` activará el modo inmersivo.
|
||
|
||
\ **Nota:** Establecer la ventana en pantalla completa establece forzosamente la bandera sin bordes a ``true``, así que asegúrate de volver a establecerlo en ``false`` cuando no se desee.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_mouse_passthrough:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_mouse_passthrough**\ (\ region\: :ref:`PackedVector2Array<class_PackedVector2Array>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_mouse_passthrough>`
|
||
|
||
Establece una región poligonal de la ventana que acepta eventos del ratón. Los eventos del ratón fuera de la región se pasarán a través.
|
||
|
||
Pasar un array vacío desactivará el soporte de passthrough (todos los eventos del ratón serán interceptados por la ventana, que es el comportamiento por defecto).
|
||
|
||
|
||
.. tabs::
|
||
|
||
.. code-tab:: gdscript
|
||
|
||
# Establecer la región, usando el nodo Path2D.
|
||
DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points())
|
||
|
||
# Establecer la región, usando el nodo Polygon2D.
|
||
DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon)
|
||
|
||
# Restablecer la región a su valor por defecto.
|
||
DisplayServer.window_set_mouse_passthrough([])
|
||
|
||
.. code-tab:: csharp
|
||
|
||
// Establecer la región, usando el nodo Path2D.
|
||
DisplayServer.WindowSetMousePassthrough(GetNode<Path2D>("Path2D").Curve.GetBakedPoints());
|
||
|
||
// Establecer la región, usando el nodo Polygon2D.
|
||
DisplayServer.WindowSetMousePassthrough(GetNode<Polygon2D>("Polygon2D").Polygon);
|
||
|
||
// Restablecer la región a su valor por defecto.
|
||
DisplayServer.WindowSetMousePassthrough([]);
|
||
|
||
|
||
|
||
\ **Nota:** En Windows, la porción de una ventana que se encuentra fuera de la región no se dibuja, mientras que en Linux (X11) y macOS sí lo hace.
|
||
|
||
\ **Nota:** Este método está implementado en Linux (X11), macOS y Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_popup_safe_rect:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_popup_safe_rect**\ (\ window\: :ref:`int<class_int>`, rect\: :ref:`Rect2i<class_Rect2i>`\ ) :ref:`🔗<class_DisplayServer_method_window_set_popup_safe_rect>`
|
||
|
||
Establece el cuadro delimitador del control, o el elemento del menú que se utilizó para abrir la ventana emergente, en el sistema de coordenadas de la pantalla. Hacer clic en esta área no cerrará automáticamente esta ventana emergente.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_position:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_position>`
|
||
|
||
Sets the position of the given window to ``position``. On multi-monitor setups, the screen position is relative to the virtual desktop area. On multi-monitor setups with different screen resolutions or orientations, the origin may be located outside any display like this:
|
||
|
||
.. code:: text
|
||
|
||
* (0, 0) +-------+
|
||
| |
|
||
+-------------+ | |
|
||
| | | |
|
||
| | | |
|
||
+-------------+ +-------+
|
||
|
||
See also :ref:`window_get_position()<class_DisplayServer_method_window_get_position>` and :ref:`window_set_size()<class_DisplayServer_method_window_set_size>`.
|
||
|
||
\ **Note:** It's recommended to change this value using :ref:`Window.position<class_Window_property_position>` instead.
|
||
|
||
\ **Note:** On Linux (Wayland): this method is a no-op.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_rect_changed_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_rect_changed_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_rect_changed_callback>`
|
||
|
||
Sets the ``callback`` that will be called when the window specified by ``window_id`` is moved or resized.
|
||
|
||
\ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_size:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_size**\ (\ size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_size>`
|
||
|
||
Establece el tamaño de la ventana dada a ``size`` (en píxeles). Véase también :ref:`window_get_size()<class_DisplayServer_method_window_get_size>` y :ref:`window_get_position()<class_DisplayServer_method_window_get_position>`.
|
||
|
||
\ **Nota:** Se recomienda cambiar este valor usando :ref:`Window.size<class_Window_property_size>` en su lugar.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_title:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_title**\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_title>`
|
||
|
||
Establece el título de la ventana dada a ``title``.
|
||
|
||
\ **Nota:** Se recomienda cambiar este valor usando :ref:`Window.title<class_Window_property_title>` en su lugar.
|
||
|
||
\ **Nota:** Evita cambiar el título de la ventana cada fotograma, ya que esto puede causar problemas de rendimiento en ciertos administradores de ventanas. Intenta cambiar el título de la ventana solo unas pocas veces por segundo como máximo.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_transient:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_transient**\ (\ window_id\: :ref:`int<class_int>`, parent_window_id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_window_set_transient>`
|
||
|
||
Sets window transient parent. Transient window will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode.
|
||
|
||
\ **Note:** It's recommended to change this value using :ref:`Window.transient<class_Window_property_transient>` instead.
|
||
|
||
\ **Note:** The behavior might be different depending on the platform.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_vsync_mode:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_vsync_mode**\ (\ vsync_mode\: :ref:`VSyncMode<enum_DisplayServer_VSyncMode>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_vsync_mode>`
|
||
|
||
Sets the V-Sync mode of the given window. See also :ref:`ProjectSettings.display/window/vsync/vsync_mode<class_ProjectSettings_property_display/window/vsync/vsync_mode>`.
|
||
|
||
Depending on the platform and used renderer, the engine will fall back to :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` if the desired mode is not supported.
|
||
|
||
\ **Note:** V-Sync modes other than :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` are only supported in the Forward+ and Mobile rendering methods, not Compatibility.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_window_buttons_offset:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_window_buttons_offset**\ (\ offset\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_window_buttons_offset>`
|
||
|
||
When :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>` flag is set, set offset to the center of the first titlebar button.
|
||
|
||
\ **Note:** This flag is implemented only on macOS.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_set_window_event_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_set_window_event_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_window_event_callback>`
|
||
|
||
Sets the ``callback`` that will be called when an event occurs in the window specified by ``window_id``.
|
||
|
||
\ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_start_drag:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_start_drag**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_start_drag>`
|
||
|
||
Starts an interactive drag operation on the window with the given ``window_id``, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's title bar. Using this method allows the window to participate in space switching, tiling, and other system features.
|
||
|
||
\ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_window_start_resize:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **window_start_resize**\ (\ edge\: :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_start_resize>`
|
||
|
||
Starts an interactive resize operation on the window with the given ``window_id``, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's edge.
|
||
|
||
\ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows.
|
||
|
||
.. |virtual| replace:: :abbr:`virtual (Normalmente, este método debería ser sobreescrito por el usuario para que tenga algún efecto.)`
|
||
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
||
.. |const| replace:: :abbr:`const (Este método no tiene efectos secundarios. No modifica ninguna de las variables miembro de la instancia.)`
|
||
.. |vararg| replace:: :abbr:`vararg (Este método permite agregar cualquier número de argumentos después de los descritos aquí.)`
|
||
.. |constructor| replace:: :abbr:`constructor (Este método se utiliza para construir un tipo.)`
|
||
.. |static| replace:: :abbr:`static (Este método no necesita una instancia para ser llamado, por lo que puede llamarse directamente utilizando el nombre de la clase.)`
|
||
.. |operator| replace:: :abbr:`operator (Este método describe un operador válido para usar con este tipo como operando izquierdo.)`
|
||
.. |bitfield| replace:: :abbr:`BitField (Este valor es un entero compuesto como una máscara de bits de las siguientes banderas.)`
|
||
.. |void| replace:: :abbr:`void (Sin valor de retorno.)`
|