API
Return to top
WindowUtil
编辑

工具 / WindowUtil

WindowUtil Class
​

窗口设置工具。

可设置窗口聚焦失焦时触发某种行为，获取分辨率等功能。

使用示例:创建一个名为WindowExample的脚本，放置在对象栏中，打开脚本，将原本内容修改为如下内容，保存并运行游戏，会在控制台打印出屏幕的分辨率大小。
ts
@Component
export default class WindowExample extends Script {

    protected onStart(): void {
        this.test();
    }

    private async test(): `Promise`<`void`\> {
        if (!SystemUtil.isClient()) return;
        let viewportSize = WindowUtil.getViewportSize();
        // X=1920 Y=1080
        console.log(`viewportSize ${viewportSize}`);
    }
}
@Component
export default class WindowExample extends Script {

    protected onStart(): void {
        this.test();
    }

    private async test(): `Promise`<`void`\> {
        if (!SystemUtil.isClient()) return;
        let viewportSize = WindowUtil.getViewportSize();
        // X=1920 Y=1080
        console.log(`viewportSize ${viewportSize}`);
    }
}

Table of contents ​

Accessors
​

onDefocus(): MulticastDelegate<() => void>
用户游戏窗口失焦，显示器当前游戏窗口切出。调用onDefocused。返回一个多播委托类型。可使用多播委托中的Add、remove、clear、broadcast等函数，当出现窗口聚焦时编写你想要的逻辑。
onFocus(): MulticastDelegate<() => void>
用户游戏窗口聚焦，显示器显示当前游戏窗口。调用onFocused，返回一个多播委托类型。可使用多播委托中的Add、remove、clear、broadcast等函数，当出现窗口聚焦时编写你想要的逻辑。

Methods
​

getViewportSize(): Vector2 client
获取屏幕的分辨率大小（不跟随屏幕缩放变化）。

Accessors ​

onDefocus
​

• Static get onDefocus(): MulticastDelegate<() => void>

用户游戏窗口失焦，显示器当前游戏窗口切出。调用onDefocused。返回一个多播委托类型。可使用多播委托中的Add、remove、clear、broadcast等函数，当出现窗口聚焦时编写你想要的逻辑。

Returns ​

MulticastDelegate<() => void>

onFocus
​

• Static get onFocus(): MulticastDelegate<() => void>

用户游戏窗口聚焦，显示器显示当前游戏窗口。调用onFocused，返回一个多播委托类型。可使用多播委托中的Add、remove、clear、broadcast等函数，当出现窗口聚焦时编写你想要的逻辑。

Returns ​

使用示例:创建一个名为"NewScript"的脚本，放置在对象管理器对象子级中，打开脚本，输入以下代码保存，运行游戏，将屏幕切出会显示"游戏窗口失焦，屏幕切出"的log,将屏幕切回，将显示"游戏窗口聚焦，屏幕显现"的log。
ts
@Component
export default class NewScript extends Script {

     protected onStart(): void {
         WindowUtil.onDefocused.add(()=>{console.log("游戏窗口失焦，屏幕切出")});
         WindowUtil.onFocused.add(()=>{console.log("游戏窗口聚焦，屏幕显现")});
     }
 }
@Component
export default class NewScript extends Script {

     protected onStart(): void {
         WindowUtil.onDefocused.add(()=>{console.log("游戏窗口失焦，屏幕切出")});
         WindowUtil.onFocused.add(()=>{console.log("游戏窗口聚焦，屏幕显现")});
     }
 }
MulticastDelegate<() => void>

Methods ​

getViewportSize
​

• Static getViewportSize(): Vector2 client

获取屏幕的分辨率大小（不跟随屏幕缩放变化）。

Returns ​

Vector2返回屏幕的分辨率大小。

此方法仅在客户端调用生效。

使用示例:调用方法
ts
let viewportSize = WindowUtil.getViewportSize();
console.log(`viewportSize ${viewportSize}`);

// 打印输出为：X=1920 Y=1080
let viewportSize = WindowUtil.getViewportSize();
console.log(`viewportSize ${viewportSize}`);

// 打印输出为：X=1920 Y=1080