界面模块管理接口 CustomUI

具体函数名及描述如下:

序号	函数名	函数描述
1	SetText(...)	设置文本元件内容
2	SetTexture(...)	设置元件图案纹理
3	SetSize(...)	设置元件大小
4	SetFontSize(...)	设置文本元件字体大小
5	SetColor(...)	设置元件颜色
6	ShowElement(...)	显示元件
7	HideElement(...)	隐藏元件
8	RotateElement(...)	旋转元件
9	SetAlpha(...)	设置透明度
10	SetState(...)	设置界面状态
11	SetPosition(...)	设置元件位置
12	SetScale(...)	设置元件缩放
13	GetItemIcon(...)	获取道具图标
14	GetMonsterObjIcon(...)	获取生物图标(对象)
15	GetMonsterIcon(...)	获取生物图标(类型)
16	GetStatusIcon(...)	获取状态图标
17	GetBlockIcon(...)	获取方块图标
18	GetRoleIcon(...)	获取角色图标
19	GetRoleHeadIcon(...)	获取角色头像图标
20	GetShortcutIcon(...)	获取快捷栏图标
21	SmoothMoveTo(...)	元件平滑移动到指定位置
22	SmoothMoveBy(...)	元件平滑移动相对距离
23	SmoothScaleTo(...)	元件平滑缩放到指定尺寸
24	SmoothScaleBy(...)	元件平滑改变相对宽高
25	SmoothScaleByEx(...)	元件平滑缩放(扩展)
26	SmoothRotateTo(...)	元件平滑旋转到指定角度
27	SmoothRotateBy(...)	元件平滑旋转相对角度
28	PlayElementAnim(...)	播放元件动画
29	StopAnim(...)	停止元件动画
30	SetLoaderModel(...)	设置装载器模型
31	SetLoaderModelScale(...)	设置装载器模型缩放
32	SetLoaderModelDir(...)	设置装载器模型方向
33	SetLoaderModelPosition(...)	设置装载器模型位置
34	SetLoaderModelAct(...)	设置装载器模型动画
35	TurnSliderToPos(...)	滑动列表跳转到位置
36	SetSliderDir(...)	设置滑动列表滑动方式
37	SetSliderBarImg(...)	设置滑动条图案
38	SetRelationPosition(...)	设置元件相对位置
39	SetRelationSize(...)	设置元件相对大小
40	CreateElement(...)	动态创建元件
41	CloneElement(...)	克隆元件
42	ChangeParent(...)	修改元件父元件
43	SetProgressBarValue(...)	设置进度条值
44	GetProgressBarValue(...)	获取进度条值
45	SetProgressBarResId(...)	设置进度条纹理
46	SmoothChangeProgress(...)	进度条文本平滑变化
47	SetSpineAnimID(...)	设置Spine动画ID
48	SmoothIncreaseProgress(...)	进度条文本平滑变化(增减)
49	SetFloatDamageTxt(...)	设置浮动伤害文本
50	GetScreenSize(...)	获取屏幕分辨率
51	DeleteElement(...)	删除UI元件
52	SetBeaconBandPos(...)	设置信标位置
53	SetBeaconObjId(...)	设置信标对象
54	SetBeaconOffset(...)	设置信标偏移
55	SetBeaconClampType(...)	设置信标限制范围
56	SetBeaconRadius(...)	设置信标半径
57	SetBeaconMargin(...)	设置信标矩形范围

SetText

• 参数及类型：
  • objid:number 玩家/对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • text:string 文本内容
  • animid:number 动画ID(可选)
  • time:number 动画时长(可选)
  • mode:number 播放模式(可选)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置指定文本元件的内容，可选带动画效果（打字机等）
• 具体使用案例如下：

    local isSuccess = CustomUI:SetText(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_2", "测试文本")

SetTexture

• 参数及类型：
  • objid:number 玩家/对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • url:string 图案纹理ID
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置指定元件的图案纹理（使用纹理资源ID）
• 具体使用案例如下：

    local isSuccess = CustomUI:SetTexture(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_3", "0_10103")

SetSize

• 参数及类型：
  • objid:number 玩家/对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • width:number 元件宽度
  • height:number 元件高度
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置指定元件的尺寸（宽高）
• 具体使用案例如下：

    local isSuccess = CustomUI:SetSize(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_3", 200, 100)

SetFontSize

• 参数及类型：
  • objid:number 玩家/对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • size:number 字体大小
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置指定文本元件的字体大小
• 具体使用案例如下：

    local isSuccess = CustomUI:SetFontSize(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_2", 20)

SetColor

• 参数及类型：
  • objid:number 玩家/对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • color:number 颜色值(0xFFFFFF)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置指定元件的颜色
• 具体使用案例如下：

    local isSuccess = CustomUI:SetColor(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1", "0xf44336")

ShowElement

• 参数及类型：
  • objid:number 玩家/对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • effectid:number 动画ID(可选)
  • time:number 动画时长(可选)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 显示指定元件，可选播放显示动画
• 具体使用案例如下：

    local isSuccess = CustomUI:ShowElement(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1")

HideElement

• 参数及类型：
  • objid:number 玩家/对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • effectid:number 动画ID(可选)
  • time:number 动画时长(可选)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 隐藏指定元件，可选播放隐藏动画
• 具体使用案例如下：

    local isSuccess = CustomUI:HideElement(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1")

RotateElement

• 参数及类型：
  • objid:number 玩家/对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • rotate:number 旋转角度
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置指定元件的旋转角度
• 具体使用案例如下：

    local isSuccess = CustomUI:RotateElement(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1", 45)

SetAlpha

• 参数及类型：
  • objid:number 玩家/对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • alpha:number 透明度(0~100)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置指定元件的透明度
• 具体使用案例如下：

    local isSuccess = CustomUI:SetAlpha(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1", 0.5)

SetState

• 参数及类型：
  • objid:number 玩家/对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • pageIndex:string 状态ID
  • easeType:number 缓动类型(Easing)(可选)Easing
  • time:number 过渡时长(可选)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置界面状态，可指定缓动类型与过渡时长
• 具体使用案例如下：

    local isSuccess = CustomUI:SetState(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886-状态2", Easing.Linear, 1)

SetPosition

• 参数及类型：
  • objid:number 玩家/对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • x:number X坐标值
  • y:number Y坐标值
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置指定元件在界面上的坐标位置
• 具体使用案例如下：

    local isSuccess = CustomUI:SetPosition(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1", 600, 200)

SetScale

• 参数及类型：
  • objid:number 玩家/对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • x:number X缩放
  • y:number Y缩放
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置指定元件的缩放比例
• 具体使用案例如下：

    local isSuccess = CustomUI:SetScale(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1", 2, 2)

GetItemIcon

• 参数及类型：
  • itemid:number / string 道具类型ID/预制ID
• 返回值及类型：
  • icon:string 道具图标标识；失败返回""
• 该方法的其他说明： 根据道具类型ID/预制ID获取道具图标
• 具体使用案例如下：

    local icon = CustomUI:GetItemIcon(12004)

    if icon and icon ~= "" then

        print("获取图标成功")

    end

GetMonsterObjIcon

• 参数及类型：
  • objid:number 对象ID
• 返回值及类型：
  • icon:string 生物图标标识；无效返回""
• 该方法的其他说明： 根据生物对象ID获取对应的生物图标标识字符串
• 具体使用案例如下：

    local obj = GameObject:CreatePrefabInst("r1_7482990429829028854_22890", nil, 10,8,10)

    if obj then

        local icon = CustomUI:GetMonsterObjIcon(obj:GetId())

        if icon and icon ~= "" then

            print("获取怪物图标成功")

        end

    end

GetMonsterIcon

• 参数及类型：
  • actorid:number / string 生物类型ID/预制ID
• 返回值及类型：
  • icon:string 生物图标标识；无效返回""
• 该方法的其他说明： 根据生物类型ID/预制ID生成生物图标标识字符串
• 具体使用案例如下：

    local icon = CustomUI:GetMonsterIcon(3400)

    if icon and icon ~= "" then

        print("获取怪物图标成功")

    end

GetStatusIcon

• 参数及类型：
  • buffid:number / string 状态ID/预制ID
• 返回值及类型：
  • icon:string 状态图标标识；无效返回""或nil
• 该方法的其他说明： 根据状态ID/预制ID获取状态图标标识字符串
• 具体使用案例如下：

    local icon = CustomUI:GetStatusIcon(4001)

    if icon and icon ~= "" then

        print("获取状态图标成功")

    end

GetBlockIcon

• 参数及类型：
  • blockid:number / string 方块类型ID/预制ID
• 返回值及类型：
  • icon:string 方块图标标识；无效返回""
• 该方法的其他说明： 根据方块类型ID/预制ID生成方块图标标识字符串
• 具体使用案例如下：

    local icon = CustomUI:GetBlockIcon(200)

    if icon and icon ~= "" then

        print("获取方块图标成功")

    end

GetRoleIcon

• 参数及类型：
  • playerid:number 玩家ID
• 返回值及类型：
  • icon:string 角色图标标识；失败返回nil
• 该方法的其他说明： 获取玩家当前角色的图标标识字符串
• 具体使用案例如下：

    local icon = CustomUI:GetRoleIcon(Player:GetHostUin())

    if icon and icon ~= "" then

        print("获取角色图标成功")

    end

GetRoleHeadIcon

• 参数及类型：
  • playerid:number 玩家ID
• 返回值及类型：
  • icon:string 头像图标标识
• 该方法的其他说明： 根据玩家ID生成默认头像图标标识字符串
• 具体使用案例如下：

    local icon = CustomUI:GetRoleHeadIcon(Player:GetHostUin())

    if icon and icon ~= "" then

        print("获取角色头像成功")

    end

GetShortcutIcon

• 参数及类型：
  • playerid:number 玩家ID
  • ix:number 快捷栏索引(1-8)
• 返回值及类型：
  • icon:string 道具图标标识；失败返回nil
• 该方法的其他说明： 获取玩家快捷栏指定格子的道具图标标识字符串
• 具体使用案例如下：

    local icon = CustomUI:GetShortcutIcon(Player:GetHostUin(), 1)

SmoothMoveTo

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • time:number 执行时间(需大于0)
  • x:number X坐标(可选)
  • y:number Y坐标(可选)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 让元件在指定时间内平滑移动到绝对坐标位置
• 具体使用案例如下：

    local isSuccess = CustomUI:SmoothMoveTo(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_4", 1, 200, 300)

SmoothMoveBy

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • time:number 执行时间(需大于0)
  • x:number X方向距离
  • y:number Y方向距离
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 让元件在指定时间内按相对距离平滑移动
• 具体使用案例如下：

    local isSuccess = CustomUI:SmoothMoveBy(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1", 1, 100, 100)

SmoothScaleTo

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • time:number 执行时间(需大于0)
  • w:number 宽度(可选)
  • h:number 高度(可选)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 让元件在指定时间内平滑改变到指定宽度和高度
• 具体使用案例如下：

    local isSuccess = CustomUI:SmoothScaleTo(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1", 1, 100, 200)

SmoothScaleBy

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • time:number 执行时间(需大于0)
  • w:number 宽度增量
  • h:number 高度增量
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 让元件在指定时间内按相对增量平滑改变宽度和高度
• 具体使用案例如下：

    local isSuccess = CustomUI:SmoothScaleBy(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1", 1, 30, 20)

SmoothScaleByEx

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • time:number 执行时间(需大于0)
  • x:number X缩放值
  • y:number Y缩放值
  • delayTime:number 延迟时间(可选)
  • easeType:number 缓动枚举(Easing,可选)Easing
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 让元件在指定时间内平滑改变相对缩放大小（子节点也会改变大小）<1.47+>
• 具体使用案例如下：

    local isSuccess = CustomUI:SmoothScaleByEx(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1",5, 3, 3)

SmoothRotateTo

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • time:number 执行时间(需大于0)
  • angle:number 角度值
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 让元件在指定时间内平滑旋转到指定角度
• 具体使用案例如下：

    local isSuccess = CustomUI:SmoothRotateTo(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1", 1, 45)

SmoothRotateBy

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • time:number 执行时间(需大于0)
  • angle:number 角度增量
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 让元件在指定时间内按相对角度平滑旋转
• 具体使用案例如下：

    local isSuccess = CustomUI:SmoothRotateBy(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1", 1, 20)

PlayElementAnim

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • animid:number 动画ID
  • time:number 单次执行时间(需大于0)
  • mode:number 播放模式(AnimMode)AnimMode
  • easetype:number 缓动类型(Easing,可选)Easing
  • delaytime:number 延迟播放时间(可选)
  • endvalue:number / table 动画结束值(可选)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 播放元件动画（动效/缓动/延迟等参数按配置生效）
• 具体使用案例如下：

    local isSuccess = CustomUI:PlayElementAnim(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1", 30007, 1, ViedoPlayMode.Once)

StopAnim

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • itype:number 停止类型(0全部/1指定元件)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 停止元件动画（可停止全部动效或指定元件动效）
• 具体使用案例如下：

    local isSuccess = CustomUI:StopAnim(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_1", 0)

SetLoaderModel

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • modleName:string 模型名称(如ItemInstance_xxx/avator_xxx等)stance
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置装载器元件显示的模型（支持按约定格式解析模型来源）
• 具体使用案例如下：

    local isSuccess = CustomUI:SetLoaderModel(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_5", "mob_3419")

SetLoaderModelScale

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • modlescale:number 缩放大小
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置装载器元件模型缩放大小
• 具体使用案例如下：

    local isSuccess = CustomUI:SetLoaderModelScale(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_5", 1.5)

SetLoaderModelDir

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • yaw:number 水平角度(角度制)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置装载器元件模型的水平旋转角度
• 具体使用案例如下：

    local isSuccess = CustomUI:SetLoaderModelDir(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_5", 90)

SetLoaderModelPosition

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • x:number x坐标
  • y:number y坐标
  • z:number z坐标
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置装载器元件模型的位置坐标
• 具体使用案例如下：

    local isSuccess = CustomUI:SetLoaderModelPosition(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_5", 100, 200, 300)

SetLoaderModelAct

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • animid:number / string 动画ID
  • playmode:number 播放模式(AnimMode)AnimMode
  • speed:number 播放速度(0~1)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置装载器元件模型播放的动画
• 具体使用案例如下：

    local isSuccess = CustomUI:SetLoaderModelAct(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_5", "100100", AnimMode.Default,1)

TurnSliderToPos

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • x:number X坐标值
  • y:number Y坐标值
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 让滑动列表跳转到指定坐标位置
• 具体使用案例如下：

    local isSuccess = CustomUI:TurnSliderToPos(Player:GetHostUin(), "7482986899365911542-22886","7482986899365911542-22886_6",0, 50)

SetSliderDir

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • dir:number 滑动方式(0仅左右/1仅上下/2自由滑动)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置滑动列表的滑动方向限制
• 具体使用案例如下：

    local isSuccess = CustomUI:SetSliderDir(Player:GetHostUin(), "7482986899365911542-22886","7482986899365911542-22886_6", 1)

SetSliderBarImg

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • url:string 图片资源ID/链接
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置滑动条/滑动列表滑块的图案资源
• 具体使用案例如下：

    local isSuccess = CustomUI:SetSliderBarImg(Player:GetHostUin(), "7482986899365911542-22886","7482986899365911542-22886_6", 10100)

SetRelationPosition

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • v:number 水平偏移枚举(HorizontalOffset)HorizontalOffset
  • xOffset:number X偏移值
  • xUnits:number 单位枚举(PixelUnits)PixelUnits
  • h:number 垂直偏移枚举(VerticalOffset)VerticalOffset
  • yOffset:number Y偏移值
  • yUnits:number 单位枚举(PixelUnits)PixelUnits
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置元件相对锚点/单位的偏移位置
• 具体使用案例如下：

    local isSuccess = CustomUI:SetRelationPosition(Player:GetHostUin(), "7482986899365911542-22886", "7482986899365911542-22886_1", HorizontalOffset.Left, 10, PixelUnits.Percentage, VerticalOffset.Top, 10, PixelUnits.Percentage)

SetRelationSize

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • width:number 宽度值
  • widthUnits:number 单位枚举(PixelUnits)PixelUnits
  • height:number 高度值
  • heightUnits:number 单位枚举(PixelUnits)PixelUnits
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置元件相对单位的宽高大小
• 具体使用案例如下：

    local isSuccess = CustomUI:SetRelationSize(Player:GetHostUin(), "7482986899365911542-22886","7482986899365911542-22886_7", 100, PixelUnits.Percentage, 100, PixelUnits.Percentage)

CreateElement

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementType:number 元件类型枚举(ElementType)ElementType
• 返回值及类型：
  • elementid:string 新建元件ID；失败返回nil/false
• 该方法的其他说明： 动态创建元件并返回新元件ID，创建元件的子节点用 A.B 操作。
• 具体使用案例如下：

    local id = CustomUI:CreateElement(Player:GetHostUin(), "7482986899365911542-22886",ElementType.Texture)

    if id ~= nil then

        print("创建元件成功")

    end

CloneElement

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 被克隆元件ID
• 返回值及类型：
  • elementid:string 克隆元件ID；失败返回nil/false
• 该方法的其他说明： 克隆指定元件，并返回克隆后的新元件ID
• 具体使用案例如下：

    local id = CustomUI:CloneElement(Player:GetHostUin(), "7482986899365911542-22886", "7482986899365911542-22886_7")

    if id ~= nil then

        print("克隆元件成功")

    end

ChangeParent

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • parentElementid:string 父元件ID
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 修改元件的父元件（调整层级结构）
• 具体使用案例如下：

    local isSuccess = CustomUI:ChangeParent(Player:GetHostUin(), "7482986899365911542-22886", "7482986899365911542-22886_7", "7482986899365911542-22886_1")

    if isSuccess then

        print("改变父节点成功")

    end

SetProgressBarValue

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • itype:number 类型枚举(ProgressVal)ProgressVal
  • value:number 设定值
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置进度条元件的数值（最小/最大/当前等，按类型枚举生效）
• 具体使用案例如下：

    local isSuccess = CustomUI:SetProgressBarValue(Player:GetHostUin(), "7482986899365911542-22886","7482986899365911542-22886_7", ProgressVal.Current, 100)

GetProgressBarValue

• 参数及类型：
  • reportid:number 上报ID
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
• 返回值及类型：
  • bool:boolean 是否上报成功
• 该方法的其他说明： 获取进度条元件的最小值/最大值/当前值，并通过reportid上报给主机
• 具体使用案例如下：

     local min,max,value = CustomUI:GetProgressBarValue(Player:GetHostUin(), "7482986899365911542-22886","7482986899365911542-22886_7")

SetProgressBarResId

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • itype:number 类型枚举(ProgressImg)ProgressImg
  • url:string 图片资源ID
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置进度条元件的纹理资源（背景/进度等，按类型枚举生效）
• 具体使用案例如下：

    local isSuccess = CustomUI:SetProgressBarResId(Player:GetHostUin(), "7482986899365911542-22886", "7482986899365911542-22886_7", ProgressImg.Background, 10100)

SmoothChangeProgress

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • bval:number 开始值
  • eval:number 结束值
  • time:number 执行时间
• 返回值及类型：
  • bool:boolean 是否触发成功(无显式返回值时为nil)
• 该方法的其他说明： 让进度条文本在指定时间内从起始值平滑变化到结束值
• 具体使用案例如下：

local bool = CustomUI:SmoothChangeProgress(playerid, uiid, elementid, bval, eval, time)

SetSpineAnimID

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • animid:number 内置动画ID
  • animindex:number 动画序列
  • playmode:number 播放模式(ViedoPlayMode)ViedoPlayMode
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置动画元件的动画ID/序列/播放模式
• 具体使用案例如下：

    local isSuccess = CustomUI:SetSpineAnimID(Player:GetHostUin(),"7482986899365911542-22886","7482986899365911542-22886_4", 10052, 1, ViedoPlayMode.Repeat)

SmoothIncreaseProgress

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
  • time:number 时长
  • ptype:number 类型(1增加/2减小/3变化至)
  • value:number 变化值
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 让进度条文本在指定时间内按类型平滑变化（增加/减少/变化至）
• 具体使用案例如下：

    local isSuccess = CustomUI:SmoothIncreaseProgress(Player:GetHostUin(), "7482986899365911542-22886","7482986899365911542-22886_7", 3, 1, 50)

SetFloatDamageTxt

• 参数及类型：
  • playerid:number 玩家ID
  • elementid:string 元件ID
  • objid:number 对象ID
  • text:string 文本
  • color:number 颜色(可选)
  • offsetx:number X偏移(可选)
  • offsety:number Y偏移(可选)
  • movex:number 移动X(可选)
  • movey:number 移动Y(可选)
  • showtime:number 显示时长(可选)
  • movex2:number 移动X2(可选)
  • movey2:number 移动Y2(可选)
  • showtime2:number 显示时长2(可选)
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 在对象屏幕坐标附近显示浮动伤害文本，并按参数播放移动/渐隐效果
• 具体使用案例如下：

local bool = CustomUI:SetFloatDamageTxt(playerid, elementid, objid, text, color, offsetx, offsety, movex, movey, showtime, movex2, movey2, showtime2)

GetScreenSize

• 参数及类型：
  • playerid:number 玩家ID
• 返回值及类型：
  • Width:number 屏幕宽度
  • Height:number 屏幕高度
• 该方法的其他说明： 获取客机屏幕分辨率
• 具体使用案例如下：

    local width, height = CustomUI:GetScreenSize(Player:GetHostUin())

DeleteElement

• 参数及类型：
  • playerid:number 玩家ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
  • elementid:string 元件ID
• 返回值及类型：
  • bool:boolean 是否删除成功
• 该方法的其他说明： 删除UI元件
• 具体使用案例如下：

local bool = CustomUI:DeleteElement(playerid, uiid, elementid)

SetBeaconBandPos

• 参数及类型：
  • playerid:number 玩家ID
  • elementid:string 元件ID
  • bandPosX:number x坐标
  • bandPosY:number y坐标
  • bandPosZ:number z坐标
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置信标绑定位置坐标
• 具体使用案例如下：

local bool = CustomUI:SetBeaconBandPos(playerid, elementid, bandPosX, bandPosY, bandPosZ, uiid)

SetBeaconObjId

• 参数及类型：
  • playerid:number 玩家ID
  • elementid:string 元件ID
  • objId:number 对象ID
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置信标绑定的对象ID
• 具体使用案例如下：

local bool = CustomUI:SetBeaconObjId(playerid, elementid, objId, uiid)

SetBeaconOffset

• 参数及类型：
  • playerid:number 玩家ID
  • elementid:string 元件ID
  • offsetX:number x偏移
  • offsetY:number y偏移
  • offsetZ:number z偏移
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置信标偏移量
• 具体使用案例如下：

local bool = CustomUI:SetBeaconOffset(playerid, elementid, offsetX, offsetY, offsetZ, uiid)

SetBeaconClampType

• 参数及类型：
  • playerid:number 玩家ID
  • elementid:string 元件ID
  • clampRange:number 限制类型
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置信标限制范围类型
• 具体使用案例如下：

local bool = CustomUI:SetBeaconClampType(playerid, elementid, clampType, uiid)

SetBeaconRadius

• 参数及类型：
  • playerid:number 玩家ID
  • elementid:string 元件ID
  • radius:number 半径
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置信标显示半径
• 具体使用案例如下：

local bool = CustomUI:SetBeaconRadius(playerid, elementid, radius, uiid)

SetBeaconMargin

• 参数及类型：
  • playerid:number 玩家ID
  • elementid:string 元件ID
  • horizontalMargin:number 水平边距
  • verticalMargin:number 垂直边距
  • uiid:string / number UI标识（string为2DUI界面ID，number为挂载显示板组件且内容为自定义UI的对象ID）
• 返回值及类型：
  • bool:boolean 是否设置成功
• 该方法的其他说明： 设置信标矩形限制范围
• 具体使用案例如下：

local bool = CustomUI:SetBeaconMargin(playerid, elementid, horizontalMargin, verticalMargin, uiid)