Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

DisplayServer

Успадковує: Object

Інтерфейс сервера для управління вікном низького рівня.

Опис

DisplayServer обробляє все, що пов'язано з управлінням вікон. Відокремлюється від OS як єдина операційна система може підтримувати декілька серверів відображення.

Бездротовий режим: Почати двигун з -headless command лінії аргумент відключає всі функції рендерингу та керування вікнами. Більшість функцій з DisplayServer поверне значення манометра в цьому випадку.

Методи

RID	accessibility_create_element(window_id: int, role: AccessibilityRole)
RID	accessibility_create_sub_element(parent_rid: RID, role: AccessibilityRole, insert_pos: int = -1)
RID	accessibility_create_sub_text_edit_elements(parent_rid: RID, shaped_text: RID, min_height: float, insert_pos: int = -1, is_last_line: bool = false)
Variant	accessibility_element_get_meta(id: RID) const
void	accessibility_element_set_meta(id: RID, meta: Variant)
void	accessibility_free_element(id: RID)
RID	accessibility_get_window_root(window_id: int) const
bool	accessibility_has_element(id: RID) const
int	accessibility_screen_reader_active() const
void	accessibility_set_window_focused(window_id: int, focused: bool)
void	accessibility_set_window_rect(window_id: int, rect_out: Rect2, rect_in: Rect2)
int	accessibility_should_increase_contrast() const
int	accessibility_should_reduce_animation() const
int	accessibility_should_reduce_transparency() const
void	accessibility_update_add_action(id: RID, action: AccessibilityAction, callable: Callable)
void	accessibility_update_add_child(id: RID, child_id: RID)
void	accessibility_update_add_custom_action(id: RID, action_id: int, action_description: String)
void	accessibility_update_add_related_controls(id: RID, related_id: RID)
void	accessibility_update_add_related_described_by(id: RID, related_id: RID)
void	accessibility_update_add_related_details(id: RID, related_id: RID)
void	accessibility_update_add_related_flow_to(id: RID, related_id: RID)
void	accessibility_update_add_related_labeled_by(id: RID, related_id: RID)
void	accessibility_update_add_related_radio_group(id: RID, related_id: RID)
void	accessibility_update_set_active_descendant(id: RID, other_id: RID)
void	accessibility_update_set_background_color(id: RID, color: Color)
void	accessibility_update_set_bounds(id: RID, rect: Rect2)
void	accessibility_update_set_checked(id: RID, checekd: bool)
void	accessibility_update_set_classname(id: RID, classname: String)
void	accessibility_update_set_color_value(id: RID, color: Color)
void	accessibility_update_set_description(id: RID, description: String)
void	accessibility_update_set_error_message(id: RID, other_id: RID)
void	accessibility_update_set_extra_info(id: RID, name: String)
void	accessibility_update_set_flag(id: RID, flag: AccessibilityFlags, value: bool)
void	accessibility_update_set_focus(id: RID)
void	accessibility_update_set_foreground_color(id: RID, color: Color)
void	accessibility_update_set_in_page_link_target(id: RID, other_id: RID)
void	accessibility_update_set_language(id: RID, language: String)
void	accessibility_update_set_list_item_count(id: RID, size: int)
void	accessibility_update_set_list_item_expanded(id: RID, expanded: bool)
void	accessibility_update_set_list_item_index(id: RID, index: int)
void	accessibility_update_set_list_item_level(id: RID, level: int)
void	accessibility_update_set_list_item_selected(id: RID, selected: bool)
void	accessibility_update_set_list_orientation(id: RID, vertical: bool)
void	accessibility_update_set_live(id: RID, live: AccessibilityLiveMode)
void	accessibility_update_set_member_of(id: RID, group_id: RID)
void	accessibility_update_set_name(id: RID, name: String)
void	accessibility_update_set_next_on_line(id: RID, other_id: RID)
void	accessibility_update_set_num_jump(id: RID, jump: float)
void	accessibility_update_set_num_range(id: RID, min: float, max: float)
void	accessibility_update_set_num_step(id: RID, step: float)
void	accessibility_update_set_num_value(id: RID, position: float)
void	accessibility_update_set_placeholder(id: RID, placeholder: String)
void	accessibility_update_set_popup_type(id: RID, popup: AccessibilityPopupType)
void	accessibility_update_set_previous_on_line(id: RID, other_id: RID)
void	accessibility_update_set_role(id: RID, role: AccessibilityRole)
void	accessibility_update_set_role_description(id: RID, description: String)
void	accessibility_update_set_scroll_x(id: RID, position: float)
void	accessibility_update_set_scroll_x_range(id: RID, min: float, max: float)
void	accessibility_update_set_scroll_y(id: RID, position: float)
void	accessibility_update_set_scroll_y_range(id: RID, min: float, max: float)
void	accessibility_update_set_shortcut(id: RID, shortcut: String)
void	accessibility_update_set_state_description(id: RID, description: String)
void	accessibility_update_set_table_cell_position(id: RID, row_index: int, column_index: int)
void	accessibility_update_set_table_cell_span(id: RID, row_span: int, column_span: int)
void	accessibility_update_set_table_column_count(id: RID, count: int)
void	accessibility_update_set_table_column_index(id: RID, index: int)
void	accessibility_update_set_table_row_count(id: RID, count: int)
void	accessibility_update_set_table_row_index(id: RID, index: int)
void	accessibility_update_set_text_align(id: RID, align: HorizontalAlignment)
void	accessibility_update_set_text_decorations(id: RID, underline: bool, strikethrough: bool, overline: bool)
void	accessibility_update_set_text_orientation(id: RID, vertical: bool)
void	accessibility_update_set_text_selection(id: RID, text_start_id: RID, start_char: int, text_end_id: RID, end_char: int)
void	accessibility_update_set_tooltip(id: RID, tooltip: String)
void	accessibility_update_set_transform(id: RID, transform: Transform2D)
void	accessibility_update_set_url(id: RID, url: String)
void	accessibility_update_set_value(id: RID, value: String)
void	beep() const
String	clipboard_get() const
Image	clipboard_get_image() const
String	clipboard_get_primary() const
bool	clipboard_has() const
bool	clipboard_has_image() const
void	clipboard_set(clipboard: String)
void	clipboard_set_primary(clipboard_primary: String)
bool	color_picker(callback: Callable)
int	create_status_indicator(icon: Texture2D, tooltip: String, callback: Callable)
CursorShape	cursor_get_shape() const
void	cursor_set_custom_image(cursor: Resource, shape: CursorShape = 0, hotspot: Vector2 = Vector2(0, 0))
void	cursor_set_shape(shape: CursorShape)
void	delete_status_indicator(id: int)
Error	dialog_input_text(title: String, description: String, existing_text: String, callback: Callable)
Error	dialog_show(title: String, description: String, buttons: PackedStringArray, callback: Callable)
void	enable_for_stealing_focus(process_id: int)
Error	file_dialog_show(title: String, current_directory: String, filename: String, show_hidden: bool, mode: FileDialogMode, filters: PackedStringArray, callback: Callable, parent_window_id: int = 0)
Error	file_dialog_with_options_show(title: String, current_directory: String, root: String, filename: String, show_hidden: bool, mode: FileDialogMode, filters: PackedStringArray, options: Array[Dictionary], callback: Callable, parent_window_id: int = 0)
void	force_process_and_drop_events()
Color	get_accent_color() const
Color	get_base_color() const
Array[Rect2]	get_display_cutouts() const
Rect2i	get_display_safe_area() const
int	get_keyboard_focus_screen() const
String	get_name() const
int	get_primary_screen() const
int	get_screen_count() const
int	get_screen_from_rect(rect: Rect2) const
bool	get_swap_cancel_ok()
int	get_window_at_screen_position(position: Vector2i) const
PackedInt32Array	get_window_list() const
int	global_menu_add_check_item(menu_root: String, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	global_menu_add_icon_check_item(menu_root: String, icon: Texture2D, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	global_menu_add_icon_item(menu_root: String, icon: Texture2D, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	global_menu_add_icon_radio_check_item(menu_root: String, icon: Texture2D, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	global_menu_add_item(menu_root: String, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	global_menu_add_multistate_item(menu_root: String, label: String, max_states: int, default_state: int, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	global_menu_add_radio_check_item(menu_root: String, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	global_menu_add_separator(menu_root: String, index: int = -1)
int	global_menu_add_submenu_item(menu_root: String, label: String, submenu: String, index: int = -1)
void	global_menu_clear(menu_root: String)
Key	global_menu_get_item_accelerator(menu_root: String, idx: int) const
Callable	global_menu_get_item_callback(menu_root: String, idx: int) const
int	global_menu_get_item_count(menu_root: String) const
Texture2D	global_menu_get_item_icon(menu_root: String, idx: int) const
int	global_menu_get_item_indentation_level(menu_root: String, idx: int) const
int	global_menu_get_item_index_from_tag(menu_root: String, tag: Variant) const
int	global_menu_get_item_index_from_text(menu_root: String, text: String) const
Callable	global_menu_get_item_key_callback(menu_root: String, idx: int) const
int	global_menu_get_item_max_states(menu_root: String, idx: int) const
int	global_menu_get_item_state(menu_root: String, idx: int) const
String	global_menu_get_item_submenu(menu_root: String, idx: int) const
Variant	global_menu_get_item_tag(menu_root: String, idx: int) const
String	global_menu_get_item_text(menu_root: String, idx: int) const
String	global_menu_get_item_tooltip(menu_root: String, idx: int) const
Dictionary	global_menu_get_system_menu_roots() const
bool	global_menu_is_item_checkable(menu_root: String, idx: int) const
bool	global_menu_is_item_checked(menu_root: String, idx: int) const
bool	global_menu_is_item_disabled(menu_root: String, idx: int) const
bool	global_menu_is_item_hidden(menu_root: String, idx: int) const
bool	global_menu_is_item_radio_checkable(menu_root: String, idx: int) const
void	global_menu_remove_item(menu_root: String, idx: int)
void	global_menu_set_item_accelerator(menu_root: String, idx: int, keycode: Key)
void	global_menu_set_item_callback(menu_root: String, idx: int, callback: Callable)
void	global_menu_set_item_checkable(menu_root: String, idx: int, checkable: bool)
void	global_menu_set_item_checked(menu_root: String, idx: int, checked: bool)
void	global_menu_set_item_disabled(menu_root: String, idx: int, disabled: bool)
void	global_menu_set_item_hidden(menu_root: String, idx: int, hidden: bool)
void	global_menu_set_item_hover_callbacks(menu_root: String, idx: int, callback: Callable)
void	global_menu_set_item_icon(menu_root: String, idx: int, icon: Texture2D)
void	global_menu_set_item_indentation_level(menu_root: String, idx: int, level: int)
void	global_menu_set_item_key_callback(menu_root: String, idx: int, key_callback: Callable)
void	global_menu_set_item_max_states(menu_root: String, idx: int, max_states: int)
void	global_menu_set_item_radio_checkable(menu_root: String, idx: int, checkable: bool)
void	global_menu_set_item_state(menu_root: String, idx: int, state: int)
void	global_menu_set_item_submenu(menu_root: String, idx: int, submenu: String)
void	global_menu_set_item_tag(menu_root: String, idx: int, tag: Variant)
void	global_menu_set_item_text(menu_root: String, idx: int, text: String)
void	global_menu_set_item_tooltip(menu_root: String, idx: int, tooltip: String)
void	global_menu_set_popup_callbacks(menu_root: String, open_callback: Callable, close_callback: Callable)
bool	has_additional_outputs() const
bool	has_feature(feature: Feature) const
bool	has_hardware_keyboard() const
void	help_set_search_callbacks(search_callback: Callable, action_callback: Callable)
Vector2i	ime_get_selection() const
String	ime_get_text() const
bool	is_dark_mode() const
bool	is_dark_mode_supported() const
bool	is_in_pip_mode(window_id: int = 0)
bool	is_touchscreen_available() const
bool	is_window_transparency_available() const
int	keyboard_get_current_layout() const
Key	keyboard_get_keycode_from_physical(keycode: Key) const
Key	keyboard_get_label_from_physical(keycode: Key) const
int	keyboard_get_layout_count() const
String	keyboard_get_layout_language(index: int) const
String	keyboard_get_layout_name(index: int) const
void	keyboard_set_current_layout(index: int)
BitField[MouseButtonMask]	mouse_get_button_state() const
MouseMode	mouse_get_mode() const
Vector2i	mouse_get_position() const
void	mouse_set_mode(mouse_mode: MouseMode)
void	pip_mode_enter(window_id: int = 0)
void	pip_mode_set_aspect_ratio(numerator: int, denominator: int, window_id: int = 0)
void	pip_mode_set_auto_enter_on_background(auto_enter_on_background: bool, window_id: int = 0)
void	process_events()
void	register_additional_output(object: Object)
int	screen_get_dpi(screen: int = -1) const
Image	screen_get_image(screen: int = -1) const
Image	screen_get_image_rect(rect: Rect2i) const
float	screen_get_max_scale() const
ScreenOrientation	screen_get_orientation(screen: int = -1) const
Color	screen_get_pixel(position: Vector2i) const
Vector2i	screen_get_position(screen: int = -1) const
float	screen_get_refresh_rate(screen: int = -1) const
float	screen_get_scale(screen: int = -1) const
Vector2i	screen_get_size(screen: int = -1) const
Rect2i	screen_get_usable_rect(screen: int = -1) const
bool	screen_is_kept_on() const
void	screen_set_keep_on(enable: bool)
void	screen_set_orientation(orientation: ScreenOrientation, screen: int = -1)
void	set_hardware_keyboard_connection_change_callback(callable: Callable)
void	set_icon(image: Image)
void	set_native_icon(filename: String)
void	set_system_theme_change_callback(callable: Callable)
void	show_emoji_and_symbol_picker() const
Rect2	status_indicator_get_rect(id: int) const
void	status_indicator_set_callback(id: int, callback: Callable)
void	status_indicator_set_icon(id: int, icon: Texture2D)
void	status_indicator_set_menu(id: int, menu_rid: RID)
void	status_indicator_set_tooltip(id: int, tooltip: String)
String	tablet_get_current_driver() const
int	tablet_get_driver_count() const
String	tablet_get_driver_name(idx: int) const
void	tablet_set_current_driver(name: String)
Array[Dictionary]	tts_get_voices() const
PackedStringArray	tts_get_voices_for_language(language: String) const
bool	tts_is_paused() const
bool	tts_is_speaking() const
void	tts_pause()
void	tts_resume()
void	tts_set_utterance_callback(event: TTSUtteranceEvent, callable: Callable)
void	tts_speak(text: String, voice: String, volume: int = 50, pitch: float = 1.0, rate: float = 1.0, utterance_id: int = 0, interrupt: bool = false)
void	tts_stop()
void	unregister_additional_output(object: Object)
int	virtual_keyboard_get_height() const
void	virtual_keyboard_hide()
void	virtual_keyboard_show(existing_text: String, position: Rect2 = Rect2(0, 0, 0, 0), type: VirtualKeyboardType = 0, max_length: int = -1, cursor_start: int = -1, cursor_end: int = -1)
void	warp_mouse(position: Vector2i)
bool	window_can_draw(window_id: int = 0) const
int	window_get_active_popup() const
int	window_get_attached_instance_id(window_id: int = 0) const
int	window_get_current_screen(window_id: int = 0) const
bool	window_get_flag(flag: WindowFlags, window_id: int = 0) const
float	window_get_hdr_output_current_max_luminance(window_id: int = 0) const
float	window_get_hdr_output_current_reference_luminance(window_id: int = 0) const
float	window_get_hdr_output_max_luminance(window_id: int = 0) const
float	window_get_hdr_output_reference_luminance(window_id: int = 0) const
Vector2i	window_get_max_size(window_id: int = 0) const
Vector2i	window_get_min_size(window_id: int = 0) const
WindowMode	window_get_mode(window_id: int = 0) const
int	window_get_native_handle(handle_type: HandleType, window_id: int = 0) const
float	window_get_output_max_linear_value(window_id: int = 0) const
Rect2i	window_get_popup_safe_rect(window: int) const
Vector2i	window_get_position(window_id: int = 0) const
Vector2i	window_get_position_with_decorations(window_id: int = 0) const
Vector3i	window_get_safe_title_margins(window_id: int = 0) const
Vector2i	window_get_size(window_id: int = 0) const
Vector2i	window_get_size_with_decorations(window_id: int = 0) const
Vector2i	window_get_title_size(title: String, window_id: int = 0) const
VSyncMode	window_get_vsync_mode(window_id: int = 0) const
bool	window_is_focused(window_id: int = 0) const
bool	window_is_hdr_output_enabled(window_id: int = 0) const
bool	window_is_hdr_output_requested(window_id: int = 0) const
bool	window_is_hdr_output_supported(window_id: int = 0) const
bool	window_is_maximize_allowed(window_id: int = 0) const
bool	window_maximize_on_title_dbl_click() const
bool	window_minimize_on_title_dbl_click() const
void	window_move_to_foreground(window_id: int = 0)
void	window_request_attention(window_id: int = 0)
void	window_request_hdr_output(enable: bool, window_id: int = 0)
void	window_set_color(color: Color)
void	window_set_current_screen(screen: int, window_id: int = 0)
void	window_set_drop_files_callback(callback: Callable, window_id: int = 0)
void	window_set_exclusive(window_id: int, exclusive: bool)
void	window_set_flag(flag: WindowFlags, enabled: bool, window_id: int = 0)
void	window_set_hdr_output_max_luminance(max_luminance: float, window_id: int = 0)
void	window_set_hdr_output_reference_luminance(reference_luminance: float, window_id: int = 0)
void	window_set_icon(icon: Image, window_id: int = 0)
void	window_set_ime_active(active: bool, window_id: int = 0)
void	window_set_ime_position(position: Vector2i, window_id: int = 0)
void	window_set_input_event_callback(callback: Callable, window_id: int = 0)
void	window_set_input_text_callback(callback: Callable, window_id: int = 0)
void	window_set_max_size(max_size: Vector2i, window_id: int = 0)
void	window_set_min_size(min_size: Vector2i, window_id: int = 0)
void	window_set_mode(mode: WindowMode, window_id: int = 0)
void	window_set_mouse_passthrough(region: PackedVector2Array, window_id: int = 0)
void	window_set_popup_safe_rect(window: int, rect: Rect2i)
void	window_set_position(position: Vector2i, window_id: int = 0)
void	window_set_rect_changed_callback(callback: Callable, window_id: int = 0)
void	window_set_size(size: Vector2i, window_id: int = 0)
void	window_set_taskbar_progress_state(state: ProgressState, window_id: int = 0)
void	window_set_taskbar_progress_value(value: float, window_id: int = 0)
void	window_set_title(title: String, window_id: int = 0)
void	window_set_transient(window_id: int, parent_window_id: int)
void	window_set_vsync_mode(vsync_mode: VSyncMode, window_id: int = 0)
void	window_set_window_buttons_offset(offset: Vector2i, window_id: int = 0)
void	window_set_window_event_callback(callback: Callable, window_id: int = 0)
void	window_start_drag(window_id: int = 0)
void	window_start_resize(edge: WindowResizeEdge, window_id: int = 0)

Сигнали

orientation_changed(orientation: int) 🔗

Emitted when the device orientation changes. orientation is the new orientation.

Returns 1 for portrait, 2 for landscape, and 0 if the orientation is undefined.

Note: This method is implemented on Android and iOS.

Переліки

enum Feature: 🔗

Feature FEATURE_GLOBAL_MENU = 0

Застаріло: Use NativeMenu or PopupMenu instead.

Підтримує глобальне меню. Ця програма дозволяє відображати елементи меню в верхній панелі операційної системи. macOS

Feature FEATURE_SUBWINDOWS = 1

Відображення сервера підтримує декілька вікон, які можна переміщати за межі основного вікна. Windows, macOS, Linux

Feature FEATURE_TOUCHSCREEN = 2

Display server supports touchscreen input. Windows, Linux (X11/Wayland), Android, iOS, Web

Feature FEATURE_MOUSE = 3

Дисплей сервера підтримує введення мишки. Windows, macOS, Linux (X11/Wayland), Android, Web

Feature FEATURE_MOUSE_WARP = 4

Дисплей сервера підтримує координати Warping мишки, щоб зберегти курсор мишки, обмежений в межах області, але петляцію при досягненні одного з країв. Windows, macOS, Linux (X11/Wayland)

Feature FEATURE_CLIPBOARD = 5

Налаштування та отримання даних на клавіатурі. Дивитися також FEATURE_CLIPBOARD_PRIMARY. Windows, macOS, Linux (X11/Wayland), Android, iOS, Web

Feature FEATURE_VIRTUAL_KEYBOARD = 6

Відображення сервера підтримує завантаження віртуальної клавіатури, коли запитується ввести текст без фізичної клавіатури. Android, iOS, Web

Feature FEATURE_CURSOR_SHAPE = 7

Дисплей сервера підтримує встановлення форми курсора миші, щоб бути різними від за замовчуванням. Windows, macOS, Linux (X11/Wayland), Android, Web

Feature FEATURE_CUSTOM_CURSOR_SHAPE = 8

Дисплей сервера підтримує встановлення форми курсора миші на користувацьке зображення. Windows, macOS, Linux (X11/Wayland), Web

Feature FEATURE_NATIVE_DIALOG = 9

Дисплей сервера підтримує діалогове вікно, використовуючи рідний вигляд операційної системи. Див. діалог_show(). Windows, macOS

Feature FEATURE_IME = 10

Дисплей сервера підтримує Держектор метода, який зазвичай використовується для введення китайського/японського/Коренського тексту. Це керується операційною системою, а не Godot. Windows, macOS, Linux

Feature FEATURE_WINDOW_TRANSPARENCY = 11

Сервер дисплеїв підтримує вікна, які можуть використовувати прозорість для кожного пікселя, щоб зробити вікна за ними частково або повністю видимими. Windows, macOS, Linux (X11/Wayland), Android

Feature FEATURE_HIDPI = 12

Сервер дисплеїв підтримує запити щодо коефіцієнта масштабування дисплея операційної системи. Це дозволяє автоматично надійно визначати дисплей hiDPI, замість того, щоб здогадуватися на основі роздільної здатності екрана та повідомленої DPI дисплея (яка може бути ненадійною через несправний EDID монітора). Windows, Linux (Wayland), macOS

Feature FEATURE_ICON = 13

Сервер відображення підтримує зміну значка вікна (зазвичай відображається у верхньому лівому куті). Windows, macOS, Linux (X11/Wayland)

Примітка: Використання на Wayland вимагає від композитора реалізації протоколу xdg_toplevel_icon_v1, який підтримують не всі композитори. Див. xdg_toplevel_icon_v1#compositor-support для отримання додаткової інформації про підтримку окремих композиторів.

Feature FEATURE_NATIVE_ICON = 14

Відображення сервера підтримує зміну іконки вікна (зазвичай відображається у верхньому лівому куті). Windows, macOS

Feature FEATURE_ORIENTATION = 15

Дисплей сервера підтримує зміну орієнтації екрану. Android, iOS

Feature FEATURE_SWAP_BUFFERS = 16

Відобразити сервер підтримує статус V-Sync може бути змінено з за замовчуванням (який змушений бути ввімкненими платформами, які не підтримують цю функцію). Windows, macOS, Linux (X11/Wayland)

Feature FEATURE_CLIPBOARD_PRIMARY = 18

Використовуваний сервер підтримує первинний буфер обміну. Це інший буфер з FEATURE_CLIPBOARD. Linux (X11/Wayland)

Feature FEATURE_TEXT_TO_SPEECH = 19

Дисплей сервера підтримує текстове вікно. tts_* методи. Windows, macOS, Linux (X11/Wayland), Android, iOS, Web

Feature FEATURE_EXTEND_TO_TITLE = 20

Відображення сервера підтримує розширення вмісту вікна до назви. Див. WINDOW_FLAG_EXTEND_TO_TITLE. macOS

Feature FEATURE_SCREEN_CAPTURE = 21

Сервер дисплея підтримує зчитування пікселів екрана. Див. screen_get_pixel().

Feature FEATURE_STATUS_INDICATOR = 22

Дисплей сервера підтримує показники стану додатків.

Feature FEATURE_NATIVE_HELP = 23

Сервер відображення підтримує зворотні виклики пошуку вбудованої довідкової системи. Див. help_set_search_callbacks().

Feature FEATURE_NATIVE_DIALOG_INPUT = 24

Сервер відображення підтримує створення діалогових вікон введення тексту, використовуючи вбудований зовнішній вигляд операційної системи. Див. dialog_input_text(). Windows, macOS

Feature FEATURE_NATIVE_DIALOG_FILE = 25

Дисплейний сервер підтримує створення діалогових вікон для вибору файлів або каталогів із використанням зовнішнього вигляду операційної системи. Перегляньте file_dialog_show(). Windows, macOS, Linux (X11/Wayland), Android

Feature FEATURE_NATIVE_DIALOG_FILE_EXTRA = 26

Сервер відображення підтримує всі функції FEATURE_NATIVE_DIALOG_FILE із доданими функціями Параметрів і власним доступом до діалогового файлу за шляхами res:// і user://. Перегляньте file_dialog_show() і file_dialog_with_options_show(). Windows, macOS, Linux (X11/Wayland)

Feature FEATURE_WINDOW_DRAG = 27

Сервер відображення підтримує операції перетягування вікна та зміни розміру за запитом. Див. window_start_drag() і window_start_resize().

Feature FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE = 28

Сервер відображення підтримує прапорець вікна WINDOW_FLAG_EXCLUDE_FROM_CAPTURE. Windows, macOS

Feature FEATURE_WINDOW_EMBEDDING = 29

Сервер відображення підтримує вбудовування вікна з іншого процесу. Windows, Linux (X11), macOS

Feature FEATURE_NATIVE_DIALOG_FILE_MIME = 30

Власне діалогове вікно вибору файлів підтримує типи MIME як фільтри.

Feature FEATURE_EMOJI_AND_SYMBOL_PICKER = 31

Дисплейний сервер підтримує системні смайли та засіб вибору символів. Windows, macOS

Feature FEATURE_NATIVE_COLOR_PICKER = 32

Сервер дисплея підтримує вбудований вибір кольору. Linux (X11/Wayland)

Feature FEATURE_SELF_FITTING_WINDOWS = 33

Сервер відображення автоматично підганяє спливаючі вікна відповідно до меж екрана. Вузли вікон не повинні намагатися робити це самостійно.

Feature FEATURE_ACCESSIBILITY_SCREEN_READER = 34

Сервер дисплея підтримує взаємодію з програмою зчитування з екрана або дисплеєм Брайля. Linux (X11/Wayland), macOS, Windows

Feature FEATURE_HDR_OUTPUT = 35

Display server supports HDR output. Linux (Wayland), macOS, iOS, visionOS, Windows

Feature FEATURE_PIP_MODE = 36

Display server supports putting the application in picture-in-picture mode. Android

enum AccessibilityRole: 🔗

AccessibilityRole ROLE_UNKNOWN = 0

Застаріло: Use AccessibilityServer instead.

Невідома або спеціальна роль.

AccessibilityRole ROLE_DEFAULT_BUTTON = 1

Застаріло: Use AccessibilityServer instead.

Елемент кнопки діалогового вікна за замовчуванням.

AccessibilityRole ROLE_AUDIO = 2

Застаріло: Use AccessibilityServer instead.

Елемент аудіоплеєра.

AccessibilityRole ROLE_VIDEO = 3

Застаріло: Use AccessibilityServer instead.

Елемент відеоплеєра.

AccessibilityRole ROLE_STATIC_TEXT = 4

Застаріло: Use AccessibilityServer instead.

Нередагуємий текстовий ярлик.

AccessibilityRole ROLE_CONTAINER = 5

Застаріло: Use AccessibilityServer instead.

Елемент-контейнер. Елементи з цією роллю використовуються для внутрішньої структури та ігноруються програмами зчитування з екрана.

AccessibilityRole ROLE_PANEL = 6

Застаріло: Use AccessibilityServer instead.

Елемент контейнера панелі.

AccessibilityRole ROLE_BUTTON = 7

Застаріло: Use AccessibilityServer instead.

Елемент кнопки.

AccessibilityRole ROLE_LINK = 8

Застаріло: Use AccessibilityServer instead.

Елемент посилання.

AccessibilityRole ROLE_CHECK_BOX = 9

Застаріло: Use AccessibilityServer instead.

Елемент прапорця.

AccessibilityRole ROLE_RADIO_BUTTON = 10

Застаріло: Use AccessibilityServer instead.

Елемент радіокнопки.

AccessibilityRole ROLE_CHECK_BUTTON = 11

Застаріло: Use AccessibilityServer instead.

Перевірте елемент кнопки.

AccessibilityRole ROLE_SCROLL_BAR = 12

Застаріло: Use AccessibilityServer instead.

Елемент смуги прокручування.

AccessibilityRole ROLE_SCROLL_VIEW = 13

Застаріло: Use AccessibilityServer instead.

Елемент контейнера прокручування.

AccessibilityRole ROLE_SPLITTER = 14

Застаріло: Use AccessibilityServer instead.

Елемент ручки роздільника контейнера.

AccessibilityRole ROLE_SLIDER = 15

Застаріло: Use AccessibilityServer instead.

Елемент слайдера.

AccessibilityRole ROLE_SPIN_BUTTON = 16

Застаріло: Use AccessibilityServer instead.

Елемент спін-боксу.

AccessibilityRole ROLE_PROGRESS_INDICATOR = 17

Застаріло: Use AccessibilityServer instead.

Елемент індикатора прогресу.

AccessibilityRole ROLE_TEXT_FIELD = 18

Застаріло: Use AccessibilityServer instead.

Елемент текстового поля, який можна редагувати.

AccessibilityRole ROLE_MULTILINE_TEXT_FIELD = 19

Застаріло: Use AccessibilityServer instead.

Багаторядковий елемент текстового поля з можливістю редагування.

AccessibilityRole ROLE_COLOR_PICKER = 20

Застаріло: Use AccessibilityServer instead.

Елемент вибору кольору.

AccessibilityRole ROLE_TABLE = 21

Застаріло: Use AccessibilityServer instead.

Елемент таблиці.

AccessibilityRole ROLE_CELL = 22

Застаріло: Use AccessibilityServer instead.

Елемент комірки таблиці/дерева.

AccessibilityRole ROLE_ROW = 23

Застаріло: Use AccessibilityServer instead.

Елемент рядка таблиці/дерева.

AccessibilityRole ROLE_ROW_GROUP = 24

Застаріло: Use AccessibilityServer instead.

Елемент групи рядків таблиці/дерева.

AccessibilityRole ROLE_ROW_HEADER = 25

Застаріло: Use AccessibilityServer instead.

Елемент заголовка рядка таблиці/дерева.

AccessibilityRole ROLE_COLUMN_HEADER = 26

Застаріло: Use AccessibilityServer instead.

Елемент заголовка стовпця таблиці/дерева.

AccessibilityRole ROLE_TREE = 27

Застаріло: Use AccessibilityServer instead.

Елемент деревоподібного вигляду.

AccessibilityRole ROLE_TREE_ITEM = 28

Застаріло: Use AccessibilityServer instead.

Елемент деревоподібного вигляду.

AccessibilityRole ROLE_LIST = 29

Застаріло: Use AccessibilityServer instead.

Елемент списку.

AccessibilityRole ROLE_LIST_ITEM = 30

Застаріло: Use AccessibilityServer instead.

Елемент списку.

AccessibilityRole ROLE_LIST_BOX = 31

Застаріло: Use AccessibilityServer instead.

Елемент спискового перегляду.

AccessibilityRole ROLE_LIST_BOX_OPTION = 32

Застаріло: Use AccessibilityServer instead.

Елемент списку.

AccessibilityRole ROLE_TAB_BAR = 33

Застаріло: Use AccessibilityServer instead.

Елемент панелі вкладок.

AccessibilityRole ROLE_TAB = 34

Застаріло: Use AccessibilityServer instead.

Елемент панелі вкладок.

AccessibilityRole ROLE_TAB_PANEL = 35

Застаріло: Use AccessibilityServer instead.

Елемент панелі вкладок.

AccessibilityRole ROLE_MENU_BAR = 36

Застаріло: Use AccessibilityServer instead.

Елемент рядка меню.

AccessibilityRole ROLE_MENU = 37

Застаріло: Use AccessibilityServer instead.

Елемент спливаючого меню.

AccessibilityRole ROLE_MENU_ITEM = 38

Застаріло: Use AccessibilityServer instead.

Елемент спливаючого меню.

AccessibilityRole ROLE_MENU_ITEM_CHECK_BOX = 39

Застаріло: Use AccessibilityServer instead.

Елемент кнопки перевірки спливаючого меню.

AccessibilityRole ROLE_MENU_ITEM_RADIO = 40

Застаріло: Use AccessibilityServer instead.

Елемент перемикача спливаючого меню.

AccessibilityRole ROLE_IMAGE = 41

Застаріло: Use AccessibilityServer instead.

Елемент зображення.

AccessibilityRole ROLE_WINDOW = 42

Застаріло: Use AccessibilityServer instead.

Віконний елемент.

AccessibilityRole ROLE_TITLE_BAR = 43

Застаріло: Use AccessibilityServer instead.

Вбудований елемент рядка заголовка вікна.

AccessibilityRole ROLE_DIALOG = 44

Застаріло: Use AccessibilityServer instead.

Елемент діалогового вікна.

AccessibilityRole ROLE_TOOLTIP = 45

Застаріло: Use AccessibilityServer instead.

Елемент підказки.

AccessibilityRole ROLE_REGION = 46

Застаріло: Use AccessibilityServer instead.

Region/landmark element. Screen readers can navigate between regions using landmark navigation.

AccessibilityRole ROLE_TEXT_RUN = 47

Застаріло: Use AccessibilityServer instead.

Unifor text run.

Note: This role is used for internal text elements, and should not be assigned to nodes.

enum AccessibilityPopupType: 🔗

AccessibilityPopupType POPUP_MENU = 0

Застаріло: Use AccessibilityServer instead.

Спливаюче меню.

AccessibilityPopupType POPUP_LIST = 1

Застаріло: Use AccessibilityServer instead.

Спливаючий список.

AccessibilityPopupType POPUP_TREE = 2

Застаріло: Use AccessibilityServer instead.

Спливаюче деревоподібне представлення.

AccessibilityPopupType POPUP_DIALOG = 3

Застаріло: Use AccessibilityServer instead.

Спливаюче діалогове вікно.

enum AccessibilityFlags: 🔗

AccessibilityFlags FLAG_HIDDEN = 0

Застаріло: Use AccessibilityServer instead.

Елемент приховано для інструментів доступності.

AccessibilityFlags FLAG_MULTISELECTABLE = 1

Застаріло: Use AccessibilityServer instead.

Елемент підтримує вибір кількох елементів.

AccessibilityFlags FLAG_REQUIRED = 2

Застаріло: Use AccessibilityServer instead.

Елемент вимагає введення даних користувачем.

AccessibilityFlags FLAG_VISITED = 3

Застаріло: Use AccessibilityServer instead.

Елемент – це відвідане посилання.

AccessibilityFlags FLAG_BUSY = 4

Застаріло: Use AccessibilityServer instead.

Вміст елемента не готовий (наприклад, завантажується).

AccessibilityFlags FLAG_MODAL = 5

Застаріло: Use AccessibilityServer instead.

Елемент — це модальне вікно.

AccessibilityFlags FLAG_TOUCH_PASSTHROUGH = 6

Застаріло: Use AccessibilityServer instead.

Елемент дозволяє передавати дотики, коли програма зчитування з екрана перебуває в режимі сенсорного дослідження.

AccessibilityFlags FLAG_READONLY = 7

Застаріло: Use AccessibilityServer instead.

Елемент – це текстове поле з текстом, який можна вибрати, але він доступний лише для читання.

AccessibilityFlags FLAG_DISABLED = 8

Застаріло: Use AccessibilityServer instead.

Елемент вимкнено.

AccessibilityFlags FLAG_CLIPS_CHILDREN = 9

Застаріло: Use AccessibilityServer instead.

Діти-кліпи елементів.

enum AccessibilityAction: 🔗

AccessibilityAction ACTION_CLICK = 0

Застаріло: Use AccessibilityServer instead.

Дія одним кліком, аргумент зворотного виклику не встановлено.

AccessibilityAction ACTION_FOCUS = 1

Застаріло: Use AccessibilityServer instead.

Дія фокусування, аргумент зворотного виклику не встановлено.

AccessibilityAction ACTION_BLUR = 2

Застаріло: Use AccessibilityServer instead.

Дія розмиття, аргумент зворотного виклику не встановлено.

AccessibilityAction ACTION_COLLAPSE = 3

Застаріло: Use AccessibilityServer instead.

Дія згортання, аргумент зворотного виклику не встановлено.

AccessibilityAction ACTION_EXPAND = 4

Застаріло: Use AccessibilityServer instead.

Дія розгортання, аргумент зворотного виклику не встановлено.

AccessibilityAction ACTION_DECREMENT = 5

Застаріло: Use AccessibilityServer instead.

Дія зменшення, аргумент зворотного виклику не встановлено.

AccessibilityAction ACTION_INCREMENT = 6

Застаріло: Use AccessibilityServer instead.

Дія збільшення, аргумент зворотного виклику не встановлено.

AccessibilityAction ACTION_HIDE_TOOLTIP = 7

Застаріло: Use AccessibilityServer instead.

Дія приховування підказки, аргумент зворотного виклику не встановлено.

AccessibilityAction ACTION_SHOW_TOOLTIP = 8

Застаріло: Use AccessibilityServer instead.

Показати дію підказки, аргумент зворотного виклику не встановлено.

AccessibilityAction ACTION_SET_TEXT_SELECTION = 9

Застаріло: Use AccessibilityServer instead.

Встановити дію вибору тексту, аргумент зворотного виклику встановлено на Dictionary з такими ключами:

"start_element" елемент доступності початку вибору.
"start_char" зміщення символу відносно елемента доступності початку вибору.
"end_element" елемент доступності кінця вибору.
"end_char" зміщення символу відносно елемента доступності кінця вибору.

AccessibilityAction ACTION_REPLACE_SELECTED_TEXT = 10

Застаріло: Use AccessibilityServer instead.

Дія заміни тексту, аргумент зворотного виклику встановлено на String із текстом заміни.

AccessibilityAction ACTION_SCROLL_BACKWARD = 11

Застаріло: Use AccessibilityServer instead.

Дія прокручування назад, аргумент зворотного виклику не встановлено.

AccessibilityAction ACTION_SCROLL_DOWN = 12

Застаріло: Use AccessibilityServer instead.

Дія прокручування вниз, аргумент зворотного виклику встановлено на AccessibilityScrollUnit.

AccessibilityAction ACTION_SCROLL_FORWARD = 13

Застаріло: Use AccessibilityServer instead.

Дія прокручування вперед, аргумент зворотного виклику не встановлено.

AccessibilityAction ACTION_SCROLL_LEFT = 14

Застаріло: Use AccessibilityServer instead.

Дія прокручування ліворуч, аргумент зворотного виклику встановлено на AccessibilityScrollUnit.

AccessibilityAction ACTION_SCROLL_RIGHT = 15

Застаріло: Use AccessibilityServer instead.

Дія прокручування праворуч, аргумент зворотного виклику встановлено на AccessibilityScrollUnit.

AccessibilityAction ACTION_SCROLL_UP = 16

Застаріло: Use AccessibilityServer instead.

Дія прокручування вгору, аргумент зворотного виклику встановлено на AccessibilityScrollUnit.

AccessibilityAction ACTION_SCROLL_INTO_VIEW = 17

Застаріло: Use AccessibilityServer instead.

Прокрутити до перегляду, аргумент зворотного виклику встановлено на AccessibilityScrollHint.

AccessibilityAction ACTION_SCROLL_TO_POINT = 18

Застаріло: Use AccessibilityServer instead.

Дія прокручування до точки, аргумент зворотного виклику встановлено на Vector2 з відносними координатами точки.

AccessibilityAction ACTION_SET_SCROLL_OFFSET = 19

Застаріло: Use AccessibilityServer instead.

Встановити дію зміщення прокручування, аргумент зворотного виклику встановлено на Vector2 зі зміщенням прокручування.

AccessibilityAction ACTION_SET_VALUE = 20

Застаріло: Use AccessibilityServer instead.

Дія встановлення значення, аргумент зворотного виклику встановлено на String або число з новим значенням.

AccessibilityAction ACTION_SHOW_CONTEXT_MENU = 21

Застаріло: Use AccessibilityServer instead.

Показати дію контекстного меню, аргумент зворотного виклику не встановлено.

AccessibilityAction ACTION_CUSTOM = 22

Застаріло: Use AccessibilityServer instead.

Для аргументу зворотного виклику настроюваної дії встановлено цілочисельний ідентифікатор дії.

enum AccessibilityLiveMode: 🔗

AccessibilityLiveMode LIVE_OFF = 0

Застаріло: Use AccessibilityServer instead.

Вказує на те, що оновлення активного регіону не повинні відображатися.

AccessibilityLiveMode LIVE_POLITE = 1

Застаріло: Use AccessibilityServer instead.

Вказує на те, що оновлення активної області мають бути представлені за наступної нагоди (наприклад, в кінці озвучування поточного речення).

AccessibilityLiveMode LIVE_ASSERTIVE = 2

Застаріло: Use AccessibilityServer instead.

Вказує на те, що оновлення активного регіону мають найвищий пріоритет і повинні бути представлені негайно.

enum AccessibilityScrollUnit: 🔗

AccessibilityScrollUnit SCROLL_UNIT_ITEM = 0

Застаріло: Use AccessibilityServer instead.

Величина прокручування. Окремий елемент списку, рядок тексту.

AccessibilityScrollUnit SCROLL_UNIT_PAGE = 1

Застаріло: Use AccessibilityServer instead.

Величина прокручування. Одна сторінка.

enum AccessibilityScrollHint: 🔗

AccessibilityScrollHint SCROLL_HINT_TOP_LEFT = 0

Застаріло: Use AccessibilityServer instead.

Бажане положення для вузла, прокрученого у поле зору. Верхній лівий край контейнера прокручування.

AccessibilityScrollHint SCROLL_HINT_BOTTOM_RIGHT = 1

Застаріло: Use AccessibilityServer instead.

Бажане положення для вузла, прокрученого у поле зору. Нижній правий край контейнера прокручування.

AccessibilityScrollHint SCROLL_HINT_TOP_EDGE = 2

Застаріло: Use AccessibilityServer instead.

Бажане положення для вузла, прокрученого у поле зору. Верхній край контейнера прокручування.

AccessibilityScrollHint SCROLL_HINT_BOTTOM_EDGE = 3

Застаріло: Use AccessibilityServer instead.

Бажане положення для вузла, прокрученого у поле зору. Нижній край контейнера прокручування.

AccessibilityScrollHint SCROLL_HINT_LEFT_EDGE = 4

Застаріло: Use AccessibilityServer instead.

Бажане положення для вузла, прокрученого у поле зору. Лівий край контейнера прокручування.

AccessibilityScrollHint SCROLL_HINT_RIGHT_EDGE = 5

Застаріло: Use AccessibilityServer instead.

Бажане положення для вузла, прокрученого у поле зору. Правий край контейнера прокручування.

enum MouseMode: 🔗

MouseMode MOUSE_MODE_VISIBLE = 0

Зробіть курсор мишки видимим, якщо він прихований.

MouseMode MOUSE_MODE_HIDDEN = 1

Зробіть курсор миші, прихований, якщо це видно.

MouseMode MOUSE_MODE_CAPTURED = 2

Захоплює мишу. Миша буде прихована і її позиція закривається в центрі вікна менеджера.

Примітка: Якщо ви хочете обробити рух мишки в цьому режимі, вам потрібно скористатися InputEventMouseMotion.relative.

MouseMode MOUSE_MODE_CONFINED = 3

Налаштуйте курсор миші на ігровому вікні, і зробіть його видимими.

MouseMode MOUSE_MODE_CONFINED_HIDDEN = 4

Налаштуйте курсор миші на ігровому вікні, і зробіть його прихованим.

MouseMode MOUSE_MODE_MAX = 5

Максимальне значення MouseMode.

enum ScreenOrientation: 🔗

ScreenOrientation SCREEN_LANDSCAPE = 0

За замовчуванням ландшафтна спрямованість.

ScreenOrientation SCREEN_PORTRAIT = 1

За замовчуванням портретна спрямованість.

ScreenOrientation SCREEN_REVERSE_LANDSCAPE = 2

Зворотна ландшафтна спрямованість (поза внизу).

ScreenOrientation SCREEN_REVERSE_PORTRAIT = 3

Зворотна портретна спрямованість (поза внизу).

ScreenOrientation SCREEN_SENSOR_LANDSCAPE = 4

Автоматична ландшафтна спрямованість (за замовчуванням або зворотний в залежності від датчика).

ScreenOrientation SCREEN_SENSOR_PORTRAIT = 5

Автоматична портретна спрямованість (за замовчуванням або зворотна в залежності від датчика).

ScreenOrientation SCREEN_SENSOR = 6

Автоматична ландшафтна або портретна орієнтація (за замовчуванням або зворотна в залежності від датчика).

enum VirtualKeyboardType: 🔗

VirtualKeyboardType KEYBOARD_TYPE_DEFAULT = 0

За замовчуванням текст віртуальної клавіатури.

VirtualKeyboardType KEYBOARD_TYPE_MULTILINE = 1

Багатоканальна віртуальна клавіатура.

VirtualKeyboardType KEYBOARD_TYPE_NUMBER = 2

Віртуальний номер клавіатури, корисний для входу PIN.

VirtualKeyboardType KEYBOARD_TYPE_NUMBER_DECIMAL = 3

Віртуальний номер клавіатури, корисний для введення дробових чисел.

VirtualKeyboardType KEYBOARD_TYPE_PHONE = 4

Віртуальна телефонна клавіатура.

VirtualKeyboardType KEYBOARD_TYPE_EMAIL_ADDRESS = 5

Віртуальна клавіатура з додатковими ключами, щоб допомогти з налаштуванням електронних адрес.

VirtualKeyboardType KEYBOARD_TYPE_PASSWORD = 6

Віртуальна клавіатура для введення пароля. На більшості платформ, це слід відключити автозакінчення і автоматизацію.

Примітка: Це не підтримується на Веб-сайті. Замість цього, такі породи ідентично KEYBOARD_TYPE_DEFAULT.

VirtualKeyboardType KEYBOARD_TYPE_URL = 7

Віртуальна клавіатура з додатковими ключами, щоб допомогти з натисканням URL.

enum CursorShape: 🔗

CursorShape CURSOR_ARROW = 0

Форма курсора стріли. Це за замовчуванням, коли не вказує нічого, що перенадає курсор мишки, такі як LineEdit або TextEdit.

CursorShape CURSOR_IBEAM = 1

I-beam курсор форма. Це використовується за замовчуванням при переховуванні контролю, який приймає текстовий вхід, наприклад LineEdit або TextEdit.

CursorShape CURSOR_POINTING_HAND = 2

Точка зору форма курсора. Це використовується за замовчуванням при переховуванні LinkButton або тегу URL в RichTextLabel.

CursorShape CURSOR_CROSS = 3

Курсор у формі перехрестя. Він відображатиметься, коли користувачеві потрібно точно прицілитися до елемента, такого як інструмент виділення прямокутника або засіб вибору кольору.

CursorShape CURSOR_WAIT = 4

Зачекайте курсор. На більшості курсорів теми, це відображає значок * хребта * Призначений для використання для неблокування операцій (при тому, що користувач може зробити щось інше в даний момент). Дивитися також CURSOR_BUSY.

CursorShape CURSOR_BUSY = 5

Зачекайте курсор. На більшості курсорових тем, це * перезамінює* стрілка з іконкою хребта. Призначений для блокування операцій (при тому, що користувач не може нічого зробити на даний момент). Дивитися також CURSOR_WAIT.

CursorShape CURSOR_DRAG = 6

Перетягування ручного курсора. Це відображається при операціях перетягування. Дивитися також CURSOR_CAN_DROP.

CursorShape CURSOR_CAN_DROP = 7

"Чи можу падіння" курсор. Це відображається при операціях перетягування перетягування, якщо переповнення над Control, що може прийняти подію перетягування. На більшості курсорових тем, це відображає тягу рук з символом стріли, крім цього. Дивитися також CURSOR_DRAG.

CursorShape CURSOR_FORBIDDEN = 8

Заборонений курсор. Під час перетягування робіт, якщо переповнений Control не може приймати перетягування.

CursorShape CURSOR_VSIZE = 9

Вертикальний частотний курсор. Призначений для відображення при переповненні Control може бути вертикально негабаритним за допомогою миші. Дивитися також CURSOR_VSPLIT.

CursorShape CURSOR_HSIZE = 10

Горизонтальний курс розмірів. Призначений для відображення при переховуванні Control може бути горизонтально негабаритним за допомогою миші. Дивитися також CURSOR_HSPLIT.

CursorShape CURSOR_BDIAGSIZE = 11

Вторинний диагональний курсор змінного струму (топ-право/знизу-ліво). Призначений для того, щоб бути відображенням, коли переповнений Control може бути негабаритний якось за допомогою миші.

CursorShape CURSOR_FDIAGSIZE = 12

Головний диагональний курс змінного струму (верх-лівий/низ-право). Призначений для того, щоб бути відображенням, коли переповнений Control може бути негабаритний якось за допомогою миші.

CursorShape CURSOR_MOVE = 13

Перемістити курсор. Призначений для відображення, коли ховається Control може переміщатися за допомогою миші.

CursorShape CURSOR_VSPLIT = 14

Вертикальний курс розщеплення. Це відображається при переховуванні Control з розколами, які можуть бути вертикальні за допомогою миші, наприклад VSplitContainer. На деяких курсорах цей курсор може мати той самий зовнішній вигляд, як CURSOR_VSIZE.

CursorShape CURSOR_HSPLIT = 15

Горизонтальний курс розщеплення. Це відображається при переховуванні Control з розколами, які можуть бути горизонтально негабаритними за допомогою миші, наприклад HSplitContainer. На деяких курсорах цей курсор може мати той самий зовнішній вигляд, як CURSOR_HSIZE.

CursorShape CURSOR_HELP = 16

Довідка курсора. На більшості курсорів теми, це відображає значок знака питання замість курсора миші. Призначений для використання, коли користувач запитав допомогу на наступний елемент, який буде натискати.

CursorShape CURSOR_MAX = 17

Представляє розмір CursorShape enum.

enum FileDialogMode: 🔗

FileDialogMode FILE_DIALOG_MODE_OPEN_FILE = 0

Діалогове вікно рідного файлу дозволяє вибрати один і лише один файл.

FileDialogMode FILE_DIALOG_MODE_OPEN_FILES = 1

Нативний діалог файлів дозволяє вибрати декілька файлів.

FileDialogMode FILE_DIALOG_MODE_OPEN_DIR = 2

Власне діалогове вікно файлу дозволяє лише вибрати каталог, забороняючи вибір будь-якого файлу.

FileDialogMode FILE_DIALOG_MODE_OPEN_ANY = 3

Діалогове вікно рідного файлу дозволяє вибрати один файл або каталог.

FileDialogMode FILE_DIALOG_MODE_SAVE_FILE = 4

У діалоговому вікні "Нативний файл" буде попереджати, коли існує файл.

enum WindowMode: 🔗

WindowMode WINDOW_MODE_WINDOWED = 0

Ввімкнений режим, тобто Window не займає всього екрана (незалежно від розміру екрана).

WindowMode WINDOW_MODE_MINIMIZED = 1

Мінімізований віконний режим, тобто Window не видно і доступний у віконному списку вікон. Зазвичай відбувається при натисканні кнопки мінімізації.

WindowMode WINDOW_MODE_MAXIMIZED = 2

Максимальний режим вікна, тобто Window буде займати всю площу екрана, крім бару завдання і ще відображати її кордони. Зазвичай відбувається при натисканні кнопки максимальна кнопка.

WindowMode WINDOW_MODE_FULLSCREEN = 3

Повноекранний режим з повною підтримкою кількох вікон.

Повноекранне вікно охоплює всю площу екрана та не має жодних декорацій. Відеоекранний режим дисплея не змінюється.

На Android: Це вмикає режим занурення.

На macOS: Для відображення запущеного проекту використовується новий робочий стіл.

Примітка: Незалежно від платформи, увімкнення повноекранного режиму змінить розмір вікна відповідно до розміру монітора. Тому переконайтеся, що ваш проект підтримує кілька роздільних здатностей під час увімкнення повноекранного режиму.

WindowMode WINDOW_MODE_EXCLUSIVE_FULLSCREEN = 4

Повноекранний режим одного вікна. Цей режим має менше накладних витрат, але на даному екрані одночасно може бути відкрито лише одне вікно (відкриття дочірнього вікна або перемикання програм призведе до переходу в повноекранний режим).

Повноекранне вікно охоплює всю область відображення екрана та не має рамок чи декорацій. Відеоекранний режим дисплея не змінюється.

Примітка: Цей режим може не працювати з програмним забезпеченням для запису екрана.

На Android: Це вмикає режим занурення.

На Windows: Залежно від відеодрайвера, повноекранний перехід може призвести до того, що екрани на мить стануть чорними.

На macOS: Для відображення запущеного проекту використовується новий робочий стіл. Ексклюзивний повноекранний режим запобігає відображенню Dock та Menu, коли вказівник миші знаходиться на краю екрана.

На Linux (X11): Ексклюзивний повноекранний режим обходить композитор.

У Linux (Wayland): Еквівалентно WINDOW_MODE_FULLSCREEN.

Примітка: Незалежно від платформи, увімкнення повноекранного режиму змінить розмір вікна відповідно до розміру монітора. Тому переконайтеся, що ваш проект підтримує кілька роздільних здатностей під час увімкнення повноекранного режиму.

enum ProgressState: 🔗

ProgressState PROGRESS_STATE_NOPROGRESS = 0

Stops displaying progress and returns the button to its normal state.

ProgressState PROGRESS_STATE_INDETERMINATE = 1

The progress indicator shows an indeterminate progress.

On Windows, the progress indicator does not grow in size, but cycles repeatedly along the length of the taskbar button by default.

ProgressState PROGRESS_STATE_NORMAL = 2

The progress indicator shows progress normally.

ProgressState PROGRESS_STATE_ERROR = 3

The progress indicator shows that an error has occurred.

On Windows, the progress indicator turns red by default to show that an error has occurred in one of the windows that is broadcasting progress.

ProgressState PROGRESS_STATE_PAUSED = 4

The progress indicator shows it was paused.

On Windows, the progress indicator turns yellow by default to show that progress is currently stopped in one of the windows but can be resumed by the user.

enum WindowFlags: 🔗

WindowFlags WINDOW_FLAG_RESIZE_DISABLED = 0

Розмір вікна не можна змінити перетягуванням ручки зміни розміру. Розмір вікна все ще можна змінити за допомогою window_set_size(). Цей прапорець ігнорується для повноекранних вікон.

WindowFlags WINDOW_FLAG_BORDERLESS = 1

Вікно не має рідних титульних барів та інших прикрас. Цей прапор ігнорується для повноекранних вікон.

WindowFlags WINDOW_FLAG_ALWAYS_ON_TOP = 2

Вікно пливе поверх всіх інших вікон. Цей прапор ігнорується для повноекранних вікон.

WindowFlags WINDOW_FLAG_TRANSPARENT = 3

Фон вікна може бути прозорим.

Примітка: Цей прапорець не діє, якщо is_window_transparency_available() повертає false.

Примітка: Підтримка прозорості реалізована в Linux (X11/Wayland), macOS та Windows, але доступність може відрізнятися залежно від драйвера графічного процесора, менеджера дисплеїв та можливостей композитора.

Примітка: Підтримка прозорості реалізована в Android, але її можна ввімкнути лише через ProjectSettings.display/window/per_pixel_transparency/allowed. Цей прапорець не діє в Android.

WindowFlags WINDOW_FLAG_NO_FOCUS = 4

Вікно не може бути зосередженим. Безконтактне вікно ігнорує всі вводи, крім кліків миші.

WindowFlags WINDOW_FLAG_POPUP = 5

Вікно є частиною меню або Налаштування кнопки випадання. Цей прапор не може бути змінений, коли вікно видно. Активний спливаючий вікно буде отримувати тільки всі вхідні, не вкрасивши фокус від свого батька. При використанні натиснути за її межами, або при вимкненні програми. Вікна попуп повинна мати перехідний комплект батьків (див. window_set_transient()).

WindowFlags WINDOW_FLAG_EXTEND_TO_TITLE = 6

Вміст вікон розширюється до повного розміру вікна. На відміну від без кордонів вікно, рама залишається неактуальним і може бути використана для зміни вікна, рядок заголовка прозора, але мають мінімізацію/максимізувати/закривати кнопки.

Використовуйте windows_set_window_buttons_offset() для налаштування мінімізації / максимізації / закриття кнопки offset.

Використовуйте window_get_safe_title_margins() для визначення площі під назвою бар, який не покритий прикрасами.

Примітка: Цей прапор реалізується тільки на macOS.

WindowFlags WINDOW_FLAG_MOUSE_PASSTHROUGH = 7

Всі події мишки пропускаються до основного вікна того ж програми.

WindowFlags WINDOW_FLAG_SHARP_CORNERS = 8

Стиль вікон перевизначено, створюючи гострі кути.

Примітка: цей прапор реалізований лише у Windows (11).

WindowFlags WINDOW_FLAG_EXCLUDE_FROM_CAPTURE = 9

Вікно виключається зі знімків екрана, зроблених за допомогою screen_get_image(), screen_get_image_rect() та screen_get_pixel().

Примітка: Цей прапорець реалізовано в macOS та Windows (10, 20H1).

Примітка: Встановлення цього прапорця запобігає захопленню зображення вікна стандартними методами створення знімків екрана, але НЕ гарантує, що інші програми не зможуть захопити зображення. Його не слід використовувати як засіб DRM або заходи безпеки.

WindowFlags WINDOW_FLAG_POPUP_WM_HINT = 10

Сигналізує менеджеру вікон, що це вікно має бути визначеним реалізацією "спливаючим вікном" (зазвичай плаваючим, безрамковим, незнімним дочірнім вікном).

WindowFlags WINDOW_FLAG_MINIMIZE_DISABLED = 11

Кнопка мінімізації вікна вимкнена.

Примітка: Цей прапорець реалізовано в macOS та Windows.

WindowFlags WINDOW_FLAG_MAXIMIZE_DISABLED = 12

Кнопка розгортання вікна вимкнена.

Примітка: Цей прапорець реалізовано в macOS та Windows.

WindowFlags WINDOW_FLAG_MAX = 13

Представляє розмір переліку WindowFlags.

enum WindowEvent: 🔗

WindowEvent WINDOW_EVENT_MOUSE_ENTER = 0

Увімкніть, коли увімкнено вікно миші.

WindowEvent WINDOW_EVENT_MOUSE_EXIT = 1

Увімкніть, коли увімкнено вікно миші.

WindowEvent WINDOW_EVENT_FOCUS_IN = 2

Увімкніть, коли вікно захоплюється.

WindowEvent WINDOW_EVENT_FOCUS_OUT = 3

Увімкніть, коли вікно втрачає фокус.

WindowEvent WINDOW_EVENT_CLOSE_REQUEST = 4

Якщо користувач спробував закрити вікно (наприклад, закриту кнопку натискається).

WindowEvent WINDOW_EVENT_GO_BACK_REQUEST = 5

Надсилається, коли на пристрої натискається кнопка «Назад».

Примітка: Ця подія реалізована лише на Android.

WindowEvent WINDOW_EVENT_DPI_CHANGE = 6

Надсилається, коли вікно переміщується на дисплей з іншою роздільною здатністю DPI або змінюється роздільна здатність дисплея.

Примітка: Цей прапорець реалізовано лише на macOS та Linux (Wayland).

WindowEvent WINDOW_EVENT_TITLEBAR_CHANGE = 7

При зміні віконного титульного рядка (наприклад, WINDOW_FLAG_EXTEND_TO_TITLE встановлюється або вводиться вікно/виключений повноекранний режим).

Примітка: Цей прапор реалізується тільки на macOS.

WindowEvent WINDOW_EVENT_FORCE_CLOSE = 8

Надсилається, коли вікно примусово закривається сервером відображення. Вікно негайно приховує та очищує будь-які внутрішні посилання на рендеринг.

Примітка: Цей прапорець реалізовано лише в Linux (Wayland).

WindowEvent WINDOW_EVENT_OUTPUT_MAX_LINEAR_VALUE_CHANGED = 9

Sent when the output max linear value returned by Window.get_output_max_linear_value() has changed.

This occurs when HDR output is enabled or disabled and when any HDR output luminance values of the window have changed, such as when the player adjusts their screen brightness setting or moves the window to a different screen.

enum WindowResizeEdge: 🔗

WindowResizeEdge WINDOW_EDGE_TOP_LEFT = 0

Верхній лівий край вікна.

WindowResizeEdge WINDOW_EDGE_TOP = 1

Верхній край вікна.

WindowResizeEdge WINDOW_EDGE_TOP_RIGHT = 2

Верхній правий край вікна.

WindowResizeEdge WINDOW_EDGE_LEFT = 3

Лівий край вікна.

WindowResizeEdge WINDOW_EDGE_RIGHT = 4

Правий край вікна.

WindowResizeEdge WINDOW_EDGE_BOTTOM_LEFT = 5

Нижній лівий край вікна.

WindowResizeEdge WINDOW_EDGE_BOTTOM = 6

Нижній край вікна.

WindowResizeEdge WINDOW_EDGE_BOTTOM_RIGHT = 7

Правий нижній край вікна.

WindowResizeEdge WINDOW_EDGE_MAX = 8

Представляє розмір переліку WindowResizeEdge.

enum VSyncMode: 🔗

VSyncMode VSYNC_DISABLED = 0

Вертикальну синхронізацію вимкнено, це означає, що рушій буде відображати кадри якомога швидше (можуть бути помітні розриви зображення). Частота кадрів необмежена (незалежно від Engine.max_fps).

VSyncMode VSYNC_ENABLED = 1

За замовчуванням вертикальний режим синхронізації зображення відображається тільки на вертикальні інтервали заготовки (не видно розрив). Рамат обмежений частотою оновлень монітора (незалежно від Engine.max_fps).

VSyncMode VSYNC_ADAPTIVE = 2

Працює як VSYNC_DISABLED, якщо частота кадрів падає нижче частоти оновлення екрана, щоб зменшити ривки(можуть бути помітні розриви в зображенні). В іншому випадку вертикальну синхронізацію увімкнено, щоб уникнути розривів зображення. Частоту кадрів обмежено частотою оновленя екрана (незалежно від Engine.max_fps). Працює як VSYNC_ENABLED при використанні методу рендерингу "Сумісність".

VSyncMode VSYNC_MAILBOX = 3

Відображає останнє зображення в черзі з інтервалами вертикального гасіння під час візуалізації інших зображень (розривів не видно). Частота кадрів необмежена (незалежно від Engine.max_fps).

Хоча це не гарантовано, зображення можуть відтворюватися якнайшвидше, що може зменшити затримку введення (також званий «швидкий» режим V-Sync). VSYNC_MAILBOX працює найкраще, коли відображається принаймні вдвічі більше кадрів, ніж частота оновлення дисплея. Поводиться як VSYNC_ENABLED під час використання методу візуалізації сумісності.

enum HandleType: 🔗

HandleType DISPLAY_HANDLE = 0

Ручка дисплея:

Linux (X11): X11::Display* для дисплея.
Linux (Wayland): wl_display для дисплея.
Android: EGLDisplay для дисплея.

HandleType WINDOW_HANDLE = 1

Віконна ручка:

Windows: HWND для вікна.
Linux (X11): X11::Window* для вікна.
Linux (Wayland): wl_surface для вікна.
macOS: NSWindow* для вікна.
iOS: UIViewController* для контролера перегляду.
Android: jObject для активності.

HandleType WINDOW_VIEW = 2

Вид вікна:

Windows: HDC для вікна (лише з рендерером сумісності).
macOS: NSView* для головного вигляду вікна.
iOS: UIView* для головного вигляду вікна.

HandleType OPENGL_CONTEXT = 3

Контекст OpenGL (лише з рендерером сумісності):

Windows: HGLRC для вікна (рідний GL) або EGLContext для вікна (ANGLE).
Linux (X11): GLXContext* для вікна.
Linux (Wayland): EGLContext для вікна.
macOS: NSOpenGLContext* для вікна (власний GL) або EGLContext для вікна (ANGLE).
Android: EGLContext для вікна.

HandleType EGL_DISPLAY = 4

Windows: EGLDisplay для вікна (ANGLE).
macOS: EGLDisplay для вікна (ANGLE).
Linux (Wayland): EGLDisplay для вікна.

HandleType EGL_CONFIG = 5

Windows: EGLConfig для вікна (ANGLE).
macOS: EGLConfig для вікна (ANGLE).
Linux (Wayland): EGLConfig для вікна.

HandleType GLX_VISUALID = 6

The GLX VisualID for the window.

Note: Only available on Linux when using X11.

HandleType GLX_FBCONFIG = 7

The GLXFBConfig for the window.

Note: Only available on Linux when using X11.

enum TTSUtteranceEvent: 🔗

TTSUtteranceEvent TTS_UTTERANCE_STARTED = 0

Уттеранс почав говорити.

TTSUtteranceEvent TTS_UTTERANCE_ENDED = 1

Уттеранс успішно завершився.

TTSUtteranceEvent TTS_UTTERANCE_CANCELED = 2

Уттеранс був скасований, або служба ТТС не в змозі його обробляти.

TTSUtteranceEvent TTS_UTTERANCE_BOUNDARY = 3

Уттеранс отримав слово або речення, що межує.

Константи

INVALID_SCREEN = -1 🔗

Ідентифікатор, що посилається на екран, якого не існує. Його повертають деякі методи DisplayServer, якщо жоден екран не відповідає запитуваному результату.

SCREEN_WITH_MOUSE_FOCUS = -4 🔗

Представляє екран, на якому знаходиться вказівник миші.

Примітка: На Android, iOS, Web та Linux (Wayland) ця константа завжди представляє екран з індексом 0.

SCREEN_WITH_KEYBOARD_FOCUS = -3 🔗

Представляє екран, що містить вікно з фокусом клавіатури.

Примітка: На Android, iOS, Web та Linux (Wayland) ця константа завжди представляє екран з індексом 0.

SCREEN_PRIMARY = -2 🔗

Представляє основний екран.

Примітка: На Android, iOS, Web та Linux (Wayland) ця константа завжди представляє екран з індексом 0.

SCREEN_OF_MAIN_WINDOW = -1 🔗

Представляє екран, на якому розташоване головне вікно. Зазвичай це значення за замовчуванням у функціях, які дозволяють вказати один із кількох екранів.

Примітка: На Android, iOS, Web та Linux (Wayland) ця константа завжди представляє екран з індексом 0.

MAIN_WINDOW_ID = 0 🔗

Ідентифікатор головного вікна, який може бути переданий до методів очікування window_id.

INVALID_WINDOW_ID = -1 🔗

Ідентифікатор, який відноситься до неіснуючого вікна. Це повернуто деякі методи DisplayServer, якщо вікно не відповідає запитуваному результату.

INVALID_INDICATOR_ID = -1 🔗

Ідентифікатор, який відноситься до індикатора неіснуючого стану програми.

Описи методів

RID accessibility_create_element(window_id: int, role: AccessibilityRole) 🔗

Застаріло: Use AccessibilityServer instead.

Створює новий, порожній ресурс елемента доступності.

Примітка: Елемент доступності створюється та звільняється автоматично для кожного вузла. Загалом, цю функцію не слід викликати вручну.

RID accessibility_create_sub_element(parent_rid: RID, role: AccessibilityRole, insert_pos: int = -1) 🔗

Застаріло: Use AccessibilityServer instead.

Створює новий, порожній ресурс піделементів доступності. Піделементи можна використовувати для надання інформації про доступність для об'єктів, які не є Node, таких як елементи списку, комірки таблиці або елементи меню. Піделементи звільняються автоматично, коли звільняється батьківський елемент, або їх можна звільнити раніше за допомогою методу accessibility_free_element().

RID accessibility_create_sub_text_edit_elements(parent_rid: RID, shaped_text: RID, min_height: float, insert_pos: int = -1, is_last_line: bool = false) 🔗

Застаріло: Use AccessibilityServer instead.

Створює новий, порожній піделемент доступності з буфера сформованого тексту. Піделементи звільняються автоматично, коли звільняється батьківський елемент, або можуть бути звільнені раніше за допомогою методу accessibility_free_element().

Якщо is_last_line має значення true, до текстового вмісту не додається символ нового рядка. Встановіть значення true для останнього рядка в багаторядкових текстових полях та для однорядкових текстових полів.

Variant accessibility_element_get_meta(id: RID) const 🔗

Застаріло: Use AccessibilityServer instead.

Повертає метадані елемента доступності id.

void accessibility_element_set_meta(id: RID, meta: Variant) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює метадані елемента доступності id на meta.

void accessibility_free_element(id: RID) 🔗

Застаріло: Use AccessibilityServer instead.

Звільняє елемент доступності id, створений accessibility_create_element(), accessibility_create_sub_element(), або accessibility_create_sub_text_edit_elements().

RID accessibility_get_window_root(window_id: int) const 🔗

Застаріло: Use AccessibilityServer instead.

Повертає основний елемент доступності рідного вікна ОС.

bool accessibility_has_element(id: RID) const 🔗

Застаріло: Use AccessibilityServer instead.

Повертає true, якщо id є дійсним елементом доступності.

Повертає 1, якщо активний зчитувач з екрана, дисплей Брайля або інший допоміжний додаток, в іншому випадку 0. Повертає -1, якщо статус невідомий.

Примітка: Цей метод реалізовано в Linux, macOS та Windows.

Примітка: Інструменти налагодження доступності, такі як Accessibility Insights for Windows, Accessibility Inspector (macOS) або AT-SPI Browser (Linux/BSD), не враховуються як допоміжні програми та не впливатимуть на це значення. Щоб протестувати свій проект за допомогою цих інструментів, встановіть для ProjectSettings.accessibility/general/accessibility_support значення 1.

void accessibility_set_window_focused(window_id: int, focused: bool) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює стан фокусування вікна для допоміжних програм.

Примітка: Цей метод реалізовано в Linux, macOS та Windows.

Примітка: Тільки для досвідчених користувачів! Об'єкти Window викликають цей метод автоматично.

void accessibility_set_window_rect(window_id: int, rect_out: Rect2, rect_in: Rect2) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює зовнішні (з декораціями) та внутрішні (без декорацій) межі вікна для допоміжних програм.

Примітка: Цей метод реалізовано в Linux, macOS та Windows.

Примітка: Тільки для досвідчених користувачів! Об'єкти Window викликають цей метод автоматично.

int accessibility_should_increase_contrast() const 🔗

Повертає 1, якщо слід використовувати тему інтерфейсу користувача з високою контрастністю, в іншому випадку 0. Повертає -1, якщо статус невідомий.

Примітка: Цей метод реалізовано в Linux (X11/Wayland, GNOME), macOS та Windows.

int accessibility_should_reduce_animation() const 🔗

Повертає 1, якщо слід вимкнути миготливий, мерехтливий та інший рухомий контент, який може спричинити судоми у користувачів із фоточутливою епілепсією, інакше 0. Повертає -1, якщо статус невідомий.

Примітка: Цей метод реалізовано на macOS та Windows.

int accessibility_should_reduce_transparency() const 🔗

Повертає 1, якщо фонові зображення, прозорість та інші функції, які можуть зменшити контраст між переднім планом і фоном, мають бути вимкнені, в іншому випадку 0. Повертає -1, якщо статус невідомий.

Примітка: Цей метод реалізовано на macOS та Windows.

void accessibility_update_add_action(id: RID, action: AccessibilityAction, callable: Callable) 🔗

Застаріло: Use AccessibilityServer instead.

Додає зворотний виклик для дії доступності (дія, яку можна виконати за допомогою спеціальної команди зчитувача з екрана або кнопок на дисплеї Брайля) та позначає цю дію як підтримувану. Зворотний виклик дії отримує один аргумент Variant, значення якого залежить від типу дії.

void accessibility_update_add_child(id: RID, child_id: RID) 🔗

Застаріло: Use AccessibilityServer instead.

Додає дочірній елемент доступності.

Примітка: Дочірні та піделементи Node автоматично додаються до списку дочірніх елементів.

void accessibility_update_add_custom_action(id: RID, action_id: int, action_description: String) 🔗

Застаріло: Use AccessibilityServer instead.

Додає підтримку для налаштовуваної дії доступності. action_id передається як аргумент зворотного виклику дії ACTION_CUSTOM.

Застаріло: Use AccessibilityServer instead.

Додає елемент, який контролюється цим елементом.

Застаріло: Use AccessibilityServer instead.

Додає елемент, який описує цей елемент.

Застаріло: Use AccessibilityServer instead.

Додає елемент, який детально описує цей елемент.

Застаріло: Use AccessibilityServer instead.

Додає елемент, у який цей елемент перетікає.

Застаріло: Use AccessibilityServer instead.

Додає елемент, який позначає цей елемент.

Застаріло: Use AccessibilityServer instead.

Додає елемент, що є частиною тієї ж групи радіоперемикачів.

Примітка: Цей метод слід викликати для кожного елемента групи, використовуючи всі інші елементи як related_id.

void accessibility_update_set_active_descendant(id: RID, other_id: RID) 🔗

Застаріло: Use AccessibilityServer instead.

Додає елемент, який є активним нащадком цього елемента.

void accessibility_update_set_background_color(id: RID, color: Color) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює колір фону елемента.

void accessibility_update_set_bounds(id: RID, rect: Rect2) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює обмежувальну рамку елемента відносно положення вузла.

void accessibility_update_set_checked(id: RID, checekd: bool) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює перевірений стан елемента.

void accessibility_update_set_classname(id: RID, classname: String) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює назву класу елемента.

void accessibility_update_set_color_value(id: RID, color: Color) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює значення кольору елемента.

void accessibility_update_set_description(id: RID, description: String) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює опис доступності елемента.

void accessibility_update_set_error_message(id: RID, other_id: RID) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює елемент, який містить повідомлення про помилку для цього елемента.

void accessibility_update_set_extra_info(id: RID, name: String) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює додаткову інформацію про доступність елемента, що додається до назви елемента.

void accessibility_update_set_flag(id: RID, flag: AccessibilityFlags, value: bool) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює прапор елемента.

void accessibility_update_set_focus(id: RID) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює поточний фокус на елементі.

void accessibility_update_set_foreground_color(id: RID, color: Color) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює колір переднього плану елемента.

void accessibility_update_set_in_page_link_target(id: RID, other_id: RID) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює цільовий елемент для посилання.

void accessibility_update_set_language(id: RID, language: String) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює мову тексту елемента.

void accessibility_update_set_list_item_count(id: RID, size: int) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює кількість елементів у списку.

void accessibility_update_set_list_item_expanded(id: RID, expanded: bool) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює розгорнутий стан елемента списку/дерева.

void accessibility_update_set_list_item_index(id: RID, index: int) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює позицію елемента у списку.

void accessibility_update_set_list_item_level(id: RID, level: int) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює ієрархічний рівень елемента у списку.

void accessibility_update_set_list_item_selected(id: RID, selected: bool) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює статус вибраного елемента списку/дерева.

void accessibility_update_set_list_orientation(id: RID, vertical: bool) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює орієнтацію елементів списку.

void accessibility_update_set_live(id: RID, live: AccessibilityLiveMode) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює пріоритет оновлень регіону в реальному часі.

void accessibility_update_set_member_of(id: RID, group_id: RID) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює елемент як члена групи.

void accessibility_update_set_name(id: RID, name: String) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює назву доступності елемента.

void accessibility_update_set_next_on_line(id: RID, other_id: RID) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює наступний елемент у рядку.

void accessibility_update_set_num_jump(id: RID, jump: float) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює стрибок числового значення.

void accessibility_update_set_num_range(id: RID, min: float, max: float) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює діапазон числових значень.

void accessibility_update_set_num_step(id: RID, step: float) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює крок числового значення.

void accessibility_update_set_num_value(id: RID, position: float) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює числове значення.

void accessibility_update_set_placeholder(id: RID, placeholder: String) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює текст-заповнювач.

Застаріло: Use AccessibilityServer instead.

Встановлює тип спливаючого вікна для спливаючих кнопок.

void accessibility_update_set_previous_on_line(id: RID, other_id: RID) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює попередній елемент у рядку.

void accessibility_update_set_role(id: RID, role: AccessibilityRole) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює роль доступності елемента.

void accessibility_update_set_role_description(id: RID, description: String) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює текст опису ролі доступності елемента.

void accessibility_update_set_scroll_x(id: RID, position: float) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює x-позицію смуги прокручування.

void accessibility_update_set_scroll_x_range(id: RID, min: float, max: float) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює діапазон x смуги прокручування.

void accessibility_update_set_scroll_y(id: RID, position: float) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює позицію смуги прокручування по осі Y.

void accessibility_update_set_scroll_y_range(id: RID, min: float, max: float) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює діапазон смуги прокручування по осі Y.

void accessibility_update_set_shortcut(id: RID, shortcut: String) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює список комбінацій клавіш, що використовуються елементом.

void accessibility_update_set_state_description(id: RID, description: String) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює опис поточного перевіреного стану, який може бути прочитаний людиною.

void accessibility_update_set_table_cell_position(id: RID, row_index: int, column_index: int) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює позицію комірки в таблиці.

void accessibility_update_set_table_cell_span(id: RID, row_span: int, column_span: int) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює діапазон рядків/стовпців комірок.

void accessibility_update_set_table_column_count(id: RID, count: int) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює кількість стовпців у таблиці.

void accessibility_update_set_table_column_index(id: RID, index: int) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює положення колонки.

void accessibility_update_set_table_row_count(id: RID, count: int) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює кількість рядків у таблиці.

void accessibility_update_set_table_row_index(id: RID, index: int) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює позицію рядка в таблиці.

void accessibility_update_set_text_align(id: RID, align: HorizontalAlignment) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює вирівнювання тексту елемента.

void accessibility_update_set_text_decorations(id: RID, underline: bool, strikethrough: bool, overline: bool) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює підкреслення/закриття тексту/закреслений.

void accessibility_update_set_text_orientation(id: RID, vertical: bool) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює орієнтацію тексту.

void accessibility_update_set_text_selection(id: RID, text_start_id: RID, start_char: int, text_end_id: RID, end_char: int) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює виділення тексту в текстовому полі. text_start_id та text_end_id мають бути елементами, створеними за допомогою accessibility_create_sub_text_edit_elements(). Зміщення символів задаються відносно відповідного елемента.

Застаріло: Use AccessibilityServer instead.

Встановлює текст підказки.

void accessibility_update_set_transform(id: RID, transform: Transform2D) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює 2D-перетворення елемента.

void accessibility_update_set_url(id: RID, url: String) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює URL-адресу посилання.

void accessibility_update_set_value(id: RID, value: String) 🔗

Застаріло: Use AccessibilityServer instead.

Встановлює значення тексту елемента.

void beep() const 🔗

Відтворює звуковий сигнал від операційної системи, якщо це можливо. Оскільки він походить від ОС, звуковий сигнал буде чутно, навіть якщо звук програми вимкнено. Користувач також може вимкнути його для всієї ОС.

Примітка: Цей метод реалізовано в macOS, Linux (X11/Wayland) і Windows.

String clipboard_get() const 🔗

Повертає буфер користувача як рядок, якщо це можливо.

Image clipboard_get_image() const 🔗

Повертає буфер обміну користувача як зображення, якщо це можливо.

Примітка: Цей метод використовує скопійовані дані пікселів, наприклад, з програмного забезпечення для редагування зображень або веб-браузера, а не файл зображення, скопійований з файлового провідника.

String clipboard_get_primary() const 🔗

Повернутися до користувача primary буфер обміну як рядок, якщо це можливо. Це буфер, який встановлюється, коли користувач вибирає текст у будь-якому додатку, а не при натисканні Ctrl + C. Дані буфера можна записати, натиснувши кнопку середнього мишки в будь-якому додатку, що підтримує механізм первинної буферизації.

Примітка: Цей метод реалізований тільки на Linux (X11/Wayland).

bool clipboard_has() const 🔗

Повертає true, якщо є текстовий зміст на клавіатурі користувача.

bool clipboard_has_image() const 🔗

Повертає true, якщо є вміст зображення на буфері користувача.

void clipboard_set(clipboard: String) 🔗

Встановлює вміст буфера користувача на даній рядці.

void clipboard_set_primary(clipboard_primary: String) 🔗

Встановлює користувача primary вміст буфера обміну до даної рядки. Це буфер, який встановлюється, коли користувач вибирає текст у будь-якому додатку, а не при натисканні Ctrl + C. Дані буфера можна записати, натиснувши кнопку середнього мишки в будь-якому додатку, що підтримує механізм первинної буферизації.

Примітка: Цей метод реалізований тільки на Linux (X11/Wayland).

bool color_picker(callback: Callable) 🔗

Відображає власний вибір кольору ОС.

Зворотні виклики мають такі аргументи: status: bool, color: Color.

Примітка: Цей метод реалізовано, якщо сервер відображення має функцію FEATURE_NATIVE_COLOR_PICKER.

Примітка: Цей метод реалізовано лише в Linux (X11/Wayland).

int create_status_indicator(icon: Texture2D, tooltip: String, callback: Callable) 🔗

Створює новий індикатор стану програми з вказаною іконою, інструментарієм та зворотним викликом активації.

callback повинен прийняти два аргументи: натиснута кнопка миші (одна з MouseButton) і позицію натискання в координатах екрана (а Vector2i).

CursorShape cursor_get_shape() const 🔗

Повертає форму курсора за замовчуванням, встановлену курсор_set_shape().

void cursor_set_custom_image(cursor: Resource, shape: CursorShape = 0, hotspot: Vector2 = Vector2(0, 0)) 🔗

Встановлює власне зображення курсора миші для заданого shape. Це означає, що операційна система користувача та тема курсора миші більше не впливатимуть на зовнішній вигляд курсора миші.

cursor може бути або Texture2D, або Image, і він не повинен перевищувати розмір 256×256 для правильного відображення. За бажанням hotspot можна налаштувати на зміщення положення зображення відносно точки клацання. За замовчуванням hotspot встановлено у верхньому лівому куті зображення. Дивіться також cusor_set_shape().

Примітка: У веб-сайті виклик цього методу кожного кадру може призвести до мерехтіння курсора.

void cursor_set_shape(shape: CursorShape) 🔗

Встановлює форму курсора за замовчуванням. Зовнішній вигляд курсора варіюватися в залежності від операційної системи користувача і теми курсора миші. Дивись також cursor_get_shape() і курсор_set_custom_image().

void delete_status_indicator(id: int) 🔗

Видалити індикатор стану програми.

Error dialog_input_text(title: String, description: String, existing_text: String, callback: Callable) 🔗

Показує діалогове вікно введення тексту, яке використовує зовнішній вигляд операційної системи. callback має приймати один параметр String, який містить вміст текстового поля.

Примітка: Цей метод реалізовано, якщо сервер відображення має функцію FEATURE_NATIVE_DIALOG_INPUT. Підтримувані платформи включають macOS, Windows і Android.

Error dialog_show(title: String, description: String, buttons: PackedStringArray, callback: Callable) 🔗

Показує текстове діалогове вікно, яке використовує зовнішній вигляд операційної системи. callback має приймати єдиний параметр int, який відповідає індексу натиснутої кнопки.

Примітка: Цей метод реалізовано, якщо сервер відображення має функцію FEATURE_NATIVE_DIALOG. Підтримувані платформи включають macOS, Windows і Android.

void enable_for_stealing_focus(process_id: int) 🔗

Дозволяє process_id PID вкрасти фокус з цього вікна. Іншими словами, це відключає захист операційної системи для вказаного PID.

Примітка: Цей метод реалізується тільки на Windows.

Error file_dialog_show(title: String, current_directory: String, filename: String, show_hidden: bool, mode: FileDialogMode, filters: PackedStringArray, callback: Callable, parent_window_id: int = 0) 🔗

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 FileDialog.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 FEATURE_NATIVE_DIALOG_FILE feature. Supported platforms include Linux (X11/Wayland), Windows, macOS, and Android.

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 OS.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 FileAccess to perform read/write operations.

When using 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 FileAccess.

To avoid opening the file picker again after each app restart, you can take persistable URI permission as follows:

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.

Error file_dialog_with_options_show(title: String, current_directory: String, root: String, filename: String, show_hidden: bool, mode: FileDialogMode, filters: PackedStringArray, options: Array[Dictionary], callback: Callable, parent_window_id: int = 0) 🔗

Відображає діалогове вікно ОС для вибору файлів або каталогів у файловій системі з додатковими параметрами, які може вибрати користувач.

Кожен рядок фільтра в масиві filters має бути відформатований таким чином: *.png,*.jpg,*.jpeg;Файли зображень;image/png,image/jpeg. Текст опису фільтра необов'язковий і його можна пропустити. Рекомендується встановлювати як розширення файлу, так і тип MIME. Див. також FileDialog.filters.

options – це масив значень Dictionary з такими ключами:

"name" – назва параметра String.
"values" – PackedStringArray значень. Якщо порожнє, використовується логічний параметр (прапорець).
"default" – індекс вибраного параметра за замовчуванням (int) або логічне значення за замовчуванням (bool).

Зворотні виклики мають такі аргументи: status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary.

Примітка: Цей метод реалізовано, якщо сервер відображення має функцію FEATURE_NATIVE_DIALOG_FILE_EXTRA. Підтримувані платформи включають Linux (X11/Wayland), Windows та macOS.

Примітка: Параметр current_directory може бути проігноровано.

Примітка: Вбудовані діалогові вікна файлів та діалогові вікна файлів Windows підтримують лише розширення файлів, тоді як діалогові вікна файлів Android, Linux та macOS також підтримують типи MIME.

Примітка: У Linux (X11) параметр show_hidden ігнорується.

Примітка: У macOS рідні діалогові вікна файлів не мають заголовка.

Примітка: У macOS програми в ізольованому середовищі зберігатимуть закладки з областю безпеки, щоб забезпечити доступ до відкритих папок протягом кількох сеансів. Використовуйте OS.get_granted_permissions(), щоб отримати список збережених закладок.

void force_process_and_drop_events() 🔗

Обробка віконного менеджера сил при ігноруванні всіх InputEvent. Дивись також process_events().

Примітка: Цей метод реалізується на Windows і macOS.

Color get_accent_color() const 🔗

Повертає акцентний колір теми ОС. Повертає Color(0, 0, 0, 0), якщо акцентний колір невідомий.

Примітка: Цей метод реалізовано на macOS, Windows, Android та Linux (X11/Wayland).

Color get_base_color() const 🔗

Повертає основний колір теми ОС (за замовчуванням тло елемента керування). Повертає Color(0, 0, 0, 0), якщо основний колір невідомий.

Примітка: Цей метод реалізовано в macOS, Windows і Android.

Array[Rect2] get_display_cutouts() const 🔗

Повертаємо Array Rect2, кожен з яких є зв'язаним прямокутника для відображення вирізу або ніш. Це нефункціональні зони на екранах, що використовуються камерами і датчиками. Повертає порожній масив, якщо пристрій не має вирізів. Дивись також get_display_safe_area().

Примітка: В даний час реалізовано тільки на Android. Інші платформи будуть повертати порожній масив, навіть якщо вони відображають вирізи або лавки.

Rect2i get_display_safe_area() const 🔗

Повертає незатемнену область дисплея, де мають відображатися інтерактивні елементи керування. Дивіться також get_display_cutouts().

Примітка: Наразі реалізовано лише на Android та iOS. На інших платформах screen_get_usable_rect(SCREEN_OF_MAIN_WINDOW) повертатиметься як запасний варіант. Дивіться також screen_get_usable_rect().

int get_keyboard_focus_screen() const 🔗

Повертає індекс екрана, що містить вікно з фокусом клавіатури, або основний екран, якщо фокусованого вікна немає.

Примітка: Цей метод реалізовано в Linux/X11, macOS та Windows. На інших платформах цей метод завжди повертає основний екран.

String get_name() const 🔗

Повертає назву DisplayServer, який зараз використовується. Більшість операційних систем мають лише один DisplayServer, але Linux має доступ до кількох DisplayServer (наразі X11 і Wayland).

Назви вбудованих серверів відображення: Windows, macOS, X11 (Linux), Wayland (Linux) , Android, iOS, web (HTML5) і headless (якщо починається з -- headless аргумент командного рядка).

int get_primary_screen() const 🔗

Повертає індекс основного екрана.

Примітка: Цей метод реалізовано в Linux/X11, macOS та Windows. На інших платформах цей метод завжди повертає 0.

int get_screen_count() const 🔗

Повертає кількість доступних дисплеїв.

Примітка: Цей метод реалізовано в Linux (X11 та Wayland), macOS та Windows. На інших платформах цей метод завжди повертає 1.

int get_screen_from_rect(rect: Rect2) const 🔗

Повертає індекс екрана, який найбільше перекривається з заданим прямокутником. Повертає INVALID_SCREEN, якщо прямокутник не перекривається з жодним екраном або не має площі.

bool get_swap_cancel_ok() 🔗

Повертає true, якщо позиції кнопок ОК і Скасувати у діалогах поміняно місцями. За замовчуванням у Windows цю опцію увімкнено для дотримання домовленостей щодо інтерфейсу, і її можна вимкнути зміною параметра ProjectSettings.gui/common/swap_cancel_ok.

Примітка: Це не впливає на власні діалоги, такі як ті, що породжуються dialog_show().

int get_window_at_screen_position(position: Vector2i) const 🔗

Повертає ідентифікатор вікна на вказаному екрані position (у пікселях). У налаштуваннях із кількома моніторами положення екрана залежить від області віртуального робочого столу. У налаштуваннях із кількома моніторами з різною роздільною здатністю або орієнтацією екрана джерело може розташовуватися за межами будь-якого дисплея, як це:

* (0, 0) +-------+
                |       |
+-------------+ |       |
|             | |       |
|             | |       |
+-------------+ +-------+

PackedInt32Array get_window_list() const 🔗

Повертає список ідентифікаторів вікон Godot, що належать до цього процесу.

Примітка: Системні діалоги не включені в цей список.

Застаріло: Use NativeMenu or PopupMenu instead.

Додає новий елемент-прапорець з текстом label до глобального меню з ID menu_root.

Повертає індекс вставленого елемента, який може відрізнятися від index.

Можна вказати accelerator, який є комбінацією клавіш, яку можна натиснути, для активації елементу меню навіть якщо меню ще не відкрите. accelerator, як правило, є поєднанням декількох KeyModifierMask і Key за допомогою побітового АБО, таких як KEY_MASK_CTRL | KEY_A (Ctrl + A).

Примітка: Функції callback і key_callback мають приймати рівно один параметр Variant, причому цей параметр буде значенням, переданим до tag.

Примітка: Цей метод реалізується тільки на macOS.

Підтримувані ідентифікатори системних меню:

"_main" - Головне меню (macOS).
"_dock" - Спливаюче меню панелі Dock (macOS).
"_apple" - Меню Apple (macOS, користувацькі елементи додаються перед "Служби").
"_window" - Меню "Вікно" (macOS, користувацькі елементи додаються перед "Усі наперед").
"_help" - Меню "Довідка" (macOS).

Застаріло: Use NativeMenu or PopupMenu instead.

Додає новий елемент-прапорець з текстом label та іконкою icon до глобального меню з ID menu_root.

Повертає індекс вставленого елемента, який може відрізнятися від index.

Можна вказати accelerator, який є комбінацією клавіш, яку можна натиснути, для активації елементу меню навіть якщо меню ще не відкрите. accelerator, як правило, є поєднанням декількох KeyModifierMask і Key за допомогою побітового АБО, таких як KEY_MASK_CTRL | KEY_A (Ctrl + A).

Примітка: Функції callback і key_callback мають приймати рівно один параметр Variant, причому цей параметр буде значенням, переданим до tag.

Примітка: Цей метод реалізується тільки на macOS.

Підтримувані ідентифікатори системних меню:

"_main" - Головне меню (macOS).
"_dock" - Спливаюче меню панелі Dock (macOS).
"_apple" - Меню Apple (macOS, користувацькі елементи додаються перед "Служби").
"_window" - Меню "Вікно" (macOS, користувацькі елементи додаються перед "Усі наперед").
"_help" - Меню "Довідка" (macOS).

Застаріло: Use NativeMenu or PopupMenu instead.

Додає новий елемент з текстом label та іконкою icon до глобального меню з ID menu_root.

Повертає індекс вставленого елемента, який може відрізнятися від index.

Можна вказати accelerator, який є комбінацією клавіш, яку можна натиснути, для активації елементу меню навіть якщо меню ще не відкрите. accelerator, як правило, є поєднанням декількох KeyModifierMask і Key за допомогою побітового АБО, таких як KEY_MASK_CTRL | KEY_A (Ctrl + A).

Примітка: Функції callback і key_callback мають приймати рівно один параметр Variant, причому цей параметр буде значенням, переданим до tag.

Примітка: Цей метод реалізується тільки на macOS.

Підтримувані ідентифікатори системних меню:

"_main" - Головне меню (macOS).
"_dock" - Спливаюче меню панелі Dock (macOS).
"_apple" - Меню Apple (macOS, користувацькі елементи додаються перед "Служби").
"_window" - Меню "Вікно" (macOS, користувацькі елементи додаються перед "Усі наперед").
"_help" - Меню "Довідка" (macOS).

Застаріло: Use NativeMenu or PopupMenu instead.

Додає новий елемент-радіокнопка з текстом label та іконкою icon до глобального меню з ID menu_root.

Повертає індекс вставленого елемента, який може відрізнятися від index.

Можна вказати accelerator, який є комбінацією клавіш, яку можна натиснути, для активації елементу меню навіть якщо меню ще не відкрите. accelerator, як правило, є поєднанням декількох KeyModifierMask і Key за допомогою побітового АБО, таких як KEY_MASK_CTRL | KEY_A (Ctrl + A).

Примітка: Елементи-радіокнопки просто показують галочку, але не мають ніякої вбудованої поведінки щодо вмикання та вимикання, тому потребують робити це вручну. Дивитись global_menu_set_item_checked() для додаткової інформації щодо того, як ними керувати.

Примітка: Функції callback і key_callback мають приймати рівно один параметр Variant, причому цей параметр буде значенням, переданим до tag.

Примітка: Цей метод реалізується тільки на macOS.

Підтримувані ідентифікатори системних меню:

"_main" - Головне меню (macOS).
"_dock" - Спливаюче меню панелі Dock (macOS).
"_apple" - Меню Apple (macOS, користувацькі елементи додаються перед "Служби").
"_window" - Меню "Вікно" (macOS, користувацькі елементи додаються перед "Усі наперед").
"_help" - Меню "Довідка" (macOS).

Застаріло: Use NativeMenu or PopupMenu instead.

Додає новий пункт з текстом label до глобального меню з ідентифікатором menu_root.

Повертає індекс доданого пункту, не гарантується, що він збігається зі значенням index.

За бажанням можна визначити accelerator, який є комбінацією клавіш, яку можна натиснути, щоб викликати кнопку меню, навіть якщо вона не відкрита. Прискорювач параметра зазвичай є комбінацією KeyModifierMask і Key з використанням побітового АБО, наприклад, KEY_MASK_CTRL | KEY_A (Ctrl + A).

Примітка: Викличники callback і key_callback повинні приймати рівно один параметр Variant, параметр, переданий до виклику, буде значенням, переданим до tag.

Примітка: Цей метод реалізовано лише на macOS.

Підтримувані ідентифікатори системних меню:

"_main" - Головне меню (macOS).
"_dock" - спливаюче меню док-станції (macOS).
"_apple" - меню Apple (macOS, кастомні пункти додаються перед "Сервісами").
"_window" - меню Window (macOS, користувацькі пункти додано після "Bring All to Front").
"_help" - меню довідки (macOS).

Застаріло: Use NativeMenu or PopupMenu instead.

Додає новий пункт з текстом label до глобального меню з ідентифікатором menu_root.

На відміну від звичайних бінарних елементів, багатостанівні елементи можуть мати більше двох станів, як визначено параметром max_states. Кожне натискання або активація елемента збільшує стан на одиницю. Значення за замовчуванням визначається параметром default_state.

Повертає індекс вставленого елемента, не гарантується, що він збігається зі значенням index.

Додатково можна визначити accelerator, який є комбінацією клавіш, що може бути натиснута для виклику кнопки меню, навіть якщо вона не відкрита. Прискорювач параметра зазвичай є комбінацією KeyModifierMask і Key з використанням побітового АБО, наприклад, KEY_MASK_CTRL | KEY_A (Ctrl + A).

Примітка: За замовчуванням поточний стан елемента не відображається, його слід змінити вручну.

Примітка: Викличники callback і key_callback повинні приймати рівно один параметр Variant, параметр, переданий до виклику, буде значенням, переданим до tag.

Примітка: Цей метод реалізовано лише на macOS.

Підтримувані ідентифікатори системних меню:

"_main" - Головне меню (macOS).
"_dock" - спливаюче меню док-станції (macOS).
"_apple" - меню Apple (macOS, кастомні пункти додаються перед "Сервісами").
"_window" - меню Window (macOS, користувацькі пункти додано після "Bring All to Front").
"_help" - меню довідки (macOS).

Застаріло: Use NativeMenu or PopupMenu instead.

Додає новий елемент-радіокнопка з текстом label до глобального меню з ID menu_root.

Повертає індекс вставленого елемента, який може відрізнятися від index.

Можна вказати accelerator, який є комбінацією клавіш, яку можна натиснути, для активації елементу меню навіть якщо меню ще не відкрите. accelerator, як правило, є поєднанням декількох KeyModifierMask і Key за допомогою побітового АБО, таких як KEY_MASK_CTRL | KEY_A (Ctrl + A).

Примітка: Елементи-радіокнопки просто показують галочку, але не мають ніякої вбудованої поведінки щодо вмикання та вимикання, тому потребують робити це вручну. Дивитись global_menu_set_item_checked() для додаткової інформації щодо того, як ними керувати.

Примітка: Функції callback і key_callback мають приймати рівно один параметр Variant, причому цей параметр буде значенням, переданим до tag.

Примітка: Цей метод реалізується тільки на macOS.

Підтримувані ідентифікатори системних меню:

"_main" - Головне меню (macOS).
"_dock" - Спливаюче меню панелі Dock (macOS).
"_apple" - Меню Apple (macOS, користувацькі елементи додаються перед "Служби").
"_window" - Меню "Вікно" (macOS, користувацькі елементи додаються перед "Усі наперед").
"_help" - Меню "Довідка" (macOS).

Застаріло: Use NativeMenu or PopupMenu instead.

Додає роздільник між елементами до глобального меню з ідентифікатором menu_root. Роздільники також займають індекс.

Повертає індекс вставленого елемента, не обов'язково той же, як index.

Примітка: Цей метод реалізується тільки на macOS.

Підтримувані ідентифікатори меню системи:

"_main" - Головне меню (macOS).
"_dock" - Спливне меню Dock (macOS).
"_apple" - Меню Apple (macOS, користувацькі елементи додаються перед "Служби").
"_window" - Меню вікна (macOS, користувацькі елементи додаються після "Показати всі").
"_help" - Меню допомоги (macOS).

Застаріло: Use NativeMenu or PopupMenu instead.

Додає пункт, який буде діяти як підменю глобального меню menu_root. Аргумент submenu є ідентифікатором кореня глобального меню, яке буде показано, коли елемент натискається.

Повертає індекс вставленого пункту, не обов'язково той же, що index.

Примітка: Цей метод реалізується тільки на macOS.

Підтримувані ідентифікатори меню системи:

"_main" - Головне меню (macOS).
"_dock" - Спливне меню Dock (macOS).
"_apple" - Меню Apple (macOS, користувацькі елементи додаються перед "Служби").
"_window" - Меню вікна (macOS, користувацькі елементи додаються після "Показати всі").
"_help" - Меню допомоги (macOS).

Застаріло: Use NativeMenu or PopupMenu instead.

Видаляє всі елементи з глобального меню з ID menu_root.

Примітка: Цей метод реалізується тільки на macOS.

Підтримувані ідентифікатори меню системи:

"_main" - Головне меню (macOS).
"_dock" - Спливне меню Dock (macOS).
"_apple" - Меню Apple (macOS, користувацькі елементи додаються перед "Служби").
"_window" - Меню вікна (macOS, користувацькі елементи додаються після "Показати всі").
"_help" - Меню допомоги (macOS).

Застаріло: Use NativeMenu or PopupMenu instead.

Повернення акселератора пункту за індексом idx. Прискорювачі - це спеціальні комбінації ключів, які активують предмет, незалежно від того, який контроль фокусується.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертає обернений виклик елемента за індексом idx.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертає кількість елементів у глобальному меню з ID menu_root.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертає ікону елемента в індексі idx.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертає горизонтальний зсув елемента на даній idx.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повернення індексу пункту з вказаною tag. Індикатори автоматично призначають кожному елементу двигуном, і не можна встановлювати вручну.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повернення індексу пункту за вказаною text. Індикатори автоматично призначають кожному елементу двигуном, і не можна встановлювати вручну.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повернення виклику прискорювача пункту за індексом idx.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертає кількість станів багатодержавного пункту. Див. глобальний_menu_add_multistate_item() для деталей.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертає стан багатодержавного елемента. Див. глобальний_menu_add_multistate_item() для деталей.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повернення субмену на індекс idx. Детальніше про те, як додати підменю.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повернення метаданих зазначеного елемента, який може бути будь-яким типом. Ви можете встановити його за допомогою Global_menu_set_item_tag(), який забезпечує простий спосіб присвоєння контекстних даних до елементів.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертає текст пункту за індексом idx.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертає інструмент, пов'язаний з вказаним індексом idx.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повернення словника підтримуваних системних ідентифікаторів та імен.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертаємо true, якщо пункт в індексі idx перевіряється якось, тобто якщо він має прапорець або радіокнопку.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертає true, якщо елемент в індексі idx відмічено.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертає true, якщо елемент в індексі idx вимкнено. Коли його вимкнено, він не може бути обраний, а його дія — викликана.

Дивитися global_menu_set_item_disabled() для подробиць про те, як вимкнути елемент.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертає true, якщо елемент в індексі idx прихований.

Дивитися global_menu_set_item_hidden() для подробиць про те, як приховати елемент.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Повертаємо true, якщо пункт в індексі idx має можливість перевірки кнопки-стиль.

Примітка: Це чисто косметичний, необхідно додати логіку для перевірки/розшуку предметів в радіо групах.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Видалити пункт в індексі idx з глобального меню menu_root.

Примітка: Індикатори елементів після вилученого елемента будуть переміщені одним.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює прискорювач елемента за індексом idx. keycode може бути одним Key або комбінацією KeyModifierMask і Key з використанням побітового АБО, наприклад KEY_MASK_CTRL | KEY_A (Ctrl + A).

Примітка: Цей метод реалізовано лише в macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює зворотний виклик елемента в індексі idx. Зворотний виклик викликається при натисканні елемента.

Примітка: Callable callback значення має приймати точно один параметр Variant-а, параметр, що надходить до Callable, буде передано до параметра tag при створенні пункту меню.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює, чи є пункт в індексі idx, має прапорець. Якщо false, встановлюємо тип пункту на звичайний текст.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює стан контрольного стану елемента в індексі idx.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Увімкнути/вимкнути елемент в індексі idx. Коли він вимкнений, він не може бути обраний і його дія не може бути викликана.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Приховує/показує індекс в індексі idx. Коли він прихований, елемент не з'являється в меню і його дію не можна викликати.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює зворотний виклик пункту в індексі idx. Зворотний виклик викликається при наведенні на елемент.

Note: Callable callback значення, що має прийняти точно один параметр Variant-а, параметр, що надходить до Callable, буде значенням, переданим до параметра tag, при створенні пункту меню.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Заміна іконки Texture2D вказаного idx.

Примітка: Цей метод реалізується тільки на macOS.

Примітка: Цей метод не підтримується пунктами меню macOS "_dock".

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює горизонтальний зсув елемента на даній idx.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює зворотний зв'язок пункту в індексі idx. Під час активації його акселератора видається зворотний дзвінок.

Примітка: key_callback Увімкнено значення, що необхідно прийняти точно один параметр Variant, параметр, що надходить до Callable, буде значення, передане параметру tag при створенні пункту меню.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює кількість стану багатостатевого елемента. Див. глобальний_menu_add_multistate_item() для деталей.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює тип пункту за вказаним індексом idx на кнопку радіо. Якщо false, встановлюємо тип пункту на звичайний текст.

Примітка: Це чисто косметичний, необхідно додати логіку для перевірки/розшуку предметів в радіо групах.

Note: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює стан елемента з кількома станами. Див. global_menu_add_multistate_item() для отримання детальної інформації.

Примітка: Цей метод реалізовано лише на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює субмену пункту індексу idx. Підмену є ідентифікатором кореня глобального меню, який буде показано, коли пункт натискається.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює метадані елемента, який може бути будь-яким типом. Ви можете отримати його за допомогою Global_menu_get_item_tag(), який забезпечує простий спосіб присвоєння контекстних даних до елементів.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Встановлює текст елемента в індексі idx.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Налаштовує інструментарій String пункту за вказаним індексом idx.

Примітка: Цей метод реалізується тільки на macOS.

Застаріло: Use NativeMenu or PopupMenu instead.

Записи, що випускаються, коли меню відповідно про показати або закрити. Методи зворотного дзвінка повинні мати нульові аргументи.

bool has_additional_outputs() const 🔗

Повертає true, якщо будь-які додаткові виходи були зареєстровані через register_additional_output().

bool has_feature(feature: Feature) const 🔗

Повертає true, якщо зазначена feature підтримується струмом DisplayServer, false інакше.

bool has_hardware_keyboard() const 🔗

Повертає true, якщо підключено апаратну клавіатуру.

Примітка: Цей метод реалізовано на Android та iOS. На інших платформах цей метод завжди повертає true.

void help_set_search_callbacks(search_callback: Callable, action_callback: Callable) 🔗

Встановлює власні виклики пошуку у довідковій системі.

Параметр search_callback має такі аргументи: String search_string, int result_limit і повертає Dictionary з парами "ключ, назва відображення" для результатів пошуку. Викликається, коли користувач вводить пошукові терміни в меню Довідка.

Функція action_callback має наступні аргументи: Рядковий ключ. Викликається, коли користувач вибирає результат пошуку в меню Довідка.

Примітка: Цей метод реалізовано лише на macOS.

Vector2i ime_get_selection() const 🔗

Повертає текстовий підбір в Input Method Editor рядок композиції, з Vector2i x компонент, який є положенням опіку та y, будучи довжиною вибору.

Примітка: Цей метод реалізується тільки на macOS.

String ime_get_text() const 🔗

Повертає рядок композиції, що міститься в Input Method Editor вікно.

Примітка: Цей метод реалізується тільки на macOS.

bool is_dark_mode() const 🔗

Повертаємо true, якщо ОС використовується темний режим.

Примітка: Цей метод реалізується на Android, iOS, macOS, Windows та Linux (X11/Wayland).

bool is_dark_mode_supported() const 🔗

Повертаємо true, якщо OS підтримує темний режим.

Примітка: Цей метод реалізується на Android, iOS, macOS, Windows та Linux (X11/Wayland).

bool is_in_pip_mode(window_id: int = 0) 🔗

Returns true if the application is in picture-in-picture mode.

Note: This method is implemented on Android.

bool is_touchscreen_available() const 🔗

Повертає true, якщо доступні події дотику (Android або iOS), можливість виявлено на веб-платформі або якщо ProjectSettings.input_devices/pointing/emulate_touch_from_mouse має значення true.

bool is_window_transparency_available() const 🔗

Повертає true, якщо тло вікна можна зробити прозорим. Цей метод повертає false, якщо ProjectSettings.display/window/per_pixel_transparency/allowed має значення false, або якщо прозорість не підтримується зображувачем або композитором ОС.

int keyboard_get_current_layout() const 🔗

Повертає активний індекс макета клавіатури.

Примітка: Цей метод реалізований на Linux (X11/Wayland), macOS та Windows.

Key keyboard_get_keycode_from_physical(keycode: Key) const 🔗

Конвертує фізичну (US QWERTY) памовий код в одну в активному розкладі клавіатури.

Примітка: Цей метод реалізується на Linux (X11/Wayland), macOS та Windows.

Key keyboard_get_label_from_physical(keycode: Key) const 🔗

Конвертує фізичну (US QWERTY) памовий код до локалізованого етикетки, надрукованого на ключі в активному розкладі клавіатури.

Примітка: Цей метод реалізується на Linux (X11/Wayland), macOS та Windows.

int keyboard_get_layout_count() const 🔗

Повертає кількість макетів клавіатури.

Примітка: Цей метод реалізується на Linux (X11/Wayland), macOS та Windows.

String keyboard_get_layout_language(index: int) const 🔗

Повертає код мови ISO-639/BCP-47 на позиції index.

Примітка: Цей метод реалізується на Linux (X11/Wayland), macOS та Windows.

String keyboard_get_layout_name(index: int) const 🔗

Повертає локалізоване ім’я розкладу клавіатури на позиції index.

Примітка: Цей метод реалізується на Linux (X11/Wayland), macOS та Windows.

void keyboard_set_current_layout(index: int) 🔗

Налаштовує активний макет клавіатури.

Примітка: Цей метод реалізується на Linux (X11/Wayland), macOS та Windows.

BitField[MouseButtonMask] mouse_get_button_state() const 🔗

Повертає поточний стан кнопок миші (чи натиснута кожна кнопка) у вигляді бітової маски. Якщо натиснуто декілька кнопок миші одночасно, біти додаються разом. Еквівалент Input.get_mouse_button_mask().

MouseMode mouse_get_mode() const 🔗

Повертає поточний режим миші. Див. також mouse_set_mode().

Vector2i mouse_get_position() const 🔗

Повертаємо поточну позицію курсора миші в координатах екрана.

void mouse_set_mode(mouse_mode: MouseMode) 🔗

Встановлює поточний режим миші. Див. також mouse_get_mode().

void pip_mode_enter(window_id: int = 0) 🔗

Enters picture-in-picture mode.

Note: This method is implemented on Android.

void pip_mode_set_aspect_ratio(numerator: int, denominator: int, window_id: int = 0) 🔗

Specifies the aspect ratio for picture-in-picture mode.

Note: This method is implemented on Android.

void pip_mode_set_auto_enter_on_background(auto_enter_on_background: bool, window_id: int = 0) 🔗

Specifies whether picture-in-picture mode should be entered automatically when the application goes in the background.

Note: This method is implemented on Android.

void process_events() 🔗

Виконує обробку віконного менеджера, включаючи очищення вхідних даних. Див. також force_process_and_drop_events(), Input.flush_buffered_events() та Input.use_accumulated_input.

void register_additional_output(object: Object) 🔗

Зареєструйтеся на Object, яка представляє додатковий вихід, який буде продано, крім нормальних вікон. Object використовується як ідентифікатор, який може бути пізніше переданий до unregister_additional_виведення().

Це може бути використаний для запобігання Godot від пропуску, що не видно нормальні вікна.

int screen_get_dpi(screen: int = -1) const 🔗

Повертає щільність точок на дюйм для вказаного екрана. Повертає специфічне для платформи значення за замовчуванням, якщо screen недійсний.

Примітка: Як screen можна використовувати одну з наступних констант: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS або SCREEN_WITH_KEYBOARD_FOCUS.

Примітка: У macOS повернене значення є неточним, якщо використовується режим дробового масштабування дисплея.

Примітка: На пристроях Android фактичні значення щільності екрана згруповані в шість узагальнених щільностей:

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.

Image screen_get_image(screen: int = -1) const 🔗

Повертає знімок екрана screen. Повертає null, якщо screen недійсний або DisplayServer не вдалося зробити знімок екрана.

Примітка: Як screen можна використовувати одну з наступних констант: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS або SCREEN_WITH_KEYBOARD_FOCUS.

Примітка: Цей метод реалізовано в Linux (X11, крім XWayland), macOS та Windows. На інших платформах цей метод завжди повертає null.

Примітка: У macOS цей метод вимагає дозволу "Запис екрана". Якщо дозвіл не надано, цей метод повертає знімок екрана, який не включатиме інші вікна програми або елементи ОС, не пов'язані з програмою.

Image screen_get_image_rect(rect: Rect2i) const 🔗

Повертає знімок екрана області екрана, визначеної параметром rect. Повертає null, якщо rect знаходиться за межами екрана або DisplayServer не може зробити знімок екрана.

Примітка: Цей метод реалізовано на macOS та Windows. На інших платформах цей метод завжди повертає null.

Примітка: На macOS цей метод вимагає дозволу "Запис екрана". Якщо дозвіл не надано, цей метод повертає знімок екрана, який не включатиме інші вікна програми або елементи ОС, не пов'язані з програмою.

float screen_get_max_scale() const 🔗

Повернення найбільшого масштабного фактора всіх екранів.

Примітка: На MacOS повернуто значення 2.0, якщо є принаймні один екран hiDPI (Retina) в системі, і 1.0 у всіх інших випадках.

Note: Цей метод реалізується тільки на macOS.

ScreenOrientation screen_get_orientation(screen: int = -1) const 🔗

Повертає поточну орієнтацію screen. Див. також screen_set_orientation(). Повертає SCREEN_LANDSCAPE, якщо screen недійсний.

Примітка: Як screen можна використовувати одну з наступних констант: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS або SCREEN_WITH_KEYBOARD_FOCUS.

Примітка: Цей метод реалізовано на Android та iOS. На інших платформах цей метод завжди повертає SCREEN_LANDSCAPE.

Color screen_get_pixel(position: Vector2i) const 🔗

Повертає колір пікселя на заданому екрані position. У конфігураціях з кількома моніторами положення екрана визначається відносно області віртуального робочого столу.

Примітка: Цей метод реалізовано в Linux (X11, крім XWayland), macOS та Windows. На інших платформах цей метод завжди повертає Color(0, 0, 0, 1).

Примітка: У macOS цей метод вимагає дозволу "Запис екрану". Якщо дозвіл не надано, цей метод повертає колір зі знімка екрана, який не включатиме інші вікна програми або елементи ОС, не пов'язані з програмою.

Vector2i screen_get_position(screen: int = -1) const 🔗

Повертає положення верхнього лівого кута екрана в пікселях. Повертає Vector2i.ZERO, якщо screen недійсний. У багатомоніторних конфігураціях положення екрана визначається відносно області віртуального робочого столу. У багатомоніторних конфігураціях з різною роздільною здатністю або орієнтацією екрана початок координат може бути розташований поза будь-яким дисплеєм, ось так:

* (0, 0) +--------+
| |
+--------------+ | |
| | |
| | |
+-------------+ +--------+

Див. також screen_get_size().

Примітка: Як screen можна використовувати одну з наступних констант: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS або SCREEN_WITH_KEYBOARD_FOCUS.

float screen_get_refresh_rate(screen: int = -1) const 🔗

Повертає поточну частоту оновлення вказаного екрана. Коли ввімкнено вертикальну синхронізацію, це повертає максимальну частоту кадрів, яку проект може ефективно досягти. Повертає -1.0, якщо screen недійсний або DisplayServer не може знайти частоту оновлення для вказаного екрана.

Щоб повернутися до частоти оновлення за замовчуванням, якщо метод не спрацює, спробуйте:

var refresh_rate = DisplayServer.screen_get_refresh_rate()
if refresh_rate < 0:
    refresh_rate = 60.0

Примітка: Як screen можна використовувати одну з наступних констант: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS або SCREEN_WITH_KEYBOARD_FOCUS.

Примітка: Цей метод реалізовано на Android, iOS, macOS, Linux (X11 та Wayland) та Windows. На інших платформах цей метод завжди повертає -1.0.

float screen_get_scale(screen: int = -1) const 🔗

Повертає коефіцієнт масштабування вказаного екрана за індексом. Повертає 1.0, якщо screen недійсний.

Примітка: Як screen можна використовувати одну з наступних констант: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS або SCREEN_WITH_KEYBOARD_FOCUS.

Примітка: У macOS повернене значення — 2.0 для екранів hiDPI (Retina) та 1.0 для всіх інших випадків.

Примітка: У Linux (Wayland) повернене значення є точним, лише коли screen має значення SCREEN_OF_MAIN_WINDOW. Через обмеження API, передача прямого індексу поверне округлене до більшого цілого числа, якщо екран має дробову шкалу (наприклад, 1.25 буде округлено до 2.0).

Примітка: Цей метод реалізовано на Android, iOS, Web, macOS та Linux (Wayland). На інших платформах цей метод завжди повертає 1.0.

Vector2i screen_get_size(screen: int = -1) const 🔗

Повертає розмір екрана в пікселях. Див. також screen_get_position() та screen_get_usable_rect(). Повертає Vector2i.ZERO, якщо screen недійсний.

Примітка: Як screen можна використовувати одну з наступних констант: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS або SCREEN_WITH_KEYBOARD_FOCUS.

Rect2i screen_get_usable_rect(screen: int = -1) const 🔗

Повертає частину екрана, яка не перекривається рядком стану, у пікселях. Див. також screen_get_size().

Примітка: Як параметр screen можна використовувати одну з наступних констант: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS або SCREEN_WITH_KEYBOARD_FOCUS.

Примітка: Цей метод реалізовано в Linux/X11, macOS та Windows. На інших платформах цей метод завжди повертає Rect2i(screen_get_position(screen), screen_get_size(screen)).

bool screen_is_kept_on() const 🔗

Повертає true, якщо екран ніколи не має вимикатися заходами енергозбереження операційної системи. Див. також screen_set_keep_on().

void screen_set_keep_on(enable: bool) 🔗

Встановлює, чи екран ніколи не повинен вимикатися заходами енергозбереження операційної системи. Див. також screen_is_kept_on().

void screen_set_orientation(orientation: ScreenOrientation, screen: int = -1) 🔗

Встановлює орієнтацію параметра screen orientation. Див. також screen_get_orientation().

Примітка: Як параметр screen можна використовувати одну з наступних констант: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS або SCREEN_WITH_KEYBOARD_FOCUS.

Примітка: Цей метод реалізовано на Android та iOS.

Примітка: На iOS цей метод не має ефекту, якщо для параметра ProjectSettings.display/window/handheld/orientation не встановлено значення SCREEN_SENSOR.

void set_hardware_keyboard_connection_change_callback(callable: Callable) 🔗

Встановлює зворотний виклик, який слід викликати, коли апаратна клавіатура підключена або відключена. callable повинен приймати один аргумент bool, який вказує, чи клавіатура підключена (true) чи відключена (false).

Примітка: Цей метод реалізовано лише на Android.

void set_icon(image: Image) 🔗

Sets the application icon and icons of all windows with an Image. To use icons in the operating system's native format, use set_native_icon() instead.

Note: Requires support for FEATURE_ICON.

void set_native_icon(filename: String) 🔗

Встановіть піктограму вікна (зазвичай відображається в верхньому лівому куті) у форматі операційної * системи * Файл filename повинен бути в .ico формат на Windows або .icns на macOS. За допомогою спеціально виготовлених .ico або .icns іконки, set_native_icon() дозволяє вказати різні іконки в залежності від розміру іконка відображається. Цей розмір визначається операційною системою та користувацькими вподобаннями (в тому числі фактором розміру дисплея). Щоб використовувати іконки в інших форматах, скористайтеся set_icon().

Примітка: Потрібна підтримка FEATURE_NATIVE_ICON.

void set_system_theme_change_callback(callable: Callable) 🔗

Встановлює зворотний виклик, який слід викликати, коли змінюються налаштування теми системи. callable повинен приймати нуль аргументів.

Примітка: Цей метод реалізовано на Android, iOS, macOS, Windows та Linux (X11/Wayland).

void show_emoji_and_symbol_picker() const 🔗

Відкриває системний засіб вибору смайлів і символів.

Примітка. Цей метод реалізовано в macOS і Windows.

Rect2 status_indicator_get_rect(id: int) const 🔗

Повернення прямокутника для даного показника стану id в координатах екрана. Якщо індикатор стану не видно, повертає порожній Rect2.

Примітка: Цей метод реалізується на macOS і Windows.

void status_indicator_set_callback(id: int, callback: Callable) 🔗

Налаштовує зворотний зв'язок з активацією облікового запису. callback повинен прийняти два аргументи: int індекс кнопки миші (одна з значень MouseButton і Vector2i натисніть позицію в координати екрана.

Примітка: Цей метод реалізується на macOS і Windows.

void status_indicator_set_icon(id: int, icon: Texture2D) 🔗

Налаштовує іконку індикатора стану заявки.

Примітка: Цей метод реалізується на macOS і Windows.

Встановлює індикатор стану програми у власному спливаючому меню.

Примітка: У macOS меню активується будь-якою кнопкою миші. Зворотний виклик його активації не спрацьовує.

Примітка: У Windows меню активується правою кнопкою миші, вибором піктограми стану і натисканням Shift + F10 або клавіші додатків. Для інших кнопок миші виклик меню залишається активованим.

Примітка: Нативне спливаюче меню підтримується, лише якщо NativeMenu підтримує функцію NativeMenu.FEATURE_POPUP_MENU.

Налаштовує інструментарій визначення стану програми.

Примітка: Цей метод реалізується на macOS і Windows.

String tablet_get_current_driver() const 🔗

Повертає поточний активний драйвер планшета.

Примітка: Цей метод реалізується тільки на Windows.

int tablet_get_driver_count() const 🔗

Повертає загальну кількість доступних драйверів планшета.

Примітка: Цей метод реалізується тільки на Windows.

String tablet_get_driver_name(idx: int) const 🔗

Повертає назву драйвера планшета для вказаного індексу.

Примітка: Цей метод реалізується тільки на Windows.

void tablet_set_current_driver(name: String) 🔗

Встановити назву активного драйвера планшета.

Підтримувані драйвери:

winink: Windows Ink API, за замовчуванням.
wintab: Wacom Wintab API (потрібен сумісний драйвер пристрою).
dummy: Фіктивний драйвер, введення з планшета вимкнено.

Примітка: Цей метод реалізовано лише у Windows.

Array[Dictionary] tts_get_voices() const 🔗

Повертає Array словників голосової інформації.

Кожен Dictionary містить два записи String:

name – назва голосу.
id – ідентифікатор голосу.
language – код мови у форматі lang_Variant. Частина lang – це 2- або 3-літерний код на основі стандарту ISO-639, написаний малими літерами. Частина Variant – це рядок, залежний від движка, який описує країну, регіон та/або діалект.

Зверніть увагу, що Godot залежить від системних бібліотек для функціональності перетворення тексту в мовлення. Ці бібліотеки встановлені за замовчуванням у Windows та macOS, але не у всіх дистрибутивах Linux. Якщо вони відсутні, цей метод поверне порожній список. Це стосується як користувачів Godot у Linux, так і кінцевих користувачів у Linux, які запускають ігри Godot, що використовують перетворення тексту в мовлення.

Примітка: Цей метод реалізовано на Android, iOS, Web, Linux (X11/Wayland), macOS та Windows.

PackedStringArray tts_get_voices_for_language(language: String) const 🔗

Повертає PackedStringArray голосових ідентифікаторів для language.

Примітка: Цей метод реалізовано на Android, iOS, Web, Linux (X11/Wayland), macOS та Windows.

bool tts_is_paused() const 🔗

Повертає true, якщо синтезатор перебуває у стані паузи.

Примітка: Цей метод реалізовано на Android, iOS, Web, Linux (X11/Wayland), macOS та Windows.

bool tts_is_speaking() const 🔗

Повертає true, якщо синтезатор генерує мовлення або має висловлювання, що очікує в черзі.

Примітка: Цей метод реалізовано на Android, iOS, Web, Linux (X11/Wayland), macOS та Windows.

void tts_pause() 🔗

Переводить синтезатор у стан паузи.

Примітка: Цей метод реалізовано на Android, iOS, Web, Linux (X11/Wayland), macOS та Windows.

void tts_resume() 🔗

Відновлює синтезатор, якщо він був призупинений.

Примітка: Цей метод реалізовано на Android, iOS, Web, Linux (X11/Wayland), macOS та Windows.

void tts_set_utterance_callback(event: TTSUtteranceEvent, callable: Callable) 🔗

Додає зворотний виклик, який викликається, коли висловлювання розпочалося, завершилося, скасовано або досягло межі тексту.

Методи викликуваного об'єкта TTS_UTTERANCE_STARTED, TTS_UTTERANCE_ENDED та TTS_UTTERANCE_CANCELED повинні приймати один параметр int, ідентифікатор висловлювання.
Метод викликуваного об'єкта TTS_UTTERANCE_BOUNDARY повинен приймати два параметри int, індекс символу та ідентифікатор висловлювання.

Примітка: Детальність зворотних викликів меж залежить від движка.

Примітка: Цей метод реалізовано на Android, iOS, Web, Linux (X11/Wayland), macOS та Windows.

void tts_speak(text: String, voice: String, volume: int = 50, pitch: float = 1.0, rate: float = 1.0, utterance_id: int = 0, interrupt: bool = false) 🔗

Додає висловлювання до черги. Якщо interrupt має значення true, черга очищується першою.

voice identifier — одне зі значень "id", що повертаються методом tts_get_voices(), або одне зі значень, що повертаються методом tts_get_voices_for_language().
volume коливається від 0 (найнижчий) до 100 (найвищий).
pitch коливається від 0.0 (найнижчий) до 2.0 (найвищий), 1.0 — це висота тону за замовчуванням для поточного голосу.
rate коливається від 0.1 (найнижчий) до 10.0 (найвищий), 1.0 — це нормальний темп мовлення. Інші значення діють як відносний відсоток.
utterance_id передається як параметр до функцій зворотного виклику.

Примітка: У Windows та Linux (X11/Wayland) вираз text може використовувати розмітку SSML. Підтримка SSML залежить від движка та голосу. Якщо движок не підтримує SSML, слід видалити всю розмітку XML перед викликом tts_speak().

Примітка: Детальність висоти тону, швидкості та гучності залежить від движка та голосу. Значення можуть бути скорочені.

Примітка: Цей метод реалізовано на Android, iOS, Web, Linux (X11/Wayland), macOS та Windows.

void tts_stop() 🔗

Зупиняє синтез, що виконується, та видаляє всі висловлювання з черги.

Примітка: Цей метод реалізовано на Android, iOS, Web, Linux (X11/Wayland), macOS та Windows.

void unregister_additional_output(object: Object) 🔗

Скасовує реєстрацію об'єкта Object, що представляє додатковий вихід, який був зареєстрований через register_additional_output().

int virtual_keyboard_get_height() const 🔗

Повертає висоту екранної клавіатури в пікселях. Повертає 0, якщо клавіатури немає або вона наразі прихована.

Примітка: На Android 7 та 8 висота клавіатури може повертати 0 під час першого відкриття клавіатури в неімерсивному режимі. Ця поведінка не відбувається в імерсивному режимі.

void virtual_keyboard_hide() 🔗

Приховує віртуальну клавіатуру, якщо вона показана, не робить нічого іншого.

void virtual_keyboard_show(existing_text: String, position: Rect2 = Rect2(0, 0, 0, 0), type: VirtualKeyboardType = 0, max_length: int = -1, cursor_start: int = -1, cursor_end: int = -1) 🔗

Показує віртуальну клавіатуру, якщо вона є на платформі.

Параметр existing_text корисний для реалізації власного LineEdit або TextEdit, оскільки він повідомляє віртуальній клавіатурі, який текст вже було набрано (віртуальна клавіатура використовує його для автокорекції та передбачення).

Параметр position задає розмір екранного простору Rect2 редагованого тексту.

type параметр дозволяє налаштувати тип віртуальної клавіатури для відображення.

max_length обмежує кількість символів, які можна ввести, якщо відрізняється від -1.

Параметр cursor_start може додатково визначати поточну позицію текстового курсору, якщо cursor_end не задано.

Параметри cursor_start і cursor_end можуть додатково визначати поточне виділення тексту.

Примітка: Цей метод реалізовано на Android, iOS та Web.

void warp_mouse(position: Vector2i) 🔗

Встановлює позицію курсору миші на задану параметр position відносно початку координат у верхньому лівому куті поточно сфокусовані вікна віконного менеджера гри.

Примітка: warp_mouse() підтримується лише у Windows, macOS та (X11/Wayland). Він не впливає на Android, iOS та Web.

bool window_can_draw(window_id: int = 0) const 🔗

Повертаємо true, якщо все можна намальовувати у вікні windows_id, false в іншому випадку. Використання -розвантажувального рядка `` аргументу командного рядка або безголовного збірки повернеться ``false.

Повернення ідентифікацію активної спливаючих вікон, або INVALID_WINDOW_ID, якщо немає.

int window_get_attached_instance_id(window_id: int = 0) const 🔗

Повертає Object.get_instance_id() об'єкта Window, до якого приєднаний window_id.

int window_get_current_screen(window_id: int = 0) const 🔗

Повертає екран, на якому наразі розташоване вікно, вказане параметром window_id. Якщо екран перекриває кілька дисплеїв, повертається екран, на якому розташований центр вікна. Див. також window_set_current_screen(). Повертає INVALID_SCREEN, якщо window_id недійсний.

Примітка: Цей метод реалізовано в Linux/X11, macOS та Windows. На інших платформах цей метод завжди повертає 0.

bool window_get_flag(flag: WindowFlags, window_id: int = 0) const 🔗

Повертає поточну вартість даного вікна flag.

float window_get_hdr_output_current_max_luminance(window_id: int = 0) const 🔗

Експериментальний: Цей метод може бути змінений або усунутий у наступних версіях.

When window_is_hdr_output_enabled() returns true, this returns the current maximum luminance in nits (cd/m²) for HDR output by the window specified by window_id. If the maximum luminance is being automatically adjusted based on the screen's capabilities, this method will return that value. Otherwise, it will return the value set by window_set_hdr_output_max_luminance(). This maximum luminance value is used when calculating window_get_output_max_linear_value().

Note: This maximum luminance may not match the physical behavior of the screen, but will always be proportionally correct relative to window_get_hdr_output_current_reference_luminance().

float window_get_hdr_output_current_reference_luminance(window_id: int = 0) const 🔗

When window_is_hdr_output_enabled() returns true, this returns the current reference white luminance in nits (cd/m²) for HDR output by the window specified by window_id. If the reference luminance is being automatically adjusted to match the operating system brightness, this will return that value. Otherwise, it will return the value set by window_set_hdr_output_reference_luminance(). This reference luminance value is used when calculating window_get_output_max_linear_value().

Note: This reference white luminance may not match the physical behavior of the screen, but will always be proportionally correct relative to window_get_hdr_output_current_max_luminance().

float window_get_hdr_output_max_luminance(window_id: int = 0) const 🔗

Експериментальний: Цей метод може бути змінений або усунутий у наступних версіях.

Returns the maximum luminance in nits (cd/m²) set for HDR output by the window specified by window_id. Negative values indicate that the value is being automatically adjusted based on the screen's capabilities. See also window_get_hdr_output_current_max_luminance().

float window_get_hdr_output_reference_luminance(window_id: int = 0) const 🔗

Returns the reference white luminance in nits (cd/m²) set for HDR output by the window specified by window_id. Negative values indicate that the value is being automatically adjusted to match the operating system brightness. See also window_get_hdr_output_current_reference_luminance().

Vector2i window_get_max_size(window_id: int = 0) const 🔗

Повертає максимальний розмір вікна (у пікселях). Дивись також windows_set_max_size().

Vector2i window_get_min_size(window_id: int = 0) const 🔗

Повертає розмір вікна (у пікселях). Дивись також windows_set_min_size().

WindowMode window_get_mode(window_id: int = 0) const 🔗

Повертаємо режим даного вікна.

int window_get_native_handle(handle_type: HandleType, window_id: int = 0) const 🔗

Повертає внутрішню структуру тостерів для використання в плагінах.

Примітка: Цей метод реалізований на Android, Linux (X11/Wayland), macOS та Windows.

float window_get_output_max_linear_value(window_id: int = 0) const 🔗

Returns the maximum value for linear color components that can be displayed for the window specified by window_id, regardless of SDR or HDR output. Returns 1.0 if HDR is not enabled or not supported. When HDR output is enabled, this is calculated based on window_get_hdr_output_current_reference_luminance() and window_get_hdr_output_current_max_luminance(). The Window.output_max_linear_value_changed signal will be emitted whenever this value changes. This value is used by tonemapping and other Environment effects to ensure that bright colors are presented in the range that can be displayed by this window. Corresponds to Window.get_output_max_linear_value().

Повертає межі вікна управління, або пункт меню, який використовувався для відкриття вікна спливаючих вікон, в системі координат екрана.

Vector2i window_get_position(window_id: int = 0) const 🔗

Повертає позицію клієнтської зони даного вікна на екрані.

Vector2i window_get_position_with_decorations(window_id: int = 0) const 🔗

Повертає положення даного вікна на екрані, включаючи кордони, що нараховуються операційною системою. Дивись також windows_get_position().

Vector3i window_get_safe_title_margins(window_id: int = 0) const 🔗

Повертає ліві запаси (x), праві запаси (y) і висота (z) назви, які безпечні для використання (контейнери без кнопок або інших елементів) при WINDOW_FLAG_EXTEND_TO_TITLE.

Vector2i window_get_size(window_id: int = 0) const 🔗

Повертає розмір вікна, вказаного Window_id (у пікселях), уключаючи кордони, намальовані операційною системою. Це також називається «клієнтною зоною». Дивись також windows_get_size_with_decorations(), windows_set_size() і windows_get_position().

Vector2i window_get_size_with_decorations(window_id: int = 0) const 🔗

Повертає розмір вікна, вказаного Window_id (у пікселях), включаючи кордони, намальовані операційною системою. Дивись також windows_get_size().

Vector2i window_get_title_size(title: String, window_id: int = 0) const 🔗

Повертаємо увагу, що розмір рядка заголовків вікна (включаючи текстові та вікна) для вікна, вказаного Window_id (у пікселях). Цей метод не змінює назву вікна.

Примітка: Цей метод реалізується на macOS і Windows.

VSyncMode window_get_vsync_mode(window_id: int = 0) const 🔗

Повертає режим V-Sync даної вікна.

bool window_is_focused(window_id: int = 0) const 🔗

Повертає true, якщо вікно, вказане windows_id, фокусується.

bool window_is_hdr_output_enabled(window_id: int = 0) const 🔗

Returns true if HDR output is currently enabled for the window specified by window_id. The returned value may change dynamically based on system settings, screen capabilities, and which screen the window is currently on.

bool window_is_hdr_output_requested(window_id: int = 0) const 🔗

Returns true if HDR output is requested for the window specified by window_id. Corresponds to Window.hdr_output_requested.

bool window_is_hdr_output_supported(window_id: int = 0) const 🔗

Returns true if the window specified by window_id supports HDR output. This depends on the platform, screen capabilities, system settings, and the screen the window is currently on.

bool window_is_maximize_allowed(window_id: int = 0) const 🔗

Повертаємо true, якщо дана вікно можна максимізувати (включається максимальна кнопка).

bool window_maximize_on_title_dbl_click() const 🔗

Повертає true, якщо подвійне клацання на заголовку вікна має максимізувати його.

Примітка: Цей метод реалізовано лише на macOS.

bool window_minimize_on_title_dbl_click() const 🔗

Повертає true, якщо подвійне клацання на заголовку вікна має згорнути його.

Примітка: Цей метод реалізовано лише на macOS.

void window_move_to_foreground(window_id: int = 0) 🔗

Перемістіть вікно, вказане Window_id на передмістя, щоб воно було видно над іншими вікнами.

void window_request_attention(window_id: int = 0) 🔗

Зробіть вікно, вказане Window_id, на яке матеріалізується заголовок вікна та запис панелі завдань, що підключається до фокусування вікна. Це зазвичай не має видимого ефекту, якщо вікно в даний час зосереджено. Точна поведінка залежить від операційної системи.

void window_request_hdr_output(enable: bool, window_id: int = 0) 🔗

If enable is true, HDR output is requested for the window specified by window_id. The window will automatically switch between HDR and SDR if it is moved between screens, screen capabilities change, or system settings are modified. This will internally force Viewport.use_hdr_2d to be enabled on the main Viewport. All other SubViewport of the Window must have their Viewport.use_hdr_2d property enabled to produce HDR output. Corresponds to Window.hdr_output_requested.

void window_set_color(color: Color) 🔗

Встановлює колір фону кореневого вікна.

Примітка: Цей метод реалізовано лише на Android.

void window_set_current_screen(screen: int, window_id: int = 0) 🔗

Переміщує вікно, вказане параметром window_id, на вказаний параметр screen. Див. також window_get_current_screen().

Примітка: Як параметр screen можна використовувати одну з наступних констант: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS або SCREEN_WITH_KEYBOARD_FOCUS.

Примітка: Цей метод реалізовано в Linux/X11, macOS та Windows.

void window_set_drop_files_callback(callback: Callable, window_id: int = 0) 🔗

Встановіть callback, який слід назвати, коли файли падають з файлового менеджера операційної системи до вікна, вказаного windows_id. callback повинен прийняти один PackedStringArray аргумент, який є список вилучених файлів.

Налаштування: Додаткові користувачі тільки! Додавання такого зворотного виклику в вузол Window перенаречений на його виконання за замовчуванням, який може ввести помилки.

Примітка: Цей метод реалізується на Windows, macOS, Linux (X11/Wayland), і Web.

void window_set_exclusive(window_id: int, exclusive: bool) 🔗

Якщо встановити до true, це вікно завжди буде триматися у верхній частині свого вікна батьків, вікно батьків ігноруватиме вхід, коли це вікно відкривається.

Примітка: На macOS, ексклюзивні вікна кріпляться до того ж простору (середній робочий стіл або екран) як материнське вікно.

Примітка: Цей метод реалізується на macOS і Windows.

void window_set_flag(flag: WindowFlags, enabled: bool, window_id: int = 0) 🔗

Вмикає або вимикає налаштування заданого вікна flag.

void window_set_hdr_output_max_luminance(max_luminance: float, window_id: int = 0) 🔗

Експериментальний: Цей метод може бути змінений або усунутий у наступних версіях.

Sets the maximum luminance in nits (cd/m²) for HDR output by the window specified by window_id. If max_luminance is negative, the window uses the screen's maximum luminance that is reported by the operating system. By default, this luminance is set to -1.0 for every window. Typically this property should be left at this default value, but may optionally be exposed through in-game settings to allow the player to correct an inaccurate maximum luminance reported by the operating system. See also window_get_hdr_output_current_max_luminance() and window_get_hdr_output_max_luminance().

Note: This method is only implemented on macOS and Windows. Other platforms will always use the screen's maximum luminance that is reported by the operating system.

void window_set_hdr_output_reference_luminance(reference_luminance: float, window_id: int = 0) 🔗

Sets the reference white luminance in nits (cd/m²) for HDR output by the window specified by window_id. If reference_luminance is negative, the window automatically adjusts to the brightness set by the operating system. By default, this luminance is set to -1.0 for every window. Typically this property should be left at this default value, but may optionally be exposed as an "HDR Brightness" in-game setting to allow the player to adjust the brightness of their game, independently of their device settings. See also window_get_hdr_output_current_reference_luminance() and window_get_hdr_output_reference_luminance().

Note: This method is only implemented on Windows. Other platforms will always use the reference luminance that is reported by the operating system.

void window_set_icon(icon: Image, window_id: int = 0) 🔗

Sets the window icon (usually displayed in the top-left corner) for the window specified by window_id.

Note: This method is implemented on Linux and Windows.

void window_set_ime_active(active: bool, window_id: int = 0) 🔗

Встановлює, чи має бути ввімкнено Редактор методів вводу для вікна, вказаного параметром window_id. Див. також window_set_ime_position().

void window_set_ime_position(position: Vector2i, window_id: int = 0) 🔗

Встановлює позицію Вступний редактор метод для вказаного Window_id. true для вказаного windows_id.

void window_set_input_event_callback(callback: Callable, window_id: int = 0) 🔗

Встановіть callback, який слід назвати, коли будь-який InputEvent надіслав у вікно, вказане windows_id.

Попередження: Додаткові користувачі тільки! Додавання такого зворотного виклику в вузол Window перенаречений на його виконання за замовчуванням, який може ввести помилки.

void window_set_input_text_callback(callback: Callable, window_id: int = 0) 🔗

Встановіть callback, який слід назвати при введенні тексту за допомогою віртуальної клавіатури до вікна windows_id.

Попередження: Додаткові користувачі тільки! Додавання такого зворотного виклику в вузол Window перенаречений на його виконання за замовчуванням, який може ввести помилки.

void window_set_max_size(max_size: Vector2i, window_id: int = 0) 🔗

Встановлює максимальний розмір вікна, зазначеного Window_id у пікселях. Зазвичай користувач не зможе перетягнути вікно, щоб зробити його більшим ніж заданий розмір. Дивись також windows_get_max_size().

Примітка: Рекомендовано змінити значення за допомогою Window.max_size.

Примітка: Використання сторонніх інструментів, можливо для користувачів, щоб відключити обмеження геометрії вікон і, отже, обійти цей ліміт.

void window_set_min_size(min_size: Vector2i, window_id: int = 0) 🔗

Налаштовує мінімальний розмір для даного вікна до min_size у пікселях. Зазвичай користувач не зможе перетягнути вікно, щоб зробити його меншим, ніж зазначений розмір. Дивись також windows_get_min_size().

Примітка: Рекомендовано змінити значення за допомогою Window.min_size.

Примітка: За замовчуванням основне вікно має мінімальний розмір Vector2i(64, 64). Це запобігає виникненню проблем, коли вікно негабаритне до ближнього розміру.

Примітка: Використання сторонніх інструментів, можливо для користувачів, щоб відключити обмеження геометрії вікон і, отже, обійти цей ліміт.

void window_set_mode(mode: WindowMode, window_id: int = 0) 🔗

Встановлює режим вікна для заданого вікна на mode.

Примітка: На Android встановлення значення WINDOW_MODE_FULLSCREEN або WINDOW_MODE_EXCLUSIVE_FULLSCREEN увімкне режим занурення.

Примітка: Встановлення вікна на весь екран примусово встановлює прапорець без рамок на true, тому обов’язково встановіть його назад на false, коли це небажано.

void window_set_mouse_passthrough(region: PackedVector2Array, window_id: int = 0) 🔗

Встановлює багатокутну область вікна, яка приймає події миші. Події миші за межами регіону будуть проходити.

Передача порожнього масиву вимкне підтримку проходження (усі події миші перехоплюватимуться вікном, що є типовою поведінкою).

# Встановити регіон, використовуючи вузол Path2D.
DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points())

# Встановити область, використовуючи вузол Polygon2D.
DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon)

# Скинути регіон до стандартних.
DisplayServer.window_set_mouse_passthrough([])

// Встановити регіон, використовуючи вузол 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.

Налаштовує лімітовану коробку керування, або пункт меню, який використовувався для відкриття вікна спливаючих вікон, в системі координат екрана. Натиснувши цю область не буде автоматично закрити її.

void window_set_position(position: Vector2i, window_id: int = 0) 🔗

Встановлює позицію даного вікна на position. У налаштуваннях із кількома моніторами положення екрана залежить від області віртуального робочого столу. У налаштуваннях із кількома моніторами з різною роздільною здатністю або орієнтацією екрана джерело може розташовуватися за межами будь-якого дисплея, як це:

* (0, 0) +-------+
                |       |
+-------------+ |       |
|             | |       |
|             | |       |
+-------------+ +-------+

Дивіться також window_get_position() і window_set_size().

Примітка: Рекомендується змінити це значення за допомогою Window.position.

Примітка. У Linux (Wayland): цей метод є безопераційним.

void window_set_rect_changed_callback(callback: Callable, window_id: int = 0) 🔗

Встановіть callback, який буде викликано, коли вікно, зазначене windows_id переміщається або негабаритний.

Попередження: Додаткові користувачі тільки! Додавання такого зворотного виклику в вузол Window перенаречений на його виконання за замовчуванням, який може ввести помилки.

void window_set_size(size: Vector2i, window_id: int = 0) 🔗

Встановлює розмір даної вікна до параметра (у пікселях). Дивись також windows_get_size() і windows_get_position().

Примітка: Рекомендовано змінити це значення за допомогою Window.size.

void window_set_taskbar_progress_state(state: ProgressState, window_id: int = 0) 🔗

Sets the type and state of the progress bar on the taskbar/dock icon of the window specified by window_id. See ProgressState for possible values and how each mode behaves.

Note: This method is implemented only on Windows and macOS.

Note: On macOS, the progress bar is displayed only for the main window.

void window_set_taskbar_progress_value(value: float, window_id: int = 0) 🔗

Creates a progress bar on the taskbar/dock icon of the window specified by window_id if it does not exist, sets the progress of the icon.

value acts as a relative percentage value, ranges from 0.0 (lowest) to 1.0 (highest).

Note: This method is implemented only on Windows and macOS.

Note: On macOS, the progress bar is displayed only for the main window.

void window_set_title(title: String, window_id: int = 0) 🔗

Встановлює назву даної вікна на title.

Примітка: Рекомендовано змінити це значення за допомогою Window.title.

Примітка: Уникайте зміни назви вікна кожного кадру, оскільки це може викликати проблеми продуктивності на певних вікнах. Спробуйте змінити назву вікна лише кілька разів на секунду.

void window_set_transient(window_id: int, parent_window_id: int) 🔗

Встановлює тимчасовий батьків вікна. Тимчасове вікно буде знищено разом із його тимчасовим батьківським вікном і поверне фокус до батьківського вікна, коли буде закрито. Перехідне вікно відображається поверх невиключного повноекранного батьківського вікна. Перехідні вікна не можуть перейти в повноекранний режим.

Примітка: Рекомендується змінити це значення за допомогою Window.transient.

Примітка: Поведінка може відрізнятися залежно від платформи.

void window_set_vsync_mode(vsync_mode: VSyncMode, window_id: int = 0) 🔗

Встановлює режим V-Sync для заданого вікна. Див. також ProjectSettings.display/window/vsync/vsync_mode.

Залежно від платформи та використовуваного рендерера, рушій повернеться до VSYNC_ENABLED, якщо потрібний режим не підтримується.

Примітка: Режими V-Sync, відмінні від VSYNC_ENABLED, підтримуються лише в методах рендерингу Forward+ та Mobile, а не в Compatibility.

void window_set_window_buttons_offset(offset: Vector2i, window_id: int = 0) 🔗

Коли WINDOW_FLAG_EXTEND_TO_TITLE прапор встановлюється, встановіть офсет до центру кнопки першого заголовка.

Примітка: Цей прапор реалізується тільки на macOS.

void window_set_window_event_callback(callback: Callable, window_id: int = 0) 🔗

Встановіть callback, який буде називатися при виникненні події в вікні, вказаному windows_id.

Попередження: Додаткові користувачі тільки! Додавання такого зворотного виклику в вузол Window перенаречений на його виконання за замовчуванням, який може ввести помилки.

void window_start_drag(window_id: int = 0) 🔗

Починає інтерактивну операцію перетягування у вікні з заданим window_id, використовуючи поточну позицію миші. Викликайте цей метод під час обробки натиснутої кнопки миші, щоб імітувати подію натискання в рядку заголовка вікна. Використання цього методу дозволяє вікну брати участь у перемиканні простору, мозаїці та інших функціях системи.

Примітка: Цей метод реалізовано в Linux (X11/Wayland), macOS і Windows.

void window_start_resize(edge: WindowResizeEdge, window_id: int = 0) 🔗

Починає інтерактивну операцію зміни розміру вікна з заданим window_id, використовуючи поточну позицію миші. Викликайте цей метод під час обробки натиснутої кнопки миші, щоб імітувати подію натискання на краю вікна.

Примітка: Цей метод реалізовано в Linux (X11/Wayland), macOS і Windows.