|
@@ -46,7 +46,7 @@ Methods
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`force_process_and_drop_events<class_DisplayServer_method_force_process_and_drop_events>` **(** **)** |
|
|
| void | :ref:`force_process_and_drop_events<class_DisplayServer_method_force_process_and_drop_events>` **(** **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
-| :ref:`Array<class_Array>` | :ref:`get_display_cutouts<class_DisplayServer_method_get_display_cutouts>` **(** **)** |const| |
|
|
|
|
|
|
+| :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:`Rect2i<class_Rect2i>` | :ref:`get_display_safe_area<class_DisplayServer_method_get_display_safe_area>` **(** **)** |const| |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
@@ -60,23 +60,23 @@ Methods
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_window_list<class_DisplayServer_method_get_window_list>` **(** **)** |const| |
|
|
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_window_list<class_DisplayServer_method_get_window_list>` **(** **)** |const| |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
-| void | :ref:`global_menu_add_check_item<class_DisplayServer_method_global_menu_add_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
|
|
|
|
+| :ref:`int<class_int>` | :ref:`global_menu_add_check_item<class_DisplayServer_method_global_menu_add_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
-| void | :ref:`global_menu_add_icon_check_item<class_DisplayServer_method_global_menu_add_icon_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
|
|
|
|
+| :ref:`int<class_int>` | :ref:`global_menu_add_icon_check_item<class_DisplayServer_method_global_menu_add_icon_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
-| void | :ref:`global_menu_add_icon_item<class_DisplayServer_method_global_menu_add_icon_item>` **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
|
|
|
|
+| :ref:`int<class_int>` | :ref:`global_menu_add_icon_item<class_DisplayServer_method_global_menu_add_icon_item>` **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
-| void | :ref:`global_menu_add_icon_radio_check_item<class_DisplayServer_method_global_menu_add_icon_radio_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
|
|
|
|
+| :ref:`int<class_int>` | :ref:`global_menu_add_icon_radio_check_item<class_DisplayServer_method_global_menu_add_icon_radio_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
-| void | :ref:`global_menu_add_item<class_DisplayServer_method_global_menu_add_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
|
|
|
|
+| :ref:`int<class_int>` | :ref:`global_menu_add_item<class_DisplayServer_method_global_menu_add_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
-| void | :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` labe, :ref:`int<class_int>` max_states, :ref:`int<class_int>` default_state, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
|
|
|
|
+| :ref:`int<class_int>` | :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` labe, :ref:`int<class_int>` max_states, :ref:`int<class_int>` default_state, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
-| void | :ref:`global_menu_add_radio_check_item<class_DisplayServer_method_global_menu_add_radio_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
|
|
|
|
+| :ref:`int<class_int>` | :ref:`global_menu_add_radio_check_item<class_DisplayServer_method_global_menu_add_radio_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
-| void | :ref:`global_menu_add_separator<class_DisplayServer_method_global_menu_add_separator>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` index=-1 **)** |
|
|
|
|
|
|
+| :ref:`int<class_int>` | :ref:`global_menu_add_separator<class_DisplayServer_method_global_menu_add_separator>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` index=-1 **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
-| void | :ref:`global_menu_add_submenu_item<class_DisplayServer_method_global_menu_add_submenu_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`String<class_String>` submenu, :ref:`int<class_int>` index=-1 **)** |
|
|
|
|
|
|
+| :ref:`int<class_int>` | :ref:`global_menu_add_submenu_item<class_DisplayServer_method_global_menu_add_submenu_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`String<class_String>` submenu, :ref:`int<class_int>` index=-1 **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`global_menu_clear<class_DisplayServer_method_global_menu_clear>` **(** :ref:`String<class_String>` menu_root **)** |
|
|
| void | :ref:`global_menu_clear<class_DisplayServer_method_global_menu_clear>` **(** :ref:`String<class_String>` menu_root **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
@@ -86,6 +86,8 @@ Methods
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Texture2D<class_Texture2D>` | :ref:`global_menu_get_item_icon<class_DisplayServer_method_global_menu_get_item_icon>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const| |
|
|
| :ref:`Texture2D<class_Texture2D>` | :ref:`global_menu_get_item_icon<class_DisplayServer_method_global_menu_get_item_icon>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const| |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| :ref:`int<class_int>` | :ref:`global_menu_get_item_indentation_level<class_DisplayServer_method_global_menu_get_item_indentation_level>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const| |
|
|
|
|
++----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`global_menu_get_item_index_from_tag<class_DisplayServer_method_global_menu_get_item_index_from_tag>` **(** :ref:`String<class_String>` menu_root, :ref:`Variant<class_Variant>` tag **)** |const| |
|
|
| :ref:`int<class_int>` | :ref:`global_menu_get_item_index_from_tag<class_DisplayServer_method_global_menu_get_item_index_from_tag>` **(** :ref:`String<class_String>` menu_root, :ref:`Variant<class_Variant>` tag **)** |const| |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`global_menu_get_item_index_from_text<class_DisplayServer_method_global_menu_get_item_index_from_text>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` text **)** |const| |
|
|
| :ref:`int<class_int>` | :ref:`global_menu_get_item_index_from_text<class_DisplayServer_method_global_menu_get_item_index_from_text>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` text **)** |const| |
|
|
@@ -124,6 +126,8 @@ Methods
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`global_menu_set_item_icon<class_DisplayServer_method_global_menu_set_item_icon>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Texture2D<class_Texture2D>` icon **)** |
|
|
| void | :ref:`global_menu_set_item_icon<class_DisplayServer_method_global_menu_set_item_icon>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Texture2D<class_Texture2D>` icon **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| void | :ref:`global_menu_set_item_indentation_level<class_DisplayServer_method_global_menu_set_item_indentation_level>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` level **)** |
|
|
|
|
++----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`global_menu_set_item_max_states<class_DisplayServer_method_global_menu_set_item_max_states>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` max_states **)** |
|
|
| void | :ref:`global_menu_set_item_max_states<class_DisplayServer_method_global_menu_set_item_max_states>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` max_states **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`global_menu_set_item_radio_checkable<class_DisplayServer_method_global_menu_set_item_radio_checkable>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checkable **)** |
|
|
| void | :ref:`global_menu_set_item_radio_checkable<class_DisplayServer_method_global_menu_set_item_radio_checkable>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checkable **)** |
|
|
@@ -202,7 +206,7 @@ Methods
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`tablet_set_current_driver<class_DisplayServer_method_tablet_set_current_driver>` **(** :ref:`String<class_String>` name **)** |
|
|
| void | :ref:`tablet_set_current_driver<class_DisplayServer_method_tablet_set_current_driver>` **(** :ref:`String<class_String>` name **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
-| :ref:`Array<class_Array>` | :ref:`tts_get_voices<class_DisplayServer_method_tts_get_voices>` **(** **)** |const| |
|
|
|
|
|
|
+| :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>` **(** :ref:`String<class_String>` language **)** |const| |
|
|
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`tts_get_voices_for_language<class_DisplayServer_method_tts_get_voices_for_language>` **(** :ref:`String<class_String>` language **)** |const| |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
@@ -224,7 +228,7 @@ Methods
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`virtual_keyboard_hide<class_DisplayServer_method_virtual_keyboard_hide>` **(** **)** |
|
|
| void | :ref:`virtual_keyboard_hide<class_DisplayServer_method_virtual_keyboard_hide>` **(** **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
-| void | :ref:`virtual_keyboard_show<class_DisplayServer_method_virtual_keyboard_show>` **(** :ref:`String<class_String>` existing_text, :ref:`Rect2<class_Rect2>` position=Rect2(0, 0, 0, 0), :ref:`bool<class_bool>` multiline=false, :ref:`int<class_int>` max_length=-1, :ref:`int<class_int>` cursor_start=-1, :ref:`int<class_int>` cursor_end=-1 **)** |
|
|
|
|
|
|
+| void | :ref:`virtual_keyboard_show<class_DisplayServer_method_virtual_keyboard_show>` **(** :ref:`String<class_String>` existing_text, :ref:`Rect2<class_Rect2>` position=Rect2(0, 0, 0, 0), :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` type=0, :ref:`int<class_int>` max_length=-1, :ref:`int<class_int>` cursor_start=-1, :ref:`int<class_int>` cursor_end=-1 **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>` **(** :ref:`Vector2i<class_Vector2i>` position **)** |
|
|
| void | :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>` **(** :ref:`Vector2i<class_Vector2i>` position **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
@@ -254,10 +258,16 @@ Methods
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_real_size<class_DisplayServer_method_window_get_real_size>` **(** :ref:`int<class_int>` window_id=0 **)** |const| |
|
|
| :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_real_size<class_DisplayServer_method_window_get_real_size>` **(** :ref:`int<class_int>` window_id=0 **)** |const| |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_safe_title_margins<class_DisplayServer_method_window_get_safe_title_margins>` **(** :ref:`int<class_int>` window_id=0 **)** |const| |
|
|
|
|
++----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_size<class_DisplayServer_method_window_get_size>` **(** :ref:`int<class_int>` window_id=0 **)** |const| |
|
|
| :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_size<class_DisplayServer_method_window_get_size>` **(** :ref:`int<class_int>` window_id=0 **)** |const| |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` | :ref:`window_get_vsync_mode<class_DisplayServer_method_window_get_vsync_mode>` **(** :ref:`int<class_int>` window_id=0 **)** |const| |
|
|
| :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` | :ref:`window_get_vsync_mode<class_DisplayServer_method_window_get_vsync_mode>` **(** :ref:`int<class_int>` window_id=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>` **(** :ref:`int<class_int>` window_id=0 **)** |
|
|
| void | :ref:`window_move_to_foreground<class_DisplayServer_method_window_move_to_foreground>` **(** :ref:`int<class_int>` window_id=0 **)** |
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`window_request_attention<class_DisplayServer_method_window_request_attention>` **(** :ref:`int<class_int>` window_id=0 **)** |
|
|
| void | :ref:`window_request_attention<class_DisplayServer_method_window_request_attention>` **(** :ref:`int<class_int>` window_id=0 **)** |
|
|
@@ -346,6 +356,8 @@ Enumerations
|
|
|
|
|
|
.. _class_DisplayServer_constant_FEATURE_TEXT_TO_SPEECH:
|
|
.. _class_DisplayServer_constant_FEATURE_TEXT_TO_SPEECH:
|
|
|
|
|
|
|
|
+.. _class_DisplayServer_constant_FEATURE_EXTEND_TO_TITLE:
|
|
|
|
+
|
|
enum **Feature**:
|
|
enum **Feature**:
|
|
|
|
|
|
- **FEATURE_GLOBAL_MENU** = **0**
|
|
- **FEATURE_GLOBAL_MENU** = **0**
|
|
@@ -386,6 +398,8 @@ enum **Feature**:
|
|
|
|
|
|
- **FEATURE_TEXT_TO_SPEECH** = **19** --- Display server supports text-to-speech. See ``tts_*`` methods.
|
|
- **FEATURE_TEXT_TO_SPEECH** = **19** --- Display server supports text-to-speech. See ``tts_*`` methods.
|
|
|
|
|
|
|
|
+- **FEATURE_EXTEND_TO_TITLE** = **20** --- Display server supports expanding window content to the title. See :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>`.
|
|
|
|
+
|
|
----
|
|
----
|
|
|
|
|
|
.. _enum_DisplayServer_MouseMode:
|
|
.. _enum_DisplayServer_MouseMode:
|
|
@@ -450,6 +464,46 @@ enum **ScreenOrientation**:
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
|
|
+.. _enum_DisplayServer_VirtualKeyboardType:
|
|
|
|
+
|
|
|
|
+.. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT:
|
|
|
|
+
|
|
|
|
+.. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE:
|
|
|
|
+
|
|
|
|
+.. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER:
|
|
|
|
+
|
|
|
|
+.. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL:
|
|
|
|
+
|
|
|
|
+.. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE:
|
|
|
|
+
|
|
|
|
+.. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS:
|
|
|
|
+
|
|
|
|
+.. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD:
|
|
|
|
+
|
|
|
|
+.. _class_DisplayServer_constant_KEYBOARD_TYPE_URL:
|
|
|
|
+
|
|
|
|
+enum **VirtualKeyboardType**:
|
|
|
|
+
|
|
|
|
+- **KEYBOARD_TYPE_DEFAULT** = **0** --- Default text virtual keyboard.
|
|
|
|
+
|
|
|
|
+- **KEYBOARD_TYPE_MULTILINE** = **1** --- Multiline virtual keyboard.
|
|
|
|
+
|
|
|
|
+- **KEYBOARD_TYPE_NUMBER** = **2** --- Virtual number keypad, useful for PIN entry.
|
|
|
|
+
|
|
|
|
+- **KEYBOARD_TYPE_NUMBER_DECIMAL** = **3** --- Virtual number keypad, useful for entering fractional numbers.
|
|
|
|
+
|
|
|
|
+- **KEYBOARD_TYPE_PHONE** = **4** --- Virtual phone number keypad.
|
|
|
|
+
|
|
|
|
+- **KEYBOARD_TYPE_EMAIL_ADDRESS** = **5** --- Virtual keyboard with additional keys to assist with typing email addresses.
|
|
|
|
+
|
|
|
|
+- **KEYBOARD_TYPE_PASSWORD** = **6** --- Virtual keyboard for entering a password. On most platforms, this should disable autocomplete and autocapitalization.
|
|
|
|
+
|
|
|
|
+\ **Note:** This is not supported on Web. Instead, this behaves identically to :ref:`KEYBOARD_TYPE_DEFAULT<class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT>`.
|
|
|
|
+
|
|
|
|
+- **KEYBOARD_TYPE_URL** = **7** --- Virtual keyboard with additional keys to assist with typing URLs.
|
|
|
|
+
|
|
|
|
+----
|
|
|
|
+
|
|
.. _enum_DisplayServer_CursorShape:
|
|
.. _enum_DisplayServer_CursorShape:
|
|
|
|
|
|
.. _class_DisplayServer_constant_CURSOR_ARROW:
|
|
.. _class_DisplayServer_constant_CURSOR_ARROW:
|
|
@@ -574,6 +628,8 @@ Regardless of the platform, enabling fullscreen will change the window size to m
|
|
|
|
|
|
.. _class_DisplayServer_constant_WINDOW_FLAG_POPUP:
|
|
.. _class_DisplayServer_constant_WINDOW_FLAG_POPUP:
|
|
|
|
|
|
|
|
+.. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE:
|
|
|
|
+
|
|
.. _class_DisplayServer_constant_WINDOW_FLAG_MAX:
|
|
.. _class_DisplayServer_constant_WINDOW_FLAG_MAX:
|
|
|
|
|
|
enum **WindowFlags**:
|
|
enum **WindowFlags**:
|
|
@@ -590,7 +646,11 @@ enum **WindowFlags**:
|
|
|
|
|
|
- **WINDOW_FLAG_POPUP** = **5** --- Window is part of menu or :ref:`OptionButton<class_OptionButton>` dropdown. This flag can't be changed when window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have :ref:`WINDOW_FLAG_TRANSPARENT<class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT>` set.
|
|
- **WINDOW_FLAG_POPUP** = **5** --- Window is part of menu or :ref:`OptionButton<class_OptionButton>` dropdown. This flag can't be changed when window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have :ref:`WINDOW_FLAG_TRANSPARENT<class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT>` set.
|
|
|
|
|
|
-- **WINDOW_FLAG_MAX** = **6**
|
|
|
|
|
|
+- **WINDOW_FLAG_EXTEND_TO_TITLE** = **6** --- Window content is expanded to the full size of the window. Unlike borderless window, the frame is left intact and can be used to resize the window, title bar is transparent, but have minimize/maximize/close buttons.
|
|
|
|
+
|
|
|
|
+\ **Note:** This flag is implemented on macOS.
|
|
|
|
+
|
|
|
|
+- **WINDOW_FLAG_MAX** = **7**
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -672,7 +732,7 @@ enum **HandleType**:
|
|
|
|
|
|
- Linux: ``X11::Window*`` for the window.
|
|
- Linux: ``X11::Window*`` for the window.
|
|
|
|
|
|
- - MacOS: ``NSWindow*`` for the window.
|
|
|
|
|
|
+ - macOS: ``NSWindow*`` for the window.
|
|
|
|
|
|
- iOS: ``UIViewController*`` for the view controller.
|
|
- iOS: ``UIViewController*`` for the view controller.
|
|
|
|
|
|
@@ -680,7 +740,7 @@ enum **HandleType**:
|
|
|
|
|
|
- **WINDOW_VIEW** = **2** --- Window view:
|
|
- **WINDOW_VIEW** = **2** --- Window view:
|
|
|
|
|
|
- - MacOS: ``NSView*`` for the window main view.
|
|
|
|
|
|
+ - macOS: ``NSView*`` for the window main view.
|
|
|
|
|
|
- iOS: ``UIView*`` for the window main view.
|
|
- iOS: ``UIView*`` for the window main view.
|
|
|
|
|
|
@@ -824,7 +884,7 @@ Sets the user's primary clipboard content to the given string.
|
|
|
|
|
|
.. _class_DisplayServer_method_get_display_cutouts:
|
|
.. _class_DisplayServer_method_get_display_cutouts:
|
|
|
|
|
|
-- :ref:`Array<class_Array>` **get_display_cutouts** **(** **)** |const|
|
|
|
|
|
|
+- :ref:`Rect2[]<class_Rect2>` **get_display_cutouts** **(** **)** |const|
|
|
|
|
|
|
Returns an :ref:`Array<class_Array>` of :ref:`Rect2<class_Rect2>`, each of which is the bounding rectangle for a display cutout or notch. These are non-functional areas on edge-to-edge screens used by cameras and sensors. Returns an empty array if the device does not have cutouts. See also :ref:`get_display_safe_area<class_DisplayServer_method_get_display_safe_area>`.
|
|
Returns an :ref:`Array<class_Array>` of :ref:`Rect2<class_Rect2>`, each of which is the bounding rectangle for a display cutout or notch. These are non-functional areas on edge-to-edge screens used by cameras and sensors. Returns an empty array if the device does not have cutouts. See also :ref:`get_display_safe_area<class_DisplayServer_method_get_display_safe_area>`.
|
|
|
|
|
|
@@ -872,61 +932,69 @@ Returns the unobscured area of the display where interactive controls should be
|
|
|
|
|
|
.. _class_DisplayServer_method_global_menu_add_check_item:
|
|
.. _class_DisplayServer_method_global_menu_add_check_item:
|
|
|
|
|
|
-- void **global_menu_add_check_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
+- :ref:`int<class_int>` **global_menu_add_check_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
Adds a new checkable item with text ``label`` to the global menu with ID ``menu_root``.
|
|
Adds a new checkable item with text ``label`` to the global menu with ID ``menu_root``.
|
|
|
|
|
|
|
|
+Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
|
|
|
+
|
|
\ **Note:** This method is implemented on macOS.
|
|
\ **Note:** This method is implemented on macOS.
|
|
|
|
|
|
\ **Supported system menu IDs:**\
|
|
\ **Supported system menu IDs:**\
|
|
|
|
|
|
::
|
|
::
|
|
|
|
|
|
- "" - Main menu (macOS).
|
|
|
|
|
|
+ "_main" - Main menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
.. _class_DisplayServer_method_global_menu_add_icon_check_item:
|
|
.. _class_DisplayServer_method_global_menu_add_icon_check_item:
|
|
|
|
|
|
-- void **global_menu_add_icon_check_item** **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
+- :ref:`int<class_int>` **global_menu_add_icon_check_item** **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
Adds a new checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
|
|
Adds a new checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
|
|
|
|
|
|
|
|
+Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
|
|
|
+
|
|
\ **Note:** This method is implemented on macOS.
|
|
\ **Note:** This method is implemented on macOS.
|
|
|
|
|
|
\ **Supported system menu IDs:**\
|
|
\ **Supported system menu IDs:**\
|
|
|
|
|
|
::
|
|
::
|
|
|
|
|
|
- "" - Main menu (macOS).
|
|
|
|
|
|
+ "_main" - Main menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
.. _class_DisplayServer_method_global_menu_add_icon_item:
|
|
.. _class_DisplayServer_method_global_menu_add_icon_item:
|
|
|
|
|
|
-- void **global_menu_add_icon_item** **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
+- :ref:`int<class_int>` **global_menu_add_icon_item** **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
Adds a new item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
|
|
Adds a new item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
|
|
|
|
|
|
|
|
+Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
|
|
|
+
|
|
\ **Note:** This method is implemented on macOS.
|
|
\ **Note:** This method is implemented on macOS.
|
|
|
|
|
|
\ **Supported system menu IDs:**\
|
|
\ **Supported system menu IDs:**\
|
|
|
|
|
|
::
|
|
::
|
|
|
|
|
|
- "" - Main menu (macOS).
|
|
|
|
|
|
+ "_main" - Main menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
.. _class_DisplayServer_method_global_menu_add_icon_radio_check_item:
|
|
.. _class_DisplayServer_method_global_menu_add_icon_radio_check_item:
|
|
|
|
|
|
-- void **global_menu_add_icon_radio_check_item** **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
+- :ref:`int<class_int>` **global_menu_add_icon_radio_check_item** **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
|
|
Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
|
|
|
|
|
|
|
|
+Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
|
|
|
+
|
|
\ **Note:** Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`global_menu_set_item_checked<class_DisplayServer_method_global_menu_set_item_checked>` for more info on how to control it.
|
|
\ **Note:** Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`global_menu_set_item_checked<class_DisplayServer_method_global_menu_set_item_checked>` for more info on how to control it.
|
|
|
|
|
|
\ **Note:** This method is implemented on macOS.
|
|
\ **Note:** This method is implemented on macOS.
|
|
@@ -935,53 +1003,61 @@ Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the glo
|
|
|
|
|
|
::
|
|
::
|
|
|
|
|
|
- "" - Main menu (macOS).
|
|
|
|
|
|
+ "_main" - Main menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
.. _class_DisplayServer_method_global_menu_add_item:
|
|
.. _class_DisplayServer_method_global_menu_add_item:
|
|
|
|
|
|
-- void **global_menu_add_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
+- :ref:`int<class_int>` **global_menu_add_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
|
|
Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
|
|
|
|
|
|
|
|
+Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
|
|
|
+
|
|
\ **Note:** This method is implemented on macOS.
|
|
\ **Note:** This method is implemented on macOS.
|
|
|
|
|
|
\ **Supported system menu IDs:**\
|
|
\ **Supported system menu IDs:**\
|
|
|
|
|
|
::
|
|
::
|
|
|
|
|
|
- "" - Main menu (macOS).
|
|
|
|
|
|
+ "_main" - Main menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
.. _class_DisplayServer_method_global_menu_add_multistate_item:
|
|
.. _class_DisplayServer_method_global_menu_add_multistate_item:
|
|
|
|
|
|
-- void **global_menu_add_multistate_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` labe, :ref:`int<class_int>` max_states, :ref:`int<class_int>` default_state, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
+- :ref:`int<class_int>` **global_menu_add_multistate_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` labe, :ref:`int<class_int>` max_states, :ref:`int<class_int>` default_state, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
-Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
|
|
|
|
|
|
+Adds a new item with text ``labe`` to the global menu with ID ``menu_root``.
|
|
|
|
|
|
Contrarily to normal binary items, multistate items can have more than two states, as defined by ``max_states``. Each press or activate of the item will increase the state by one. The default value is defined by ``default_state``.
|
|
Contrarily to normal binary items, multistate items can have more than two states, as defined by ``max_states``. Each press or activate of the item will increase the state by one. The default value is defined by ``default_state``.
|
|
|
|
|
|
|
|
+Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
|
|
|
+
|
|
|
|
+\ **Note:** By default, there's no indication of the current item state, it should be changed manually.
|
|
|
|
+
|
|
\ **Note:** This method is implemented on macOS.
|
|
\ **Note:** This method is implemented on macOS.
|
|
|
|
|
|
\ **Supported system menu IDs:**\
|
|
\ **Supported system menu IDs:**\
|
|
|
|
|
|
::
|
|
::
|
|
|
|
|
|
- "" - Main menu (macOS).
|
|
|
|
|
|
+ "_main" - Main menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
.. _class_DisplayServer_method_global_menu_add_radio_check_item:
|
|
.. _class_DisplayServer_method_global_menu_add_radio_check_item:
|
|
|
|
|
|
-- void **global_menu_add_radio_check_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
+- :ref:`int<class_int>` **global_menu_add_radio_check_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
Adds a new radio-checkable item with text ``label`` to the global menu with ID ``menu_root``.
|
|
Adds a new radio-checkable item with text ``label`` to the global menu with ID ``menu_root``.
|
|
|
|
|
|
|
|
+Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
|
|
|
+
|
|
\ **Note:** Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`global_menu_set_item_checked<class_DisplayServer_method_global_menu_set_item_checked>` for more info on how to control it.
|
|
\ **Note:** Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`global_menu_set_item_checked<class_DisplayServer_method_global_menu_set_item_checked>` for more info on how to control it.
|
|
|
|
|
|
\ **Note:** This method is implemented on macOS.
|
|
\ **Note:** This method is implemented on macOS.
|
|
@@ -990,41 +1066,45 @@ Adds a new radio-checkable item with text ``label`` to the global menu with ID `
|
|
|
|
|
|
::
|
|
::
|
|
|
|
|
|
- "" - Main menu (macOS).
|
|
|
|
|
|
+ "_main" - Main menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
.. _class_DisplayServer_method_global_menu_add_separator:
|
|
.. _class_DisplayServer_method_global_menu_add_separator:
|
|
|
|
|
|
-- void **global_menu_add_separator** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
+- :ref:`int<class_int>` **global_menu_add_separator** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
Adds a separator between items to the global menu with ID ``menu_root``. Separators also occupy an index.
|
|
Adds a separator between items to the global menu with ID ``menu_root``. Separators also occupy an index.
|
|
|
|
|
|
|
|
+Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
|
|
|
+
|
|
\ **Note:** This method is implemented on macOS.
|
|
\ **Note:** This method is implemented on macOS.
|
|
|
|
|
|
\ **Supported system menu IDs:**\
|
|
\ **Supported system menu IDs:**\
|
|
|
|
|
|
::
|
|
::
|
|
|
|
|
|
- "" - Main menu (macOS).
|
|
|
|
|
|
+ "_main" - Main menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
.. _class_DisplayServer_method_global_menu_add_submenu_item:
|
|
.. _class_DisplayServer_method_global_menu_add_submenu_item:
|
|
|
|
|
|
-- void **global_menu_add_submenu_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`String<class_String>` submenu, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
+- :ref:`int<class_int>` **global_menu_add_submenu_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`String<class_String>` submenu, :ref:`int<class_int>` index=-1 **)**
|
|
|
|
|
|
Adds an item that will act as a submenu of the global menu ``menu_root``. The ``submenu`` argument is the ID of the global menu root that will be shown when the item is clicked.
|
|
Adds an item that will act as a submenu of the global menu ``menu_root``. The ``submenu`` argument is the ID of the global menu root that will be shown when the item is clicked.
|
|
|
|
|
|
|
|
+Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
|
|
|
|
+
|
|
\ **Note:** This method is implemented on macOS.
|
|
\ **Note:** This method is implemented on macOS.
|
|
|
|
|
|
\ **Supported system menu IDs:**\
|
|
\ **Supported system menu IDs:**\
|
|
|
|
|
|
::
|
|
::
|
|
|
|
|
|
- "" - Main menu (macOS).
|
|
|
|
|
|
+ "_main" - Main menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
|
|
|
|
----
|
|
----
|
|
@@ -1041,7 +1121,7 @@ Removes all items from the global menu with ID ``menu_root``.
|
|
|
|
|
|
::
|
|
::
|
|
|
|
|
|
- "" - Main menu (macOS).
|
|
|
|
|
|
+ "_main" - Main menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
"_dock" - Dock popup menu (macOS).
|
|
|
|
|
|
----
|
|
----
|
|
@@ -1076,6 +1156,16 @@ Returns the icon of the item at index ``idx``.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
|
|
+.. _class_DisplayServer_method_global_menu_get_item_indentation_level:
|
|
|
|
+
|
|
|
|
+- :ref:`int<class_int>` **global_menu_get_item_indentation_level** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
|
|
|
|
+
|
|
|
|
+Returns the horizontal offset of the item at the given ``idx``.
|
|
|
|
+
|
|
|
|
+\ **Note:** This method is implemented on macOS.
|
|
|
|
+
|
|
|
|
+----
|
|
|
|
+
|
|
.. _class_DisplayServer_method_global_menu_get_item_index_from_tag:
|
|
.. _class_DisplayServer_method_global_menu_get_item_index_from_tag:
|
|
|
|
|
|
- :ref:`int<class_int>` **global_menu_get_item_index_from_tag** **(** :ref:`String<class_String>` menu_root, :ref:`Variant<class_Variant>` tag **)** |const|
|
|
- :ref:`int<class_int>` **global_menu_get_item_index_from_tag** **(** :ref:`String<class_String>` menu_root, :ref:`Variant<class_Variant>` tag **)** |const|
|
|
@@ -1274,6 +1364,16 @@ Replaces the :ref:`Texture2D<class_Texture2D>` icon of the specified ``idx``.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
|
|
+.. _class_DisplayServer_method_global_menu_set_item_indentation_level:
|
|
|
|
+
|
|
|
|
+- void **global_menu_set_item_indentation_level** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` level **)**
|
|
|
|
+
|
|
|
|
+Sets the horizontal offset of the item at the given ``idx``.
|
|
|
|
+
|
|
|
|
+\ **Note:** This method is implemented on macOS.
|
|
|
|
+
|
|
|
|
+----
|
|
|
|
+
|
|
.. _class_DisplayServer_method_global_menu_set_item_max_states:
|
|
.. _class_DisplayServer_method_global_menu_set_item_max_states:
|
|
|
|
|
|
- void **global_menu_set_item_max_states** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` max_states **)**
|
|
- void **global_menu_set_item_max_states** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` max_states **)**
|
|
@@ -1460,7 +1560,7 @@ Returns the mouse cursor's current position.
|
|
|
|
|
|
- :ref:`int<class_int>` **screen_get_dpi** **(** :ref:`int<class_int>` screen=-1 **)** |const|
|
|
- :ref:`int<class_int>` **screen_get_dpi** **(** :ref:`int<class_int>` screen=-1 **)** |const|
|
|
|
|
|
|
-Returns the dots per inch density of the specified screen. If ``screen`` is ``\ SCREEN_OF_MAIN_WINDOW`` (the default value), a screen with the main window will be used.
|
|
|
|
|
|
+Returns the dots per inch density of the specified screen. If ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>` (the default value), a screen with the main window will be used.
|
|
|
|
|
|
\ **Note:** On macOS, returned value is inaccurate if fractional display scaling mode is used.
|
|
\ **Note:** On macOS, returned value is inaccurate if fractional display scaling mode is used.
|
|
|
|
|
|
@@ -1509,7 +1609,7 @@ Returns the greatest scale factor of all screens.
|
|
|
|
|
|
Returns the current refresh rate of the specified screen. If ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>` (the default value), a screen with the main window will be used.
|
|
Returns the current refresh rate of the specified screen. If ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>` (the default value), a screen with the main window will be used.
|
|
|
|
|
|
-\ **Note:** Returns ``-1.0`` if the DisplayServer fails to find the refresh rate for the specified screen. On HTML5, :ref:`screen_get_refresh_rate<class_DisplayServer_method_screen_get_refresh_rate>` will always return ``-1.0`` as there is no way to retrieve the refresh rate on that platform.
|
|
|
|
|
|
+\ **Note:** Returns ``-1.0`` if the DisplayServer fails to find the refresh rate for the specified screen. On Web, :ref:`screen_get_refresh_rate<class_DisplayServer_method_screen_get_refresh_rate>` will always return ``-1.0`` as there is no way to retrieve the refresh rate on that platform.
|
|
|
|
|
|
To fallback to a default refresh rate if the method fails, try:
|
|
To fallback to a default refresh rate if the method fails, try:
|
|
|
|
|
|
@@ -1623,7 +1723,7 @@ Set active tablet driver name.
|
|
|
|
|
|
.. _class_DisplayServer_method_tts_get_voices:
|
|
.. _class_DisplayServer_method_tts_get_voices:
|
|
|
|
|
|
-- :ref:`Array<class_Array>` **tts_get_voices** **(** **)** |const|
|
|
|
|
|
|
+- :ref:`Dictionary[]<class_Dictionary>` **tts_get_voices** **(** **)** |const|
|
|
|
|
|
|
Returns an :ref:`Array<class_Array>` of voice information dictionaries.
|
|
Returns an :ref:`Array<class_Array>` of voice information dictionaries.
|
|
|
|
|
|
@@ -1635,7 +1735,7 @@ Each :ref:`Dictionary<class_Dictionary>` contains two :ref:`String<class_String>
|
|
|
|
|
|
- ``language`` is language code in ``lang_Variant`` format. ``lang`` part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. And ``Variant`` part is an engine dependent string describing country, region or/and dialect.
|
|
- ``language`` is language code in ``lang_Variant`` format. ``lang`` part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. And ``Variant`` part is an engine dependent string describing country, region or/and dialect.
|
|
|
|
|
|
-\ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
|
|
|
|
|
|
+\ **Note:** This method is implemented on Android, iOS, Web, Linux, macOS, and Windows.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -1645,7 +1745,7 @@ Each :ref:`Dictionary<class_Dictionary>` contains two :ref:`String<class_String>
|
|
|
|
|
|
Returns an :ref:`PackedStringArray<class_PackedStringArray>` of voice identifiers for the ``language``.
|
|
Returns an :ref:`PackedStringArray<class_PackedStringArray>` of voice identifiers for the ``language``.
|
|
|
|
|
|
-\ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
|
|
|
|
|
|
+\ **Note:** This method is implemented on Android, iOS, Web, Linux, macOS, and Windows.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -1655,7 +1755,7 @@ Returns an :ref:`PackedStringArray<class_PackedStringArray>` of voice identifier
|
|
|
|
|
|
Returns ``true`` if the synthesizer is in a paused state.
|
|
Returns ``true`` if the synthesizer is in a paused state.
|
|
|
|
|
|
-\ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
|
|
|
|
|
|
+\ **Note:** This method is implemented on Android, iOS, Web, Linux, macOS, and Windows.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -1665,7 +1765,7 @@ Returns ``true`` if the synthesizer is in a paused state.
|
|
|
|
|
|
Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue.
|
|
Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue.
|
|
|
|
|
|
-\ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
|
|
|
|
|
|
+\ **Note:** This method is implemented on Android, iOS, Web, Linux, macOS, and Windows.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -1675,7 +1775,7 @@ Returns ``true`` if the synthesizer is generating speech, or have utterance wait
|
|
|
|
|
|
Puts the synthesizer into a paused state.
|
|
Puts the synthesizer into a paused state.
|
|
|
|
|
|
-\ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
|
|
|
|
|
|
+\ **Note:** This method is implemented on Android, iOS, Web, Linux, macOS, and Windows.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -1685,7 +1785,7 @@ Puts the synthesizer into a paused state.
|
|
|
|
|
|
Resumes the synthesizer if it was paused.
|
|
Resumes the synthesizer if it was paused.
|
|
|
|
|
|
-\ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
|
|
|
|
|
|
+\ **Note:** This method is implemented on Android, iOS, Web, Linux, macOS, and Windows.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -1701,7 +1801,7 @@ Adds a callback, which is called when the utterance has started, finished, cance
|
|
|
|
|
|
\ **Note:** The granularity of the boundary callbacks is engine dependent.
|
|
\ **Note:** The granularity of the boundary callbacks is engine dependent.
|
|
|
|
|
|
-\ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
|
|
|
|
|
|
+\ **Note:** This method is implemented on Android, iOS, Web, Linux, macOS, and Windows.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -1725,7 +1825,7 @@ Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is clear
|
|
|
|
|
|
\ **Note:** The granularity of pitch, rate, and volume is engine and voice dependent. Values may be truncated.
|
|
\ **Note:** The granularity of pitch, rate, and volume is engine and voice dependent. Values may be truncated.
|
|
|
|
|
|
-\ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
|
|
|
|
|
|
+\ **Note:** This method is implemented on Android, iOS, Web, Linux, macOS, and Windows.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -1735,7 +1835,7 @@ Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is clear
|
|
|
|
|
|
Stops synthesis in progress and removes all utterances from the queue.
|
|
Stops synthesis in progress and removes all utterances from the queue.
|
|
|
|
|
|
-\ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
|
|
|
|
|
|
+\ **Note:** This method is implemented on Android, iOS, Web, Linux, macOS, and Windows.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -1757,23 +1857,23 @@ Hides the virtual keyboard if it is shown, does nothing otherwise.
|
|
|
|
|
|
.. _class_DisplayServer_method_virtual_keyboard_show:
|
|
.. _class_DisplayServer_method_virtual_keyboard_show:
|
|
|
|
|
|
-- void **virtual_keyboard_show** **(** :ref:`String<class_String>` existing_text, :ref:`Rect2<class_Rect2>` position=Rect2(0, 0, 0, 0), :ref:`bool<class_bool>` multiline=false, :ref:`int<class_int>` max_length=-1, :ref:`int<class_int>` cursor_start=-1, :ref:`int<class_int>` cursor_end=-1 **)**
|
|
|
|
|
|
+- void **virtual_keyboard_show** **(** :ref:`String<class_String>` existing_text, :ref:`Rect2<class_Rect2>` position=Rect2(0, 0, 0, 0), :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` type=0, :ref:`int<class_int>` max_length=-1, :ref:`int<class_int>` cursor_start=-1, :ref:`int<class_int>` cursor_end=-1 **)**
|
|
|
|
|
|
Shows the virtual keyboard if the platform has one.
|
|
Shows the virtual keyboard if the platform has one.
|
|
|
|
|
|
-\ ``existing_text`` parameter is useful for implementing your own :ref:`LineEdit<class_LineEdit>` or :ref:`TextEdit<class_TextEdit>`, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions).
|
|
|
|
|
|
+``existing_text`` parameter is useful for implementing your own :ref:`LineEdit<class_LineEdit>` or :ref:`TextEdit<class_TextEdit>`, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions).
|
|
|
|
|
|
-\ ``position`` parameter is the screen space :ref:`Rect2<class_Rect2>` of the edited text.
|
|
|
|
|
|
+``position`` parameter is the screen space :ref:`Rect2<class_Rect2>` of the edited text.
|
|
|
|
|
|
-\ ``multiline`` parameter needs to be set to ``true`` to be able to enter multiple lines of text, as in :ref:`TextEdit<class_TextEdit>`.
|
|
|
|
|
|
+``type`` parameter allows configuring which type of virtual keyboard to show.
|
|
|
|
|
|
-\ ``max_length`` limits the number of characters that can be entered if different from ``-1``.
|
|
|
|
|
|
+``max_length`` limits the number of characters that can be entered if different from ``-1``.
|
|
|
|
|
|
-\ ``cursor_start`` can optionally define the current text cursor position if ``cursor_end`` is not set.
|
|
|
|
|
|
+``cursor_start`` can optionally define the current text cursor position if ``cursor_end`` is not set.
|
|
|
|
|
|
-\ ``cursor_start`` and ``cursor_end`` can optionally define the current text selection.
|
|
|
|
|
|
+``cursor_start`` and ``cursor_end`` can optionally define the current text selection.
|
|
|
|
|
|
-\ **Note:** This method is implemented on Android, iOS and UWP.
|
|
|
|
|
|
+\ **Note:** This method is implemented on Android, iOS and Web.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -1877,6 +1977,14 @@ Returns the position of the given window to on the screen.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
|
|
+.. _class_DisplayServer_method_window_get_safe_title_margins:
|
|
|
|
+
|
|
|
|
+- :ref:`Vector2i<class_Vector2i>` **window_get_safe_title_margins** **(** :ref:`int<class_int>` window_id=0 **)** |const|
|
|
|
|
+
|
|
|
|
+Returns left and right margins of the title that are safe to use (contains no buttons or other elements) when :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>` flag is set.
|
|
|
|
+
|
|
|
|
+----
|
|
|
|
+
|
|
.. _class_DisplayServer_method_window_get_size:
|
|
.. _class_DisplayServer_method_window_get_size:
|
|
|
|
|
|
- :ref:`Vector2i<class_Vector2i>` **window_get_size** **(** :ref:`int<class_int>` window_id=0 **)** |const|
|
|
- :ref:`Vector2i<class_Vector2i>` **window_get_size** **(** :ref:`int<class_int>` window_id=0 **)** |const|
|
|
@@ -1887,7 +1995,27 @@ Returns the position of the given window to on the screen.
|
|
|
|
|
|
- :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **window_get_vsync_mode** **(** :ref:`int<class_int>` window_id=0 **)** |const|
|
|
- :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **window_get_vsync_mode** **(** :ref:`int<class_int>` window_id=0 **)** |const|
|
|
|
|
|
|
-Returns the VSync mode of the given window.
|
|
|
|
|
|
+Returns the V-Sync mode of the given window.
|
|
|
|
+
|
|
|
|
+----
|
|
|
|
+
|
|
|
|
+.. _class_DisplayServer_method_window_maximize_on_title_dbl_click:
|
|
|
|
+
|
|
|
|
+- :ref:`bool<class_bool>` **window_maximize_on_title_dbl_click** **(** **)** |const|
|
|
|
|
+
|
|
|
|
+Returns ``true``, if double-click on a window title should maximize it.
|
|
|
|
+
|
|
|
|
+\ **Note:** This method is implemented on macOS.
|
|
|
|
+
|
|
|
|
+----
|
|
|
|
+
|
|
|
|
+.. _class_DisplayServer_method_window_minimize_on_title_dbl_click:
|
|
|
|
+
|
|
|
|
+- :ref:`bool<class_bool>` **window_minimize_on_title_dbl_click** **(** **)** |const|
|
|
|
|
+
|
|
|
|
+Returns ``true``, if double-click on a window title should minimize it.
|
|
|
|
+
|
|
|
|
+\ **Note:** This method is implemented on macOS.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -2074,7 +2202,7 @@ Sets the title of the given window to ``title``.
|
|
|
|
|
|
- void **window_set_vsync_mode** **(** :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` vsync_mode, :ref:`int<class_int>` window_id=0 **)**
|
|
- void **window_set_vsync_mode** **(** :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` vsync_mode, :ref:`int<class_int>` window_id=0 **)**
|
|
|
|
|
|
-Sets the VSync mode of the given window.
|
|
|
|
|
|
+Sets the V-Sync mode of the given window.
|
|
|
|
|
|
See :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` for possible values and how they affect the behavior of your application.
|
|
See :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` for possible values and how they affect the behavior of your application.
|
|
|
|
|