DisplayServer

public static Rid AccessibilityCreateElement(int windowId, DisplayServer.AccessibilityRole role);

Создает новый, пустой ресурс элемента доступности. Примечание: Элемент доступности создается и освобождается автоматически для каждого Entity. В общем случае эту функцию не следует вызывать вручную.

public static Rid AccessibilityCreateSubElement(Rid parentRid, DisplayServer.AccessibilityRole role, int insertPos = -1);

Создает новый, пустой ресурс подэлемента доступности. Подэлементы могут использоваться для предоставления информации о доступности для объектов, которые не являются Entity, таких как элементы списка, ячейки таблицы или пункты меню. Подэлементы освобождаются автоматически при освобождении родительского элемента или могут быть освобождены заранее с помощью метода DisplayServer.AccessibilityFreeElement.

public static Rid AccessibilityCreateSubTextEditElements(Rid parentRid, Rid shapedText, float minHeight, int insertPos);

Создает новый пустой подэлемент доступности из буфера текста определенной формы. Подэлементы освобождаются автоматически при освобождении родительского элемента или могут быть освобождены досрочно с помощью метода DisplayServer.AccessibilityFreeElement. Если is_last_line имеет значение true, к содержимому текста не добавляется завершающая новая строка. Установите значение true для последней строки в многострочных текстовых полях и для однострочных текстовых полей.

public static Rid AccessibilityCreateSubTextEditElements(Rid parentRid, Rid shapedText, float minHeight, int insertPos = -1, bool isLastLine = false);

Создает новый пустой подэлемент доступности из буфера текста определенной формы. Подэлементы освобождаются автоматически при освобождении родительского элемента или могут быть освобождены досрочно с помощью метода DisplayServer.AccessibilityFreeElement. Если is_last_line имеет значение true, к содержимому текста не добавляется завершающая новая строка. Установите значение true для последней строки в многострочных текстовых полях и для однострочных текстовых полей.

public static Variant AccessibilityElementGetMeta(Rid id);

Возвращает метаданные элемента доступности id.

public static void AccessibilityElementSetMeta(Rid id, Variant meta);

Устанавливает метаданные элемента доступности id равными meta.

public static void AccessibilityFreeElement(Rid id);

Освобождает элемент доступности id, созданный с помощью DisplayServer.AccessibilityCreateElement, DisplayServer.AccessibilityCreateSubElement или DisplayServer.AccessibilityCreateSubTextEditElements.

public static Rid AccessibilityGetWindowRoot(int windowId);

Возвращает основной элемент доступности OS Оконное окно.

public static bool AccessibilityHasElement(Rid id);

Возвращает true, если id является допустимым элементом доступности.

public static int AccessibilityScreenReaderActive();

Returns (Возврат) 1 если считывающее устройство экрана, дисплей Брайля или другое ассистивное приложение активировано, 0 Возвращение -1 если статус неизвестен. Примечание: Этот метод применяется на Android, Linux, acOS и Windows. Примечание: Инструменты отладки доступа, такие, как доступная интуиция для Windows, Инспектор доступности (MacOS) или Просмотр AT-SPI (Linux/BSD), не считаются ассистирующими приложениями и не будут влиять на это значение. Для проверки вашего проекта с помощью этих инструментов, настройка ProjectSettings.accessibility/general/accessibility_support в адрес 1.

public static void AccessibilitySetWindowFocused(int windowId, bool focused);

Устанавливает состояние фокуса окна для вспомогательных приложений. Примечание: Этот метод реализован в Linux, macOS и Windows. Примечание: Только для опытных пользователей! Объекты Window вызывают этот метод автоматически.

public static void AccessibilitySetWindowRect(int windowId, Rect2 rectOut, Rect2 rectIn);

Устанавливает внешние (с украшениями) и внутренние (без украшений) границы окна для вспомогательных приложений. Примечание: Этот метод реализован в Linux, macOS и Windows. Примечание: Только для опытных пользователей! Объекты Window вызывают этот метод автоматически.

public static int AccessibilityShouldIncreaseContrast();

Returns (Возврат) 1 - если следует использовать тему интерфейса с высокой конструкцией, 0 Возвращение -1 если статус неизвестен. Примечание: Этот метод применяется на Android, Linux (X11/Wayland, GNOME), MacOS и Windows.

public static int AccessibilityShouldReduceAnimation();

Returns (Возврат) 1 если мигающий, мигающий и другой движущийся контент, который может вызвать припадки у пользователей с фоточувствительной эпилепсией, должен быть отключен, 0 Возвращение -1 если статус неизвестен. Примечание: Этот метод применяется на Android, acOS и Windows.

public static int AccessibilityShouldReduceTransparency();

Возвращает 1, если фоновые изображения, прозрачность и другие функции, которые могут уменьшить контраст между передним планом и фоном, должны быть отключены, 0 в противном случае. Возвращает -1, если статус неизвестен. Примечание: Этот метод реализован в macOS и Windows.

public static void AccessibilityUpdateAddAction(Rid id, DisplayServer.AccessibilityAction action, Callable callable);

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

public static void AccessibilityUpdateAddChild(Rid id, Rid childId);

Добавляет дочерний элемент доступности. Примечание: Дочерние и подэлементы Entity добавляются в список дочерних элементов автоматически.

public static void AccessibilityUpdateAddCustomAction(Rid id, int actionId, string actionDescription);

Добавляет поддержку для настраиваемого действия специальных возможностей. action_id передается как аргумент обратному вызову действия DisplayServer.AccessibilityAction.Custom.

public static void AccessibilityUpdateAddRelatedControls(Rid id, Rid relatedId);

Добавляет элемент, который контролируется данным элементом.

public static void AccessibilityUpdateAddRelatedDescribedBy(Rid id, Rid relatedId);

Добавляет элемент, описывающий этот элемент.

public static void AccessibilityUpdateAddRelatedDetails(Rid id, Rid relatedId);

Добавляет элемент, детализирующий этот элемент.

public static void AccessibilityUpdateAddRelatedFlowTo(Rid id, Rid relatedId);

Добавляет элемент, в который вливается данный элемент.

public static void AccessibilityUpdateAddRelatedLabeledBy(Rid id, Rid relatedId);

Добавляет элемент, маркирующий этот элемент.

public static void AccessibilityUpdateAddRelatedRadioGroup(Rid id, Rid relatedId);

Добавляет элемент, который является частью той же радиогруппы. Примечание: Этот метод следует вызывать для каждого элемента группы, используя все остальные элементы как related_id.

public static void AccessibilityUpdateSetActiveDescendant(Rid id, Rid otherId);

Добавляет элемент, который является активным потомком данного элемента.

public static void AccessibilityUpdateSetBackgroundColor(Rid id, Color color);

Устанавливает цвет фона элемента.

public static void AccessibilityUpdateSetBounds(Rid id, Rect2 rect);

Устанавливает ограничивающую рамку элемента относительно положения узла.

public static void AccessibilityUpdateSetChecked(Rid id, bool checekd);

Устанавливает состояние проверки элемента.

public static void AccessibilityUpdateSetClassname(Rid id, string classname);

Задает имя класса элемента.

public static void AccessibilityUpdateSetColorValue(Rid id, Color color);

Устанавливает значение цвета элемента.

public static void AccessibilityUpdateSetDescription(Rid id, string description);

Устанавливает описание доступности элемента.

public static void AccessibilityUpdateSetErrorMessage(Rid id, Rid otherId);

Устанавливает элемент, содержащий сообщение об ошибке для этого элемента.

public static void AccessibilityUpdateSetExtraInfo(Rid id, string name);

Устанавливает дополнительную информацию о доступности элемента, добавляемую к имени элемента.

public static void AccessibilityUpdateSetFlag(Rid id, DisplayServer.AccessibilityFlags flag, bool value);

Устанавливает флаг элемента.

public static void AccessibilityUpdateSetFocus(Rid id);

Устанавливает текущий элемент, находящийся в фокусе.

public static void AccessibilityUpdateSetForegroundColor(Rid id, Color color);

Устанавливает цвет переднего плана элемента.

public static void AccessibilityUpdateSetInPageLinkTarget(Rid id, Rid otherId);

Устанавливает цель элемента для ссылки.

public static void AccessibilityUpdateSetLanguage(Rid id, string language);

Устанавливает язык текста элемента.

public static void AccessibilityUpdateSetListItemCount(Rid id, int size);

Устанавливает количество элементов в списке.

public static void AccessibilityUpdateSetListItemExpanded(Rid id, bool expanded);

Устанавливает развернутый статус элемента списка/дерева.

public static void AccessibilityUpdateSetListItemIndex(Rid id, int index);

Устанавливает позицию элемента в списке.

public static void AccessibilityUpdateSetListItemLevel(Rid id, int level);

Устанавливает иерархический уровень элемента в списке.

public static void AccessibilityUpdateSetListItemSelected(Rid id, bool selected);

Устанавливает статус выбранного элемента списка/дерева.

public static void AccessibilityUpdateSetListOrientation(Rid id, bool vertical);

Задает ориентацию элементов списка.

public static void AccessibilityUpdateSetLive(Rid id, DisplayServer.AccessibilityLiveMode live);

Устанавливает приоритет обновлений региона в реальном времени.

public static void AccessibilityUpdateSetMemberOf(Rid id, Rid groupId);

Устанавливает элемент как член группы.

public static void AccessibilityUpdateSetName(Rid id, string name);

Устанавливает имя доступности элемента.

public static void AccessibilityUpdateSetNextOnLine(Rid id, Rid otherId);

Устанавливает следующий элемент в строке.

public static void AccessibilityUpdateSetNumJump(Rid id, double jump);

Устанавливает скачок числового значения.

public static void AccessibilityUpdateSetNumRange(Rid id, double min, double max);

Устанавливает диапазон числовых значений.

public static void AccessibilityUpdateSetNumStep(Rid id, double step);

Устанавливает шаг числового значения.

public static void AccessibilityUpdateSetNumValue(Rid id, double position);

Устанавливает числовое значение.

public static void AccessibilityUpdateSetPlaceholder(Rid id, string placeholder);

Устанавливает текст-заполнитель.

public static void AccessibilityUpdateSetPopupType(Rid id, DisplayServer.AccessibilityPopupType popup);

Устанавливает тип всплывающего окна для всплывающих кнопок.

public static void AccessibilityUpdateSetPreviousOnLine(Rid id, Rid otherId);

Устанавливает предыдущий элемент в строке.

public static void AccessibilityUpdateSetRole(Rid id, DisplayServer.AccessibilityRole role);

Устанавливает роль доступности элемента.

public static void AccessibilityUpdateSetRoleDescription(Rid id, string description);

Устанавливает текст описания роли доступности элемента.

public static void AccessibilityUpdateSetScrollX(Rid id, double position);

Устанавливает положение полосы прокрутки по оси x.

public static void AccessibilityUpdateSetScrollXRange(Rid id, double min, double max);

Устанавливает диапазон полосы прокрутки x.

public static void AccessibilityUpdateSetScrollY(Rid id, double position);

Устанавливает положение полосы прокрутки по оси Y.

public static void AccessibilityUpdateSetScrollYRange(Rid id, double min, double max);

Устанавливает диапазон прокрутки по оси Y.

public static void AccessibilityUpdateSetShortcut(Rid id, string shortcut);

Задает список сочетаний клавиш, используемых элементом.

public static void AccessibilityUpdateSetStateDescription(Rid id, string description);

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

public static void AccessibilityUpdateSetTableCellPosition(Rid id, int rowIndex, int columnIndex);

Устанавливает положение ячейки в таблице.

public static void AccessibilityUpdateSetTableCellSpan(Rid id, int rowSpan, int columnSpan);

Устанавливает диапазон строк/столбцов ячеек.

public static void AccessibilityUpdateSetTableColumnCount(Rid id, int count);

Задает количество столбцов в таблице.

public static void AccessibilityUpdateSetTableColumnIndex(Rid id, int index);

Устанавливает положение столбца.

public static void AccessibilityUpdateSetTableRowCount(Rid id, int count);

Устанавливает количество строк в таблице.

public static void AccessibilityUpdateSetTableRowIndex(Rid id, int index);

Устанавливает положение строки в таблице.

public static void AccessibilityUpdateSetTextAlign(Rid id, HorizontalAlignment align);

Устанавливает выравнивание текста элемента.

public static void AccessibilityUpdateSetTextDecorations(Rid id, bool underline, bool strikethrough, bool overline);

Устанавливает подчеркивание/надчеркивание/зачеркивание текста.

public static void AccessibilityUpdateSetTextOrientation(Rid id, bool vertical);

Устанавливает ориентацию текста.

public static void AccessibilityUpdateSetTextSelection(Rid id, Rid textStartId, int startChar, Rid textEndId, int endChar);

Устанавливает выделение текста в текстовое поле. text_start_id и text_end_id должны быть элементами, созданными DisplayServer.AccessibilityCreateSubTextEditElements. Смещения символов указаны относительно соответствующего элемента.

public static void AccessibilityUpdateSetTooltip(Rid id, string tooltip);

Устанавливает текст подсказки.

public static void AccessibilityUpdateSetTransform(Rid id, Transform2D transform);

Устанавливает 2D-преобразование элемента.

public static void AccessibilityUpdateSetUrl(Rid id, string url);

Устанавливает URL-адрес ссылки.

public static void AccessibilityUpdateSetValue(Rid id, string value);

Устанавливает текстовое значение элемента.

public static void Beep();

Играет звуковой сигнал из операционной системы, если возможно. OS, звук звука звука будет слышен даже в том случае, если приложение выключено. OS пользователем. Примечание: Этот метод применяется на MacOS, Linux (X11/Wayland) и Windows.

public static string ClipboardGet();

Возвращает буфер обмена пользователя в виде строки, если это возможно.

public static Image ClipboardGetImage();

Возвращает содержимое буфера обмена пользователя в виде изображения, если это возможно. Примечание: Этот метод использует скопированные пиксельные данные, например, из программы для редактирования изображений или веб-браузера, а не файл изображения, скопированный из проводника.

public static string ClipboardGetPrimary();

Возвращает основной буфер обмена пользователя в виде строки, если это возможно. Это буфер обмена, который устанавливается, когда пользователь выделяет текст в любом приложении, а не при нажатии [kbd]Ctrl + C[/kbd]. Затем данные буфера обмена можно вставить, щелкнув среднюю кнопку мыши в любом приложении, которое поддерживает механизм основного буфера обмена. Примечание: Этот метод реализован только в Linux (X11/Wayland).

public static bool ClipboardHas();

Возвращает true, если в буфере обмена пользователя есть текстовое содержимое.

public static bool ClipboardHasImage();

Возвращает true, если в буфере обмена пользователя есть изображение.

public static void ClipboardSet(string clipboard);

Устанавливает содержимое буфера обмена пользователя в соответствии с заданной строкой.

public static void ClipboardSetPrimary(string clipboardPrimary);

Устанавливает содержимое буфера обмена пользователя основного на указанную строку. Это буфер обмена, который устанавливается, когда пользователь выделяет текст в любом приложении, а не при нажатии [kbd]Ctrl + C[/kbd]. Затем данные буфера обмена можно вставить, щелкнув среднюю кнопку мыши в любом приложении, которое поддерживает механизм основного буфера обмена. Примечание: Этот метод реализован только в Linux (X11/Wayland).

public static bool ColorPicker(Callable callback);

Показать OS Ловкий цвет. У звонков есть следующие аргументы: status: bool, color: Color. Примечание: Этот метод применяется, если сервер дисплея имеет DisplayServer.Feature.NativeColorPicker функция. Примечание: Этот метод применяется только на Linux (X11/Wayland).

public static int CreateStatusIndicator(Texture2D icon, string tooltip, Callable callback);

Создает новый индикатор состояния приложения с указанным значком, подсказкой и обратным вызовом активации. callback должен принимать два аргумента: нажатую кнопку мыши (одну из констант MouseButton) и позицию щелчка в координатах экрана (a Vector2I).

public static DisplayServer.CursorShape CursorGetShape();

Возвращает форму курсора мыши по умолчанию, установленную DisplayServer.CursorSetShape.

public static void CursorSetCustomImage(Resource cursor, DisplayServer.CursorShape shape = DisplayServer.CursorShape.Arrow, Vector2? hotspot = default);

Устанавливает пользовательское изображение курсора мыши для заданного параметра shape. Это означает, что операционная система пользователя и тема курсора мыши больше не будут влиять на его внешний вид. Параметр cursor может быть либо Texture2D, либо Image, и его размер не должен превышать 256×256 для корректного отображения. При желании параметр hotspot может быть установлен для смещения положения изображения относительно точки щелчка. По умолчанию hotspot устанавливается в верхний левый угол изображения. См. также DisplayServer.CursorSetShape. Примечание: В веб-среде вызов этого метода каждый кадр может привести к мерцанию курсора.

public static void CursorSetShape(DisplayServer.CursorShape shape);

Устанавливает форму курсора мыши по умолчанию. Внешний вид курсора будет зависеть от операционной системы пользователя и темы курсора мыши. См. также DisplayServer.CursorGetShape и DisplayServer.CursorSetCustomImage.

public static void DeleteStatusIndicator(int id);

Удаляет индикатор состояния приложения.

public static Error DialogInputText(string title, string description, string existingText, Callable callback);

Показывает диалоговое окно ввода текста, которое использует собственный стиль операционной системы. callback должен принимать один параметр string, содержащий содержимое текстового поля. Примечание: Этот метод реализуется, если сервер отображения имеет функцию DisplayServer.Feature.NativeDialogInput. Поддерживаемые платформы включают macOS, Windows и Android.

public static Error DialogShow(string title, string description, ReadOnlySpan<string> buttons, Callable callback);

Показывает текстовый диалог, который использует собственный стиль операционной системы. callback должен принимать один параметр [int], который соответствует индексу нажатой кнопки. Примечание: Этот метод реализуется, если сервер отображения имеет функцию DisplayServer.Feature.NativeDialog. Поддерживаемые платформы включают macOS, Windows и Android.

public static Error DialogShow(string title, string description, string[] buttons, Callable callback);

Показывает текстовый диалог, который использует собственный стиль операционной системы. callback должен принимать один параметр [int], который соответствует индексу нажатой кнопки. Примечание: Этот метод реализуется, если сервер отображения имеет функцию DisplayServer.Feature.NativeDialog. Поддерживаемые платформы включают macOS, Windows и Android.

public static void EnableForStealingFocus(long processId);

Позволяет process_id PID украсть фокус из этого окна. Другими словами, это отключает защиту операционной системы от украденного фокуса для указанного PID. Примечание: Этот метод реализован только в Windows.

public static Error FileDialogShow(string title, string currentDirectory, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, ReadOnlySpan<string> filters, Callable callback);

Показать OS Диалог для выбора файлов или каталогов в файловой системе. Каждый фильтр в строчке filters Формат массива должен быть следующим: *.png,*.jpg,*.jpeg;Image Files;image/png,image/jpegТекст описания фильтра является факультативным и может быть опущен. Рекомендуется устанавливать как расширение файла, так и тип MIME. См. также FileDialog.Filters. У звонков есть следующие аргументы: status: bool, selected_paths: PackedStringArray, selected_filter_index: int. На Андроид, третий аргумент об обратном звонке (selected_filter_index) всегда 0. Примечание: Этот метод применяется, если сервер дисплея имеет DisplayServer.Feature.NativeDialogFile В число поддерживаемых платформ входят Linux (X11/Wayland), Windows, acOS и Android. Примечание: current_directory может быть проигнорировано. Примечание: Встроенные диалоги файлов и диалоги файлов Windows поддерживают только расширение файлов, в то время как диалоги файлов Android, Linux и acOS также поддерживают типы MIME. Примечание: На Андроид и Линукс, show_hidden игнорируется. Примечание: На Android и acOS диалоги местных файлов не имеют названия. Примечание: На макосе приложения с песчаными коробками сохранят закладки с защищенным кодом, чтобы сохранить доступ к открытым папкам в ходе нескольких сеансов. OS.GetGrantedPermissions чтобы получить список сохранённых закладок. Примечание: На Android этот метод использует систему доступа для хранения Android (SAF). Файлоискатель возвращает URI вместо файловой системы. Этот URI может быть передан непосредственно на FileAccess выполнять операции считывания и записи. При использовании DisplayServer.FileDialogMode.OpenDir, она возвращает дерево URI, которое предоставляет полный доступ к выбранному каталогу. Файл операции внутри этого каталога могут быть выполнены, проходя путь на бланке treeUri#relative/path/to/file в адрес FileAccess. Во избежание повторного открытия сборщика файлов после каждого перезапуска приложения вы можете получить устойчивое разрешение URI следующим образом:

Разрешение на сохранение URI остается действительным при перезапуске приложения, если каталог не перемещен, не переименован и не удален.

public static Error FileDialogShow(string title, string currentDirectory, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, ReadOnlySpan<string> filters, Callable callback, int parentWindowId);

Показать OS Диалог для выбора файлов или каталогов в файловой системе. Каждый фильтр в строчке filters Формат массива должен быть следующим: *.png,*.jpg,*.jpeg;Image Files;image/png,image/jpegТекст описания фильтра является факультативным и может быть опущен. Рекомендуется устанавливать как расширение файла, так и тип MIME. См. также FileDialog.Filters. У звонков есть следующие аргументы: status: bool, selected_paths: PackedStringArray, selected_filter_index: int. На Андроид, третий аргумент об обратном звонке (selected_filter_index) всегда 0. Примечание: Этот метод применяется, если сервер дисплея имеет DisplayServer.Feature.NativeDialogFile В число поддерживаемых платформ входят Linux (X11/Wayland), Windows, acOS и Android. Примечание: current_directory может быть проигнорировано. Примечание: Встроенные диалоги файлов и диалоги файлов Windows поддерживают только расширение файлов, в то время как диалоги файлов Android, Linux и acOS также поддерживают типы MIME. Примечание: На Андроид и Линукс, show_hidden игнорируется. Примечание: На Android и acOS диалоги местных файлов не имеют названия. Примечание: На макосе приложения с песчаными коробками сохранят закладки с защищенным кодом, чтобы сохранить доступ к открытым папкам в ходе нескольких сеансов. OS.GetGrantedPermissions чтобы получить список сохранённых закладок. Примечание: На Android этот метод использует систему доступа для хранения Android (SAF). Файлоискатель возвращает URI вместо файловой системы. Этот URI может быть передан непосредственно на FileAccess выполнять операции считывания и записи. При использовании DisplayServer.FileDialogMode.OpenDir, она возвращает дерево URI, которое предоставляет полный доступ к выбранному каталогу. Файл операции внутри этого каталога могут быть выполнены, проходя путь на бланке treeUri#relative/path/to/file в адрес FileAccess. Во избежание повторного открытия сборщика файлов после каждого перезапуска приложения вы можете получить устойчивое разрешение URI следующим образом:

Разрешение на сохранение URI остается действительным при перезапуске приложения, если каталог не перемещен, не переименован и не удален.

public static Error FileDialogShow(string title, string currentDirectory, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, string[] filters, Callable callback);

Показать OS Диалог для выбора файлов или каталогов в файловой системе. Каждый фильтр в строчке filters Формат массива должен быть следующим: *.png,*.jpg,*.jpeg;Image Files;image/png,image/jpegТекст описания фильтра является факультативным и может быть опущен. Рекомендуется устанавливать как расширение файла, так и тип MIME. См. также FileDialog.Filters. У звонков есть следующие аргументы: status: bool, selected_paths: PackedStringArray, selected_filter_index: int. На Андроид, третий аргумент об обратном звонке (selected_filter_index) всегда 0. Примечание: Этот метод применяется, если сервер дисплея имеет DisplayServer.Feature.NativeDialogFile В число поддерживаемых платформ входят Linux (X11/Wayland), Windows, acOS и Android. Примечание: current_directory может быть проигнорировано. Примечание: Встроенные диалоги файлов и диалоги файлов Windows поддерживают только расширение файлов, в то время как диалоги файлов Android, Linux и acOS также поддерживают типы MIME. Примечание: На Андроид и Линукс, show_hidden игнорируется. Примечание: На Android и acOS диалоги местных файлов не имеют названия. Примечание: На макосе приложения с песчаными коробками сохранят закладки с защищенным кодом, чтобы сохранить доступ к открытым папкам в ходе нескольких сеансов. OS.GetGrantedPermissions чтобы получить список сохранённых закладок. Примечание: На Android этот метод использует систему доступа для хранения Android (SAF). Файлоискатель возвращает URI вместо файловой системы. Этот URI может быть передан непосредственно на FileAccess выполнять операции считывания и записи. При использовании DisplayServer.FileDialogMode.OpenDir, она возвращает дерево URI, которое предоставляет полный доступ к выбранному каталогу. Файл операции внутри этого каталога могут быть выполнены, проходя путь на бланке treeUri#relative/path/to/file в адрес FileAccess. Во избежание повторного открытия сборщика файлов после каждого перезапуска приложения вы можете получить устойчивое разрешение URI следующим образом:

Разрешение на сохранение URI остается действительным при перезапуске приложения, если каталог не перемещен, не переименован и не удален.

public static Error FileDialogShow(string title, string currentDirectory, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, string[] filters, Callable callback, int parentWindowId = 0);

Показать OS Диалог для выбора файлов или каталогов в файловой системе. Каждый фильтр в строчке filters Формат массива должен быть следующим: *.png,*.jpg,*.jpeg;Image Files;image/png,image/jpegТекст описания фильтра является факультативным и может быть опущен. Рекомендуется устанавливать как расширение файла, так и тип MIME. См. также FileDialog.Filters. У звонков есть следующие аргументы: status: bool, selected_paths: PackedStringArray, selected_filter_index: int. На Андроид, третий аргумент об обратном звонке (selected_filter_index) всегда 0. Примечание: Этот метод применяется, если сервер дисплея имеет DisplayServer.Feature.NativeDialogFile В число поддерживаемых платформ входят Linux (X11/Wayland), Windows, acOS и Android. Примечание: current_directory может быть проигнорировано. Примечание: Встроенные диалоги файлов и диалоги файлов Windows поддерживают только расширение файлов, в то время как диалоги файлов Android, Linux и acOS также поддерживают типы MIME. Примечание: На Андроид и Линукс, show_hidden игнорируется. Примечание: На Android и acOS диалоги местных файлов не имеют названия. Примечание: На макосе приложения с песчаными коробками сохранят закладки с защищенным кодом, чтобы сохранить доступ к открытым папкам в ходе нескольких сеансов. OS.GetGrantedPermissions чтобы получить список сохранённых закладок. Примечание: На Android этот метод использует систему доступа для хранения Android (SAF). Файлоискатель возвращает URI вместо файловой системы. Этот URI может быть передан непосредственно на FileAccess выполнять операции считывания и записи. При использовании DisplayServer.FileDialogMode.OpenDir, она возвращает дерево URI, которое предоставляет полный доступ к выбранному каталогу. Файл операции внутри этого каталога могут быть выполнены, проходя путь на бланке treeUri#relative/path/to/file в адрес FileAccess. Во избежание повторного открытия сборщика файлов после каждого перезапуска приложения вы можете получить устойчивое разрешение URI следующим образом:

Разрешение на сохранение URI остается действительным при перезапуске приложения, если каталог не перемещен, не переименован и не удален.

public static Error FileDialogWithOptionsShow(string title, string currentDirectory, string root, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, ReadOnlySpan<string> filters, Reckfell.Collections.Array<Reckfell.Collections.Dictionary> options, Callable callback);

Показать OS Диалог для выбора файлов или каталогов в файловой системе с дополнительными выбранными пользователями опциями. Каждый фильтр в строчке filters Формат массива должен быть следующим: *.png,*.jpg,*.jpeg;Image Files;image/png,image/jpegТекст описания фильтра является факультативным и может быть опущен. Рекомендуется устанавливать как расширение файла, так и тип MIME. См. также FileDialog.Filters. options - массив из Reckfell.Collections.Dictionarys со следующими ключами:

• "name" - название опциона string.
• "values" - string[] Если используется пустой, то используется булевый опцион (проверочный ящик).
• "default" - индекс выбранных вариантов по умолчанию ([int]) или по умолчанию булевое значение ([bool]). У звонков есть следующие аргументы: status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary. Примечание: Этот метод применяется, если сервер дисплея имеет DisplayServer.Feature.NativeDialogFileExtra Поддержка платформ включает Linux (X11/Wayland), Windows и MacOS. Примечание: current_directory может быть проигнорировано. Примечание: Встроенные диалоги файлов и диалоги файлов Windows поддерживают только расширение файлов, в то время как диалоги файлов Android, Linux и acOS также поддерживают типы MIME. Примечание: На Linux (X11), show_hidden игнорируется. Примечание: На сайте MacOS диалоги местных файлов не имеют названия. Примечание: На макосе приложения с песчаными коробками сохранят закладки с защищенным кодом, чтобы сохранить доступ к открытым папкам в ходе нескольких сеансов. OS.GetGrantedPermissions чтобы получить список сохранённых закладок.

public static Error FileDialogWithOptionsShow(string title, string currentDirectory, string root, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, ReadOnlySpan<string> filters, Reckfell.Collections.Array<Reckfell.Collections.Dictionary> options, Callable callback, int parentWindowId);

Показать OS Диалог для выбора файлов или каталогов в файловой системе с дополнительными выбранными пользователями опциями. Каждый фильтр в строчке filters Формат массива должен быть следующим: *.png,*.jpg,*.jpeg;Image Files;image/png,image/jpegТекст описания фильтра является факультативным и может быть опущен. Рекомендуется устанавливать как расширение файла, так и тип MIME. См. также FileDialog.Filters. options - массив из Reckfell.Collections.Dictionarys со следующими ключами:

• "name" - название опциона string.
• "values" - string[] Если используется пустой, то используется булевый опцион (проверочный ящик).
• "default" - индекс выбранных вариантов по умолчанию ([int]) или по умолчанию булевое значение ([bool]). У звонков есть следующие аргументы: status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary. Примечание: Этот метод применяется, если сервер дисплея имеет DisplayServer.Feature.NativeDialogFileExtra Поддержка платформ включает Linux (X11/Wayland), Windows и MacOS. Примечание: current_directory может быть проигнорировано. Примечание: Встроенные диалоги файлов и диалоги файлов Windows поддерживают только расширение файлов, в то время как диалоги файлов Android, Linux и acOS также поддерживают типы MIME. Примечание: На Linux (X11), show_hidden игнорируется. Примечание: На сайте MacOS диалоги местных файлов не имеют названия. Примечание: На макосе приложения с песчаными коробками сохранят закладки с защищенным кодом, чтобы сохранить доступ к открытым папкам в ходе нескольких сеансов. OS.GetGrantedPermissions чтобы получить список сохранённых закладок.

public static Error FileDialogWithOptionsShow(string title, string currentDirectory, string root, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, string[] filters, Reckfell.Collections.Array<Reckfell.Collections.Dictionary> options, Callable callback);

Показать OS Диалог для выбора файлов или каталогов в файловой системе с дополнительными выбранными пользователями опциями. Каждый фильтр в строчке filters Формат массива должен быть следующим: *.png,*.jpg,*.jpeg;Image Files;image/png,image/jpegТекст описания фильтра является факультативным и может быть опущен. Рекомендуется устанавливать как расширение файла, так и тип MIME. См. также FileDialog.Filters. options - массив из Reckfell.Collections.Dictionarys со следующими ключами:

• "name" - название опциона string.
• "values" - string[] Если используется пустой, то используется булевый опцион (проверочный ящик).
• "default" - индекс выбранных вариантов по умолчанию ([int]) или по умолчанию булевое значение ([bool]). У звонков есть следующие аргументы: status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary. Примечание: Этот метод применяется, если сервер дисплея имеет DisplayServer.Feature.NativeDialogFileExtra Поддержка платформ включает Linux (X11/Wayland), Windows и MacOS. Примечание: current_directory может быть проигнорировано. Примечание: Встроенные диалоги файлов и диалоги файлов Windows поддерживают только расширение файлов, в то время как диалоги файлов Android, Linux и acOS также поддерживают типы MIME. Примечание: На Linux (X11), show_hidden игнорируется. Примечание: На сайте MacOS диалоги местных файлов не имеют названия. Примечание: На макосе приложения с песчаными коробками сохранят закладки с защищенным кодом, чтобы сохранить доступ к открытым папкам в ходе нескольких сеансов. OS.GetGrantedPermissions чтобы получить список сохранённых закладок.

public static Error FileDialogWithOptionsShow(string title, string currentDirectory, string root, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, string[] filters, Reckfell.Collections.Array<Reckfell.Collections.Dictionary> options, Callable callback, int parentWindowId = 0);

Показать OS Диалог для выбора файлов или каталогов в файловой системе с дополнительными выбранными пользователями опциями. Каждый фильтр в строчке filters Формат массива должен быть следующим: *.png,*.jpg,*.jpeg;Image Files;image/png,image/jpegТекст описания фильтра является факультативным и может быть опущен. Рекомендуется устанавливать как расширение файла, так и тип MIME. См. также FileDialog.Filters. options - массив из Reckfell.Collections.Dictionarys со следующими ключами:

• "name" - название опциона string.
• "values" - string[] Если используется пустой, то используется булевый опцион (проверочный ящик).
• "default" - индекс выбранных вариантов по умолчанию ([int]) или по умолчанию булевое значение ([bool]). У звонков есть следующие аргументы: status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary. Примечание: Этот метод применяется, если сервер дисплея имеет DisplayServer.Feature.NativeDialogFileExtra Поддержка платформ включает Linux (X11/Wayland), Windows и MacOS. Примечание: current_directory может быть проигнорировано. Примечание: Встроенные диалоги файлов и диалоги файлов Windows поддерживают только расширение файлов, в то время как диалоги файлов Android, Linux и acOS также поддерживают типы MIME. Примечание: На Linux (X11), show_hidden игнорируется. Примечание: На сайте MacOS диалоги местных файлов не имеют названия. Примечание: На макосе приложения с песчаными коробками сохранят закладки с защищенным кодом, чтобы сохранить доступ к открытым папкам в ходе нескольких сеансов. OS.GetGrantedPermissions чтобы получить список сохранённых закладок.

public static void ForceProcessAndDropEvents();

Запускает обработку оконного менеджера, игнорируя все InputEvent. См. также DisplayServer.ProcessEvents. Примечание: Этот метод реализован в Windows и macOS.

public static Color GetAccentColor();

Returns (Возврат) OS Цвет тематического акцента. Color(0, 0, 0, 0)Если цвет акцента неизвестен. Примечание: Этот метод применяется на acOS, Windows, Android и Linux (X11/Wayland).

public static Color GetBaseColor();

Возвращает OS Цвет основной темы (средний фон контроля по умолчанию). Возвращение Color(0, 0, 0, 0) если цвет основания неизвестен. Примечание: Этот метод применяется на MacOS, Windows и Android.

public static Reckfell.Collections.Array<Rect2> GetDisplayCutouts();

Возвращает Reckfell.Collections.Array Количество Rect2, каждый из которых является ограничивающим прямоугольником для вырезки или вырезки. Это нефункциональные зоны на экранах от края до края, используемых камерами и датчиками. Возвращает пустой массив, если устройство не имеет вырезок. См. также DisplayServer.GetDisplaySafeArea. Примечание: Возвращенные прямоугольники относятся к физическому экрану, а не к виртуальному рабочему столу. Примечание: Одна из следующих констант может использоваться в качестве screen: DisplayServer.ScreenOfMainWindow, DisplayServer.ScreenPrimary, DisplayServer.ScreenWithMouseFocusили DisplayServer.ScreenWithKeyboardFocus. Примечание: Другие платформы вернут пустой массив, даже если у них есть вырезы или ноты.

public static Reckfell.Collections.Array<Rect2> GetDisplayCutouts(int screen = -1);

Возвращает Reckfell.Collections.Array Количество Rect2, каждый из которых является ограничивающим прямоугольником для вырезки или вырезки. Это нефункциональные зоны на экранах от края до края, используемых камерами и датчиками. Возвращает пустой массив, если устройство не имеет вырезок. См. также DisplayServer.GetDisplaySafeArea. Примечание: Возвращенные прямоугольники относятся к физическому экрану, а не к виртуальному рабочему столу. Примечание: Одна из следующих констант может использоваться в качестве screen: DisplayServer.ScreenOfMainWindow, DisplayServer.ScreenPrimary, DisplayServer.ScreenWithMouseFocusили DisplayServer.ScreenWithKeyboardFocus. Примечание: Другие платформы вернут пустой массив, даже если у них есть вырезы или ноты.

public static Rect2I GetDisplaySafeArea();

Возвращает незащищённую зону дисплея, где должны быть установлены интерактивные механизмы управления. См. также DisplayServer.GetDisplayCutouts. Примечание: Возвращенный прямоугольник относительно физического экрана, а не виртуального рабочего стола. Примечание: Одна из следующих констант может использоваться в качестве screen: DisplayServer.ScreenOfMainWindow, DisplayServer.ScreenPrimary, DisplayServer.ScreenWithMouseFocusили DisplayServer.ScreenWithKeyboardFocus. Примечание: В настоящее время применяется только на Android, iOS и макос. screen_get_usable_rect(SCREEN_OF_MAIN_WINDOW) вернётся как запасной вариант. DisplayServer.ScreenGetUsableRect.

public static Rect2I GetDisplaySafeArea(int screen = -1);

Возвращает незащищённую зону дисплея, где должны быть установлены интерактивные механизмы управления. См. также DisplayServer.GetDisplayCutouts. Примечание: Возвращенный прямоугольник относительно физического экрана, а не виртуального рабочего стола. Примечание: Одна из следующих констант может использоваться в качестве screen: DisplayServer.ScreenOfMainWindow, DisplayServer.ScreenPrimary, DisplayServer.ScreenWithMouseFocusили DisplayServer.ScreenWithKeyboardFocus. Примечание: В настоящее время применяется только на Android, iOS и макос. screen_get_usable_rect(SCREEN_OF_MAIN_WINDOW) вернётся как запасной вариант. DisplayServer.ScreenGetUsableRect.

public static int GetKeyboardFocusScreen();

Возвращает индекс экрана, содержащего окно с фокусом клавиатуры, или основного экрана, если нет окна с фокусом. Примечание: Этот метод реализован в Linux/X11, macOS и Windows. На других платформах этот метод всегда возвращает основной экран.

public static string GetName();

Возвращает имя DisplayServer, который в данный момент используется. Большинство операционных систем имеют только один DisplayServer, но Linux имеет доступ к нескольким DisplayServer (в настоящее время X11 и Wayland). Имена встроенных серверов отображения: Windows, macOS, X11 (Линюкс), Wayland (Линюкс), Android, iOS, web (HTML5) и headless (при запуске с --headless аргументом командной строки).

public static int GetPrimaryScreen();

Возвращает индекс основного экрана. Примечание: Этот метод реализован в Linux/X11, macOS и Windows. На других платформах этот метод всегда возвращает 0.

public static int GetScreenCount();

Возвращает количество доступных дисплеев. Примечание: Этот метод реализован в Linux (X11 и Wayland), macOS и Windows. На других платформах этот метод всегда возвращает 1.

public static int GetScreenFromRect(Rect2 rect);

Возвращает индекс экрана, который больше всего перекрывается с указанным прямоугольником. Возвращает DisplayServer.InvalidScreen, если прямоугольник не перекрывается ни с одним экраном или не имеет области.

public static bool GetSwapCancelOk();

Возвращает true, если позиции кнопок OK и Cancel поменяны местами в диалогах. Это включено по умолчанию в Windows для соблюдения соглашений интерфейса и может быть переключено путем изменения ProjectSettings.gui/common/swap_cancel_ok. Примечание: Это не влияет на собственные диалоги, такие как те, которые порождаются DisplayServer.DialogShow.

public static int GetWindowAtScreenPosition(Vector2I position);

Возвращает идентификатор окна на указанном экране position (в пикселях). В многомониторных установках положение экрана относительно области виртуального рабочего стола. В многомониторных установках с различными разрешениями экрана или ориентациями начало координат может располагаться за пределами любого дисплея, например:

* (0, 0)        ┌───────┐
                │       │
┌─────────────┐ │       │
│             │ │       │
│             │ │       │
└─────────────┘ └───────┘

public static int[] GetWindowList();

Возвращает список идентификаторов окон Reckfell, принадлежащих этому процессу. Примечание: Собственные диалоги не включены в этот список.

public static int GlobalMenuAddCheckItem(string menuRoot, string label, Callable callback = default, Callable keyCallback = default, Variant tag = default, Key accelerator = Key.None, int index = -1);

Добавляет новый отмечаемый элемент с текстом label в глобальное меню с идентификатором menu_root. Возвращает индекс вставленного элемента, он не обязательно будет таким же, как значение index. Дополнительно может быть определен accelerator, представляющий собой сочетание клавиш, которое можно нажать для вызова кнопки меню, даже если оно в данный момент не открыто. accelerator обычно представляет собой комбинацию KeyModifierMask и Key с использованием побитового ИЛИ, например KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). Примечание: Вызываемые объекты callback и key_callback должны принимать ровно один параметр Variant, параметр, переданный в вызываемые объекты, будет значением, переданным в tag. Примечание: Этот метод реализован только в macOS. Поддерживаемые идентификаторы системного меню:

"_main" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
"_apple" - Apple menu (macOS, custom items added before "Services").
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
"_help" - Help menu (macOS).

public static int GlobalMenuAddIconCheckItem(string menuRoot, Texture2D icon, string label, Callable callback = default, Callable keyCallback = default, Variant tag = default, Key accelerator = Key.None, int index = -1);

Добавляет новый отмечаемый элемент с текстом label и значком icon в глобальное меню с идентификатором menu_root. Возвращает индекс вставленного элемента, он не обязательно будет таким же, как значение index. Дополнительно может быть определен accelerator, представляющий собой сочетание клавиш, которое можно нажать для вызова кнопки меню, даже если оно в данный момент не открыто. accelerator обычно представляет собой комбинацию KeyModifierMask и Key с использованием побитового ИЛИ, например KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). Примечание: Вызываемые объекты callback и key_callback должны принимать ровно один параметр Variant, параметр, переданный в вызываемые объекты, будет значением, переданным в tag. Примечание: Этот метод реализован только в macOS. Поддерживаемые идентификаторы системного меню:

"_main" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
"_apple" - Apple menu (macOS, custom items added before "Services").
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
"_help" - Help menu (macOS).

public static int GlobalMenuAddIconItem(string menuRoot, Texture2D icon, string label, Callable callback = default, Callable keyCallback = default, Variant tag = default, Key accelerator = Key.None, int index = -1);

Добавляет новый элемент с текстом label и значком icon в глобальное меню с идентификатором menu_root. Возвращает индекс вставленного элемента, он не обязательно будет таким же, как значение index. Дополнительно может быть определен accelerator, представляющий собой сочетание клавиш, которое можно нажать для вызова кнопки меню, даже если оно в данный момент не открыто. accelerator обычно представляет собой комбинацию KeyModifierMask и Key с использованием побитового ИЛИ, например KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). Примечание: Вызываемые объекты callback и key_callback должны принимать ровно один параметр Variant, параметр, переданный в вызываемые объекты, будет значением, переданным в tag. Примечание: Этот метод реализован только в macOS. Поддерживаемые идентификаторы системного меню:

"_main" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
"_apple" - Apple menu (macOS, custom items added before "Services").
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
"_help" - Help menu (macOS).

public static int GlobalMenuAddIconRadioCheckItem(string menuRoot, Texture2D icon, string label, Callable callback = default, Callable keyCallback = default, Variant tag = default, Key accelerator = Key.None, int index = -1);

Добавляет новый элемент с возможностью радио-отметки с текстом label и значком icon в глобальное меню с идентификатором menu_root. Возвращает индекс вставленного элемента, он не обязательно будет таким же, как значение index. Дополнительно может быть определен accelerator, представляющий собой сочетание клавиш, которое можно нажать для вызова кнопки меню, даже если оно в данный момент не открыто. accelerator обычно представляет собой комбинацию KeyModifierMask и Key с использованием побитового ИЛИ, например KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). Примечание: Элементы, которые можно отмечать радиокнопками, просто отображают галочку, но не имеют встроенного поведения проверки и должны быть отмечены/сняты вручную. См. DisplayServer.GlobalMenuSetItemChecked для получения дополнительной информации о том, как им управлять. Примечание: Вызываемые объекты callback и key_callback должны принимать ровно один параметр Variant, параметр, переданный в вызываемые объекты, будет значением, переданным в tag. Примечание: Этот метод реализован только в macOS. Поддерживаемые идентификаторы системных меню:

"_main" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
"_apple" - Apple menu (macOS, custom items added before "Services").
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
"_help" - Help menu (macOS).

public static int GlobalMenuAddItem(string menuRoot, string label, Callable callback = default, Callable keyCallback = default, Variant tag = default, Key accelerator = Key.None, int index = -1);

Добавляет новый элемент с текстом label в глобальное меню с идентификатором menu_root. Возвращает индекс вставленного элемента, он не обязательно будет таким же, как значение index. Дополнительно может быть определен accelerator, представляющий собой сочетание клавиш, которое можно нажать для вызова кнопки меню, даже если оно в данный момент не открыто. accelerator обычно представляет собой комбинацию KeyModifierMask и Key с использованием побитового ИЛИ, например KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). Примечание: Вызываемые объекты callback и key_callback должны принимать ровно один параметр Variant, параметр, переданный в вызываемые объекты, будет значением, переданным в tag. Примечание: Этот метод реализован только в macOS. Поддерживаемые идентификаторы системного меню:

"_main" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
"_apple" - Apple menu (macOS, custom items added before "Services").
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
"_help" - Help menu (macOS).

public static int GlobalMenuAddMultistateItem(string menuRoot, string label, int maxStates, int defaultState, Callable callback = default, Callable keyCallback = default, Variant tag = default, Key accelerator = Key.None, int index = -1);

Добавляет новый элемент с текстом label в глобальное меню с идентификатором menu_root. В отличие от обычных двоичных элементов, элементы с несколькими состояниями могут иметь более двух состояний, как определено max_states. Каждое нажатие или активация элемента увеличит состояние на единицу. Значение по умолчанию определяется default_state. Возвращает индекс вставленного элемента, он не обязательно будет таким же, как значение index. Необязательно может быть определен accelerator, представляющий собой сочетание клавиш, которое можно нажать для вызова кнопки меню, даже если оно в данный момент не открыто. accelerator обычно представляет собой комбинацию KeyModifierMask и Key с использованием побитового ИЛИ, например KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). Примечание: По умолчанию нет указания на текущее состояние элемента, его следует изменить вручную. Примечание: Вызываемые объекты callback и key_callback должны принимать ровно один параметр Variant, параметр, переданный в вызываемые объекты, будет значением, переданным в tag. Примечание: Этот метод реализован только в macOS. Поддерживаемые идентификаторы системных меню:

"_main" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
"_apple" - Apple menu (macOS, custom items added before "Services").
"_window" - Window menu (macOS, custom items added after "Bring All to Front").
"_help" - Help menu (macOS).