Appearance
界面模块管理接口 CustomUI
具体函数名及描述如下:
SetText
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置指定文本元件的内容,可选带动画效果(打字机等)
- 具体使用案例如下:
lua
local result = CustomUI:SetText(playerId, uiId, "7482986899365911542-22886_2", "测试文本2")SetTexture
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置指定元件的图案纹理(使用纹理资源ID)
- 具体使用案例如下:
lua
local result = CustomUI:SetTexture(playerId, uiId, "7482986899365911542-22886_3", "0_10103")SetSize
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置指定元件的尺寸(宽高)
- 具体使用案例如下:
lua
local result = CustomUI:SetSize(playerId, uiId, "7482986899365911542-22886_3", 200, 100)SetFontSize
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置指定文本元件的字体大小
- 具体使用案例如下:
lua
local result = CustomUI:SetFontSize(playerId, uiId, "7482986899365911542-22886_2", 20)SetColor
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置指定元件的颜色
- 具体使用案例如下:
lua
local result = CustomUI:SetColor(playerId, uiId, "7482986899365911542-22886_1", "0xf44336")ShowElement
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 显示指定元件,可选播放显示动画
- 具体使用案例如下:
lua
local result = CustomUI:ShowElement(playerId, uiId, "7482986899365911542-22886_1")HideElement
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 隐藏指定元件,可选播放隐藏动画
- 具体使用案例如下:
lua
local result = CustomUI:HideElement(playerId, uiId, "7482986899365911542-22886_1")RotateElement
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置指定元件的旋转角度
- 具体使用案例如下:
lua
local result = CustomUI:RotateElement(playerId, uiId, "7482986899365911542-22886_1", 45)SetAlpha
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置指定元件的透明度
- 具体使用案例如下:
lua
local result = CustomUI:SetAlpha(playerId, uiId, "7482986899365911542-22886_1", 50)SetState
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置界面状态,可指定缓动类型与过渡时长
- 具体使用案例如下:
lua
local result = CustomUI:SetState(playerId, uiId, "7482986899365911542-22886-状态2", Easing.Linear, 1)SetPosition
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置指定元件在界面上的坐标位置
- 具体使用案例如下:
lua
local result = CustomUI:SetPosition(playerId, uiId, "7482986899365911542-22886_1", 600, 200)SetScale
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置指定元件的缩放比例
- 具体使用案例如下:
lua
local result = CustomUI:SetScale(playerId, uiId, "7482986899365911542-22886_1", 2, 2)GetItemIcon
- 参数及类型:
- 返回值及类型:
- icon:
string道具图标标识;失败返回""
- icon:
- 该方法的其他说明: 根据道具类型ID/预制ID获取道具图标
- 具体使用案例如下:
lua
local result = CustomUI:GetItemIcon(12005)GetMonsterObjIcon
lua
local result = CustomUI:GetMonsterObjIcon(playerId)GetMonsterIcon
- 参数及类型:
- 返回值及类型:
- icon:
string生物图标标识;无效返回""
- icon:
- 该方法的其他说明: 根据生物类型ID/预制ID生成生物图标标识字符串
- 具体使用案例如下:
lua
local result = CustomUI:GetMonsterIcon(playerId)GetStatusIcon
- 参数及类型:
- 返回值及类型:
- icon:
string状态图标标识;无效返回""或nil
- icon:
- 该方法的其他说明: 根据状态ID/预制ID获取状态图标标识字符串
- 具体使用案例如下:
lua
local result = CustomUI:GetStatusIcon(4001)GetBlockIcon
- 参数及类型:
- 返回值及类型:
- icon:
string方块图标标识;无效返回""
- icon:
- 该方法的其他说明: 根据方块类型ID/预制ID生成方块图标标识字符串
- 具体使用案例如下:
lua
local result = CustomUI:GetBlockIcon(376)GetRoleIcon
lua
local playerId = Player:GetHostUin()
local result = CustomUI:GetRoleIcon(playerId)GetRoleHeadIcon
lua
local playerId = Player:GetHostUin()
local result = CustomUI:GetRoleHeadIcon(playerId)GetShortcutIcon
- 参数及类型:
- 返回值及类型:
- icon:
string道具图标标识;失败返回nil
- icon:
- 该方法的其他说明: 获取玩家快捷栏指定格子的道具图标标识字符串
- 具体使用案例如下:
lua
local playerId = Player:GetHostUin()
local result = CustomUI:GetShortcutIcon(playerId, 1)SmoothMoveTo
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 让元件在指定时间内平滑移动到绝对坐标位置
- 具体使用案例如下:
lua
local result = CustomUI:SmoothMoveTo(playerId, uiId, "7482986899365911542-22886_4", 1, 200, 300)SmoothMoveBy
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 让元件在指定时间内按相对距离平滑移动
- 具体使用案例如下:
lua
local result = CustomUI:SmoothMoveBy(playerId, uiId, "7482986899365911542-22886_1", 1, 100, 100)SmoothScaleTo
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 让元件在指定时间内平滑改变到指定宽度和高度
- 具体使用案例如下:
lua
local result = CustomUI:SmoothScaleTo(playerId, uiId, "7482986899365911542-22886_1", 1, 100, 200)SmoothScaleBy
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 让元件在指定时间内按相对增量平滑改变宽度和高度
- 具体使用案例如下:
lua
local result = CustomUI:SmoothScaleBy(playerId, uiId, "7482986899365911542-22886_1", 1, 30, 20)SmoothScaleByEx
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 让元件在指定时间内平滑改变相对缩放大小(子节点也会改变大小)<1.47+>
- 具体使用案例如下:
lua
local result = CustomUI:SmoothScaleByEx(playerId, uiId, "7482986899365911542-22886_1", 5, 3, 3)SmoothRotateTo
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 让元件在指定时间内平滑旋转到指定角度
- 具体使用案例如下:
lua
local result = CustomUI:SmoothRotateTo(playerId, uiId, "7482986899365911542-22886_1", 1, 45)SmoothRotateBy
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 让元件在指定时间内按相对角度平滑旋转
- 具体使用案例如下:
lua
local result = CustomUI:SmoothRotateBy(playerId, uiId, "7482986899365911542-22886_1", 1, 20)PlayElementAnim
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 播放元件动画(动效/缓动/延迟等参数按配置生效)
- 具体使用案例如下:
lua
local result = CustomUI:PlayElementAnim(playerId, uiId, "7482986899365911542-22886_1", 30007, 1, ViedoPlayMode.Once)StopAnim
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 停止元件动画(可停止全部动效或指定元件动效)
- 具体使用案例如下:
lua
local result = CustomUI:StopAnim(playerId, uiId, "7482986899365911542-22886_1", 0)SetLoaderModel
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置装载器元件显示的模型(支持按约定格式解析模型来源)
- 具体使用案例如下:
lua
local result = CustomUI:SetLoaderModel(playerId, uiId, "7482986899365911542-22886_5", "mob_3419")SetLoaderModelScale
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置装载器元件模型缩放大小
- 具体使用案例如下:
lua
local result = CustomUI:SetLoaderModelScale(playerId, uiId, "7482986899365911542-22886_5", 1.5)SetLoaderModelDir
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置装载器元件模型的水平旋转角度
- 具体使用案例如下:
lua
local result = CustomUI:SetLoaderModelDir(playerId, uiId, "7482986899365911542-22886_5", 90)SetLoaderModelPosition
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置装载器元件模型的位置坐标
- 具体使用案例如下:
lua
local result = CustomUI:SetLoaderModelPosition(playerId, uiId, "7482986899365911542-22886_5", 100, 200, 300)SetLoaderModelAct
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置装载器元件模型播放的动画
- 具体使用案例如下:
lua
local result = CustomUI:SetLoaderModelAct(playerId, uiId, "7482986899365911542-22886_5", "100100", AnimMode.Default, 1)TurnSliderToPos
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 让滑动列表跳转到指定坐标位置
- 具体使用案例如下:
lua
local result = CustomUI:TurnSliderToPos(playerId, uiId, "7482986899365911542-22886_6", 0, 50)SetSliderDir
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置滑动列表的滑动方向限制
- 具体使用案例如下:
lua
local result = CustomUI:SetSliderDir(playerId, uiId, "7482986899365911542-22886_6", 1)SetSliderBarImg
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置滑动条/滑动列表滑块的图案资源
- 具体使用案例如下:
lua
local result = CustomUI:SetSliderBarImg(playerId, uiId, "7482986899365911542-22886_6", 10100)SetRelationPosition
- 参数及类型:
- playerid:
number玩家ID - uiid:
string/numberUI标识(string为2DUI界面ID,number为挂载显示板组件且内容为自定义UI的对象ID) - elementid:
string元件ID - v:
number水平偏移枚举(HorizontalOffset)HorizontalOffset - xOffset:
numberX偏移值 - xUnits:
number单位枚举(PixelUnits)PixelUnits - h:
number垂直偏移枚举(VerticalOffset)VerticalOffset - yOffset:
numberY偏移值 - yUnits:
number单位枚举(PixelUnits)PixelUnits
- playerid:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置元件相对锚点/单位的偏移位置
- 具体使用案例如下:
lua
local result = CustomUI:SetRelationPosition(playerId, uiId, elementId, HorizontalOffset.Left, 10, PixelUnits.Percentage, VerticalOffset.Top, 10, PixelUnits.Percentage)SetRelationSize
- 参数及类型:
- playerid:
number玩家ID - uiid:
string/numberUI标识(string为2DUI界面ID,number为挂载显示板组件且内容为自定义UI的对象ID) - elementid:
string元件ID - width:
number宽度值 - widthUnits:
number单位枚举(PixelUnits)PixelUnits - height:
number高度值 - heightUnits:
number单位枚举(PixelUnits)PixelUnits
- playerid:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置元件相对单位的宽高大小
- 具体使用案例如下:
lua
local result = CustomUI:SetRelationSize(playerId, uiId, elementId, 100, PixelUnits.Percentage, 100, PixelUnits.Percentage)CreateElement
- 参数及类型:
- playerid:
number玩家ID - uiid:
string/numberUI标识(string为2DUI界面ID,number为挂载显示板组件且内容为自定义UI的对象ID) - elementType:
number元件类型枚举(ElementType)ElementType
- playerid:
- 返回值及类型:
- elementid:
string新建元件ID;失败返回nil/false
- elementid:
- 该方法的其他说明: 动态创建元件并返回新元件ID,创建元件的子节点用 A.B 操作。
- 具体使用案例如下:
lua
local result = CustomUI:CreateElement(playerId, uiId, ElementType.Texture)CloneElement
- 参数及类型:
- 返回值及类型:
- elementid:
string克隆元件ID;失败返回nil/false
- elementid:
- 该方法的其他说明: 克隆指定元件,并返回克隆后的新元件ID
- 具体使用案例如下:
lua
local result = CustomUI:CloneElement(playerId, uiId, "7482986899365911542-22886_7")ChangeParent
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 修改元件的父元件(调整层级结构)
- 具体使用案例如下:
lua
local result = CustomUI:ChangeParent(playerId, uiId, "7482986899365911542-22886_7", "7482986899365911542-22886_1")SetProgressBarValue
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置进度条元件的数值(最小/最大/当前等,按类型枚举生效)
- 具体使用案例如下:
lua
local result = CustomUI:SetProgressBarValue(playerId, uiId, "7482986899365911542-22886_7", ProgressVal.Current, 100)GetProgressBarValue
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否上报成功
- bool:
- 该方法的其他说明: 获取进度条元件的最小值/最大值/当前值,并通过reportid上报给主机
- 具体使用案例如下:
lua
local minValue, maxValue, currentValue = CustomUI:GetProgressBarValue(playerId, uiId, elementId)SetProgressBarResId
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置进度条元件的纹理资源(背景/进度等,按类型枚举生效)
- 具体使用案例如下:
lua
local result = CustomUI:SetProgressBarResId(playerId, uiId, "7482986899365911542-22886_7", ProgressImg.Background, 10100)SmoothChangeProgress
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否触发成功(无显式返回值时为nil)
- bool:
- 该方法的其他说明: 让进度条文本在指定时间内从起始值平滑变化到结束值
- 具体使用案例如下:
lua
--进度条2s内从3变化到50
local result = CustomUI:SmoothChangeProgress(playerId, uiId, elementId, 3, 50, 2)SetSpineAnimID
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置动画元件的动画ID/序列/播放模式
- 具体使用案例如下:
lua
local result = CustomUI:SetSpineAnimID(playerId, uiId, "7482986899365911542-22886_4", 10052, 1, ViedoPlayMode.Repeat)SmoothIncreaseProgress
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 让进度条文本在指定时间内按类型平滑变化(增加/减少/变化至)
- 具体使用案例如下:
lua
--进度条3s增加50
local result = CustomUI:SmoothIncreaseProgress(playerId, uiId, "7482986899365911542-22886_7", 3, 1, 50)SetFloatDamageTxt
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 在对象屏幕坐标附近显示浮动伤害文本,并按参数播放移动/渐隐效果
- 具体使用案例如下:
lua
local result = CustomUI:SetFloatDamageTxt(playerId, "7482986899365911542-22886_2", playerId, "test", 0xffffff, nil, nil, nil, nil, 1, nil, nil, 1)GetScreenSize
lua
local width, height = CustomUI:GetScreenSize(playerId)DeleteElement
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否删除成功
- bool:
- 该方法的其他说明: 删除UI元件
- 具体使用案例如下:
lua
local result = CustomUI:DeleteElement(playerId, uiId, "7482986899365911542-22886_7")SetBeaconBandPos
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置信标绑定位置坐标
- 具体使用案例如下:
lua
local result = CustomUI:SetBeaconBandPos(playerId, "7482986899365911542-22886_8", 0, 0, 0)SetBeaconObjId
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置信标绑定的对象ID
- 具体使用案例如下:
lua
local result = CustomUI:SetBeaconObjId(playerId, "7482986899365911542-22886_8", playerId)SetBeaconOffset
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置信标偏移量
- 具体使用案例如下:
lua
local result = CustomUI:SetBeaconOffset(playerId, "7482986899365911542-22886_8", 0, 0, 0)SetBeaconClampType
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置信标限制范围类型
- 具体使用案例如下:
lua
local result = CustomUI:SetBeaconClampType(playerId, "7482986899365911542-22886_8", BeaconClampType.Rectangle)SetBeaconRadius
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置信标显示半径
- 具体使用案例如下:
lua
local result = CustomUI:SetBeaconRadius(playerId, "7482986899365911542-22886_8", 128)SetBeaconMargin
- 参数及类型:
- 返回值及类型:
- bool:
boolean是否设置成功
- bool:
- 该方法的其他说明: 设置信标矩形限制范围
- 具体使用案例如下:
lua
local result = CustomUI:SetBeaconMargin(playerId, "7482986899365911542-22886_8", 128, 128)