mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
6840 lines
594 KiB
ReStructuredText
6840 lines
594 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. _class_DisplayServer:
|
||
|
||
DisplayServer
|
||
=============
|
||
|
||
**继承:** :ref:`Object<class_Object>`
|
||
|
||
用于低阶窗口管理的服务器接口。
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
描述
|
||
----
|
||
|
||
所有与窗口管理相关的内容都由 **DisplayServer**\ (显示服务器)处理。因为一个操作系统可能支持多个显示服务器,所以与 :ref:`OS<class_OS>` 是分开的。
|
||
|
||
\ **无头模式:**\ 如果使用 ``--headless`` :doc:`命令行参数 <../tutorials/editor/command_line_tutorial>`\ 启动引擎,就会禁用所有渲染和窗口管理功能。此时 **DisplayServer** 的大多数函数都会返回虚设值。
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
方法
|
||
----
|
||
|
||
.. 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
|
||
|
||
枚举
|
||
----
|
||
|
||
.. _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``
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
显示服务器支持全局菜单。能够让应用程序在操作系统的顶部栏显示其菜单项。\ **macOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_SUBWINDOWS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SUBWINDOWS** = ``1``
|
||
|
||
显示服务器支持多窗口,可以移动到主窗口之外。\ **Windows、macOS、Linux(X11)**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_TOUCHSCREEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TOUCHSCREEN** = ``2``
|
||
|
||
显示服务器支持触屏输入。\ **Windows、Linux(X11)、Android、iOS、Web**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_MOUSE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE** = ``3``
|
||
|
||
显示服务器支持鼠标输入。\ **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``
|
||
|
||
显示服务器支持扭曲鼠标坐标以将鼠标光标限制在一个区域内,但在到达其中一个边缘时循环。\ **Windows, macOS, Linux (X11/Wayland)**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_CLIPBOARD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD** = ``5``
|
||
|
||
显示服务器支持剪贴板数据的设置和获取。另见 :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``
|
||
|
||
显示服务器支持在请求输入文本但没有物理键盘时弹出虚拟键盘。\ **Android、iOS、Web**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_CURSOR_SHAPE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CURSOR_SHAPE** = ``7``
|
||
|
||
显示服务器支持将鼠标光标形状设置为与默认不同。\ **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``
|
||
|
||
显示服务器支持将鼠标光标形状设置为自定义图像。\ **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``
|
||
|
||
显示服务器支持使用操作系统的原生外观生成文本对话框。请参阅 :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``
|
||
|
||
显示服务器支持 `输入法 <https://en.wikipedia.org/wiki/Input_method>`__\ ,它通常用于输入中文、日文和韩文文本。这由操作系统处理,而不是由 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``
|
||
|
||
显示服务器支持窗口可以使用逐像素透明,以使它们后面的窗口部分或完全可见。\ **Windows、macOS、Linux(X11/Wayland)、Android**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_HIDPI:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_HIDPI** = ``12``
|
||
|
||
显示服务器支持查询操作系统的显示缩放系数。这允许\ *可靠地*\ 执行自动 hiDPI 显示器检测,而不是根据屏幕分辨率和报告的显示器 DPI 进行猜测(由于显示器 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``
|
||
|
||
显示服务器支持改变窗口图标(通常显示在左上角)。\ **Windows、macOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_ORIENTATION:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ORIENTATION** = ``15``
|
||
|
||
显示服务器支持改变屏幕朝向。\ **Android、iOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_SWAP_BUFFERS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SWAP_BUFFERS** = ``16``
|
||
|
||
显示服务器支持将垂直同步状态改为非默认状态(不支持此功能的平台强制启用垂直同步)。\ **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``
|
||
|
||
显示服务器支持使用主剪贴板。主剪贴板和 :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``
|
||
|
||
显示服务器支持文字转语音。见 ``tts_*`` 方法。\ **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``
|
||
|
||
显示服务器支持将窗口内容扩展到标题。见 :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``
|
||
|
||
显示服务器支持读取屏幕像素。见 :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``
|
||
|
||
显示服务器支持应用程序状态指示器。
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_NATIVE_HELP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_HELP** = ``23``
|
||
|
||
显示服务器支持本机帮助系统搜索回调。请参阅 :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``
|
||
|
||
显示服务器支持使用操作系统的原生外观生成文本输入对话框。请参阅 :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``
|
||
|
||
显示服务器支持使用操作系统的原生外观和操作方式来生成选择文件或目录的对话框。见 :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``
|
||
|
||
显示服务器支持 :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>` 的所有功能,并增加了“选项”功能以及对 ``res://`` 和 ``user://`` 路径的原生对话框文件访问。见 :ref:`file_dialog_show()<class_DisplayServer_method_file_dialog_show>` 和 :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``
|
||
|
||
显示服务器支持在需要时发起窗口拖拽和大小调整操作。见 :ref:`window_start_drag()<class_DisplayServer_method_window_start_drag>` 和 :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``
|
||
|
||
显示服务器支持窗口标志 :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``
|
||
|
||
显示服务器支持嵌入其他进程的窗口。\ **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``
|
||
|
||
原生文件选择对话框支持使用 MIME 类型作为过滤器。
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_EMOJI_AND_SYMBOL_PICKER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EMOJI_AND_SYMBOL_PICKER** = ``31``
|
||
|
||
显示服务器支持系统 Emoji 和符号拾取器。\ **Windows、macOS**
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_NATIVE_COLOR_PICKER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_COLOR_PICKER** = ``32``
|
||
|
||
显示服务器支持原生取色器。\ **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``
|
||
|
||
显示服务器会根据屏幕边界自动调整弹出窗口的大小。Window 节点不应该自行进行此类调整。
|
||
|
||
.. _class_DisplayServer_constant_FEATURE_ACCESSIBILITY_SCREEN_READER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ACCESSIBILITY_SCREEN_READER** = ``34``
|
||
|
||
显示服务器支持与屏幕阅读器或盲文显示器的交互。\ **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``
|
||
|
||
未知角色或自定义角色。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_DEFAULT_BUTTON:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_DEFAULT_BUTTON** = ``1``
|
||
|
||
默认对话框按钮元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_AUDIO:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_AUDIO** = ``2``
|
||
|
||
音频播放器元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_VIDEO:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_VIDEO** = ``3``
|
||
|
||
视频播放器元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_STATIC_TEXT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_STATIC_TEXT** = ``4``
|
||
|
||
不可编辑的文本标签。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_CONTAINER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_CONTAINER** = ``5``
|
||
|
||
容器元素。带有该角色的元素用于内部结构,会被屏幕阅读器忽略。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_PANEL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_PANEL** = ``6``
|
||
|
||
面板容器元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_BUTTON:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_BUTTON** = ``7``
|
||
|
||
按钮元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_LINK:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LINK** = ``8``
|
||
|
||
链接元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_CHECK_BOX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_CHECK_BOX** = ``9``
|
||
|
||
复选框元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_RADIO_BUTTON:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_RADIO_BUTTON** = ``10``
|
||
|
||
单选按钮元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_CHECK_BUTTON:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_CHECK_BUTTON** = ``11``
|
||
|
||
复选按钮元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_SCROLL_BAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SCROLL_BAR** = ``12``
|
||
|
||
滚动条元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_SCROLL_VIEW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SCROLL_VIEW** = ``13``
|
||
|
||
滚动容器元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_SPLITTER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SPLITTER** = ``14``
|
||
|
||
容器拆分器手柄元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_SLIDER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SLIDER** = ``15``
|
||
|
||
滑块元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_SPIN_BUTTON:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SPIN_BUTTON** = ``16``
|
||
|
||
数字输入框元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_PROGRESS_INDICATOR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_PROGRESS_INDICATOR** = ``17``
|
||
|
||
进度指示元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TEXT_FIELD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TEXT_FIELD** = ``18``
|
||
|
||
可编辑文本框元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_MULTILINE_TEXT_FIELD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MULTILINE_TEXT_FIELD** = ``19``
|
||
|
||
多行可编辑文本框元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_COLOR_PICKER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_COLOR_PICKER** = ``20``
|
||
|
||
取色器元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TABLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TABLE** = ``21``
|
||
|
||
表格元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_CELL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_CELL** = ``22``
|
||
|
||
表格/树中的单元格元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_ROW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_ROW** = ``23``
|
||
|
||
表格/树中的行元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_ROW_GROUP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_ROW_GROUP** = ``24``
|
||
|
||
表格/树中的行分组元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_ROW_HEADER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_ROW_HEADER** = ``25``
|
||
|
||
表格/树中的行头元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_COLUMN_HEADER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_COLUMN_HEADER** = ``26``
|
||
|
||
表格/树中的列头元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TREE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TREE** = ``27``
|
||
|
||
树视图元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TREE_ITEM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TREE_ITEM** = ``28``
|
||
|
||
树视图项元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_LIST:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LIST** = ``29``
|
||
|
||
列表元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_LIST_ITEM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LIST_ITEM** = ``30``
|
||
|
||
列表项元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_LIST_BOX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LIST_BOX** = ``31``
|
||
|
||
列表视图元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_LIST_BOX_OPTION:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LIST_BOX_OPTION** = ``32``
|
||
|
||
列表视图项元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TAB_BAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TAB_BAR** = ``33``
|
||
|
||
选项卡栏元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TAB:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TAB** = ``34``
|
||
|
||
选项卡栏项目元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TAB_PANEL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TAB_PANEL** = ``35``
|
||
|
||
选项卡面板元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_MENU_BAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU_BAR** = ``36``
|
||
|
||
菜单栏元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_MENU:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU** = ``37``
|
||
|
||
弹出菜单元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_MENU_ITEM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU_ITEM** = ``38``
|
||
|
||
弹出菜单项元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_MENU_ITEM_CHECK_BOX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU_ITEM_CHECK_BOX** = ``39``
|
||
|
||
弹出菜单复选按钮菜单项元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_MENU_ITEM_RADIO:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU_ITEM_RADIO** = ``40``
|
||
|
||
弹出菜单单选按钮菜单项元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_IMAGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_IMAGE** = ``41``
|
||
|
||
图像元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_WINDOW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_WINDOW** = ``42``
|
||
|
||
窗口元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TITLE_BAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TITLE_BAR** = ``43``
|
||
|
||
内嵌窗口标题栏元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_DIALOG:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_DIALOG** = ``44``
|
||
|
||
对话框窗口元素。
|
||
|
||
.. _class_DisplayServer_constant_ROLE_TOOLTIP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TOOLTIP** = ``45``
|
||
|
||
工具提示元素。
|
||
|
||
.. 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``
|
||
|
||
弹出菜单元素。
|
||
|
||
.. _class_DisplayServer_constant_POPUP_LIST:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>` **POPUP_LIST** = ``1``
|
||
|
||
弹出列表。
|
||
|
||
.. _class_DisplayServer_constant_POPUP_TREE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>` **POPUP_TREE** = ``2``
|
||
|
||
弹出树视图。
|
||
|
||
.. _class_DisplayServer_constant_POPUP_DIALOG:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>` **POPUP_DIALOG** = ``3``
|
||
|
||
弹出对话框。
|
||
|
||
.. 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``
|
||
|
||
元素对无障碍工具隐藏。
|
||
|
||
.. _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``
|
||
|
||
元素要求用户输入。
|
||
|
||
.. _class_DisplayServer_constant_FLAG_VISITED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_VISITED** = ``3``
|
||
|
||
元素为已访问链接。
|
||
|
||
.. _class_DisplayServer_constant_FLAG_BUSY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_BUSY** = ``4``
|
||
|
||
元素内容未就绪(例如正在加载)。
|
||
|
||
.. _class_DisplayServer_constant_FLAG_MODAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_MODAL** = ``5``
|
||
|
||
元素为模态窗口。
|
||
|
||
.. _class_DisplayServer_constant_FLAG_TOUCH_PASSTHROUGH:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_TOUCH_PASSTHROUGH** = ``6``
|
||
|
||
屏幕阅读器处于触摸探索模式时,元素允许触摸事件穿透。
|
||
|
||
.. _class_DisplayServer_constant_FLAG_READONLY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_READONLY** = ``7``
|
||
|
||
元素是文本框,包含可选择但只读的文本。
|
||
|
||
.. _class_DisplayServer_constant_FLAG_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_DISABLED** = ``8``
|
||
|
||
元素已禁用。
|
||
|
||
.. _class_DisplayServer_constant_FLAG_CLIPS_CHILDREN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_CLIPS_CHILDREN** = ``9``
|
||
|
||
元素会裁剪子级。
|
||
|
||
.. 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``
|
||
|
||
单击动作,不设置回调参数。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_FOCUS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_FOCUS** = ``1``
|
||
|
||
聚焦动作,不设置回调参数。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_BLUR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_BLUR** = ``2``
|
||
|
||
散焦动作,不设置回调参数。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_COLLAPSE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_COLLAPSE** = ``3``
|
||
|
||
折叠动作,不设置回调参数。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_EXPAND:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_EXPAND** = ``4``
|
||
|
||
展开动作,不设置回调参数。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_DECREMENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_DECREMENT** = ``5``
|
||
|
||
下调动作,不设置回调参数。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_INCREMENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_INCREMENT** = ``6``
|
||
|
||
上调动作,不设置回调参数。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_HIDE_TOOLTIP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_HIDE_TOOLTIP** = ``7``
|
||
|
||
隐藏工具提示动作,不设置回调参数。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SHOW_TOOLTIP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SHOW_TOOLTIP** = ``8``
|
||
|
||
显示工具提示动作,不设置回调参数。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SET_TEXT_SELECTION:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SET_TEXT_SELECTION** = ``9``
|
||
|
||
文本选区动作,回调参数被设置为 :ref:`Dictionary<class_Dictionary>`\ ,带有以下键:
|
||
|
||
- ``"start_element"`` 选区起点的无障碍元素。
|
||
|
||
- ``"start_char"`` 相对于选区起点无障碍元素的字符偏移量。
|
||
|
||
- ``"end_element"`` 选区终点的无障碍元素。
|
||
|
||
- ``"end_char"`` 相对于选区终点无障碍元素的字符偏移量。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_REPLACE_SELECTED_TEXT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_REPLACE_SELECTED_TEXT** = ``10``
|
||
|
||
替换文本动作,回调参数被设置为 :ref:`String<class_String>`\ ,表示替换后的文本。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SCROLL_BACKWARD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_BACKWARD** = ``11``
|
||
|
||
向后滚动动作,不设置回调参数。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SCROLL_DOWN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_DOWN** = ``12``
|
||
|
||
向下滚动动作,回调参数被设置为 :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``
|
||
|
||
向前滚动动作,不设置回调参数。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SCROLL_LEFT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_LEFT** = ``14``
|
||
|
||
向左滚动动作,回调参数被设置为 :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``
|
||
|
||
向右滚动动作,回调参数被设置为 :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``
|
||
|
||
向上滚动动作,回调参数被设置为 :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``
|
||
|
||
滚动至视图动作,回调参数被设置为 :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``
|
||
|
||
滚动至点动作,回调参数被设置为 :ref:`Vector2<class_Vector2>`\ ,表示点的相对坐标。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SET_SCROLL_OFFSET:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SET_SCROLL_OFFSET** = ``19``
|
||
|
||
设置滚动偏移量动作,回调参数被设置为 :ref:`Vector2<class_Vector2>`\ ,表示滚动偏移量。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SET_VALUE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SET_VALUE** = ``20``
|
||
|
||
设值动作,回调参数被设置为 :ref:`String<class_String>` 或数字,表示新值。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_SHOW_CONTEXT_MENU:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SHOW_CONTEXT_MENU** = ``21``
|
||
|
||
显示上下文菜单动作,不设置回调参数。
|
||
|
||
.. _class_DisplayServer_constant_ACTION_CUSTOM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_CUSTOM** = ``22``
|
||
|
||
自定义动作,回调参数被设置为整数动作 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``
|
||
|
||
表示不应展示对实时区域的更新。
|
||
|
||
.. _class_DisplayServer_constant_LIVE_POLITE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>` **LIVE_POLITE** = ``1``
|
||
|
||
表示对实时区域的更新应在下次机会时展示(例如讲完当前句子后)。
|
||
|
||
.. _class_DisplayServer_constant_LIVE_ASSERTIVE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>` **LIVE_ASSERTIVE** = ``2``
|
||
|
||
表示对实时区域的更新具有最高优先级,应立即展示。
|
||
|
||
.. 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``
|
||
|
||
要滚动的量度。列表中的单个项目,一行文本。
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_UNIT_PAGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollUnit<enum_DisplayServer_AccessibilityScrollUnit>` **SCROLL_UNIT_PAGE** = ``1``
|
||
|
||
要滚动的量度。单页。
|
||
|
||
.. 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``
|
||
|
||
节点滚动到视图的首选位置。滚动容器的左上边缘。
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_HINT_BOTTOM_RIGHT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollHint<enum_DisplayServer_AccessibilityScrollHint>` **SCROLL_HINT_BOTTOM_RIGHT** = ``1``
|
||
|
||
节点滚动到视图的首选位置。滚动容器的右下边缘。
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_HINT_TOP_EDGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollHint<enum_DisplayServer_AccessibilityScrollHint>` **SCROLL_HINT_TOP_EDGE** = ``2``
|
||
|
||
节点滚动到视图的首选位置。滚动容器的顶部边缘。
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_HINT_BOTTOM_EDGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollHint<enum_DisplayServer_AccessibilityScrollHint>` **SCROLL_HINT_BOTTOM_EDGE** = ``3``
|
||
|
||
节点滚动到视图的首选位置。滚动容器的底部边缘。
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_HINT_LEFT_EDGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollHint<enum_DisplayServer_AccessibilityScrollHint>` **SCROLL_HINT_LEFT_EDGE** = ``4``
|
||
|
||
节点滚动到视图的首选位置。滚动容器的左部边缘。
|
||
|
||
.. _class_DisplayServer_constant_SCROLL_HINT_RIGHT_EDGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AccessibilityScrollHint<enum_DisplayServer_AccessibilityScrollHint>` **SCROLL_HINT_RIGHT_EDGE** = ``5``
|
||
|
||
节点滚动到视图的首选位置。滚动容器的右部边缘。
|
||
|
||
.. 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``
|
||
|
||
如果鼠标光标处于隐藏状态,则使其可见。
|
||
|
||
.. _class_DisplayServer_constant_MOUSE_MODE_HIDDEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_HIDDEN** = ``1``
|
||
|
||
如果鼠标光标是可见的,则使其隐藏。
|
||
|
||
.. _class_DisplayServer_constant_MOUSE_MODE_CAPTURED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CAPTURED** = ``2``
|
||
|
||
捕获鼠标。鼠标将被隐藏,其位置被锁定在窗口管理器窗口的中心。
|
||
|
||
\ **注意:**\ 如果你想在这种模式下处理鼠标的移动,则需要使用 :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``
|
||
|
||
将鼠标光标限制在游戏窗口内,并使其可见。
|
||
|
||
.. _class_DisplayServer_constant_MOUSE_MODE_CONFINED_HIDDEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED_HIDDEN** = ``4``
|
||
|
||
将鼠标光标限制在游戏窗口内,并使其隐藏。
|
||
|
||
.. _class_DisplayServer_constant_MOUSE_MODE_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_MAX** = ``5``
|
||
|
||
: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``
|
||
|
||
默认横屏朝向。
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_PORTRAIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_PORTRAIT** = ``1``
|
||
|
||
默认竖屏朝向。
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_LANDSCAPE** = ``2``
|
||
|
||
倒横屏朝向(上下颠倒)。
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_REVERSE_PORTRAIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_PORTRAIT** = ``3``
|
||
|
||
倒竖屏朝向(上下颠倒)。
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_SENSOR_LANDSCAPE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_LANDSCAPE** = ``4``
|
||
|
||
自动横屏朝向(传感器决定默认或倒向)。
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_SENSOR_PORTRAIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_PORTRAIT** = ``5``
|
||
|
||
自动竖屏朝向(传感器决定默认或倒向)。
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_SENSOR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR** = ``6``
|
||
|
||
自动横屏或竖屏朝向(传感器决定默认或倒向)。
|
||
|
||
.. 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``
|
||
|
||
默认文本虚拟键盘。
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_MULTILINE** = ``1``
|
||
|
||
多行虚拟键盘。
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER** = ``2``
|
||
|
||
虚拟数字键盘,可用于 PIN 输入。
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER_DECIMAL** = ``3``
|
||
|
||
虚拟数字键盘,可用于输入小数。
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PHONE** = ``4``
|
||
|
||
虚拟手机号码键盘。
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_EMAIL_ADDRESS** = ``5``
|
||
|
||
带有附加键的虚拟键盘,可帮助输入电子邮件地址。
|
||
|
||
.. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PASSWORD** = ``6``
|
||
|
||
用于输入密码的虚拟键盘。在大多数平台上,这应该会禁用自动完成和自动首字母大写功能。
|
||
|
||
\ **注意:**\ Web 平台不支持。与 :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``
|
||
|
||
带有附加键的虚拟键盘,可帮助输入 URL。
|
||
|
||
.. 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``
|
||
|
||
箭头光标形状。这是默认形状,没有指向 :ref:`LineEdit<class_LineEdit>` 和 :ref:`TextEdit<class_TextEdit>` 等会覆盖鼠标指针的节点时显示。
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_IBEAM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_IBEAM** = ``1``
|
||
|
||
工字光标形状。默认在悬停于 :ref:`LineEdit<class_LineEdit>` 和 :ref:`TextEdit<class_TextEdit>` 等接受文本输入的控件时显示。
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_POINTING_HAND:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_POINTING_HAND** = ``2``
|
||
|
||
指点的手形光标形状。默认在悬停于 :ref:`LinkButton<class_LinkButton>` 或 :ref:`RichTextLabel<class_RichTextLabel>` 中的 URL 标签时使用。
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_CROSS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CROSS** = ``3``
|
||
|
||
十字光标。应当在用户需要精确瞄准某个元素时显示,例如矩形选择工具和颜色拾取器。
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_WAIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_WAIT** = ``4``
|
||
|
||
等待光标。大多数光标主题会在箭头\ *旁边*\ 显示旋转图标。旨在用于非阻塞操作(此时用户可以做其他事情)。另见 :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``
|
||
|
||
等待光标。大多数光标主题会把箭头\ *替换*\ 为旋转图标。旨在用于阻塞操作(此时用户无法做其他事情)。另见 :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``
|
||
|
||
拖动的手形光标。在拖放操作过程中显示。另见 :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``
|
||
|
||
“能放下”光标。在拖放操作过程中,如果将鼠标悬停在可以接受拖放事件的 :ref:`Control<class_Control>` 上,就会显示这个光标。大多数光标主题会显示一只正在拖拽的手,旁边有一个箭头符号。另见 :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``
|
||
|
||
禁止光标。在拖放操作过程中,如果将鼠标悬停在不可接受拖放事件的 :ref:`Control<class_Control>` 上,就会显示这个光标。
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_VSIZE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSIZE** = ``9``
|
||
|
||
垂直尺寸调整光标。只在用于悬停的 :ref:`Control<class_Control>` 可以用鼠标调整垂直大小时显示。另见 :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``
|
||
|
||
水平尺寸调整光标。只在用于悬停的 :ref:`Control<class_Control>` 可以用鼠标调整水平大小时显示。另见 :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``
|
||
|
||
辅助对角线尺寸调整光标(右上/左下)。只在但悬停的 :ref:`Control<class_Control>` 可以使用鼠标同时在两个轴上调整大小时显示。
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_FDIAGSIZE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FDIAGSIZE** = ``12``
|
||
|
||
主对角线尺寸调整光标(左上/右下)。只在当悬停的 :ref:`Control<class_Control>` 可以使用鼠标同时在两个轴上调整大小时显示。
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_MOVE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MOVE** = ``13``
|
||
|
||
移动光标。应在能够使用鼠标移动被悬停 :ref:`Control<class_Control>` 时显示。
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_VSPLIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSPLIT** = ``14``
|
||
|
||
垂直分割光标。当光标悬停于 :ref:`VSplitContainer<class_VSplitContainer>` 等能够使用鼠标调整拆分的垂直大小的 :ref:`Control<class_Control>` 时显示。部分光标主题中,该光标的外观和 :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``
|
||
|
||
水平分割光标。当光标悬停于 :ref:`HSplitContainer<class_HSplitContainer>` 等能够使用鼠标调整拆分的水平大小的 :ref:`Control<class_Control>` 时显示。部分光标主题中,该光标的外观和 :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``
|
||
|
||
帮助光标。在大多数光标主题中显示为问号图标,不显示为鼠标光标。应在用户请求对下一次点击的元素提供帮助信息时使用。
|
||
|
||
.. _class_DisplayServer_constant_CURSOR_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MAX** = ``17``
|
||
|
||
代表 :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``
|
||
|
||
该原生对话框只允许选择一个文件。
|
||
|
||
.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILES:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILES** = ``1``
|
||
|
||
该原生对话框允许选择多个文件。
|
||
|
||
.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_DIR** = ``2``
|
||
|
||
该原生对话框只允许选择一个目录,不允许选择任何文件。
|
||
|
||
.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_ANY** = ``3``
|
||
|
||
该原生对话框允许选择一个文件或目录。
|
||
|
||
.. _class_DisplayServer_constant_FILE_DIALOG_MODE_SAVE_FILE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_SAVE_FILE** = ``4``
|
||
|
||
当文件存在时,原生对话框会发出警告。
|
||
|
||
.. 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``
|
||
|
||
窗口模式,即 :ref:`Window<class_Window>` 不占据整个屏幕(除非设置为屏幕的大小)。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_MODE_MINIMIZED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MINIMIZED** = ``1``
|
||
|
||
最小化窗口模式,即 :ref:`Window<class_Window>` 在窗口管理器的窗口列表中既不可见也不可用。通常发生在按下最小化按钮时。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_MODE_MAXIMIZED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MAXIMIZED** = ``2``
|
||
|
||
最大化窗口模式,即 :ref:`Window<class_Window>` 会占据整个屏幕区域,任务栏除外,并且会显示边框。通常发生在按下最大化按钮时。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_FULLSCREEN** = ``3``
|
||
|
||
具有完整多窗口支持的全屏模式。
|
||
|
||
全屏窗口覆盖屏幕的整个显示区域,且没有任何装饰。显示的视频模式没有更改。
|
||
|
||
\ **在 Android 上:**\ 将启用沉浸模式。
|
||
|
||
\ **在 macOS 上:**\ 使用新桌面来显示正在运行的项目。
|
||
|
||
\ **注意:**\ 无论平台如何,启用全屏都会更改窗口大小以匹配显示器的大小。因此,请确保你的项目在启用全屏模式时支持\ :doc:`多种分辨率 <../tutorials/rendering/multiple_resolutions>`\ 。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = ``4``
|
||
|
||
单窗口全屏模式。这种模式开销较小,但一次只能在给定屏幕上打开一个窗口(打开子窗口或切换应用程序会触发全屏过渡)。
|
||
|
||
全屏窗口会覆盖屏幕的整个显示区域,没有边框或装饰。显示视频模式没有改变。
|
||
|
||
\ **注意:**\ 该模式可能不适用于屏幕录制软件。
|
||
|
||
\ **在 Android 上:**\ 将启用沉浸模式。
|
||
|
||
\ **在 Windows 上:**\ 取决于视频驱动程序,全屏过渡可能会导致屏幕暂时变黑。
|
||
|
||
\ **在 macOS 上:**\ 一个新的桌面用于显示正在运行的项目。当鼠标指针悬停在屏幕边缘时,独占全屏模式会阻止 Dock 和 Menu 出现。
|
||
|
||
\ **在 Linux(X11)上:**\ 独占全屏模式会绕过合成器。
|
||
|
||
\ **在 Linux(Wayland)上:**\ 等价于 :ref:`WINDOW_MODE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN>`\ 。
|
||
|
||
\ **注意:**\ 无论平台如何,启用全屏都会更改窗口大小以匹配显示器的大小。因此,确保你的项目在启用全屏模式时支持\ :doc:`多个分辨率 <../tutorials/rendering/multiple_resolutions>`\ 。
|
||
|
||
.. 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``
|
||
|
||
该窗口不能通过拖动其调整大小的手柄来调整大小。但仍然可以使用 :ref:`window_set_size()<class_DisplayServer_method_window_set_size>` 调整窗口大小。全屏窗口会忽略该标志。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_BORDERLESS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_BORDERLESS** = ``1``
|
||
|
||
该窗口没有原生标题栏和其他装饰。全屏窗口会忽略该标志。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_ALWAYS_ON_TOP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_ALWAYS_ON_TOP** = ``2``
|
||
|
||
该窗口悬浮在所有其他窗口之上。全屏窗口会忽略该标志。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_TRANSPARENT** = ``3``
|
||
|
||
该窗口背景可以是透明的。
|
||
|
||
\ **注意:**\ 如果 :ref:`is_window_transparency_available()<class_DisplayServer_method_is_window_transparency_available>` 返回 ``false``\ ,则该标志无效。
|
||
|
||
\ **注意:**\ Linux (X11/Wayland)、macOS 和 Windows 上实现了透明支持,但可用性可能因 GPU 驱动程序、显示管理器和合成器功能而异。
|
||
|
||
\ **注意:**\ Android 系统已实现透明支持,但只能通过 :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>` 启用。该标志在 Android 上无效。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_NO_FOCUS** = ``4``
|
||
|
||
该窗口无法获得焦点。无聚焦窗口会忽略除鼠标点击外的所有输入。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_POPUP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP** = ``5``
|
||
|
||
窗口是菜单或 :ref:`OptionButton<class_OptionButton>` 下拉菜单的一部分。当窗口可见时,不能更改该标志。活动的弹出窗口会以独占的形式接收所有输入,但不会从其父窗口窃取焦点。当在其外部点击或切换应用程序时,弹出窗口将会自动关闭。 弹出窗口必须已经设置了临时父级(参见 :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``
|
||
|
||
窗口内容扩展到窗口的全部大小。与无边框窗口不同,框架仍保持不变,可以调整窗口大小,标题栏是透明的,但具有最小化/最大化/关闭按钮。
|
||
|
||
使用 :ref:`window_set_window_buttons_offset()<class_DisplayServer_method_window_set_window_buttons_offset>` 调整最小化/最大化/关闭按钮的偏移量。
|
||
|
||
使用 :ref:`window_get_safe_title_margins()<class_DisplayServer_method_window_get_safe_title_margins>` 确定标题栏下方未被装饰覆盖的区域。
|
||
|
||
\ **注意:**\ 该标志仅在 macOS 上实现。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_MOUSE_PASSTHROUGH:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MOUSE_PASSTHROUGH** = ``7``
|
||
|
||
所有鼠标事件都被传递到同一应用程序的底层窗口。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_SHARP_CORNERS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_SHARP_CORNERS** = ``8``
|
||
|
||
覆盖了窗口样式,强制使用尖角。
|
||
|
||
\ **注意:**\ 该标志仅在 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``
|
||
|
||
在 :ref:`screen_get_image()<class_DisplayServer_method_screen_get_image>`\ 、\ :ref:`screen_get_image_rect()<class_DisplayServer_method_screen_get_image_rect>` 和 :ref:`screen_get_pixel()<class_DisplayServer_method_screen_get_pixel>` 的截图中排除该窗口。
|
||
|
||
\ **注意:**\ 该标志在 macOS 和 Windows(10、20H1)上实现。
|
||
|
||
\ **注意:**\ 设置该标志将阻止标准屏幕截图方法截取窗口图像,但\ **不**\ 保证其他应用无法截取图像。它不应用作 DRM 或安全措施。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_POPUP_WM_HINT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP_WM_HINT** = ``10``
|
||
|
||
向窗口管理器发出信号,表明该窗口应该是实现定义的“弹出窗口” (通常是浮动、无边框、不可平铺且不可移动的子窗口)。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_MINIMIZE_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MINIMIZE_DISABLED** = ``11``
|
||
|
||
禁用窗口的最小化按钮。
|
||
|
||
\ **注意:**\ 该标志在 macOS 和 Windows 上实现。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_FLAG_MAXIMIZE_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MAXIMIZE_DISABLED** = ``12``
|
||
|
||
禁用窗口的最大化按钮。
|
||
|
||
\ **注意:**\ 该标志在 macOS 和 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``
|
||
|
||
当鼠标指针进入该窗口时发送。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_EXIT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_EXIT** = ``1``
|
||
|
||
当鼠标指针退出该窗口时发送。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_IN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_IN** = ``2``
|
||
|
||
当窗口获得焦点时发送。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_OUT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_OUT** = ``3``
|
||
|
||
当窗口失去焦点时发送。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_CLOSE_REQUEST:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_CLOSE_REQUEST** = ``4``
|
||
|
||
当用户试图关闭该窗口时发送(例如按下关闭按钮)。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_GO_BACK_REQUEST:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_GO_BACK_REQUEST** = ``5``
|
||
|
||
当按下设备的“后退”按钮时发送。
|
||
|
||
\ **注意:**\ 该事件仅在 Android 上实现。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_DPI_CHANGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_DPI_CHANGE** = ``6``
|
||
|
||
当窗口被移动到具有不同 DPI 的显示器上,或者显示器的 DPI 更改时发送。
|
||
|
||
\ **注意:**\ 该标志仅在 macOS 和 Linux(Wayland)上实现。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_TITLEBAR_CHANGE** = ``7``
|
||
|
||
当窗口标题栏的装饰改变时发送(例如 :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>` 被设置或窗口进入/退出全屏模式)。
|
||
|
||
\ **注意:**\ 该标志仅在 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``
|
||
|
||
窗口左上边缘。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_TOP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_TOP** = ``1``
|
||
|
||
窗口上边缘。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_TOP_RIGHT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_TOP_RIGHT** = ``2``
|
||
|
||
窗口右上边缘。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_LEFT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_LEFT** = ``3``
|
||
|
||
窗口左边缘。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_RIGHT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_RIGHT** = ``4``
|
||
|
||
窗口右边缘。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_LEFT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_BOTTOM_LEFT** = ``5``
|
||
|
||
窗口左下边缘。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_BOTTOM** = ``6``
|
||
|
||
窗口下边缘。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_RIGHT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_BOTTOM_RIGHT** = ``7``
|
||
|
||
窗口右下边缘。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_EDGE_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_MAX** = ``8``
|
||
|
||
代表 :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``
|
||
|
||
没有垂直同步,这意味着引擎将尽可能快地显示帧(可能会有可见的撕裂)。帧速率是未限制的(不考虑 :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``
|
||
|
||
默认的垂直同步模式,图像只在垂直消隐间隔显示(没有可见的撕裂)。帧速率受显示器刷新率的限制(不考虑 :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``
|
||
|
||
当帧速率降至屏幕刷新率以下以减少卡顿(可能有可见的撕裂)时,行为类似于 :ref:`VSYNC_DISABLED<class_DisplayServer_constant_VSYNC_DISABLED>`\ 。否则,启用垂直同步以避免撕裂。帧速率受显示器刷新率的限制(不考虑 :ref:`Engine.max_fps<class_Engine_property_max_fps>`\ )。使用兼容渲染方法时表现得像 :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>`\ 。
|
||
|
||
.. _class_DisplayServer_constant_VSYNC_MAILBOX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_MAILBOX** = ``3``
|
||
|
||
在垂直消隐间隔显示队列中的最新图像,同时对其他图像渲染(没有可见的撕裂)。帧速率是未限制的(不考虑 :ref:`Engine.max_fps<class_Engine_property_max_fps>`\ )。
|
||
|
||
虽然不能保证,但可以尽可能快地渲染图像,这可能会减少输入滞后(也称为“快速”V-Sync 模式)。\ :ref:`VSYNC_MAILBOX<class_DisplayServer_constant_VSYNC_MAILBOX>` 在渲染的帧数至少是显示器刷新率的两倍时效果最佳。使用兼容渲染方法时表现得像 :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>`\ 。
|
||
|
||
.. 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``
|
||
|
||
显示器句柄:
|
||
|
||
- Linux(X11):显示器的 ``X11::Display*``\ 。
|
||
|
||
- Linux(Wayland):显示器的 ``wl_display``\ 。
|
||
|
||
- Android:显示器的 ``EGLDisplay``\ 。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_HANDLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_HANDLE** = ``1``
|
||
|
||
窗口句柄:
|
||
|
||
- Windows:窗口的 ``HWND``\ 。
|
||
|
||
- Linux(X11):窗口的 ``X11::Window*``\ 。
|
||
|
||
- Linux(Wayland):窗口的 ``wl_surface``\ 。
|
||
|
||
- macOS:窗口的 ``NSWindow*``\ 。
|
||
|
||
- iOS:视图控制器的 ``UIViewController*``\ 。
|
||
|
||
- Android:Activity 的 ``jObject``\ 。
|
||
|
||
.. _class_DisplayServer_constant_WINDOW_VIEW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_VIEW** = ``2``
|
||
|
||
窗口视图:
|
||
|
||
- Windows:窗口的 ``HDC``\ (仅适用于 Compatibility 渲染器)。
|
||
|
||
- macOS:窗口主视图的 ``NSView*``\ 。
|
||
|
||
- iOS:窗口主视图的 ``UIView*``\ 。
|
||
|
||
.. _class_DisplayServer_constant_OPENGL_CONTEXT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandleType<enum_DisplayServer_HandleType>` **OPENGL_CONTEXT** = ``3``
|
||
|
||
OpenGL 上下文(仅适用于 Compatibility 渲染器):
|
||
|
||
- Windows:窗口的 ``HGLRC``\ (原生 GL)或窗口的 ``EGLContext``\ (ANGLE)。
|
||
|
||
- Linux(X11):窗口的 ``GLXContext*``\ 。
|
||
|
||
- Linux(Wayland):窗口的 ``EGLContext``\ 。
|
||
|
||
- macOS:窗口的 ``NSOpenGLContext*``\ (原生 GL)或窗口的 ``EGLContext``\ (ANGLE)。
|
||
|
||
- Android:窗口的 ``EGLContext``\ 。
|
||
|
||
.. _class_DisplayServer_constant_EGL_DISPLAY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandleType<enum_DisplayServer_HandleType>` **EGL_DISPLAY** = ``4``
|
||
|
||
- Windows:窗口的 ``EGLDisplay``\ (ANGLE)。
|
||
|
||
- macOS:窗口的 ``EGLDisplay``\ (ANGLE)。
|
||
|
||
- Linux(Wayland):窗口的 ``EGLDisplay``\ 。
|
||
|
||
.. _class_DisplayServer_constant_EGL_CONFIG:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandleType<enum_DisplayServer_HandleType>` **EGL_CONFIG** = ``5``
|
||
|
||
- Windows:窗口的 ``EGLConfig``\ (ANGLE)。
|
||
|
||
- macOS:窗口的 ``EGLConfig``\ (ANGLE)。
|
||
|
||
- Linux(Wayland):窗口的 ``EGLConfig``\ 。
|
||
|
||
.. 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``
|
||
|
||
发言开始。
|
||
|
||
.. _class_DisplayServer_constant_TTS_UTTERANCE_ENDED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_ENDED** = ``1``
|
||
|
||
发言顺利结束。
|
||
|
||
.. _class_DisplayServer_constant_TTS_UTTERANCE_CANCELED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_CANCELED** = ``2``
|
||
|
||
发言取消,或者 TTS 服务无法处理。
|
||
|
||
.. _class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_BOUNDARY** = ``3``
|
||
|
||
发言到达单词或句子的边界。
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
常量
|
||
----
|
||
|
||
.. _class_DisplayServer_constant_INVALID_SCREEN:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**INVALID_SCREEN** = ``-1`` :ref:`🔗<class_DisplayServer_constant_INVALID_SCREEN>`
|
||
|
||
指向一个不存在屏幕的 ID。如果没有屏幕与请求的结果相匹配,某些 **DisplayServer** 方法将返回这个 ID。
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**SCREEN_WITH_MOUSE_FOCUS** = ``-4`` :ref:`🔗<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`
|
||
|
||
表示包含鼠标指针的屏幕。
|
||
|
||
\ **注意:**\ 在 Android、iOS、Web、Linux(Wayland)上,该常量始终代表索引 ``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>`
|
||
|
||
表示包含具有键盘焦点的窗口的屏幕。
|
||
|
||
\ **注意:**\ 在 Android、iOS、Web、Linux(Wayland)上,该常量始终代表索引 ``0`` 处的屏幕。
|
||
|
||
.. _class_DisplayServer_constant_SCREEN_PRIMARY:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**SCREEN_PRIMARY** = ``-2`` :ref:`🔗<class_DisplayServer_constant_SCREEN_PRIMARY>`
|
||
|
||
代表主屏幕。
|
||
|
||
\ **注意:**\ 在 Android、iOS、Web、Linux(Wayland)上,该常量始终代表索引 ``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>`
|
||
|
||
代表主窗口所在的屏幕。这通常是允许指定多个屏幕之一的函数中的默认值。
|
||
|
||
\ **注意:**\ 在 Android、iOS、Web、Linux(Wayland)上,该常量始终代表索引 ``0`` 处的屏幕。
|
||
|
||
.. _class_DisplayServer_constant_MAIN_WINDOW_ID:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**MAIN_WINDOW_ID** = ``0`` :ref:`🔗<class_DisplayServer_constant_MAIN_WINDOW_ID>`
|
||
|
||
主窗口的 ID,可以传给需要 ``window_id`` 的方法,该窗口由引擎生成。
|
||
|
||
.. _class_DisplayServer_constant_INVALID_WINDOW_ID:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**INVALID_WINDOW_ID** = ``-1`` :ref:`🔗<class_DisplayServer_constant_INVALID_WINDOW_ID>`
|
||
|
||
指向一个不存在窗口的 ID。如果没有窗口与请求的结果相匹配,某些 **DisplayServer** 方法将返回这个 ID。
|
||
|
||
.. _class_DisplayServer_constant_INVALID_INDICATOR_ID:
|
||
|
||
.. rst-class:: classref-constant
|
||
|
||
**INVALID_INDICATOR_ID** = ``-1`` :ref:`🔗<class_DisplayServer_constant_INVALID_INDICATOR_ID>`
|
||
|
||
引用不存在的应用程序状态指示器的 ID。
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
方法说明
|
||
--------
|
||
|
||
.. _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>`
|
||
|
||
新建空的无障碍元素资源。
|
||
|
||
\ **注意:**\ 每个 :ref:`Node<class_Node>` 都会自动创建并释放无障碍元素。一般来说不应手动调用该函数。
|
||
|
||
.. 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>`
|
||
|
||
新建空的无障碍子元素资源。子元素可用于为非 :ref:`Node<class_Node>` 对象提供无障碍信息,例如列表项、表格单元格或菜单项。子元素在父元素被释放时会自动释放,也可以通过 :ref:`accessibility_free_element()<class_DisplayServer_method_accessibility_free_element>` 方法提前释放。
|
||
|
||
.. 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>`
|
||
|
||
返回操作系统原生窗口的主要无障碍元素。
|
||
|
||
.. 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>`
|
||
|
||
如果 ``id`` 是有效的无障碍元素,则返回 ``true``\ 。
|
||
|
||
.. 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>`
|
||
|
||
设置辅助应用的窗口聚焦状态。
|
||
|
||
\ **注意:**\ 该方法在 Linux、macOS 和 Windows 上实现。
|
||
|
||
\ **注意:**\ 仅限高级用户!\ :ref:`Window<class_Window>` 对象会自动调用此方法。
|
||
|
||
.. 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>`
|
||
|
||
设置辅助应用的窗口外部边界(带装饰)和内部边界(不带装饰)。
|
||
|
||
\ **注意:**\ 该方法在 Linux、macOS 和 Windows 上实现。
|
||
|
||
\ **注意:**\ 仅限高级用户!\ :ref:`Window<class_Window>` 对象会自动调用此方法。
|
||
|
||
.. 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>`
|
||
|
||
如果应该使用高对比度用户界面主题则返回 ``1``\ ,否则返回 ``0``\ 。如果状态未知则返回 ``-1``\ 。
|
||
|
||
\ **注意:**\ 该方法在 Linux(X11/Wayland、GNOME)、macOS 和 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>`
|
||
|
||
如果应禁用闪烁、闪烁等可能导致光敏性癫痫用户发作的动态内容则返回 ``1``\ ,否则返回 ``0``\ 。如果状态未知则返回 ``-1``\ 。
|
||
|
||
\ **注意:**\ 该方法在 macOS 和 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>`
|
||
|
||
如果应禁用背景图像、透明度等可能降低前景与背景对比度的特性则返回 ``1``\ ,否则返回 ``0``\ 。如果状态未知则返回 ``-1``\ 。
|
||
|
||
\ **注意:**\ 该方法在 macOS 和 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>`
|
||
|
||
添加无障碍动作的回调(可以通过使用特殊的屏幕阅读器命令或盲文显示器上的按钮执行的动作),并将该动作标记为支持。动作回调接收一个 :ref:`Variant<class_Variant>` 参数,取值由动作类型决定。
|
||
|
||
.. 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>`
|
||
|
||
添加子级无障碍元素。
|
||
|
||
\ **注意:**\ :ref:`Node<class_Node>` 子节点和子元素会自动添加至子级列表。
|
||
|
||
.. 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>`
|
||
|
||
添加对自定义无障碍动作的支持。\ ``action_id`` 会作为参数传递给 :ref:`ACTION_CUSTOM<class_DisplayServer_constant_ACTION_CUSTOM>` 动作的回调。
|
||
|
||
.. 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>`
|
||
|
||
添加由该元素控制的元素。
|
||
|
||
.. 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>`
|
||
|
||
添加描述该元素的元素。
|
||
|
||
.. 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>`
|
||
|
||
添加补充该元素的元素。
|
||
|
||
.. 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>`
|
||
|
||
添加该元素流入的元素。
|
||
|
||
.. 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>`
|
||
|
||
添加作为该元素标签的元素。
|
||
|
||
.. 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>`
|
||
|
||
添加同一单选组中的元素。
|
||
|
||
\ **注意:**\ 单选组中的每个元素都应该调用该方法,使用其他元素作为 ``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>`
|
||
|
||
添加该元素的活动派生元素。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的背景色。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的边界框,相对于节点的位置。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的复选状态。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的类名。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的颜色值。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的无障碍描述。
|
||
|
||
.. 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>`
|
||
|
||
设置包含该元素错误消息的元素。
|
||
|
||
.. 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>`
|
||
|
||
设置为元素名添加的元素无障碍额外信息。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的标志。
|
||
|
||
.. 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>`
|
||
|
||
设置当前聚焦的元素。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的前景色。
|
||
|
||
.. 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>`
|
||
|
||
设置链接的目标元素。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的文本语言。
|
||
|
||
.. 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>`
|
||
|
||
设置列表中的项目数。
|
||
|
||
.. 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>`
|
||
|
||
设置列表项/树项目的展开状态。
|
||
|
||
.. 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>`
|
||
|
||
设置元素在列表中的位置。
|
||
|
||
.. 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>`
|
||
|
||
设置元素在列表中的层级。
|
||
|
||
.. 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>`
|
||
|
||
设置列表项/树项目的选中状态。
|
||
|
||
.. 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>`
|
||
|
||
设置列表元素的朝向。
|
||
|
||
.. 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>`
|
||
|
||
设置实时区域更新的优先级。
|
||
|
||
.. 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>`
|
||
|
||
将元素设置为分组的成员。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的无障碍名称。
|
||
|
||
.. 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>`
|
||
|
||
设置位于同一行的下一个元素。
|
||
|
||
.. 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>`
|
||
|
||
设置数值的跳变。
|
||
|
||
.. 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>`
|
||
|
||
设置数值的范围。
|
||
|
||
.. 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>`
|
||
|
||
设置数值的步长。
|
||
|
||
.. 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>`
|
||
|
||
设置数值。
|
||
|
||
.. 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>`
|
||
|
||
设置占位文本。
|
||
|
||
.. 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>`
|
||
|
||
设置弹出按钮的弹出类型。
|
||
|
||
.. 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>`
|
||
|
||
设置位于同一行的上一个元素。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的无障碍角色。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的无障碍角色描述文本。
|
||
|
||
.. 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>`
|
||
|
||
设置滚动条 X 位置。
|
||
|
||
.. 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>`
|
||
|
||
设置滚动条 X 范围。
|
||
|
||
.. 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>`
|
||
|
||
设置滚动条 Y 位置。
|
||
|
||
.. 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>`
|
||
|
||
设置滚动条 Y 范围。
|
||
|
||
.. 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>`
|
||
|
||
设置元素使用的键盘快捷键列表。
|
||
|
||
.. 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>`
|
||
|
||
设置当前复选状态的人类可读描述。
|
||
|
||
.. 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>`
|
||
|
||
设置单元格在表格中的位置。
|
||
|
||
.. 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>`
|
||
|
||
设置单元格的跨行/跨列。
|
||
|
||
.. 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>`
|
||
|
||
设置表格中的列数。
|
||
|
||
.. 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>`
|
||
|
||
设置列的位置。
|
||
|
||
.. 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>`
|
||
|
||
设置表格中的行数。
|
||
|
||
.. 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>`
|
||
|
||
设置行在表格中的位置。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的文本对齐。
|
||
|
||
.. 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>`
|
||
|
||
设置文本的下划线、上划线、删除线。
|
||
|
||
.. 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>`
|
||
|
||
设置文本朝向。
|
||
|
||
.. 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>`
|
||
|
||
设置文本框中的文本选择。\ ``text_start_id`` 和 ``text_end_id`` 应当是使用 :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_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>`
|
||
|
||
设置工具提示文本。
|
||
|
||
.. 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>`
|
||
|
||
设置元素的 2D 变换。
|
||
|
||
.. 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>`
|
||
|
||
设置链接 URL。
|
||
|
||
.. 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>`
|
||
|
||
设置元素文本值。
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_beep:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **beep**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_beep>`
|
||
|
||
播放操作系统的“哔”声,需要操作系统支持。因为发出声音的是操作系统,所以即便应用程序被静音也能听到“哔”声。这一功能可能被用户在操作系统层面禁用。
|
||
|
||
\ **注意:**\ 该方法在 macOS、Linux(X11/Wayland)和 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>`
|
||
|
||
如果可能,将用户的剪贴板作为字符串返回。
|
||
|
||
.. 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>`
|
||
|
||
如果可能,将用户的剪贴板作为图像返回。
|
||
|
||
\ **注意:**\ 该方法使用复制的像素数据(例如来自图像编辑软件或 Web 浏览器的数据),而不是从文件资源管理器复制的图像文件。
|
||
|
||
.. 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>`
|
||
|
||
如果可能的话,将用户的\ `主 <https://unix.stackexchange.com/questions/139191/whats-the-difference-between-primary-selection-and-clipboard-buffer>`__\ 剪贴板作为字符串返回。这是当用户在任何应用程序中选择文本时设置的剪贴板,而不是在按下 :kbd:`Ctrl + C` 时设置的。然后可以通过在支持主剪贴板机制的任何应用程序中,通过点击鼠标中键来粘贴该剪贴板数据。
|
||
|
||
\ **注意:**\ 这个方法只在 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>`
|
||
|
||
如果用户的剪贴板中有文本内容,则返回 ``true``\ 。
|
||
|
||
.. 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>`
|
||
|
||
如果用户的剪贴板中有图像内容,则返回 ``true``\ 。
|
||
|
||
.. 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>`
|
||
|
||
将用户的剪贴板内容设置为给定的字符串。
|
||
|
||
.. 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>`
|
||
|
||
将用户的\ `主剪贴板 <https://unix.stackexchange.com/questions/139191/whats-the-difference-between-primary-selection-and-clipboard-buffer>`__\ 内容设置为给定的字符串。这是用户在应用程序中选中文本时设置的剪贴板,不是按 :kbd:`Ctrl + C` 时设置的。设置后可以在任何支持主剪贴板机制的应用程序中通过点击鼠标中键粘贴剪贴板数据。
|
||
|
||
\ **注意:**\ 这个方法只在 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>`
|
||
|
||
显示操作系统原生取色器。
|
||
|
||
回调的参数为:\ ``status: bool, color: Color``\ 。
|
||
|
||
\ **注意:**\ 如果显示服务器具有 :ref:`FEATURE_NATIVE_COLOR_PICKER<class_DisplayServer_constant_FEATURE_NATIVE_COLOR_PICKER>` 功能,则该方法已被实现。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
新建应用程序状态指示器,可以指定图标、工具提示以及激活回调。
|
||
|
||
\ ``callback`` 应该接受两个参数:按下的鼠标按键(\ :ref:`MouseButton<enum_@GlobalScope_MouseButton>` 常量)以及点击位置(屏幕坐标 :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>`
|
||
|
||
返回默认鼠标光标形状,由 :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>`
|
||
|
||
为给定的形状 ``shape`` 设置自定义鼠标指针图像。这意味着用户的操作系统和鼠标光标主题不再影响鼠标光标的外观。
|
||
|
||
\ ``cursor`` 可以是 :ref:`Texture2D<class_Texture2D>` 或 :ref:`Image<class_Image>`\ ,并且它不应大于 256×256 才能正确显示。还可以选择设置 ``hotspot`` 以偏移图像相对于点击点的位置。默认情况下,\ ``hotspot`` 被设置为图像的左上角。另见 :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>`
|
||
|
||
设置默认的鼠标光标形状。光标的外观将根据用户的操作系统和鼠标光标主题而变化。另见 :ref:`cursor_get_shape()<class_DisplayServer_method_cursor_get_shape>` 和 :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>`
|
||
|
||
移除应用程序状态指示器。
|
||
|
||
.. 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>`
|
||
|
||
显示文本输入对话框,该对话框使用操作系统原生外观。\ ``callback`` 应接受包含文本字段内容的单个 :ref:`String<class_String>` 参数。
|
||
|
||
\ **注意:**\ 如果显示服务器具有 :ref:`FEATURE_NATIVE_DIALOG_INPUT<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_INPUT>` 功能,则实现该方法。支持的平台包括 macOS、Windows 和 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>`
|
||
|
||
显示文本对话框,该对话框使用操作系统原生外观。\ ``callback`` 应接受与按下按钮的索引相对应的单个 :ref:`int<class_int>` 参数。
|
||
|
||
\ **注意:**\ 如果显示服务器具有 :ref:`FEATURE_NATIVE_DIALOG<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG>` 功能,则实现该方法。支持的平台包括 macOS、Windows 和 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>`
|
||
|
||
让进程 PID ``process_id`` 窃取该窗口的焦点。换句话说,会禁用操作系统对指定 PID 的焦点窃取保护。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
强制窗口管理器进行处理,会忽略所有 :ref:`InputEvent<class_InputEvent>`\ 。另见 :ref:`process_events()<class_DisplayServer_method_process_events>`\ 。
|
||
|
||
\ **注意:**\ 这个方法在 Windows 和 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>`
|
||
|
||
返回操作系统主题色。如果主题色未知则返回 ``Color(0, 0, 0, 0)``\ 。
|
||
|
||
\ **注意:**\ 该方法在 macOS、Windows、Android、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>`
|
||
|
||
返回操作系统主题基色(默认控件背景)。如果基色未知,则返回 ``Color(0, 0, 0, 0)``\ 。
|
||
|
||
\ **注意:**\ 该方法在 macOS、Windows 和 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>`
|
||
|
||
返回 :ref:`Rect2<class_Rect2>` 的 :ref:`Array<class_Array>`\ ,其中每个都是显示切口或凹口的边界矩形。这些是相机和传感器使用的无边框屏幕上的非功能区域。如果设备没有切口,则返回一个空数组。另见 :ref:`get_display_safe_area()<class_DisplayServer_method_get_display_safe_area>`\ 。
|
||
|
||
\ **注意:**\ 目前仅在 Android 上实现。其他平台将返回一个空数组,即使它们确实有显示切口或凹口。
|
||
|
||
.. 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>`
|
||
|
||
返回显示器上未被遮挡的区域,交互式空间应当在此区域中渲染。另见 :ref:`get_display_cutouts()<class_DisplayServer_method_get_display_cutouts>`\ 。
|
||
|
||
\ **注意:**\ 当前仅在 Android 和 iOS 上实现。其他平台上会使用 ``screen_get_usable_rect(SCREEN_OF_MAIN_WINDOW)`` 作为回退返回。另见 :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>`
|
||
|
||
返回包含具有键盘焦点的窗口的屏幕索引,如果没有被聚焦的窗口则返回主屏幕。
|
||
|
||
\ **注意:**\ 该方法在 Linux/X11、macOS、Windows 上实现。该方法在其他平台上始终返回主屏幕。
|
||
|
||
.. 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>`
|
||
|
||
返回当前使用的 **DisplayServer** 的名称。大多数操作系统只有一种 **DisplayServer**\ ,但 Linux 可以使用多种 **DisplayServer**\ (目前有 X11 和 Wayland 两种)。
|
||
|
||
内置显示服务器的名称有 ``Windows``\ 、\ ``macOS``\ 、\ ``X11``\ (Linux)、\ ``Wayland``\ (Linux)、\ ``Android``\ 、\ ``iOS``\ 、\ ``web``\ (HTML5)、\ ``headless``\ (使用 ``--headless`` :doc:`命令行参数 <../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>`
|
||
|
||
返回可用显示器的数量。
|
||
|
||
\ **注意:**\ 该方法在 Linux(X11 和 Wayland)、macOS、Windows 上实现。该方法在其他平台上始终返回 ``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>`
|
||
|
||
返回与给定矩形重叠最多的屏幕的索引。如果矩形没有与任何屏幕重叠或矩形面积为零,则返回 :ref:`INVALID_SCREEN<class_DisplayServer_constant_INVALID_SCREEN>`\ 。
|
||
|
||
.. 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>`
|
||
|
||
如果对话框中的\ **确定**\ 和\ **取消**\ 按钮进行了交换,则返回 ``true``\ 。在 Windows 上默认启用,从而遵循界面规范,可以使用 :ref:`ProjectSettings.gui/common/swap_cancel_ok<class_ProjectSettings_property_gui/common/swap_cancel_ok>` 开关。
|
||
|
||
\ **注意:**\ 由 :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>`
|
||
|
||
返回位于指定屏幕位置 ``position`` 的窗口 ID(单位为像素)。使用多个监视器时,屏幕位置是相对于虚拟桌面区域的位置。如果多监视器中使用了不同的屏幕分辨率或朝向,原点有可能位于所有显示器之外,类似于:
|
||
|
||
.. 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>`
|
||
|
||
返回属于该进程的 Godot 窗口 ID 列表。
|
||
|
||
\ **注意:**\ 这个列表中不含原生对话框。
|
||
|
||
.. 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
向 ID 为 ``menu_root`` 的全局菜单添加新的可勾选菜单项,显示的文本为 ``label``\ 。
|
||
|
||
返回插入菜单项的索引,不保证与 ``index`` 的值相同。
|
||
|
||
还可以定义键盘快捷键 ``accelerator``\ ,按下后即便该菜单按钮尚未打开,也会进行触发。\ ``accelerator`` 通常是将 :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` 和 :ref:`Key<enum_@GlobalScope_Key>` 用按位或操作进行的组合,例如 ``KEY_MASK_CTRL | KEY_A``\ (\ :kbd:`Ctrl + A`\ )。
|
||
|
||
\ **注意:**\ ``callback`` 和 ``key_callback`` Callable 均只接受一个 Variant 参数,传入 Callable 的参数是传给 ``tag`` 的参数。
|
||
|
||
\ **注意:**\ 该方法仅在 macOS 上实现。
|
||
|
||
\ **支持的系统菜单 ID:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - 主菜单(macOS)。
|
||
"_dock" - 程序坞弹出菜单(macOS)。
|
||
"_apple" - Apple 菜单(macOS,在“服务”之前添加的自定义项目)。
|
||
"_window" - 窗口菜单(macOS,“将所有内容置于前面”之后添加的自定义项目)。
|
||
"_help" - 帮助菜单 (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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
向 ID 为 ``menu_root`` 的全局菜单添加新的可勾选菜单项,显示的文本为 ``label``\ ,图标为 ``icon``\ 。
|
||
|
||
返回插入菜单项的索引,不保证与 ``index`` 的值相同。
|
||
|
||
还可以定义键盘快捷键 ``accelerator``\ ,按下后即便该菜单按钮尚未打开,也会进行触发。\ ``accelerator`` 通常是将 :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` 和 :ref:`Key<enum_@GlobalScope_Key>` 用按位或操作进行的组合,例如 ``KEY_MASK_CTRL | KEY_A``\ (\ :kbd:`Ctrl + A`\ )。
|
||
|
||
\ **注意:**\ ``callback`` 和 ``key_callback`` Callable 均只接受一个 Variant 参数,传入 Callable 的参数是传给 ``tag`` 的参数。
|
||
|
||
\ **注意:**\ 该方法仅在 macOS 上实现。
|
||
|
||
\ **支持的系统菜单 ID:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - 主菜单(macOS)。
|
||
"_dock" - 程序坞弹出菜单(macOS)。
|
||
"_apple" - Apple 菜单(macOS,在“服务”之前添加的自定义项目)。
|
||
"_window" - 窗口菜单(macOS,“将所有内容置于前面”之后添加的自定义项目)。
|
||
"_help" - 帮助菜单 (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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
向 ID 为 ``menu_root`` 的全局菜单添加新的菜单项,显示的文本为 ``label``\ ,图标为 ``icon``\ 。
|
||
|
||
返回插入菜单项的索引,不保证与 ``index`` 的值相同。
|
||
|
||
还可以定义键盘快捷键 ``accelerator``\ ,按下后即便该菜单按钮尚未打开,也会进行触发。\ ``accelerator`` 通常是将 :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` 和 :ref:`Key<enum_@GlobalScope_Key>` 用按位或操作进行的组合,例如 ``KEY_MASK_CTRL | KEY_A``\ (\ :kbd:`Ctrl + A`\ )。
|
||
|
||
\ **注意:**\ ``callback`` 和 ``key_callback`` Callable 均只接受一个 Variant 参数,传入 Callable 的参数是传给 ``tag`` 的参数。
|
||
|
||
\ **注意:**\ 该方法仅在 macOS 上实现。
|
||
|
||
\ **支持的系统菜单 ID:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - 主菜单(macOS)。
|
||
"_dock" - 程序坞弹出菜单(macOS)。
|
||
"_apple" - Apple 菜单(macOS,在“服务”之前添加的自定义项目)。
|
||
"_window" - 窗口菜单(macOS,“将所有内容置于前面”之后添加的自定义项目)。
|
||
"_help" - 帮助菜单 (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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
向 ID 为 ``menu_root`` 的全局菜单添加新的单选菜单项,显示的文本为 ``label``\ ,图标为 ``icon``\ 。
|
||
|
||
返回插入菜单项的索引,不保证与 ``index`` 的值相同。
|
||
|
||
还可以定义键盘快捷键 ``accelerator``\ ,按下后即便该菜单按钮尚未打开,也会进行触发。\ ``accelerator`` 通常是将 :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` 和 :ref:`Key<enum_@GlobalScope_Key>` 用按位或操作进行的组合,例如 ``KEY_MASK_CTRL | KEY_A``\ (\ :kbd:`Ctrl + A`\ )。
|
||
|
||
\ **注意:**\ 单选菜单项只负责显示选中标记,并没有任何内置检查行为,必须手动进行选中、取消选中的操作。关于如何进行控制的更多信息见 :ref:`global_menu_set_item_checked()<class_DisplayServer_method_global_menu_set_item_checked>`\ 。
|
||
|
||
\ **注意:**\ ``callback`` 和 ``key_callback`` Callable 均只接受一个 Variant 参数,传入 Callable 的参数是传给 ``tag`` 的参数。
|
||
|
||
\ **注意:**\ 该方法仅在 macOS 上实现。
|
||
|
||
\ **支持的系统菜单 ID:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - 主菜单(macOS)。
|
||
"_dock" - 程序坞弹出菜单(macOS)。
|
||
"_apple" - Apple 菜单(macOS,在“服务”之前添加的自定义项目)。
|
||
"_window" - 窗口菜单(macOS,“将所有内容置于前面”之后添加的自定义项目)。
|
||
"_help" - 帮助菜单 (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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
向 ID 为 ``menu_root`` 的全局菜单添加新的菜单项,显示的文本为 ``label``\ 。
|
||
|
||
返回插入菜单项的索引,不保证与 ``index`` 的值相同。
|
||
|
||
还可以定义键盘快捷键 ``accelerator``\ ,按下后即便该菜单按钮尚未打开,也会进行触发。\ ``accelerator`` 通常是将 :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` 和 :ref:`Key<enum_@GlobalScope_Key>` 用按位或操作进行的组合,例如 ``KEY_MASK_CTRL | KEY_A``\ (\ :kbd:`Ctrl + A`\ )。
|
||
|
||
\ **注意:**\ ``callback`` 和 ``key_callback`` Callable 均只接受一个 Variant 参数,传入 Callable 的参数是传给 ``tag`` 的参数。
|
||
|
||
\ **注意:**\ 该方法仅在 macOS 上实现。
|
||
|
||
\ **支持的系统菜单 ID:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - 主菜单(macOS)。
|
||
"_dock" - 程序坞弹出菜单(macOS)。
|
||
"_apple" - Apple 菜单(macOS,在“服务”之前添加的自定义项目)。
|
||
"_window" - 窗口菜单(macOS,“将所有内容置于前面”之后添加的自定义项目)。
|
||
"_help" - 帮助菜单 (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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
向 ID 为 ``menu_root`` 的全局菜单添加新的菜单项,显示的文本为 ``label``\ 。
|
||
|
||
与常规的二态菜单项不同,多状态菜单项的状态可以多于两个,由 ``max_states`` 定义。每点击或激活该菜单项一次,状态就会加一。默认值由 ``default_state`` 定义。
|
||
|
||
返回插入菜单项的索引,不保证与 ``index`` 的值相同。
|
||
|
||
还可以定义键盘快捷键 ``accelerator``\ ,按下后即便该菜单按钮尚未打开,也会进行触发。\ ``accelerator`` 通常是将 :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` 和 :ref:`Key<enum_@GlobalScope_Key>` 用按位或操作进行的组合,例如 ``KEY_MASK_CTRL | KEY_A``\ (\ :kbd:`Ctrl + A`\ )。
|
||
|
||
\ **注意:**\ 默认情况下不会展示当前菜单项的状态,应该手动更改。
|
||
|
||
\ **注意:**\ ``callback`` 和 ``key_callback`` Callable 均只接受一个 Variant 参数,传入 Callable 的参数是传给 ``tag`` 的参数。
|
||
|
||
\ **注意:**\ 该方法仅在 macOS 上实现。
|
||
|
||
\ **支持的系统菜单 ID:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - 主菜单(macOS)。
|
||
"_dock" - 程序坞弹出菜单(macOS)。
|
||
"_apple" - Apple 菜单(macOS,在“服务”之前添加的自定义项目)。
|
||
"_window" - 窗口菜单(macOS,“将所有内容置于前面”之后添加的自定义项目)。
|
||
"_help" - 帮助菜单 (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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
向 ID 为 ``menu_root`` 的全局菜单添加新的单选菜单项,显示的文本为 ``label``\ 。
|
||
|
||
返回插入菜单项的索引,不保证与 ``index`` 的值相同。
|
||
|
||
还可以定义键盘快捷键 ``accelerator``\ ,按下后即便该菜单按钮尚未打开,也会进行触发。\ ``accelerator`` 通常是将 :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` 和 :ref:`Key<enum_@GlobalScope_Key>` 用按位或操作进行的组合,例如 ``KEY_MASK_CTRL | KEY_A``\ (\ :kbd:`Ctrl + A`\ )。
|
||
|
||
\ **注意:**\ 单选菜单项只负责显示选中标记,并没有任何内置检查行为,必须手动进行选中、取消选中的操作。关于如何进行控制的更多信息见 :ref:`global_menu_set_item_checked()<class_DisplayServer_method_global_menu_set_item_checked>`\ 。
|
||
|
||
\ **注意:**\ ``callback`` 和 ``key_callback`` Callable 均只接受一个 Variant 参数,传入 Callable 的参数是传给 ``tag`` 的参数。
|
||
|
||
\ **注意:**\ 该方法仅在 macOS 上实现。
|
||
|
||
\ **支持的系统菜单 ID:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - 主菜单(macOS)。
|
||
"_dock" - 程序坞弹出菜单(macOS)。
|
||
"_apple" - Apple 菜单(macOS,在“服务”之前添加的自定义项目)。
|
||
"_window" - 窗口菜单(macOS,“将所有内容置于前面”之后添加的自定义项目)。
|
||
"_help" - 帮助菜单 (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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
向 ID 为 ``menu_root`` 的全局菜单添加分隔符。分隔符也拥有索引。
|
||
|
||
返回插入菜单项的索引,不保证与 ``index`` 的值相同。
|
||
|
||
\ **注意:**\ 该方法仅在 macOS 上实现。
|
||
|
||
\ **支持的系统菜单 ID:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - 主菜单(macOS)。
|
||
"_dock" - 程序坞弹出菜单(macOS)。
|
||
"_apple" - Apple 菜单(macOS,在“服务”之前添加的自定义项目)。
|
||
"_window" - 窗口菜单(macOS,“将所有内容置于前面”之后添加的自定义项目)。
|
||
"_help" - 帮助菜单 (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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
向 ID 为 ``menu_root`` 的全局菜单添加作为子菜单的菜单项。\ ``submenu`` 参数为全局菜单根菜单项的 ID,会在点击该菜单项时显示
|
||
|
||
返回插入菜单项的索引,不保证与 ``index`` 的值相同。
|
||
|
||
\ **注意:**\ 该方法仅在 macOS 上实现。
|
||
|
||
\ **支持的系统菜单 ID:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - 主菜单(macOS)。
|
||
"_dock" - 程序坞弹出菜单(macOS)。
|
||
"_apple" - Apple 菜单(macOS,在“服务”之前添加的自定义项目)。
|
||
"_window" - 窗口菜单(macOS,“将所有内容置于前面”之后添加的自定义项目)。
|
||
"_help" - 帮助菜单 (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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
移除 ID 为 ``menu_root`` 的全局菜单中的所有菜单项。
|
||
|
||
\ **注意:**\ 该方法仅在 macOS 上实现。
|
||
|
||
\ **支持的系统菜单 ID:**\
|
||
|
||
.. code:: text
|
||
|
||
"_main" - 主菜单(macOS)。
|
||
"_dock" - 程序坞弹出菜单(macOS)。
|
||
"_apple" - Apple 菜单(macOS,在“服务”之前添加的自定义项目)。
|
||
"_window" - 窗口菜单(macOS,“将所有内容置于前面”之后添加的自定义项目)。
|
||
"_help" - 帮助菜单 (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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回索引为 ``idx`` 的菜单项的快捷键。快捷键是能够激活该菜单项的特殊按键组合,无论该控件是否有焦点。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回索引为 ``idx`` 的菜单项的回调。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回 ID 为 ``menu_root`` 的全局菜单中菜单项的数量。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回索引为 ``idx`` 的菜单项的图标。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回索引为 ``idx`` 的菜单项的水平偏移量。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回标签为指定的 ``tag`` 的菜单项的索引。引擎会自动为每个菜单项分配索引,无法手动设置。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回文本为指定的 ``text`` 的菜单项的索引。引擎会自动为每个菜单项分配索引,无法手动设置。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回索引为 ``idx`` 的菜单项的快捷键回调。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回多状态项的状态数。详见 :ref:`global_menu_add_multistate_item()<class_DisplayServer_method_global_menu_add_multistate_item>`\ 。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回多状态项的状态。详见 :ref:`global_menu_add_multistate_item()<class_DisplayServer_method_global_menu_add_multistate_item>`\ 。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回索引为 ``idx`` 的菜单项的子菜单 ID。关于如何添加子菜单的更多信息见 :ref:`global_menu_add_submenu_item()<class_DisplayServer_method_global_menu_add_submenu_item>`\ 。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回指定菜单项的元数据,可能是任何类型。元数据可以使用 :ref:`global_menu_set_item_tag()<class_DisplayServer_method_global_menu_set_item_tag>` 设置,可以方法地为菜单项关联上下文数据。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回索引为 ``idx`` 的菜单项的文本。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回索引为 ``idx`` 的菜单项所关联的工具提示。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
返回受支持的系统菜单 ID 和名称的字典。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
如果索引为 ``idx`` 的菜单项能够以某种方式选中,即有复选框或单选按钮,则返回 ``true``\ 。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
如果索引为 ``idx`` 的菜单项处于选中状态,则返回 ``true``\ 。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
如果索引为 ``idx`` 的菜单项处于禁用状态,则返回 ``true``\ 。禁用状态下无法被选中,也无法激活动作。
|
||
|
||
关于如何禁用菜单项的更多信息见 :ref:`global_menu_set_item_disabled()<class_DisplayServer_method_global_menu_set_item_disabled>`\ 。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
如果索引为 ``idx`` 的菜单项被隐藏,则返回 ``true``\ 。
|
||
|
||
关于如何隐藏菜单项的更多信息见 :ref:`global_menu_set_item_hidden()<class_DisplayServer_method_global_menu_set_item_hidden>`\ 。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
如果索引为 ``idx`` 的菜单项为单选按钮风格,则返回 ``true``\ 。
|
||
|
||
\ **注意:**\ 仅为装饰作用;必须自行为单选组添加选中、取消选中的逻辑。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
从全局菜单 ``menu_root`` 移除索引为 ``idx`` 的菜单项。
|
||
|
||
\ **注意:**\ 位置在被移除菜单项之后的菜单项的索引号都会减一。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置索引为 ``idx`` 的菜单项的快捷键。\ ``keycode`` 可以是单一 :ref:`Key<enum_@GlobalScope_Key>`\ ,也可以是 :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` 和 :ref:`Key<enum_@GlobalScope_Key>` 用按位或操作进行的组合,例如 ``KEY_MASK_CTRL | KEY_A``\ (\ :kbd:`Ctrl + A`\ )。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置索引为 ``idx`` 的菜单项的回调。回调会在按下菜单项时发出。
|
||
|
||
\ **注意:**\ ``callback`` Callable 只接受一个 Variant 参数,传入 Callable 的参数是创建菜单项时传给 ``tag`` 参数的值。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置索引为 ``idx`` 的菜单项是否为复选框。如果为 ``false``\ ,则会将该菜单项的类型设置为纯文本。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置索引为 ``idx`` 的菜单项的选中状态。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
启用/禁用索引为 ``idx`` 的菜单项。禁用状态下无法被选中,也无法激活动作。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
隐藏/显示索引为 ``idx`` 的菜单项。当它被隐藏时,项目不会出现在菜单中,并且无法调用其操作。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置索引为 ``idx`` 的菜单项的回调。回调会在菜单项被悬停时发出。
|
||
|
||
\ **注意:**\ ``callback`` Callable 需要接受一个 Variant 参数,传入 Callable 的参数是创建菜单项时传给 ``tag`` 参数的值。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
替换指定索引 ``idx`` 的 :ref:`Texture2D<class_Texture2D>` 图标。
|
||
|
||
\ **注意:**\ 该方法仅在 macOS 上实现。
|
||
|
||
\ **注意:**\ 该方法不支持 macOS 的“_dock”菜单项。
|
||
|
||
.. 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置索引为 ``idx`` 的菜单项的水平偏移量。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置索引为 ``idx`` 的菜单项的回调。回调会在激活快捷键时发出。
|
||
|
||
\ **注意:**\ ``key_callback`` Callable 只接受一个 Variant 参数,传入 Callable 的参数是创建菜单项时传给 ``tag`` 参数的值。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置多状态项的状态数。详见 :ref:`global_menu_add_multistate_item()<class_DisplayServer_method_global_menu_add_multistate_item>`\ 。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
将索引为 ``idx`` 的菜单项设置为单选按钮风格。如果为 ``false``\ ,则会将该菜单项的类型设置为纯文本。
|
||
|
||
\ **注意:**\ 仅为装饰作用;必须自行为单选组添加选中、取消选中的逻辑。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置多状态项的状态。详见 :ref:`global_menu_add_multistate_item()<class_DisplayServer_method_global_menu_add_multistate_item>`\ 。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置索引为 ``idx`` 的菜单项的子菜单。子菜单是某个全局菜单根菜单项的 ID,点击该菜单项时会显示子菜单。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置指定菜单项的元数据,可以是任何类型。后续可以使用 :ref:`global_menu_get_item_tag()<class_DisplayServer_method_global_menu_get_item_tag>` 获取,可以方法地为菜单项关联上下文数据。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置索引为 ``idx`` 的菜单项的文本。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
设置索引为 ``idx`` 的菜单项的工具提示 :ref:`String<class_String>`\ 。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
**已弃用:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
|
||
|
||
注册当菜单分别即将显示或关闭时发出的可调用对象。回调方法应该没有参数。
|
||
|
||
.. 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>`
|
||
|
||
如果已通过 :ref:`register_additional_output()<class_DisplayServer_method_register_additional_output>` 注册了任何额外输出,则返回 ``true``\ 。
|
||
|
||
.. 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>`
|
||
|
||
如果当前的 **DisplayServer** 支持指定的特性 ``feature``\ ,则返回 ``true``\ ,否则返回 ``false``\ 。
|
||
|
||
.. 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>`
|
||
|
||
如果连接了物理键盘,则返回 ``true``\ 。
|
||
|
||
\ **注意:**\ 该方法在 Android 和 iOS 上实现。该方法在其他平台上始终返回 ``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>`
|
||
|
||
设置原生帮助系统搜索回调。
|
||
|
||
\ ``search_callback`` 的参数是 ``String search_string, int result_limit``\ ,返回的是包含一对对“key、显示名称”的 :ref:`Dictionary<class_Dictionary>`\ 。用户在\ ``帮助``\ 菜单中输入搜索内容的时候就会调用这个回调。
|
||
|
||
\ ``action_callback`` 的参数是 ``String key``\ 。用户在\ ``帮助``\ 菜单中选择某个搜索结果时就会调用这个回调。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
返回\ `输入法编辑器 <https://zh.wikipedia.org/wiki/%E8%BE%93%E5%85%A5%E6%B3%95>`__\ 编组字符串中选中的文本,\ :ref:`Vector2i<class_Vector2i>` 的 ``x`` 分量为光标的位置,\ ``y`` 则为所选项的长度。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
返回\ `输入法编辑器 <https://zh.wikipedia.org/wiki/%E8%BE%93%E5%85%A5%E6%B3%95>`__\ 窗口中的编组字符串。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
如果操作系统正在使用暗黑模式,则返回 ``true``\ 。
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS、macOS、Windows 和 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>`
|
||
|
||
如果操作系统支持暗黑模式,则返回 ``true``\ 。
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS、macOS、Windows 和 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>`
|
||
|
||
如果触摸事件可用(Android 或 iOS)、在 Web 平台上检测到该功能或如果 :ref:`ProjectSettings.input_devices/pointing/emulate_touch_from_mouse<class_ProjectSettings_property_input_devices/pointing/emulate_touch_from_mouse>` 为 ``true`` 时,则返回 ``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>`
|
||
|
||
如果窗口背景可以设为透明,则返回 ``true``\ 。如果 :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>` 被设置为 ``false``\ ,或者如果渲染器或 OS 合成器不支持透明,则该方法将返回 ``false``\ 。
|
||
|
||
.. 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>`
|
||
|
||
返回激活的键盘布局的索引。
|
||
|
||
\ **注意:**\ 本方法在 Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
将物理(美式 QWERTY)键码 ``keycode`` 转换为激活键盘布局中的键码。
|
||
|
||
\ **注意:**\ 本方法在 Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
将物理(美式 QWERTY)键码 ``keycode`` 转换为活动键盘布局中的按键上印刷的本地化标签。
|
||
|
||
\ **注意:**\ 该方法在 Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
返回键盘布局的数量。
|
||
|
||
\ **注意:**\ 本方法在 Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
返回位于 ``index`` 位置的键盘布局的 ISO-639/BCP-47 语言代码。
|
||
|
||
\ **注意:**\ 本方法在 Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
返回位于 ``index`` 位置的键盘布局的本地化名称。
|
||
|
||
\ **注意:**\ 本方法在 Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
设置激活的键盘布局。
|
||
|
||
\ **注意:**\ 本方法在 Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
以位掩码的形式返回当前鼠标按键的状态(各个按钮是否处于按下状态)。如果同时按下了多个按键,则会同时设置多个比特位。等价于 :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>`
|
||
|
||
返回当前的鼠标模式。另见 :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>`
|
||
|
||
返回鼠标光标的当前位置,使用屏幕坐标。
|
||
|
||
.. 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>`
|
||
|
||
设置当前的鼠标模式。另见 :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>`
|
||
|
||
执行窗口管理器处理,包括输入的清空。另见 :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>`\ 、\ :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>`
|
||
|
||
注册一个 :ref:`Object<class_Object>`\ ,表示除了普通窗口之外还将渲染的额外输出。\ :ref:`Object<class_Object>` 仅用作标识符,稍后可将其传递给 :ref:`unregister_additional_output()<class_DisplayServer_method_unregister_additional_output>`\ 。
|
||
|
||
这可用于防止 Godot 在没有可见普通窗口时跳过渲染。
|
||
|
||
.. 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>`
|
||
|
||
返回指定屏幕的密度,单位为每英寸点数。如果 ``screen`` 无效则返回对应平台的默认值。
|
||
|
||
\ **注意:**\ 下列常量可以当作 ``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>`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`\ 。
|
||
|
||
\ **注意:**\ 在 macOS 上,如果使用小数显示缩放模式,则返回值不准确。
|
||
|
||
\ **注意:**\ 在 Android 设备上,实际屏幕密度分为六种通用密度:
|
||
|
||
.. code:: text
|
||
|
||
ldpi - 120 dpi
|
||
mdpi - 160 dpi
|
||
hdpi - 240 dpi
|
||
xhdpi - 320 dpi
|
||
xxhdpi - 480 dpi
|
||
xxxhdpi - 640 dpi
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS、Linux(X11/Wayland)、macOS、Web、Windows 上实现。该方法在其他平台上始终返回 ``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>`
|
||
|
||
返回屏幕 ``screen`` 的截图。如果 ``screen`` 无效或 **DisplayServer** 无法捕捉到截图,则返回 ``null``\ 。
|
||
|
||
\ **注意:**\ 下列常量可以当作 ``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>`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`\ 。
|
||
|
||
\ **注意:**\ 该方法在 Linux(X11,但非 Wayland)、macOS、Windows 上实现。该方法在其他平台上始终返回 ``null``\ 。
|
||
|
||
\ **注意:**\ 在 macOS 上,该方法需要“屏幕录制”权限。如果未授予该权限,则该方法返回的截图中不包含其他应用程序的窗口以及与该应用程序无关的操作系统元素。
|
||
|
||
.. 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>`
|
||
|
||
返回由 ``rect`` 定义的屏幕区域的屏幕截图。如果 ``rect`` 超出屏幕边界或 **DisplayServer** 无法捕获屏幕截图,则返回 ``null``\ 。
|
||
|
||
\ ** 注意:**\ 该方法在 macOS 和 Windows 上实现,在其他平台上始终返回 ``null``\ 。
|
||
|
||
\ ** 注意:**\ 在 macOS 上,该方法需要“屏幕录制”权限。如果未授予权限,则该方法返回的屏幕截图中将不包含其他应用程序窗口以及与该应用程序无关的操作系统元素。
|
||
|
||
.. 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>`
|
||
|
||
返回所有屏幕的最大缩放系数。
|
||
|
||
\ **注意:**\ 在 macOS 上,如果系统中至少有一个 hiDPI(Retina)屏幕,则返回值为 ``2.0``\ ,在所有其他情况下返回值为 ``1.0`` 。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
返回屏幕 ``screen`` 的当前朝向。另见 :ref:`screen_set_orientation()<class_DisplayServer_method_screen_set_orientation>`\ 。如果 ``screen`` 无效则返回 :ref:`SCREEN_LANDSCAPE<class_DisplayServer_constant_SCREEN_LANDSCAPE>`\ 。
|
||
|
||
\ **注意:**\ 下列常量可以当作 ``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>`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`\ 。
|
||
|
||
\ **注意:**\ 该方法在 Android 和 iOS 上实现。该方法在其他平台上始终返回 :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>`
|
||
|
||
返回屏幕左上角的位置,单位为像素。如果 ``screen`` 无效则返回 :ref:`Vector2i.ZERO<class_Vector2i_constant_ZERO>`\ 。使用多个监视器时,屏幕位置是相对于虚拟桌面区域的位置。如果多监视器中使用了不同的屏幕分辨率或朝向,原点有可能位于所有显示器之外,类似于:
|
||
|
||
.. code:: text
|
||
|
||
* (0, 0) +-------+
|
||
| |
|
||
+-------------+ | |
|
||
| | | |
|
||
| | | |
|
||
+-------------+ +-------+
|
||
|
||
另见\ :ref:`screen_get_size()<class_DisplayServer_method_screen_get_size>`\ 。
|
||
|
||
\ **注意:**\ 下列常量可以当作 ``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>`\ 、\ :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>`
|
||
|
||
返回屏幕的缩放系数,屏幕使用索引号指定。如果 ``screen`` 无效则返回 ``1.0``\ 。
|
||
|
||
\ **注意:**\ 下列常量可以当作 ``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>`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`\ 。
|
||
|
||
\ **注意:**\ 在 macOS 上,hiDPI(视网膜)屏幕返回 ``2.0``\ ,其它所有情况均返回 ``1.0``\ 。
|
||
|
||
\ **注意:**\ 在 Linux(Wayland)上,只有 ``screen`` 为 :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>` 时返回值才是精确的。由于 API 的限制,如果屏幕缩放存在小数点,传入直接的索引号返回的是向上取整后的结果(即 ``1.25`` 会向上取整成 ``2.0``\ )。
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS、Web、macOS 和 Linux(Wayland)上实现。该方法在其他平台上始终返回 ``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>`
|
||
|
||
返回屏幕的大小,单位为像素。另见 :ref:`screen_get_position()<class_DisplayServer_method_screen_get_position>` 和 :ref:`screen_get_usable_rect()<class_DisplayServer_method_screen_get_usable_rect>`\ 。如果 ``screen`` 无效则返回 :ref:`Vector2i.ZERO<class_Vector2i_constant_ZERO>`\ 。
|
||
|
||
\ **注意:**\ 下列常量可以当作 ``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>`\ 、\ :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>`
|
||
|
||
返回屏幕上未被状态栏遮挡部分。另见 :ref:`screen_get_size()<class_DisplayServer_method_screen_get_size>`\ 。
|
||
|
||
\ **注意:**\ 下列常量可以当作 ``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>`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`\ 。
|
||
|
||
\ **注意:**\ 该方法在 Linux/X11、macOS、Windows 上实现。该方法在其他平台上始终返回 ``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>`
|
||
|
||
如果操作系统的节电措施永远不会关闭屏幕,则返回 ``true``\ 。另见 :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>`
|
||
|
||
设置屏幕是否总是不会被操作系统的节能措施关闭。另见 :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>`
|
||
|
||
设置 ``screen`` 的 ``orientation``\ 。另见 :ref:`screen_get_orientation()<class_DisplayServer_method_screen_get_orientation>`\ 。
|
||
|
||
\ **注意:**\ 下列常量可以当作 ``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>`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`\ 。
|
||
|
||
\ **注意:**\ 该方法在 Android 和 iOS 上实现。
|
||
|
||
\ **注意:**\ 在 iOS 上,如果 :ref:`ProjectSettings.display/window/handheld/orientation<class_ProjectSettings_property_display/window/handheld/orientation>` 不为 :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>`
|
||
|
||
使用 :ref:`Image<class_Image>` 设置窗口图标(通常显示在左上角)。要使用操作系统的原生格式设置图标,请改用 :ref:`set_native_icon()<class_DisplayServer_method_set_native_icon>`\ 。
|
||
|
||
\ **注意:**\ 需要支持 :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>`
|
||
|
||
使用操作系统的\ *原生*\ 格式设置窗口图标(通常显示在左上角)。位于 ``filename`` 的文件在 Windows 上必须为 ``.ico`` 格式,在 macOS 上必须为 ``.icns`` 格式。使用特制的 ``.ico`` 或 ``.icns`` 图标,就能够让 :ref:`set_native_icon()<class_DisplayServer_method_set_native_icon>` 指定以不同尺寸显示图标时显示不同的图标。大小由操作系统和用户首选项决定(包括显示器缩放系数)。要使用其他格式的图标,请改用 :ref:`set_icon()<class_DisplayServer_method_set_icon>`\ 。
|
||
|
||
\ **注意:**\ 需要支持 :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>`
|
||
|
||
打开系统 Emoji 和符号拾取器。
|
||
|
||
\ **注意:**\ 该方法在 macOS 和 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>`
|
||
|
||
返回给定状态指示器 ``id`` 的矩形,使用屏幕坐标系。如果状态指示器不可见,则返回空的 :ref:`Rect2<class_Rect2>`\ 。
|
||
|
||
\ **注意:**\ 该方法在 macOS 和 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>`
|
||
|
||
设置应用程序状态指示器激活回调。\ ``callback`` 应采用两个参数:\ :ref:`int<class_int>` 鼠标按钮索引(\ :ref:`MouseButton<enum_@GlobalScope_MouseButton>` 值之一)和 :ref:`Vector2i<class_Vector2i>` 屏幕坐标中的点击位置。
|
||
|
||
\ **注意:**\ 该方法在 macOS 和 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>`
|
||
|
||
设置应用程序状态指示器图标。
|
||
|
||
\ **注意:**\ 该方法在 macOS 和 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>`
|
||
|
||
设置应用程序状态指示器原生弹出菜单。
|
||
|
||
\ **注意:**\ 在 macOS 上,该菜单可通过任何鼠标按键激活。其激活回调\ *未*\ 触发。
|
||
|
||
\ **注意:**\ 在 Windows 上,该菜单可通过鼠标右键激活,选择状态图标并按下 :kbd:`Shift + F10` 或应用程序键。菜单的其他鼠标按键的激活回调仍会触发。
|
||
|
||
\ **注意:**\ 仅当 :ref:`NativeMenu<class_NativeMenu>` 支持 :ref:`NativeMenu.FEATURE_POPUP_MENU<class_NativeMenu_constant_FEATURE_POPUP_MENU>` 功能时,才支持原生弹出窗口。
|
||
|
||
.. 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>`
|
||
|
||
设置应用程序状态指示器工具提示。
|
||
|
||
\ **注意:**\ 该方法在 macOS 和 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>`
|
||
|
||
返回当前活动的数位板驱动程序的名称。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
返回可用的数位板驱动程序的总数。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
返回给定索引的数位板驱动程序名称。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
设置活动平板驱动程序名称。
|
||
|
||
支持的驱动程序:
|
||
|
||
- ``winink``\ :Windows Ink API,默认。
|
||
|
||
- ``wintab``\ :Wacom Wintab API(需要兼容的设备驱动程序)。
|
||
|
||
- ``dummy``\ :虚设驱动程序,禁用平板输入。
|
||
|
||
\ **注意:**\ 该方法仅在 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>`
|
||
|
||
返回语音信息字典的 :ref:`Array<class_Array>`\ 。
|
||
|
||
每个 :ref:`Dictionary<class_Dictionary>` 包含两个 :ref:`String<class_String>` 条目:
|
||
|
||
- ``name`` 是语音名称。
|
||
|
||
- ``id`` 是语音标识符。
|
||
|
||
- ``language`` 是语言代码,格式为 ``lang_Variant`` 。\ ``lang`` 部分是小写的基于 ISO-639 标准的 2 或 3 字母代码。而 ``Variant`` 部分是一个依赖于引擎的字符串,描述国家、地区或/和方言。
|
||
|
||
请注意,Godot 依赖于系统库来实现文本到语音的功能。这些库在 Windows 和 MacOS 上是默认安装的,但并非安装在所有 Linux 发行版上。如果它们不存在,此方法将返回一个空列表。这适用于 Linux 上的 Godot 用户,以及在 Linux 上运行使用文本到语音的 Godot 游戏的最终用户。
|
||
|
||
\ **注意:**\ 这个方法在 Android、iOS、Web、Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
返回 :ref:`PackedStringArray<class_PackedStringArray>`\ ,内容为 ``language`` 语言对应的语音标识符。
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS、Web、Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
如果合成器处于暂停状态,则返回 ``true``\ 。
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS、Web、Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
如果合成器正在生成语音,或者有发言正在队列中等待,则返回 ``true``\ 。
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS、Web、Linux(X11/Wayland)、macOS 和 Windows 上实现。
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tts_pause:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **tts_pause**\ (\ ) :ref:`🔗<class_DisplayServer_method_tts_pause>`
|
||
|
||
将合成器置为暂停状态。
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS、Web、Linux(X11/Wayland)、macOS 和 Windows 上实现。
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tts_resume:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **tts_resume**\ (\ ) :ref:`🔗<class_DisplayServer_method_tts_resume>`
|
||
|
||
恢复暂停的合成器。
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS、Web、Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
添加回调,会在发言开始、结束、取消、到达文本边界时调用。
|
||
|
||
- :ref:`TTS_UTTERANCE_STARTED<class_DisplayServer_constant_TTS_UTTERANCE_STARTED>`\ 、\ :ref:`TTS_UTTERANCE_ENDED<class_DisplayServer_constant_TTS_UTTERANCE_ENDED>`\ 、\ :ref:`TTS_UTTERANCE_CANCELED<class_DisplayServer_constant_TTS_UTTERANCE_CANCELED>` 可调用体的方法应接受一个 :ref:`int<class_int>` 参数,即发言 ID。
|
||
|
||
- :ref:`TTS_UTTERANCE_BOUNDARY<class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY>` 可调用体的方法应接受两个 :ref:`int<class_int>` 参数:字符索引和发言 ID。
|
||
|
||
\ **注意:**\ 边界回调的颗粒度由引擎决定。
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS、Web、Linux(X11/Wayland)、macOS 以及 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>`
|
||
|
||
向队列中添加发言。如果 ``interrupt`` 为 ``true``\ ,则会先清空队列。
|
||
|
||
- ``voice`` 语音标识符是 :ref:`tts_get_voices()<class_DisplayServer_method_tts_get_voices>` 所返回的 ``"id"`` 值,也可以是 :ref:`tts_get_voices_for_language()<class_DisplayServer_method_tts_get_voices_for_language>` 返回的值。
|
||
|
||
- ``volume`` 音量从 ``0``\ (最低)到 ``100``\ (最高)。
|
||
|
||
- ``pitch`` 音高从 ``0.0``\ (最低)到 ``2.0``\ (最高), ``1.0`` 为当前语音的默认音高。
|
||
|
||
- ``rate`` 语速从 ``0.1``\ (最低)到 ``10.0``\ (最高), ``1.0`` 为普通语速。其他值为相对百分比。
|
||
|
||
- ``utterance_id`` 话语 ID 会作为参数传递给回调函数。
|
||
|
||
\ **注意:**\ 在 Windows 和 Linux(X11/Wayland)上,发言的 ``text`` 可以使用 SSML 标记。对 SSML 支持取决于引擎和语音。如果引擎不支持 SSML,你应该在调用 :ref:`tts_speak()<class_DisplayServer_method_tts_speak>` 之前剥离所有 XML 标记。
|
||
|
||
\ **注意:**\ 音高、语速、音量的颗粒度由引擎和语音决定。设置的值可能被截断。
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS、Web、Linux(X11/Wayland)、macOS 以及 Windows 上实现。
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_DisplayServer_method_tts_stop:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **tts_stop**\ (\ ) :ref:`🔗<class_DisplayServer_method_tts_stop>`
|
||
|
||
停止执行中的合成器,移除队列中的所有发言。
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS、Web、Linux(X11/Wayland)、macOS 以及 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>`
|
||
|
||
取消注册通过 :ref:`register_additional_output()<class_DisplayServer_method_register_additional_output>` 注册的代表额外输出的 :ref:`Object<class_Object>`\ 。
|
||
|
||
.. 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>`
|
||
|
||
如果虚拟键盘为显示状态则隐藏虚拟键盘,否则不做任何操作。
|
||
|
||
.. 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>`
|
||
|
||
如果该平台有虚拟键盘,则显示虚拟键盘。
|
||
|
||
\ ``existing_text`` 参数对于实现你自己的 :ref:`LineEdit<class_LineEdit>` 或 :ref:`TextEdit<class_TextEdit>` 很有用,因为它告诉虚拟键盘已经输入了哪些文本(虚拟键盘使用它进行自动更正和预测)。
|
||
|
||
\ ``position`` 参数为编辑文本的屏幕空间 :ref:`Rect2<class_Rect2>`\ 。
|
||
|
||
\ ``type`` 参数允许配置要显示的虚拟键盘类型。
|
||
|
||
\ ``max_length`` 在当与 ``-1`` 不同时,限制可输入的字符数。
|
||
|
||
如果未设置 ``cursor_end``\ ,则可选参数 ``cursor_start`` 可以定义当前文本光标位置。
|
||
|
||
可选参数 ``cursor_start`` 和 ``cursor_end``\ ,可以定义当前文本选区。
|
||
|
||
\ **注意:**\ 该方法在 Android、iOS 和 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>`
|
||
|
||
将鼠标光标位置设置为相对于当前聚焦的游戏窗口管理器窗口左上角的原点的给定 ``position``\ 。
|
||
|
||
\ **注意:**\ :ref:`warp_mouse()<class_DisplayServer_method_warp_mouse>` 仅在 Windows、macOS 和 Linux(X11/Wayland)上受支持。它在 Android、iOS 和 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>`
|
||
|
||
如果可以在 ``window_id`` 指定的窗口中绘制任何内容,则返回 ``true``\ ,否则返回 ``false``\ 。使用 ``--disable-render-loop`` 命令行参数或无头构建将返回 ``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>`
|
||
|
||
返回活动弹出窗口的 ID,如果没有则返回 :ref:`INVALID_WINDOW_ID<class_DisplayServer_constant_INVALID_WINDOW_ID>`\ 。
|
||
|
||
.. 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>`
|
||
|
||
返回 ``window_id`` 所附加的 :ref:`Window<class_Window>` 的 :ref:`Object.get_instance_id()<class_Object_method_get_instance_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>`
|
||
|
||
该函数返回窗口 ``window_id`` 所在的屏幕。如果屏幕跨越多个显示器,则返回窗口中心所在的屏幕。另见 :ref:`window_set_current_screen()<class_DisplayServer_method_window_set_current_screen>` 。如果 ``window_id`` 无效则返回 :ref:`INVALID_SCREEN<class_DisplayServer_constant_INVALID_SCREEN>`\ 。
|
||
|
||
\ **注意:**\ 该方法在 Linux/X11、macOS、Windows 上实现。在其他平台上始终返回 ``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>`
|
||
|
||
返回给定窗口当前的 ``flag`` 值。
|
||
|
||
.. 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>`
|
||
|
||
返回该窗口的最大尺寸,单位为像素。另见 :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>`
|
||
|
||
返回该窗口的最小尺寸,单位为像素。另见 :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>`
|
||
|
||
返回给定窗口的模式。
|
||
|
||
.. 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>`
|
||
|
||
该函数返回用于插件的内部结构指针。
|
||
|
||
\ **注意:**\ 该方法在 Android、Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
该函数返回控件或菜单项在屏幕坐标系统中的边界框,这个控件或菜单项被用来打开弹出窗口。
|
||
|
||
.. 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>`
|
||
|
||
返回屏幕上给定窗口的客户端区域位置。
|
||
|
||
.. 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>`
|
||
|
||
该函数返回给定窗口在屏幕上的位置,包括操作系统绘制的边框。另见 :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>`
|
||
|
||
当设置了 :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>` 标志时,该函数返回标题左边距 (``x``)、右边距 (``y``) 和高度 (``z``),这些边距可以安全地使用(不包含任何按钮或其他元素)。
|
||
|
||
.. 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>`
|
||
|
||
返回窗口的大小(单位为像素),不包含操作系统绘制的边框,该窗口由 ``window_id`` 指定。这个区域也叫做“客户区域”。另见 :ref:`window_get_size_with_decorations()<class_DisplayServer_method_window_get_size_with_decorations>`\ 、\ :ref:`window_set_size()<class_DisplayServer_method_window_set_size>`\ 、\ :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>`
|
||
|
||
返回窗口的大小(单位为像素),包含操作系统绘制的边框,该窗口由 ``window_id`` 指定。另见 :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>`
|
||
|
||
返回由 ``window_id`` 指定的窗口的估计窗口标题栏大小(包括文本和窗口按钮)(单位:像素)。该方法不会更改窗口标题。
|
||
|
||
\ **注意:**\ 该方法在 macOS 和 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>`
|
||
|
||
返回给定窗口的垂直同步模式。
|
||
|
||
.. 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>`
|
||
|
||
如果 ``window_id`` 指定的窗口已获得焦点,则返回 ``true``\ 。
|
||
|
||
.. 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>`
|
||
|
||
如果给定的窗口能够最大化(最大化按钮已启用),则返回 ``true``\ 。
|
||
|
||
.. 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>`
|
||
|
||
将由 ``window_id`` 指定的窗口移动至前台,使其位于其他窗口之上。
|
||
|
||
.. 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>`
|
||
|
||
让由 ``window_id`` 指定的窗口请求注意,该窗口获得焦点之前会闪烁窗口标题和任务栏项目。如果该窗口目前持有焦点,则通常是没有可见效果的。实际的行为因操作系统而异。
|
||
|
||
.. 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>`
|
||
|
||
将 ``window_id`` 指定的窗口移动到 ``screen`` 屏幕。另见 :ref:`window_get_current_screen()<class_DisplayServer_method_window_get_current_screen>`\ 。
|
||
|
||
\ **注意:**\ 下列常量可以当作 ``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>`\ 、\ :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`\ 。
|
||
|
||
\ **注意:**\ 该方法在 Linux/X11、macOS 和 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>`
|
||
|
||
设置当文件从操作系统的文件管理器拖放到 ``window_id`` 指定的窗口时应调用的 ``callback``\ 。\ ``callback`` 应采用一个 :ref:`PackedStringArray<class_PackedStringArray>` 参数,即拖放的文件列表。
|
||
|
||
\ **警告:**\ 仅限高级用户!将这样的回调添加到 :ref:`Window<class_Window>` 节点将覆盖其默认实现,这可能会引入错误。
|
||
|
||
\ **注意:**\ 这个方法在 Windows、macOS、Linux(X11/Wayland)、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>`
|
||
|
||
如果设置为 ``true``\ ,该窗口将始终位于其父窗口之上,父窗口将在该窗口打开时忽略输入。
|
||
|
||
\ **注意:**\ 在 macOS 上,独占窗口被限制在与父窗口相同的空间(虚拟桌面或屏幕)中。
|
||
|
||
\ **注意:**\ 该方法在 macOS 和 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>`
|
||
|
||
禁用或启用给定窗口的 ``flag`` 标志。
|
||
|
||
.. 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>`
|
||
|
||
设置是否应该为窗口启用\ `输入法编辑器 <https://zh.wikipedia.org/wiki/%E8%BE%93%E5%85%A5%E6%B3%95>`__\ ,该窗口由 ``window_id`` 指定。另见 :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>`
|
||
|
||
设置指定 ``window_id`` 的\ `输入法编辑器 <https://zh.wikipedia.org/wiki/%E8%BE%93%E5%85%A5%E6%B3%95>`__\ 弹出框的位置。仅在指定 ``window_id`` 的 :ref:`window_set_ime_active()<class_DisplayServer_method_window_set_ime_active>` 为 ``true`` 时有效。
|
||
|
||
.. 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>`
|
||
|
||
设置回调 ``callback``\ ,向由 ``window_id`` 指定的窗口发送任何 :ref:`InputEvent<class_InputEvent>` 时会进行回调。
|
||
|
||
\ **警告:**\ 仅限高级用户!将这样的回调添加到 :ref:`Window<class_Window>` 节点将覆盖其默认实现,这可能会引入错误。
|
||
|
||
.. 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>`
|
||
|
||
设置回调 ``callback``\ ,使用虚拟键盘向由 ``window_id`` 指定的窗口输入文本时会进行回调。
|
||
|
||
\ **警告:**\ 仅限高级用户!将这样的回调添加到 :ref:`Window<class_Window>` 节点将覆盖其默认实现,这可能会引入错误。
|
||
|
||
.. 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>`
|
||
|
||
设置由 ``window_id`` 指定的窗口的最大大小(单位为像素)。通常,用户将无法拖动窗口使其大于该指定大小。另见 :ref:`window_get_max_size()<class_DisplayServer_method_window_get_max_size>`\ 。
|
||
|
||
\ **注意:**\ 建议改用 :ref:`Window.max_size<class_Window_property_max_size>` 更改此值。
|
||
|
||
\ **注意:**\ 使用第三方工具,用户可以禁用窗口几何限制,从而绕过此限制。
|
||
|
||
.. 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>`
|
||
|
||
将给定窗口的最小大小设置为 ``min_size``\ (单位为像素)。通常,用户将无法拖动窗口使其小于该指定大小。另见 :ref:`window_get_min_size()<class_DisplayServer_method_window_get_min_size>`\ 。
|
||
|
||
\ **注意:**\ 建议改用 :ref:`Window.min_size<class_Window_property_min_size>` 来更改此值。
|
||
|
||
\ **注意:**\ 默认情况下,主窗口的最小大小为 ``Vector2i(64, 64)``\ 。这可以防止将窗口调整为接近零的大小时可能出现的问题。
|
||
|
||
\ **注意:**\ 使用第三方工具,用户可以禁用窗口几何限制,从而绕过此限制。
|
||
|
||
.. 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>`
|
||
|
||
将给定窗口的窗口模式设置为 ``mode``\ 。
|
||
|
||
\ **注意:**\ 在 Android 上,设为 :ref:`WINDOW_MODE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN>` 或 :ref:`WINDOW_MODE_EXCLUSIVE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN>` 会启用沉浸模式。
|
||
|
||
\ **注意:**\ 将窗口设置为全屏会强制将无边框标志设为 ``true``\ ,所以不再需要时请务必将其设回 ``false``\ 。
|
||
|
||
.. 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>`
|
||
|
||
设置一个接受鼠标事件的窗口的多边形区域。该区域外的鼠标事件将被传递出去。
|
||
|
||
传递一个空数组将禁用穿透支持(所有鼠标事件将被窗口拦截,这是默认行为)。
|
||
|
||
|
||
.. tabs::
|
||
|
||
.. code-tab:: gdscript
|
||
|
||
# 设置区域,使用 Path2D 节点。
|
||
DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points())
|
||
|
||
# 设置区域,使用 Polygon2D 节点。
|
||
DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon)
|
||
|
||
# 重置区域为默认值。
|
||
DisplayServer.window_set_mouse_passthrough([])
|
||
|
||
.. code-tab:: csharp
|
||
|
||
// 设置区域,使用 Path2D 节点。
|
||
DisplayServer.WindowSetMousePassthrough(GetNode<Path2D>("Path2D").Curve.GetBakedPoints());
|
||
|
||
// 设置区域,使用 Polygon2D 节点。
|
||
DisplayServer.WindowSetMousePassthrough(GetNode<Polygon2D>("Polygon2D").Polygon);
|
||
|
||
// 重置区域为默认值。
|
||
DisplayServer.WindowSetMousePassthrough([]);
|
||
|
||
|
||
|
||
\ **注意:**\ 在 Windows 上,不会绘制位于区域之外的窗口部分,而在 Linux(X11)和 macOS 上则会绘制。
|
||
|
||
\ **注意:**\ 该方法在 Linux(X11)、macOS 和 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>`
|
||
|
||
设置用于打开弹出窗口的控件或菜单项的范围框,使用屏幕坐标系。在该区域中点击不会自动关闭该弹出框。
|
||
|
||
.. 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>`
|
||
|
||
将给定窗口的位置设置为 ``position``\ 。使用多个监视器时,屏幕位置是相对于虚拟桌面区域的位置。如果多监视器中使用了不同的屏幕分辨率或朝向,原点有可能位于所有显示器之外,类似于:
|
||
|
||
.. code:: text
|
||
|
||
* (0, 0) +-------+
|
||
| |
|
||
+-------------+ | |
|
||
| | | |
|
||
| | | |
|
||
+-------------+ +-------+
|
||
|
||
另见 :ref:`window_get_position()<class_DisplayServer_method_window_get_position>` 和 :ref:`window_set_size()<class_DisplayServer_method_window_set_size>`\ 。
|
||
|
||
\ **注意:**\ 建议改用 :ref:`Window.position<class_Window_property_position>` 更改此值。
|
||
|
||
\ **注意:**\ 在 Linux(Wayland)上:该方法是没有操作。
|
||
|
||
.. 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>`
|
||
|
||
设置回调 ``callback``\ ,由 ``window_id`` 指定的窗口发生移动或调整大小时会进行回调。
|
||
|
||
\ **警告:**\ 仅限高级用户!将这样的回调添加到 :ref:`Window<class_Window>` 节点将覆盖其默认实现,这可能会引入错误。
|
||
|
||
.. 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>`
|
||
|
||
将给定窗口的大小设置为 ``size``\ (单位为像素)。另见 :ref:`window_get_size()<class_DisplayServer_method_window_get_size>` 和 :ref:`window_get_position()<class_DisplayServer_method_window_get_position>`\ 。
|
||
|
||
\ **注意:**\ 建议改用 :ref:`Window.size<class_Window_property_size>` 更改此值。
|
||
|
||
.. 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>`
|
||
|
||
将给定窗口的标题设置为 ``title``\ 。
|
||
|
||
\ **注意:**\ 建议改用 :ref:`Window.title<class_Window_property_title>` 更改此值。
|
||
|
||
\ **注意:**\ 避免每一帧都更改窗口标题,因为这会导致某些窗口管理器出现性能问题。尝试每秒最多更改几次窗口标题。
|
||
|
||
.. 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>`
|
||
|
||
设置窗口瞬态父级。瞬态窗口将与其瞬态父级一起销毁,并在关闭时将焦点返回到父级。瞬态窗口显示在非排他性全屏父窗口的顶部。瞬态窗口无法进入全屏模式。
|
||
|
||
\ **注意:**\ 建议改用 :ref:`Window.transient<class_Window_property_transient>` 更改此值。
|
||
|
||
\ **注意:**\ 行为可能因平台而异。
|
||
|
||
.. 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>`
|
||
|
||
设置给定窗口的垂直同步模式。另见 :ref:`ProjectSettings.display/window/vsync/vsync_mode<class_ProjectSettings_property_display/window/vsync/vsync_mode>`\ 。
|
||
|
||
根据平台和使用的渲染器,如果不支持所需的模式,引擎将回退到 :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>`\ 。
|
||
|
||
\ **注意:**\ 除 :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` 以外的垂直同步模式,仅支持 Forward+ 和 Mobile 渲染方式,不支持 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>`
|
||
|
||
设置了 :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>` 标志时,会设置第一个标题栏按钮中心的偏移量。
|
||
|
||
\ **注意:**\ 这个标志仅在 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>`
|
||
|
||
设置回调 ``callback``\ ,由 ``window_id`` 指定的窗口发生事件时会进行回调。
|
||
|
||
\ **警告:**\ 仅限高级用户!将这样的回调添加到 :ref:`Window<class_Window>` 节点将覆盖其默认实现,这可能会引入错误。
|
||
|
||
.. 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>`
|
||
|
||
在窗口编号为 ``window_id`` 的窗口上启动交互式拖动操作,使用当前鼠标位置。处理鼠标按钮按下事件时调用该方法可以模拟在窗口标题栏上按下的事件。使用该方法可以使窗口参与空间切换、平铺等系统功能。
|
||
|
||
\ **注意:**\ 该方法在 Linux(X11/Wayland)、macOS 和 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>`
|
||
|
||
在窗口编号为 ``window_id`` 的窗口上启动交互式调整大小操作,使用当前鼠标位置。处理鼠标按钮按下事件时调用该方法可以模拟在窗口边缘上按下的事件。
|
||
|
||
\ **注意:**\ 该方法在 Linux(X11/Wayland)、macOS 和 Windows 上实现。
|
||
|
||
.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)`
|
||
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
||
.. |const| replace:: :abbr:`const (本方法无副作用,不会修改该实例的任何成员变量。)`
|
||
.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外,还能够继续接受任意数量的参数。)`
|
||
.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)`
|
||
.. |static| replace:: :abbr:`static (调用本方法无需实例,可直接使用类名进行调用。)`
|
||
.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)`
|
||
.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)`
|
||
.. |void| replace:: :abbr:`void (无返回值。)`
|