文档-迷你世界创作者学院-迷你教程

自定义UI接口：Customui

彼得兔更新时间: 2024-11-07 15:12:42

具体函数名及描述如下:（除前两个，其余的目前只能在UI编辑器内部的脚本使用）

序号	函数名	函数描述
1	openUIView(...)	打开一个UI界面（注意：继承自player对象）
2	hideUIView(...)	隐藏一个UI界面（注意：继承自player对象）
1	setText(...)	设置文本元件内容（只在UI局部脚本有效）
2	setTexture(...)	设置文本元件图案纹理（只在UI局部脚本有效）
3	setSize(...)	设置元件大小（只在UI局部脚本有效）
4	setFontSize(...)	设置文本元件字体大小（只在UI局部脚本有效）
5	setColor(...)	设置文本元件颜色（只在UI局部脚本有效）
6	showElement(...)	显示元件（只在UI局部脚本有效）
7	hideElement(...)	隐藏元件（只在UI局部脚本有效）
8	rotateElement(...)	旋转元件（只在UI局部脚本有效）
9	setState(...)	切换页面状态（只在UI局部脚本有效）
10	setAlpha(...)	设置元件透明度（只在UI局部脚本有效）
11	setPosition(...)	设置元件位置（只在UI局部脚本有效）
12	getItemIcon(...)	获取道具类型图标iconID（只在UI局部脚本有效）
13	getMonsterObjIcon(...)	获取生物图标iconID（只在UI局部脚本有效）
14	getMonsterIcon(...)	获取生物类型图标iconID（只在UI局部脚本有效）
15	getStatusIcon(...)	获取状态类型图标iconID（只在UI局部脚本有效）
16	getBlockIcon(...)	获取方块类型图标iconID（只在UI局部脚本有效）
17	getRoleIcon(...)	获取角色类型图标iconID
18	getShuctIcon(...)	获取玩家快捷栏道具图标iconID
19	SmoothMoveTo(...)	元件平滑移动到指定位置
20	SmoothMoveBy(...)	元件平滑移动相对距离
21	SmoothScaleTo(...)	元件平滑改变到指定宽度和高度
22	SmoothScaleBy(...)	元件平滑改变相对宽度和高度
23	SmoothRotateTo(...)	元件平滑旋转到指定角度
24	SmoothRotateBy(...)	元件平滑旋转到相对角度
25	PlayElementAnim(...)	元件播放动画
26	StopAnim(...)	元件停止动画
27	SetLoaderModel(...)	设置装载器的模型
28	SetLoaderModelScale(...)	设置装载器的模型缩放
29	SetLoaderModelDir(...)	设置装载器的模型方向
30	SetLoaderModelAct(...)	设置装载器的模型动画
31	TurnSliderToPos(...)	滑动列表跳转到某位置
32	SetSliderDir(...)	设置滑动列表的滑动方式
33	SetSliderBarImg(...)	设置滑动条的图案
34	SetProgressBarValue(...)	设置玩家界面进度条的值
35	SetProgressBarResId(...)	设置玩家界面进度条的纹理
36	SmoothIncreaseProgress(...)	进度条文本平滑计时

如何查看界面、元件和图片id？

方法一：

方法二：

1.利用触发器触发需要获得id的对象：

2.在运行日志里可以看到相关id：

特别注意：界面id、元件id均为字符串，使用时需要添加引号；图片id使用字符串或数字均可。

openUIView

参数及类型：
- objid:number玩家ID
- uiname:string自定义界面的UIID
返回值及类型：
- ErrorCode.OK
该方法的主要作用：打开一个UI界面
具体使用案例如下：

--有玩家进入游戏时，执行此函数
local function player_enter(event)
    local uin=event.eventobjid--进入游戏的玩家迷你号
    local uiid="6986982063319417057"--要打开的界面id
    Player:openUIView(uin,uiid)--给玩家打开界面
end
ScriptSupportEvent:registerEvent([=[Game.AnyPlayer.EnterGame]=],player_enter)

hideUIView

参数及类型：
- objid:number玩家ID
- uiname:string自定义界面的UIID
返回值及类型：
- ErrorCode.OK
该方法的主要作用：隐藏一个UI界面
具体使用案例如下：

--玩家点击方块时，执行此函数
local function clickblock(event)
    local uin=event.eventobjid--点击方块的玩家迷你号
    local uiid="6986982063319417057"--要隐藏的界面id
    Player:hideUIView(uin,uiid)--给玩家隐藏界面
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=],clickblock)

setText

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- text:string文本内容
- animid:number动画ID(缺省参数)
- time:number动画时长(缺省参数)
- mode:number播放模式(缺省参数)
返回值及类型：
- ErrorCode.OK
该方法的主要作用：设置文本元件内容
具体使用案例如下：

--玩家点击方块时，执行此函数
local function clickblock(event)
    local playerid=event.eventobjid--点击方块的玩家迷你号
    local uiid="6986982063319417057"--界面id
    local elementid="6986982063319417057_1"--文本元件id
    local text="你好呀"--要设置的文本内容
    --设置玩家的文本元件的显示内容
    Customui:setText(playerid, uiid, elementid, text)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], clickblock)

setTexture

参数及类型：
- playerid:number玩家ID
- uiid:string自定义界面的UIID
- elementid:string元件的UIID
- url:string图片ID
返回值及类型：
- ErrorCode.OK
该方法的主要作用：设置图片元件图案纹理
具体使用案例如下：

--玩家点击方块时，执行此函数
local function clickblock(event)
    local playerid=event.eventobjid--点击方块的玩家迷你号
    local uiid="6986982063319417057"--界面id
    local elementid="6986982063319417057_3"--图片元件id
    local url="10010"--要设置的图案id
    --设置玩家的图片元件的图案
    Customui:setTexture(playerid, uiid, elementid, url)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], clickblock)

setSize

参数及类型：
- playerid:number玩家ID
- uiid:string自定义界面的UIID
- elementid:string元件的UIID
- width:number元件宽度
- height:number元件高度
返回值及类型：
- ErrorCode.OK
该方法的主要作用：设置元件大小
具体使用案例如下：

--玩家点击方块时，执行此函数
local function clickblock(event)
    local playerid=event.eventobjid--点击方块的玩家迷你号
    local uiid="6986982063319417057"--界面id
    local elementid="6986982063319417057_3"--元件id
    local width,height=500,200--设置元件的宽高
    --设置玩家的元件的大小
    Customui:setSize(playerid, uiid, elementid, width, height)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], clickblock)

setFontSize

参数及类型：
- playerid:number玩家ID
- uiid:string自定义界面的UIID
- elementid:string元件的UIID
- size:number字体大小
返回值及类型：
- ErrorCode.OK
该方法的主要作用：设置文本元件字体大小
具体使用案例如下：

--玩家点击方块时，执行此函数
local function clickblock(event)
    local playerid=event.eventobjid--点击方块的玩家迷你号
    local uiid="6986982063319417057"--界面id
    local elementid="6986982063319417057_1"--文本元件id
    local size=50--要设置的文本元件的字体大小
    --设置玩家的文本元件的字体大小
    Customui:setFontSize(playerid, uiid, elementid, size)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], clickblock)

setColor

参数及类型：
- playerid:number玩家ID
- uiid:string自定义界面的UIID
- elementid:string元件的UIID
- color:string16进制颜色值
返回值及类型：
- ErrorCode.OK
该方法的主要作用：设置文本元件颜色
具体使用案例如下：

--玩家点击方块时，执行此函数
local function clickblock(event)
    local playerid=event.eventobjid--点击方块的玩家迷你号
    local uiid="6986982063319417057"--界面id
    local elementid="6986982063319417057_1"--元件id
    local color="0xFF0000"--要设置的元件颜色
    --设置玩家的元件颜色
    Customui:setColor(playerid, uiid, elementid, color)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], clickblock)

showElement

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- effectid:number动画ID(缺省参数)
- time:number动画时长(缺省参数)
返回值及类型：
- ErrorCode.OK
该方法的主要作用：显示元件
具体使用案例如下：

--玩家点击方块时，执行此函数
local function clickblock(event)
    local playerid=event.eventobjid--点击方块的玩家迷你号
    local uiid="6986982063319417057"--要显示的元件所在的界面id
    local elementid="6986982063319417057_1"--要显示的元件id
    --对玩家显示元件
    Customui:showElement(playerid, uiid, elementid)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=],clickblock)

hideElement

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- effectid:number动画ID(缺省参数)
- time:number动画时长(缺省参数)
返回值及类型：
- ErrorCode.OK
该方法的主要作用：隐藏元件
具体使用案例如下：

--玩家点击方块时，执行此函数
local function clickblock(event)
    local playerid=event.eventobjid--点击方块的玩家迷你号
    local uiid="6986982063319417057"--要隐藏的元件所在的界面id
    local elementid="6986982063319417057_1"--要隐藏的元件id
    --对玩家隐藏元件
    Customui:hideElement(playerid, uiid, elementid)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=],clickblock)

rotateElement

参数及类型：
- playerid:number玩家ID
- uiid:string自定义界面的UIID
- elementid:string元件的UIID
- rotate:number旋转角度
返回值及类型：
- ErrorCode.OK
该方法的主要作用：旋转元件
具体使用案例如下：

--玩家点击方块时，执行此函数
local function clickblock(event)
    local playerid=event.eventobjid--点击方块的玩家迷你号
    local uiid="6986982063319417057"--要旋转的元件所在的界面id
    local elementid="6986982063319417057_1"--要旋转的元件id
    local rotate=90--要旋转的度数（顺时针）
    --对玩家旋转元件
    Customui:rotateElement(playerid, uiid, elementid, rotate)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=],clickblock)

setState

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- pageIndex:string状态值
- effectid:number动作枚举LinearTransformation.None或LinearLinearTransformation
- time:number动画事件(缺省参数)
返回值及类型：
- ErrorCode.OK
该方法的主要作用：切换页面状态
具体使用案例如下：

--玩家点击方块时，执行此函数
local function clickblock(event)
    local playerid=event.eventobjid--点击方块的玩家迷你号
    local uiid="6997615793455979871"--界面id
    local statename="6997615793455979871-基础页面1"--页面状态
    --切换玩家的页面状态
    Customui:setState(playerid, uiid, statename)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], clickblock)

setAlpha

参数及类型：
- playerid:number玩家ID
- uiid:string自定义界面的UIID
- elementid:string元件的UIID
- alpha:number透明度
返回值及类型：
- ErrorCode.OK
该方法的主要作用：设置元件透明度
具体使用案例如下：

--玩家点击方块时，执行此函数
local function clickblock(event)
    local playerid=event.eventobjid--点击方块的玩家迷你号
    local uiid="6997615793455979871"--界面id
	local elementid="6997615793455979871_1"--元件id
	local alpha=99--透明度
    --设置元件透明度
    Customui:setAlpha(playerid, uiid, elementid, alpha)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], clickblock)

setPosition

参数及类型：
- playerid:number玩家ID
- uiid:string自定义界面的UIID
- elementid:string元件的UIID
- x, y:number坐标
返回值及类型：
- ErrorCode.OK
该方法的主要作用：设置元件位置
具体使用案例如下：

--玩家点击方块时，执行此函数
local function clickblock(event)
    local playerid=event.eventobjid--点击方块的玩家迷你号
    local uiid="6997615793455979871"--界面id
	local elementid="6997615793455979871_1"--元件id
	local x,y=100,100--要设置到的坐标
    --设置元件位置
    Customui:setPosition(playerid, uiid, elementid, x, y)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], clickblock)

getItemIcon

参数及类型：
- itemid:number道具类型ID
返回值及类型：
- ErrorCode.OK
- iconid:number道具iconID
该方法的主要作用：获取道具类型图标iconID
具体使用案例如下：

local result,iconid = Customui:getItemIcon(itemid)

getMonsterObjIcon

参数及类型：
- objid:number生物ID
返回值及类型：
- ErrorCode.OK
- iconid:number生物iconID
该方法的主要作用：获取生物图标iconID
具体使用案例如下：

local result,iconid = Customui:getMonsterObjIcon(objid)

getMonsterIcon

参数及类型：
- actorid:number生物类型ID
返回值及类型：
- ErrorCode.OK
- iconid:number生物iconID
该方法的主要作用：获取生物类型图标iconID
具体使用案例如下：

local result,iconid = Customui:getMonsterIcon(actorid)

getStatusIcon

参数及类型：
- buffid:number状态类型ID
返回值及类型：
- ErrorCode.OK
- iconid:number状态iconID
该方法的主要作用：获取状态类型图标iconID
具体使用案例如下：

local result,iconid = Customui:getStatusIcon(buffid)

getBlockIcon

参数及类型：
- blockid:number方块类型ID
返回值及类型：
- ErrorCode.OK
- iconid:number方块iconID
该方法的主要作用：获取方块类型图标iconID
具体使用案例如下：

local result,iconid = Customui:getBlockIcon(blockid)

getRoleIcon

参数及类型：
- playerid:number玩家ID
返回值及类型：
- ErrorCode.OK
- iconid:number角色iconID
该方法的主要作用：获取角色类型图标iconID
具体使用案例如下：

local result,iconid = Customui:getRoleIcon(playerid)

getShuctIcon

参数及类型：
- playerid:number玩家ID
- ix:number快捷栏索引（1~8）
返回值及类型：
- ErrorCode.OK
- iconid:number道具iconID
该方法的主要作用：获取玩家快捷栏道具图标iconID
具体使用案例如下：

local result,iconid = Customui:getShuctIcon(playerid，ix)

SmoothMoveTo

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- time:number执行时间(需大于0)
- x:number横坐标值
- y:number竖坐标值
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：元件平滑移动到指定位置
具体使用案例如下：

local code  = Customui:SmoothMoveTo(playerid, uiid, elementid, time, x, y)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SmoothMoveBy

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- time:number执行时间(需大于0)
- x:number横向距离
- y:number竖向距离
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：元件平滑移动相对距离
具体使用案例如下：

local code  = Customui:SmoothMoveBy(playerid, uiid, elementid, time, x, y)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SmoothScaleTo

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- time:number执行时间(需大于0)
- w:number宽度
- h:number高度
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：元件平滑改变到指定宽度和高度
具体使用案例如下：

local code  = Customui:SmoothScaleTo(playerid, uiid, elementid, time, w, h)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SmoothScaleBy

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- time:number执行时间(需大于0)
- w:number宽度
- h:number高度
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：元件平滑改变相对宽度和高度
具体使用案例如下：

local code  = Customui:SmoothScaleBy(playerid, uiid, elementid, time, w, h)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SmoothRotateTo

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- time:number执行时间(需大于0)
- angle:number角度值
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：元件平滑旋转到指定角度
具体使用案例如下：

local code  = Customui:SmoothRotateTo(playerid, uiid, elementid, time, angle)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SmoothRotateBy

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- time:number执行时间(需大于0)
- angle:number角度值
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：元件平滑旋转到相对角度
具体使用案例如下：

local code  = Customui:SmoothRotateBy(playerid, uiid, elementid, time, angle)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

PlayElementAnim

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- animid:number动画ID
- time:number单次时长(需大于0)
- mode:number播放模式循环1单次2(VIEDOPLAYMODE)VIEDOPLAYMODE
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：元件播放动画
具体使用案例如下：

local code  = Customui:PlayElementAnim(playerid, uiid, elementid, animid, time, mode)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

StopAnim

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：元件停止动画
具体使用案例如下：

local code  = Customui:StopAnim(playerid, uiid, elementid)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SetLoaderModel

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- modleid:string模型ID
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：设置装载器的模型
具体使用案例如下：

local code  = Customui:SetLoaderModel(playerid, uiid, elementid, modleid)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SetLoaderModelScale

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- modlescale:number缩放大小
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：设置装载器的模型缩放
具体使用案例如下：

local code  = Customui:SetLoaderModelScale(playerid, uiid, elementid, modlescale)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SetLoaderModelDir

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- yaw:number水平角度(角度制)
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：设置装载器的模型方向
具体使用案例如下：

local code  = Customui:SetLoaderModelDir(playerid, uiid, elementid, yaw)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SetLoaderModelAct

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- animid:number动画ID
- playmode:number播放模式(ANIMMODE)
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：设置装载器的模型动画
具体使用案例如下：

local code  = Customui:SetLoaderModelAct(playerid, uiid, elementid, animid, playmode)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

TurnSliderToPos

参数及类型：
- playerid : number 玩家ID
- uiid : string 界面ID
- elementid : string 元件ID
- x : number X坐标值
- y : number Y坐标值
返回值及类型：
- code:number成功(ErrorCode.OK)ErrorCode
该方法的主要作用：滑动列表跳转到某位置
具体使用案例如下：

local code  = Customui:TurnSliderToPos(playerid, uiid, elementid, x, y)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SetSliderDir

参数及类型：
- playerid : number 玩家ID
- uiid : string 界面ID
- elementid : string 元件ID
- dir : number 滑动方式（0仅左右，1仅上下，2自由滑动）
返回值及类型：
- code : number成功(ErrorCode.OK) ErrorCode
该方法的主要作用：设置滑动列表的滑动方式
具体使用案例如下：

local code  = Customui:SetSliderDir(playerid, uiid, elementid, dir)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SetSliderBarImg

参数及类型：
- playerid : number 玩家ID
- uiid : string 界面ID
- elementid : string 元件ID
- url : string 图片库链接
返回值及类型：
- code : number成功(ErrorCode.OK) ErrorCode
该方法的主要作用：设置滑动条的图案
具体使用案例如下：

local code  = Customui:SetSliderBarImg(playerid, uiid, elementid, url)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SetProgressBarValue

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- itype:number类型枚举（1最小值，2最大值，3当前值）
- value:number值类型
返回值及类型：
- ret:bool是否成功
该方法的主要作用：设置玩家界面进度条的值

具体使用案例如下：

local ret  = Customui:SetProgressBarValue(playerid, uiid, elementid, itype, value)
if ret == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SetProgressBarResId

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- itype:number类型枚举（1背景，2进度条）
- url:string图片ID
返回值及类型：
- ret:bool是否成功
该方法的主要作用：设置玩家界面进度条的纹理

具体使用案例如下：

local ret  = Customui:SetProgressBarResId(playerid, uiid, elementid, itype, url)
if ret == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

SmoothIncreaseProgress

参数及类型：
- playerid:number玩家ID
- uiid:string界面ID
- elementid:string元件ID
- time:number时长
- ptype:number类型枚举（1增加，2减小，3变化至）
- value:number变化的值
返回值及类型：
- ret:bool是否成功
该方法的主要作用：进度条文本平滑计时

具体使用案例如下：

local ret  = Customui:SmoothIncreaseProgress(playerid, uiid, elementid, time, ptype, value)
if ret == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end