跳到主要内容

OS

继承

Object

简要描述

操作系统功能。

描述

操作系统功能。 操作系统包装了与主机操作系统进行通信的最常用功能,例如剪贴板,视频驱动程序,日期和时间,计时器,环境变量,二进制文件的执行,命令行等。

成员

类型属性名默认值
Stringclipboard""
intcurrent_screen0
intexit_code0
boolkeep_screen_ontrue
boollow_processor_usage_modefalse
intlow_processor_usage_mode_sleep_usec6900
Vector2max_window_sizeVector2( 0, 0 )
Vector2min_window_sizeVector2( 0, 0 )
intscreen_orientation0
boolvsync_enabledtrue
boolvsync_via_compositorfalse
boolwindow_borderlessfalse
boolwindow_fullscreenfalse
boolwindow_maximizedfalse
boolwindow_minimizedfalse
boolwindow_per_pixel_transparency_enabledfalse
Vector2window_positionVector2( 0, 0 )
boolwindow_resizabletrue
Vector2window_sizeVector2( 0, 0 )

方法

返回值类型方法名称
voidalert(text: String, title: String = "Alert!")
boolcan_draw() const
boolcan_use_threads() const
voidcenter_window()
voidclose_midi_inputs()
voiddelay_msec(msec: int) const
voiddelay_usec(usec: int) const
voiddump_memory_to_file(file: String)
voiddump_resources_to_file(file: String)
intexecute(path: String, arguments: PoolStringArray, blocking: bool = true, output: Array = [], read_stderr: bool = false)
intfind_scancode_from_string(string: String) const
intget_audio_driver_count() const
Stringget_audio_driver_name(driver: int) const
PoolStringArrayget_cmdline_args()
PoolStringArrayget_connected_midi_inputs()
intget_current_video_driver() const
Dictionaryget_date(utc: bool = false) const
Dictionaryget_datetime(utc: bool = false) const
Dictionaryget_datetime_from_unix_time(unix_time_val: int) const
intget_dynamic_memory_usage() const
Stringget_environment(environment: String) const
Stringget_executable_path() const
PoolStringArrayget_granted_permissions() const
Vector2get_ime_selection() const
Stringget_ime_text() const
Stringget_latin_keyboard_variant() const
Stringget_locale() const
Stringget_model_name() const
Stringget_name() const
intget_power_percent_left()
intget_power_seconds_left()
intget_power_state()
intget_process_id() const
intget_processor_count() const
Vector2get_real_window_size() const
Stringget_scancode_string(code: int) const
intget_screen_count() const
intget_screen_dpi(screen: int = -1) const
Vector2get_screen_position(screen: int = -1) const
Vector2get_screen_size(screen: int = -1) const
intget_splash_tick_msec() const
intget_static_memory_peak_usage() const
intget_static_memory_usage() const
Stringget_system_dir(dir: int) const
intget_system_time_msecs() const
intget_system_time_secs() const
intget_ticks_msec() const
intget_ticks_usec() const
Dictionaryget_time(utc: bool = false) const
Dictionaryget_time_zone_info() const
Stringget_unique_id() const
intget_unix_time() const
intget_unix_time_from_datetime(datetime: Dictionary) const
Stringget_user_data_dir() const
intget_video_driver_count() const
Stringget_video_driver_name(driver: int) const
intget_virtual_keyboard_height()
Rect2get_window_safe_area() const
voidglobal_menu_add_item(menu: String, label: String, id: Variant, meta: Variant)
voidglobal_menu_add_separator(menu: String)
voidglobal_menu_clear(menu: String)
voidglobal_menu_remove_item(menu: String, idx: int)
boolhas_environment(environment: String) const
boolhas_feature(tag_name: String) const
boolhas_touchscreen_ui_hint() const
boolhas_virtual_keyboard() const
voidhide_virtual_keyboard()
boolis_debug_build() const
boolis_ok_left_and_cancel_right() const
boolis_scancode_unicode(code: int) const
boolis_stdout_verbose() const
boolis_userfs_persistent() const
boolis_window_always_on_top() const
boolis_window_focused() const
intkill(pid: int)
voidmove_window_to_foreground()
boolnative_video_is_playing()
voidnative_video_pause()
intnative_video_play(path: String, volume: float, audio_track: String, subtitle_track: String)
voidnative_video_stop()
voidnative_video_unpause()
voidopen_midi_inputs()
voidprint_all_resources(tofile: String = "")
voidprint_all_textures_by_size()
voidprint_resources_by_type(types: PoolStringArray)
voidprint_resources_in_use(short: bool = false)
voidrequest_attention()
boolrequest_permission(name: String)
boolrequest_permissions()
voidset_icon(icon: Image)
voidset_ime_active(active: bool)
voidset_ime_position(position: Vector2)
voidset_native_icon(filename: String)
intset_thread_name(name: String)
voidset_use_file_access_save_and_swap(enabled: bool)
voidset_window_always_on_top(enabled: bool)
voidset_window_title(title: String)
intshell_open(uri: String)
voidshow_virtual_keyboard(existing_text: String = "")

枚举

enum VideoDriver:

  • **VIDEO_DRIVER_GLES2 = 1**

GLES2渲染后端。

  • **VIDEO_DRIVER_GLES3 = 0**

GLES3渲染后端。


enum Weekday:

  • **DAY_SUNDAY = 0**

星期日。

  • **DAY_MONDAY = 1**

星期一。

  • **DAY_TUESDAY = 2**

星期二。

  • **DAY_WEDNESDAY = 3**

星期三。

  • **DAY_THURSDAY = 4**

星期四。

  • **DAY_FRIDAY = 5**

星期五。

  • **DAY_SATURDAY = 6**

星期六。


enum Month:

  • **MONTH_JANUARY = 1**

一月。

  • **MONTH_FEBRUARY = 2**

二月。

  • **MONTH_MARCH = 3**

三月。

  • **MONTH_APRIL = 4**

四月。

  • **MONTH_MAY = 5**

五月。

  • **MONTH_JUNE = 6**

六月。

  • **MONTH_JULY = 7**

七月。

  • **MONTH_AUGUST = 8**

八月。

  • **MONTH_SEPTEMBER = 9**

九月。

  • **MONTH_OCTOBER = 10**

十月。

  • **MONTH_NOVEMBER = 11**

十一月。

  • **MONTH_DECEMBER = 12**

十二月。


enum ScreenOrientation:

  • **SCREEN_ORIENTATION_LANDSCAPE = 0**

横向屏幕方向。

  • **SCREEN_ORIENTATION_PORTRAIT = 1**

纵向屏幕方向。

  • **SCREEN_ORIENTATION_REVERSE_LANDSCAPE = 2**

反转横向屏幕方向。

  • **SCREEN_ORIENTATION_REVERSE_PORTRAIT = 3**

反转纵向屏幕方向。

  • **SCREEN_ORIENTATION_SENSOR_LANDSCAPE = 4**

根据硬件传感器使用横向或反向横向。

  • **SCREEN_ORIENTATION_SENSOR_PORTRAIT = 5**

根据硬件传感器使用纵向或反向纵向。

  • **SCREEN_ORIENTATION_SENSOR = 6**

根据硬件传感器使用最合适的方向。


enum SystemDir:

  • **SYSTEM_DIR_DESKTOP = 0**

桌面目录路径。

  • **SYSTEM_DIR_DCIM = 1**

DCIM(数码相机图像)目录路径。

  • **SYSTEM_DIR_DOCUMENTS = 2**

文档目录路径。

  • **SYSTEM_DIR_DOWNLOADS = 3**

下载目录路径。

  • **SYSTEM_DIR_MOVIES = 4**

电影目录路径。

  • **SYSTEM_DIR_MUSIC = 5**

音乐目录路径。

  • **SYSTEM_DIR_PICTURES = 6**

图片目录路径。

  • **SYSTEM_DIR_RINGTONES = 7**

铃声目录路径。


enum PowerState:

  • **POWERSTATE_UNKNOWN = 0**

未知电源状态。

  • **POWERSTATE_ON_BATTERY = 1**

拔下电源,用电池供电。

  • **POWERSTATE_NO_BATTERY = 2**

插入电源,没有可用电池。

  • **POWERSTATE_CHARGING = 3**

插入电源,为电池充电。

  • **POWERSTATE_CHARGED = 4**

插入电源,电池充满电。


常量

成员说明

  • String clipboard
Default""
setterset_clipboard(value)
getterget_clipboard
  • int current_screen
Default0
setterset_current_screen(value)
getterget_current_screen
  • int exit_code
Default0
setterset_exit_code(value)
getterget_exit_code
  • bool keep_screen_on
Defaulttrue
setterset_keep_screen_on(value)
getteris_keep_screen_on
  • bool low_processor_usage_mode
Defaultfalse
setterset_low_processor_usage_mode(value)
getteris_in_low_processor_usage_mode
  • int low_processor_usage_mode_sleep_usec
Default6900
setterset_low_processor_usage_mode_sleep_usec(value)
getterget_low_processor_usage_mode_sleep_usec
  • Vector2 max_window_size
DefaultVector2( 0, 0 )
setterset_max_window_size(value)
getterget_max_window_size
  • Vector2 min_window_size
DefaultVector2( 0, 0 )
setterset_min_window_size(value)
getterget_min_window_size
  • int screen_orientation
Default0
setterset_screen_orientation(value)
getterget_screen_orientation
  • bool vsync_enabled
Defaulttrue
setterset_use_vsync(value)
getteris_vsync_enabled
  • bool vsync_via_compositor
Defaultfalse
setterset_vsync_via_compositor(value)
getteris_vsync_via_compositor_enabled
  • bool window_borderless
Defaultfalse
setterset_borderless_window(value)
getterget_borderless_window
  • bool window_fullscreen
Defaultfalse
setterset_window_fullscreen(value)
getteris_window_fullscreen
  • bool window_maximized
Defaultfalse
setterset_window_maximized(value)
getteris_window_maximized
  • bool window_minimized
Defaultfalse
setterset_window_minimized(value)
getteris_window_minimized
  • bool window_per_pixel_transparency_enabled
Defaultfalse
setterset_window_per_pixel_transparency_enabled(value)
getterget_window_per_pixel_transparency_enabled
  • Vector2 window_position
DefaultVector2( 0, 0 )
setterset_window_position(value)
getterget_window_position
  • bool window_resizable
Defaulttrue
setterset_window_resizable(value)
getteris_window_resizable
  • Vector2 window_size
DefaultVector2( 0, 0 )
setterset_window_size(value)
getterget_window_size

方法说明

  • alert alert(text: String, title: String = "Alert!")

使用主机操作系统的工具显示模式对话框。


  • can_draw can_draw() const

如果主机操作系统允许绘制,则返回true


  • can_use_threads can_use_threads() const

如果当前主机平台正在使用多个线程,则返回true


  • center_window center_window()

如果处于窗口模式,则使窗口在屏幕上居中。


  • close_midi_inputs close_midi_inputs()

关闭系统MIDI驱动程序。

注意:此方法在Linux,macOS和Windows上实现。


  • delay_msec delay_msec(msec: int) const

将当前线程的执行延迟msec毫秒。


  • delay_usec delay_usec(usec: int) const

将当前线程的执行延迟usec微秒。


  • dump_memory_to_file dump_memory_to_file(file: String)

将内存分配列表转储到文件中(仅在调试中有效)。

每行的输入格式:“地址-大小-说明”。


  • dump_resources_to_file dump_resources_to_file(file: String)

将所有使用的资源转储到文件中(仅在调试中有效)。

每行的输入格式:“资源类型:资源位置”。

文件末尾是所有使用的资源类型的统计信息。


  • execute execute(path: String, arguments: PoolStringArray, blocking: bool = true, output: Array = [], read_stderr: bool = false)

使用作为字符串数组传递的参数在给定的路径上执行文件。

参数以给定的顺序使用,并以空格分隔,因此OS.execute(“ ping”,[-w”,“],false)将 解析到系统shell中的 ping -w 3 godotengine.org

根据是否启用blocking模式,此方法的行为略有不同。

如果blockingtrue,则IdeaXR线程将在等待进程终止时暂停其执行。

如果blockingfalse,IdeaXR线程将在新进程运行时继续。

返回值还取决于阻塞模式。

阻塞模式和检索shell输出的示例:

var output = []
var exit_code = OS.execute("ls", ["/tmp"], true, output)

非阻塞模式的示例,它运行项目的另一个实例并存储其进程ID:

var pid = OS.execute(OS.get_executable_path(), [], false)

如果您希望访问内置的Shell或执行复合命令,则可以调用特定于平台的Shell。 例如:

OS.execute("CMD.exe", ["cd], true, output)

注意:此方法在Android,iOS,Linux,macOS和Windows上实现。


  • find_scancode_from_string find_scancode_from_string(string: String) const

返回给定字符串的扫描代码(例如“转义”)。


  • get_audio_driver_count get_audio_driver_count() const

返回可用的音频驱动程序的总数。


  • get_audio_driver_name get_audio_driver_name(driver: int) const

返回给定索引的音频驱动程序名称。


  • get_cmdline_args get_cmdline_args()

返回传递给引擎的命令行参数。


  • get_connected_midi_inputs get_connected_midi_inputs()

返回MIDI设备名称的数组。

如果先前未使用open_midi_inputs初始化系统MIDI驱动程序,则返回的数组将为空。

注意:此方法在Linux,macOS和Windows上实现。


  • get_current_video_driver get_current_video_driver() const

使用VideoDriver中的一个值,返回当前使用的视频驱动程序。


  • get_date get_date(utc: bool = false) const

以键字典的形式返回当前日期:year, month, day, weekday, dst(夏令时)。


  • get_datetime get_datetime(utc: bool = false) const

返回以当前日期时间作为键的字典:year, month, day, weekday, dst(夏令时)。


  • get_datetime_from_unix_time get_datetime_from_unix_time(unix_time_val: int) const

获取与给定的UNIX纪元时间(以秒为单位)相对应的时间值字典。

返回的字典值将与get_datetime相同,但“夏令时”除外,因为无法从纪元确定该时间。


  • get_dynamic_memory_usage get_dynamic_memory_usage() const

返回使用的动态内存总量(仅在调试中有效)。


  • get_environment get_environment(environment: String) const

返回一个环境变量。


  • get_executable_path get_executable_path() const

返回当前引擎可执行文件的路径。


  • get_granted_permissions get_granted_permissions() const

使用此功能,您可以获取已授予Android应用程序的危险权限的列表。

注意:此方法在Android上实现。


  • get_ime_selection get_ime_selection() const

返回相对于合成字符串中的字符的IME光标位置(字符串的当前编辑部分)。

MainLoop.NOTIFICATION_OS_IME_UPDATE会发送到应用程序,以通知它有关IME光标位置的更改。

注意:此方法在macOS上实现。


  • get_ime_text get_ime_text() const

返回IME中间组成字符串。

MainLoop.NOTIFICATION_OS_IME_UPDATE会发送到应用程序,以通知它有关IME组成字符串的更改。

注意:此方法在macOS上实现。


  • get_latin_keyboard_variant get_latin_keyboard_variant() const

以字符串形式返回当前的拉丁键盘变体。

可能的返回值包括:"QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO", "COLEMAK""ERROR".

注意:此方法在Linux,macOS和Windows上实现。


  • get_locale get_locale() const

返回主机操作系统的语言环境。


  • get_model_name get_model_name() const

返回当前设备的型号名称。

注意:此方法在Android和iOS上实现。


  • get_name get_name() const

返回主机操作系统的名称。


  • get_power_percent_left get_power_percent_left()

以百分比形式返回设备中剩余的电池电量。

注意:此方法在Linux,macOS和Windows上实现。


  • get_power_seconds_left get_power_seconds_left()

返回设备用尽电池之前剩余时间的估计值(以秒为单位)。

注意:此方法在Linux,macOS和Windows上实现。


  • get_power_state get_power_state()

返回有关电池和电源的设备的当前状态。

注意:此方法在Linux,macOS和Windows上实现。


  • get_process_id get_process_id() const

返回项目的进程ID。

注意:此方法在Android,iOS,Linux,macOS和Windows上实现。


  • get_processor_count get_processor_count() const

返回主机上可用的线程数。


  • get_real_window_size get_real_window_size() const

返回窗口大小,包括装饰,例如窗口边框。


  • get_scancode_string get_scancode_string(code: int) const

以字符串形式返回给定的扫描代码(例如,返回值:“ Escape” “ Shift Escape” )。

另请参见InputEventKey.scancodeInputEventKey.get_scancode_with_modifiers


  • get_screen_count get_screen_count() const

返回连接到主机的显示器数量。


  • get_screen_dpi get_screen_dpi(screen: int = -1) const

返回指定屏幕每英寸密度的点数。

在Android设备上,实际的屏幕密度分为六种通用密度:

   ldpi - 120 dpi
mdpi - 160 dpi
hdpi - 240 dpi
xhdpi - 320 dpi
xxhdpi - 480 dpi
xxxhdpi - 640 dpi

注意:此方法在Android,Linux,macOS和Windows上实现。


  • get_screen_position get_screen_position(screen: int = -1) const

通过索引返回指定屏幕的位置。


  • get_screen_size get_screen_size(screen: int = -1) const

返回指定屏幕的尺寸(以像素为单位)。


  • get_splash_tick_msec get_splash_tick_msec() const

返回显示启动徽标所花费的时间(以毫秒为单位)。


  • get_static_memory_peak_usage get_static_memory_peak_usage() const

返回使用的最大静态内存量(仅在调试中有效)。


  • get_static_memory_usage get_static_memory_usage() const

返回程序正在使用的静态内存量(以字节为单位)。


  • get_system_dir get_system_dir(dir: int) const

返回跨不同平台的常用文件夹的实际路径。

注意:此方法在Android,Linux,macOS和Windows上实现。


  • get_system_time_msecs get_system_time_msecs() const

返回操作系统的纪元时间(以毫秒为单位)。


  • get_system_time_secs get_system_time_secs() const

返回操作系统的纪元时间(以秒为单位)。


  • get_ticks_msec get_ticks_msec() const

返回自引擎启动以来经过的时间(以毫秒为单位)。


  • get_ticks_usec get_ticks_usec() const

返回自引擎启动以来经过的时间(以微秒为单位)。


  • get_time get_time(utc: bool = false) const

以字典的形式返回当前时间,其键为:hour, minute, second。


  • get_time_zone_info get_time_zone_info() const

以字典的形式返回当前时区,其键为:bias和name。


  • get_unique_id get_unique_id() const

返回设备唯一的字符串。

注意:在HTML5和UWP上返回一个空字符串,因为该方法尚未在那些平台上实现。


  • get_unix_time get_unix_time() const

返回当前的UNIX纪元时间戳。


  • get_unix_time_from_datetime get_unix_time_from_datetime(datetime: Dictionary) const

从时间值字典中获取一个纪元时间值。

datetime必须使用以下键填充:year, month, day, hour, minute, second.

您可以将get_datetime_from_unix_time的输出直接传递到此函数。


  • get_user_data_dir get_user_data_dir() const

返回写入用户数据的绝对目录路径(user://)。

在Linux上,这是~/.local/share/godot/app_userdata/[project_name], 如果设置了use_custom_user_dir,则~/.local/share/[custom_name]

在macOS上,这是〜/Library /Application Support /IdeaVR /app_userdata /[project_name] ,如果设置了use_custom_user_dir,则为〜/Library /Application Support /[custom_name]`

在Windows上,这是%APPDATA%\ IdeaVR \ app_userdata \ [project_name] ,如果设置了use_custom_user_dir,则是%APPDATA%\ [custom_name]

如果项目名称为空,则user://会退回到res://


  • get_video_driver_count get_video_driver_count() const

返回当前平台支持的视频驱动程序数。


  • get_video_driver_name get_video_driver_name(driver: int) const

返回与给定driver索引匹配的视频驱动程序的名称。


  • get_virtual_keyboard_height get_virtual_keyboard_height()

返回屏幕键盘的高度(以像素为单位)。


  • get_window_safe_area get_window_safe_area() const

返回应呈现交互式控件的窗口的清晰区域。


  • global_menu_add_item global_menu_add_item(menu: String, label: String, id: Variant, meta: Variant)

将带有文本“标签”的新项目添加到全局菜单。

注意:此方法在macOS上实现。


  • global_menu_add_separator global_menu_add_separator(menu: String)

在项目之间添加分隔符。

注意:此方法在macOS上实现。


  • global_menu_clear global_menu_clear(menu: String)

清除全局菜单,实际上删除所有项目。

注意:此方法在macOS上实现。


  • global_menu_remove_item global_menu_remove_item(menu: String, idx: int)

从全局菜单中删除索引为“ idx”的项目。

注意:此方法在macOS上实现。


  • has_environment has_environment(environment: String) const

如果环境变量存在,则返回true


  • has_feature has_feature(tag_name: String) const

如果当前正在运行的实例中支持给定功能标签的功能,则返回true,具体取决于平台,内部版本等。

注意:标签名称区分大小写。


  • has_touchscreen_ui_hint has_touchscreen_ui_hint() const

如果设备具有触摸屏或模拟触摸屏,则返回true


  • has_virtual_keyboard has_virtual_keyboard() const

如果平台具有虚拟键盘,则返回true,否则返回false


  • hide_virtual_keyboard hide_virtual_keyboard()

隐藏虚拟键盘(如果显示),否则不执行任何操作。


  • is_debug_build is_debug_build() const

如果用于运行项目的IdeaXR二进制文件是debug导出模板,或者在编辑器中运行,则返回true

如果用于运行项目的IdeaXR二进制文件是 release 导出模板,则返回false

要检查用于运行项目的IdeaXR二进制文件是否是导出模板(调试或发行版),请改用 OS.has_feature(“ standalone”)


  • is_ok_left_and_cancel_right is_ok_left_and_cancel_right() const

如果 OK 按钮出现在左侧,Cancel出现在右侧,则返回true


  • is_scancode_unicode is_scancode_unicode(code: int) const

如果输入的扫描码对应于Unicode字符,则返回true


  • is_stdout_verbose is_stdout_verbose() const

如果使用-v(verbose stdout)执行引擎,则返回true


  • is_userfs_persistent is_userfs_persistent() const

如果true,则 user://文件系统是持久性的,因此在玩家退出并重新开始游戏后,其状态是相同的。


  • is_window_always_on_top is_window_always_on_top() const

如果该窗口应始终位于其他窗口的顶部,则返回true


  • is_window_focused is_window_focused() const

如果窗口当前处于焦点状态,则返回true

注意:仅在桌面平台上实现。


  • kill kill(pid: int)

杀死(终止)由给定进程ID(pid)标识的进程。

注意:此方法也可以用于杀死游戏未产生的进程。

注意:此方法在Android,iOS,Linux,macOS和Windows上实现。


  • move_window_to_foreground move_window_to_foreground()

将窗口移到最前面。

注意:此方法在Linux,macOS和Windows上实现。


  • native_video_is_playing native_video_is_playing()

如果正在播放本地视频,则返回true

注意:此方法在Android和iOS上实现。


  • native_video_pause native_video_pause()

暂停本地视频播放。

注意:此方法在Android和iOS上实现。


  • native_video_play native_video_play(path: String, volume: float, audio_track: String, subtitle_track: String)

从指定路径以给定的音量,音频和字幕轨道播放本地视频。

注意:此方法在Android和iOS上实现,当前的Android实现不支持volume, audio_tracksubtitle_track选项。


  • native_video_stop native_video_stop()

停止本地视频播放。

注意:此方法在Android和iOS上实现。


  • native_video_unpause native_video_unpause()

恢复本地视频播放。

注意:此方法在Android和iOS上实现。


  • open_midi_inputs open_midi_inputs()

初始化系统MIDI驱动程序的单例。

注意:此方法在Linux,macOS和Windows上实现。


  • print_all_resources print_all_resources(tofile: String = "")

显示游戏中的所有资源。


  • print_all_textures_by_size print_all_textures_by_size()

显示按内存大小排序的已加载纹理的列表。


  • print_resources_by_type print_resources_by_type(types: PoolStringArray)

显示给定类型的游戏加载的资源数量。


  • print_resources_in_use print_resources_in_use(short: bool = false)

显示游戏当前使用的所有资源。


  • request_attention request_attention()

要求用户注意该窗口。

注意:此方法在Linux,macOS和Windows上实现。


  • request_permission request_permission(name: String)

目前,此功能仅由AudioDriverOpenSL用于在Android上请求RECORD_AUDIO的权限。


  • request_permissions request_permissions()

使用此功能,您可以请求危险权限,因为在安装时会在Android应用程序中自动授予正常权限。

注意:此方法在Android上实现。


  • set_icon set_icon(icon: Image)

使用Image资源设置游戏的图标。

同一图像用于窗口标题,任务栏/停靠区和窗口选择对话框。

注意:此方法在HTML5,Linux,macOS和Windows上实现。


  • set_ime_active set_ime_active(active: bool)

设置是否应启用IME输入模式。

如果处于活动状态,则IME将在应用程序之前处理关键事件,并创建一个组成字符串和建议列表。

应用程序可以使用get_ime_selectionget_ime_text函数检索合成状态。

输入完成后,将提交完成的合成字符串。

注意:此方法在Linux,macOS和Windows上实现。


  • set_ime_position set_ime_position(position: Vector2)

设置IME建议列表弹出窗口的位置(在窗口坐标中)。

注意:此方法在Linux,macOS和Windows上实现。


  • set_native_icon set_native_icon(filename: String)

使用特定于平台的多尺寸图标文件(在Windows上为*.ico,在macOS上为*.icns)设置游戏的图标。

适当的大小子图标用于窗口标题,任务栏/停靠栏和窗口选择对话框。

注意:此方法在macOS和Windows上实现。


  • set_thread_name set_thread_name(name: String)

设置当前线程的名称。


  • set_use_file_access_save_and_swap set_use_file_access_save_and_swap(enabled: bool)

如果enabledtrue,则启用备份保存。


  • set_window_always_on_top set_window_always_on_top(enabled: bool)

设置窗口是否应始终位于顶部。

注意:此方法在Linux,macOS和Windows上实现。


  • set_window_title set_window_title(title: String)

将窗口标题设置为指定的字符串。

注意:应该偶尔使用。

注意:此方法在HTML5,Linux,macOS和Windows上实现。


  • shell_open shell_open(uri: String)

请求操作系统使用最合适的程序打开资源。例如:

-OS.shell_open("C:\\Users\name\Downloads")windows系统上,在用户的Downloads文件夹中打开文件资源管理器。

- OS.shell_open(“ https://ideavr.top”)在官方IdeaXR网站上打开默认的网络浏览器。

-OS.shell_open(“ mailto:example@example.com”)打开默认电子邮件客户端,并将“收件人”字段设置为 example@example.com

注意:此方法在Android,iOS,HTML5,Linux,macOS和Windows上实现。


  • show_virtual_keyboard show_virtual_keyboard(existing_text: String = "")

如果存在一个平台,则显示虚拟键盘。

注意:此方法在Android,iOS和UWP上实现。