跳转到内容

系统 API

系统 API 通过 executePluginCommand('system', ...) 调用,提供窗口管理、截图和应用控制等能力。

executePluginCommand('system', {
subCommand: 'setWindowSize',
width: 1920,
height: 1080,
factor: 1.0, // 可选:缩放因子
});
参数类型说明
widthnumber窗口宽度(像素)
heightnumber窗口高度(像素)
factornumber可选,缩放因子(DPI 缩放)
executePluginCommand('system', {
subCommand: 'setWindowState',
state: 'fullscreen', // 'maximized' | 'minimized' | 'fullscreen' | 'normal'
});
const state = executePluginCommand('system', {
subCommand: 'getWindowState',
});
// 返回 'maximized' | 'minimized' | 'fullscreen' | 'normal'
executePluginCommand('system', {
subCommand: 'setTitle',
title: '末语 — 第一章',
});

getWindowInnerPosition — 获取窗口内部位置

Section titled “getWindowInnerPosition — 获取窗口内部位置”

返回窗口内容区域左上角相对于屏幕的坐标。

const pos = executePluginCommand('system', {
subCommand: 'getWindowInnerPosition',
});
// 返回 { x: number, y: number }

getWindowInnerSize — 获取窗口内部尺寸

Section titled “getWindowInnerSize — 获取窗口内部尺寸”

返回窗口内容区域的实际像素尺寸。

const size = executePluginCommand('system', {
subCommand: 'getWindowInnerSize',
});
// 返回 { width: number, height: number }

返回引擎渲染区域的逻辑尺寸(与 index.json 中的配置对应)。

const size = executePluginCommand('system', {
subCommand: 'getStageSize',
});
// 返回 { width: number, height: number }

截取当前渲染帧的画面。截图会存储在引擎内部,可用于存档等用途。

executePluginCommand('system', {
subCommand: 'takeSnapshot',
width: 640, // 可选:缩放宽度
height: 360, // 可选:缩放高度
keepAspectRatio: true, // 可选:保持宽高比
});
参数类型说明
widthnumber可选,截图宽度
heightnumber可选,截图高度
keepAspectRatioboolean可选,是否保持宽高比
executePluginCommand('system', {
subCommand: 'quit',
});