Window

多窗口模块用于在主窗口内部或者独立于主窗口创建多个可以自由移动和改变尺寸的窗口。可以将UI界面,相机,三维模型,网页等内容放在独立的窗口中。窗口模块的很多功能需要C++或者蓝图才能使用,API层面只暴露方便直接使用的版本。

6 个 APIpiclient.emit
window.close窗口-关闭
#

关闭指定窗口

输入

参数类型必填默认值说明
windowIdnumber0.0窗口id

输出

参数类型必填默认值说明
idnumber100窗口id,用于关闭操作

调用

typescript
piclient.emit("window.close",{
	windowId: 0.0,//窗口id
})
window.move窗口-移动位置
#

移动指定窗口的位置

输入

参数类型必填默认值说明
windowIdnumber0.0窗口id
positionstring0.0, 0.0, 0.0位置

输出

参数类型必填默认值说明
idnumber100窗口id,用于关闭操作

调用

typescript
piclient.emit("window.move",{
	windowId: 0.0,//窗口id
	position: "0.0, 0.0, 0.0",//位置
})
window.resize窗口-更改大小
#

修改指定窗口的大小

输入

参数类型必填默认值说明
windowIdnumber0.0窗口id
sizestring0.0, 0.0, 0.0尺寸

输出

参数类型必填默认值说明
idnumber100窗口id,用于关闭操作

调用

typescript
piclient.emit("window.resize",{
	windowId: 0.0,//窗口id
	size: "0.0, 0.0, 0.0",//尺寸
})
window.createByCamera窗口-创建相机窗口
#

创建新窗口,并显示指定摄像机的实时画面

输入

参数类型必填默认值说明
titlestring
standalonestringfalse是否独立窗口, false=在主窗口内显示,适合云渲染。true=独立于主窗口,适合多显示器
positionstring0.0, 0.0, 0.0位置
sizestring0.0, 0.0, 0.0尺寸
cameraObjectstringObjectId任意带有相机组件的对象
cameraIndexstring0第几个相机

输出

参数类型必填默认值说明
idnumber100窗口id,用于关闭操作

调用

typescript
piclient.emit("window.createByCamera",{
	title: "",
	standalone: "false", //是否独立窗口, false=在主窗口内显示,适合云渲染。true=独立于主窗口,适合多显示器
	position: "0.0, 0.0, 0.0",//位置
	size: "0.0, 0.0, 0.0",//尺寸
	cameraObject: "ObjectId", //任意带有相机组件的对象
	cameraIndex: "0", //第几个相机
})
window.createByWidget窗口-创建原生界面窗口
#

创建新窗口,并加载指定UMG原生页面

输入

参数类型必填默认值说明
titlestring窗口标题
standalonestringfalse是否独立窗口, false=在主窗口内显示,适合云渲染。true=独立于主窗口,适合多显示器
positionstring0.0, 0.0, 0.0位置
sizestring0.0, 0.0, 0.0尺寸
widgetstring/Game/UI/TestUI.TestUI_C从UE编辑器的内容浏览器复制UMG界面的引用地址,注意蓝图路径后面的_C后缀

输出

参数类型必填默认值说明
idnumber100窗口id,用于关闭操作

调用

typescript
piclient.emit("window.createByWidget",{
	title: "",//窗口标题
	standalone: "false", //是否独立窗口, false=在主窗口内显示,适合云渲染。true=独立于主窗口,适合多显示器
	position: "0.0, 0.0, 0.0",//位置
	size: "0.0, 0.0, 0.0",//尺寸
	widget: "/Game/UI/TestUI.TestUI_C", //从UE编辑器的内容浏览器复制UMG界面的引用地址,注意蓝图路径后面的_C后缀
})
window.createByWebPage窗口-创建网页窗口
#

创建新窗口,并加载指定网页页面

输入

参数类型必填默认值说明
titlestring窗口标题
standalonestringfalse是否独立窗口, false=在主窗口内显示,适合云渲染。true=独立于主窗口,适合多显示器
positionstring0.0, 0.0, 0.0位置
sizestring0.0, 0.0, 0.0尺寸
urlstringhttps://www.bing.com网页地址

输出

参数类型必填默认值说明
idnumber100窗口id,用于关闭操作

调用

typescript
piclient.emit("window.createByWebPage",{
	title: "",//窗口标题
	standalone: "false", //是否独立窗口, false=在主窗口内显示,适合云渲染。true=独立于主窗口,适合多显示器
	position: "0.0, 0.0, 0.0",//位置
	size: "0.0, 0.0, 0.0",//尺寸
	url: "https://www.bing.com",//网页地址
})