UI

自定义界面

 提供自定义界面的操作接口

---

枚举列表

UI.AvatarType

• 描述: 头像昵称框设置类型

成员名称	成员说明
Icon	图标
NickName	昵称
Both	图标和昵称

UI.ChatPage

• 描述: 聊天页签

成员名称	成员说明
QuickChat	快捷聊天
Chat	聊天
Reserve	预约

UI.UIType

• 描述: 界面类型

成员名称	成员说明
Promotion	竞速的晋级界面
Countdown	竞速的倒计时界面
TargetPoints	竞速目标积分
CampPoints	竞速双阵营积分
PersonalPoints	竞速个人积分
Leaderboard	竞速排行榜
HealthBar	通用血条
Settings	通用设置
RemainingPlayers	FPS剩余人数
MapHint	通用地图提示
EmotesAndActions	表情|动作
QuickChat	快捷聊天
MapCover	地图封面
MoreSetting	更多设置
Photo	拍照
GameSetting	游戏设置
GameQuit	游戏退出

UI.WidgetType

• 描述: 控件类型

成员名称	成员说明
Countdown	倒计时文本
HP	初始生命值
LifeCount	初始生命数
YuanTeam	元元队
MengTeam	梦梦队
Goal	目标
CurPoint	当前积分
GoalPoint	目标积分
Defeat	击败
RemainPlayer	剩余人数
Title	通关人数标题文本
VictoryPlayer	已通关人数
MaxVictoryPlayers	最多通关人数
QuickChat_1	快捷聊天第一项
QuickChat_2	快捷聊天第二项
QuickChat_3	快捷聊天第三项
QuickChat_4	快捷聊天第四项
QuickChat_5	快捷聊天第五项
QuickChat_6	快捷聊天第六项
QuickChat_7	快捷聊天第七项
QuickChat_8	快捷聊天第八项
QuickChat_9	快捷聊天第九项

UI.TextAlignV

• 描述: 文本垂直对齐方式

成员名称	成员说明
Top	顶部
Center	中心
Bottom	底部

UI.TextAlignH

• 描述: 文本水平对齐方式

成员名称	成员说明
Left	左对齐
Center	中心对齐
Right	右对齐

UI.Font

• 描述: 字体样式

成员名称	成员说明
Font1	字体1
Font2	字体2

UI.AnchorType

• 描述: 锚点类型

成员名称	成员说明
LeftTop	左上角
TopMiddle	顶中
RightTop	右上角
LeftMiddle	左中
RightMiddle	右中
LeftBottom	左下角
BottomMiddle	下中
RightBottom	右下角
Center	中部
XTopStretch	横上轴
XMiddleStretch	横中轴
XBottomStretch	横底轴
YLeftStretch	竖左轴
YMiddleStretch	竖中轴
YRightStretch	竖右轴
XYStretch	双轴

---

函数列表

SetVisible

• 描述: 设置控件的显隐

• 范围: 客户端

• 警告: SetVisible设为false或控件隐藏时，部分控件接口不生效，例如SetPosition、GetPosition等。请留意这部分控件接口相应的说明。如果控件在不显示的情况下又要能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
Visible	boolean	true显示控件，false隐藏控件

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetVisible(listItem,false) -- 传入一组需要改变的一组UID

---

SetText

• 描述: 改变控件的文本内容

• 范围: 客户端

参数列表:

参数	类型	说明
ListItemUID	number[]|string[]	UI控件的UID数组
NewText	string	变更的文本内容

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetText(listItem,"NewText") -- 传入一组需要改变的一组UID

---

SetSize

• 描述: 改变控件的尺寸

• 范围: 客户端

• 警告: 如果在控件在组内，在游戏中需要至少设置一次锚点，否则控件位置会不准确（如消失在屏幕外）

• 警告: 也可在编组后修改一次组内控件的位置

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
NewWidth	number	变更的控件宽度
NewHeight	number	变更的控件高度

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetSize(listItem,50,50) -- 传入一组需要改变的一组UID

---

GetSize

• 描述: 获取控件的尺寸

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
ItemUID	number	控件ID

返回字段:

返回字段	字段类型	说明
Size	{X:number,Y:number}	返回大小{X,Y}

local size = UI:GetSize(ItemUID)
local X = size.X
local Y = size.Y

---

GetPosition

• 描述: 获取控件的位置

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
ItemUID	number	控件ID

返回字段:

返回字段	字段类型	说明
Size	{X:number,Y:number}	返回位置{X,Y}

local pos = UI:GetPosition(ItemUID)  -- 以屏幕中心点为锚点，x的正方向是向右偏移，y的正方向是向下偏移
local X = pos.X
local Y = pos.Y

---

SetPosition

• 描述: 改变控件的位置

• 范围: 客户端

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
NewX	number	变更的X坐标
NewY	number	变更的Y坐标

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetPosition(listItem,200,300) -- 传入一组需要改变的一组UID，以屏幕中心点为锚点，x的正方向是向右偏移，y的正方向是向下偏移

---

SetTransparency

• 描述: 改变控件的不透明度

• 范围: 客户端

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
NewOpacity	number	变更的不透明度[0,1]

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetTransparency(listItem,0.5) -- 传入一组需要改变的一组UID

---

SetTextColor

• 描述: 改变控件的文本颜色

• 范围: 客户端

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
Color	string	十六进制颜色码

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetTextColor(listItem,"#23E0F0") -- 传入一组需要改变的一组UID

---

SetTextSize

• 描述: 改变控件的文本字体大小

• 范围: 客户端

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
NewFontSize	number	变更的字体大小[15,100]

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetTextSize(listItem,50) -- 传入一组需要改变的一组UID

---

SetImage

• 描述: 改变控件的底图

• 范围: 客户端

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
ImageId	number|string	图片ID
IsCustomImage	boolean	是否使用自定义图片,默认为false，可不填

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetImage(listItem, 10000001) -- 使用图片ID
UI:SetImage(listItem, 1234567890123, true) -- 使用自定义图片id

---

SetProgressMaxValue

• 描述: 改变进度条最大值

• 范围: 客户端

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
MaxValue	number	[0,100]

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetProgressMaxValue(listItem,20) -- 传入一组需要改变的一组UID

---

SetProgressCurrentValue

• 描述: 改变进度条当前值

• 范围: 客户端

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
CurretValue	number	进度条当前值

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetProgressCurrentValue(listItem,20) -- 传入一组需要改变的一组UID

---

SetPlayerIconAndName

• 描述: 根据玩家id设置头像昵称框

• 范围: 客户端

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
PlayerId	number	玩家的UID
AvatarType	UI.AvatarType	设置类型：Icon|NickName|Both

local listItem = {}
table.insert(listItem,WidgetID)
local playerId = Character:GetLocalPlayerId()
UI:SetPlayerIconAndName(listItem,playerId,UI.AvatarType.Both) -- 传入一组需要改变的一组UID

---

SetProgressBackgroundImage

• 描述: 改变进度条的底图

• 范围: 客户端

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
ImageId	number	图片ID
IsCustomImage	boolean	是否使用自定义图片,默认为false，可不填

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetProgressBackgroundImage(listItem, 10000001)  -- 使用图片ID
UI:SetProgressBackgroundImage(listItem, 1234567890123，true) -- 使用自定义图片id

---

SetPositionByAnchor

• 描述: 通过锚点参数改变控件的位置

• 范围: 客户端

• 警告: 在控件显示时使用

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
Data	{X:number,Y:number,Left:number,Right:number,Bottom:number,Top:number}	需要变更的数据

local listItem = {}
table.insert(listItem,WidgetID)
local Data = {
   X = 0,
   Y = 0,
   Left = 100,
   Right = 200,
   Bottom = 100,
   Top = 200
}
UI:SetPositionByAnchor(listItem,Data)   --需要在编辑器中修改锚点类型 然后根据可传的参数传对应的 这边用了双侧 所以除了XY都能改

---

GetAnchoredPosition

• 描述: 获取控件以锚点为参考的位置,不同锚点使用的值不同，不使用的属性默认为0

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
ItemUID	number	UI控件的UID数组

返回字段:

返回字段	字段类型	说明
Data	{X:number,Y:number,Left:number,Right:number,Bottom:number,Top:number}	以锚点为参考的位置数据

local Data = UI:GetAnchoredPosition(ItemUID)
local X = Data.X
local Y = Data.Y
local Left = Data.Left
local Right = Data.Right
local Bottom = Data.Bottom
local Top = Data.Top

---

SetImageColor

• 描述: 改变控件的底图颜色

• 范围: 客户端

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
Color	string	十六进制颜色码

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetImageColor(listItem,"#23E0F0")

---

RegisterPressed

• 描述: 注册控件按下时回调

• 范围: 客户端

• 警告: 不支持填入组的实例ID，如有需要可通过获取组的子控件循环注册来实现。

参数列表:

参数	类型	说明
ItemUID	number	UI控件的UID
Callback	function(ItemUID:number,PosX:number,PosY:number)	回调函数

UI:RegisterPressed(WidgetID,function(ItemUID)
  UI:ShowMessageTip(tostring(ItemUID))
end)

---

UnRegisterPressed

• 描述: 取消控件按下时的回调

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	UI控件的UID

UI:UnRegisterPressed(WidgetID)

---

RegisterReleased

• 描述: 注册控件弹起时回调

• 范围: 客户端

• 警告: 不支持填入组的实例ID，如有需要可通过获取组的子控件循环注册来实现。

参数列表:

参数	类型	说明
ItemUID	number	UI控件的UID
Callback	function(ItemUID:number,PosX:number,PosY:number)	回调函数

UI:RegisterReleased(WidgetID,function(ItemUID)
  UI:ShowMessageTip(tostring(ItemUID))
end)

---

UnRegisterReleased

• 描述: 取消控件弹起时的回调

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	UI控件的UID

UI:UnRegisterReleased(WidgetID)

---

RegisterMoved

• 描述: 注册控件移动时回调,要在按钮UI打开“允许拖动”

• 范围: 客户端

• 警告: 不支持填入组的实例ID，如有需要可通过获取组的子控件循环注册来实现。

参数列表:

参数	类型	说明
ItemUID	number	UI控件的UID
Callback	function(ItemUID:number,PosX:number,PosY:number)	回调函数

UI:RegisterMoved(WidgetID,function(ItemUID)
  UI:ShowMessageTip(tostring(ItemUID))
end)

---

UnRegisterMoved

• 描述: 取消控件移动时的回调

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	UI控件的UID

UI:UnRegisterMoved(WidgetID)

---

RegisterClicked

• 描述: 注册控件点击时回调

• 范围: 客户端

• 警告: 不支持填入组的实例ID，如有需要可通过获取组的子控件循环注册来实现。

参数列表:

参数	类型	说明
ItemUID	number	UI控件的UID
Callback	function(ItemUID:number)	回调函数

UI:RegisterClicked(WidgetID,function(ItemUID)
  UI:ShowMessageTip(tostring(ItemUID))
end)

---

UnRegisterClicked

• 描述: 取消控件点击时的回调

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	UI控件的UID

UI:UnRegisterClicked(WidgetID)

---

OpenQuickChat

• 描述: 打开聊天界面并设置打开时显示的默认页签。

• 范围: 客户端

参数列表:

参数	类型	说明
ChatPage	UI.ChatPage	默认页签：快捷聊天”0”、聊天”1”、预约”2”。

UI:OpenQuickChat(UI.ChatPage.QuickChat)

---

GetText

• 描述: 获取控件的文本内容

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	UI控件的UID

返回字段:

返回字段	字段类型	说明
textString	string	返回控件的文本 默认为""

UI:GetText(10001)

---

ShowMessageTip

• 描述: 对玩家屏幕展示信息

• 描述: 可用于制作提示弹窗，制作时测试API所在事件是否触发等。

• 范围: 客户端

参数列表:

参数	类型	说明
Msg	string	消息

UI:ShowMessageTip("showtip")

---

SetNativeInterfaceVisible

• 描述: 设置原生界面的可见性

• 范围: 客户端

参数列表:

参数	类型	说明
UIType	UI.UIType	界面类型
bVisible	boolean	可见性

UI:SetNativeInterfaceVisible(UI.UIType.Countdown,false)

---

SetNativeWidgetColor

• 描述: 设置原生控件的颜色

• 范围: 客户端

参数列表:

参数	类型	说明
WidgetType	UI.WidgetType	控件类型
Color	string	十六进制颜色码

UI:SetNativeWidgetColor(UI.WidgetType.Countdown,"#23E0F0")

---

SetNativeWidgetText

• 描述: 设置原生控件的文本内容

• 描述: ui初始化较晚，在GameStart中使用可能会被覆盖

• 范围: 客户端

• 警告: 生命值和生命数不支持更改

参数列表:

参数	类型	说明
WidgetType	UI.WidgetType	控件类型
txtStr	string	文本内容

UI:SetNativeWidgetText(UI.WidgetType.YuanTeam,"text")   -- 地图设置里显示击败数可以看到效果

---

SetAngle

• 描述: 设置控件旋转角度

• 范围: 客户端

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
Angle	number	角度

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetAngle(ListItemUID, Angle)

---

GetAngle

• 描述: 获取控件旋转角度

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	控件ID

返回字段:

返回字段	字段类型	说明
Angle	number	角度

local Angle = UI:GetAngle(ItemUID)

---

SetWidgetCenter

• 描述: 设置控件中心点,中心点偏移影响通过锚点参数改变控件坐标（SetPositionByAnchor）的计算

• 描述: 对组无效

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
ListItemUID	number[]	UI控件的UID数组
AlignmentX	number	中心的X（0-1）
AlignmentY	number	中心的Y（0-1）

local listItem = {}
table.insert(listItem,WidgetID)
UI:SetWidgetCenter(listItem, 0.7,0.7)

---

GetWidgetCenter

• 描述: 获取控件中心点

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
ItemUID	number	控件ID

返回字段:

返回字段	字段类型	说明
Center	{AlignmentX:number,AlignmentY:number}	中心点数据

local Center = UI:GetWidgetCenter(ItemUID)
local AlignmentX = Center.AlignmentX
local AlignmentY = Center.AlignmentY

---

PlayUIAnimation

• 描述: 播放UI动画

• 范围: 客户端

• 警告: 游戏开始时立即使用无效

参数列表:

参数	类型	说明
ItemUID	number	控件ID
AnimationIndex	number	动画序号
startFrameIndex	number	起始帧

UI:PlayUIAnimation(ItemUID, AnimationIndex, startFrameIndex)

---

StopUIAnimation

• 描述: 停止UI动画

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	控件ID

UI:StopUIAnimation(ItemUID)

---

PauseUIAnimation

• 描述: 暂停UI动画

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	控件ID
AnimationIndex	number	动画序号

UI:PauseUIAnimation(ItemUID,AnimationIndex)

---

ResumeUIAnimation

• 描述: 恢复UI动画

• 范围: 客户端

• 警告: 游戏开始时立即使用无效

参数列表:

参数	类型	说明
ItemUID	number	控件ID
AnimationIndex	number	动画序号

UI:ResumeUIAnimation(ItemUID, AnimationIndex)

---

SetTextSpace

• 描述: 设置字距大小

• 范围: 客户端

• 警告: 游戏开始时立即使用无效，仅支持文本类控件。

参数列表:

参数	类型	说明
ItemUID	number	控件ID
Space	number	字距

UI:SetTextSpace(ItemUID, Space)

---

GetTextSpace

• 描述: 获取字距大小

• 范围: 客户端

• 警告: 游戏开始时立即使用无效，仅支持文本类控件。

参数列表:

参数	类型	说明
ItemUID	number	控件ID

返回字段:

返回字段	字段类型	说明
Space	number	字距

local Space = UI:GetTextSpace(ItemUID)

---

SetTextAlignH

• 描述: 设置文本水平对齐方式

• 范围: 客户端

• 警告: 游戏开始时立即使用无效，仅支持文本类控件。

参数列表:

参数	类型	说明
ItemUID	number	控件ID
Alignment	UI.TextAlignH	水平对齐方式

UI:SetTextAlignH(ItemUID, UI.TextAlignH.Right)

---

SetTextAlignV

• 描述: 设置文本垂直对齐方式

• 范围: 客户端

• 警告: 游戏开始时立即使用无效，仅支持文本类控件。

参数列表:

参数	类型	说明
ItemUID	number	控件ID
Alignment	UI.TextAlignV	垂直对齐方式

UI:SetTextAlignV(ItemUID, UI.TextAlignV.Bottom)

---

SetTextBold

• 描述: 设置文字加粗

• 范围: 客户端

• 警告: 游戏开始时立即使用无效，仅支持文本类控件。

参数列表:

参数	类型	说明
ItemUID	number	控件ID
IsBold	boolean	是否加粗

UI:SetTextBold(ItemUID, true)

---

SetTextEdge

• 描述: 设置文字描边

• 范围: 客户端

• 警告: 游戏开始时立即使用无效，仅支持文本类控件。

参数列表:

参数	类型	说明
ItemUID	number	控件ID
IsEdge	boolean	是否描边
Color	string	描边颜色，十六进制颜色码：#FFFFFFFF
Size	number	描边尺寸
Alpha	number	描边透明度

UI:SetTextEdge(ItemUID, true, "#23E0F0FF", 10, 0.5)

---

SetTextFont

• 描述: 设置字体

• 范围: 客户端

• 警告: 游戏开始时立即使用无效，仅支持文本类控件。

参数列表:

参数	类型	说明
ItemUID	number	控件ID
Font	UI.Font	字体样式

UI:SetTextFont(ItemUID, UI.Font)

---

SetPlayerNameVisible

• 描述: 设置玩家昵称可见性

• 范围: 客户端

• 警告: 游戏开始时立即使用无效

参数列表:

参数	类型	说明
ItemUID	number	控件ID
IsVisible	boolean	是否显示

UI:SetPlayerNameVisible(ItemUID, IsVisible)

---

SetPlayerIconVisible

• 描述: 设置玩家头像可见性

• 范围: 客户端

• 警告: 游戏开始时立即使用无效

参数列表:

参数	类型	说明
ItemUID	number	控件ID
IsVisible	boolean	是否显示

UI:SetPlayerIconVisible(ItemUID, IsVisible)

---

DuplicateWidget

• 描述: 复制UI控件

• 描述: 坐标基于屏幕中心

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	控件ID
NewX	number	X坐标
NewY	number	Y坐标

返回字段:

返回字段	字段类型	说明
UID	number	新控件的UID

UI:DuplicateWidget(ItemUID, NewX, NewY)

---

SetParent

• 描述: 设置控件的父节点

• 描述: 父节点需传入组id，创建组可在界面编辑中的管理界面进行编组

• 描述: 复制出的控件设置父节点SetParent后位置会改变，需重新设置位置

• 范围: 客户端

• 警告: 组最多嵌套4层。

参数列表:

参数	类型	说明
ItemUID	number	控件ID
NewParentUID	number	父节点ID

UI:SetParent(ItemUID, NewParentUID)

---

GetParent

• 描述: 获取控件的父节点(组)

• 描述: 创建组可在界面编辑中的管理界面进行编组

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	控件ID

返回字段:

返回字段	字段类型	说明
ParentUID	number	父节点ID

local ParentID = UI:GetParent(ItemUID)

---

GetAllChildren

• 描述: 获取父节点(组)的所有子控件

• 描述: 创建组可在界面编辑中的管理界面进行编组

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
ItemUID	number	控件ID

返回字段:

返回字段	字段类型	说明
Children	number[]	子控件ID

local Children = UI:GetAllChildren(ItemUID)
for key, value in pairs(Children) do
    local ItemID = value
end

---

GetWidgetChildCount

• 描述: 获取父节点(组)的子控件数量

• 描述: 创建组可在界面编辑中的管理界面进行编组

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
ItemUID	number	控件ID

返回字段:

返回字段	字段类型	说明
Count	number	子控件数量

local Count = UI:GetWidgetChildCount(ItemUID)

---

ScreenPositionToUIPosition

• 描述: 屏幕坐标转为UI坐标,需要指定控件，不同控件可能最后转换的结果不同

• 范围: 客户端

参数列表:

参数	类型	说明
ScreenPos	{X:number,Y:number}	屏幕坐标
ItemUID	number	控件ID

返回字段:

返回字段	字段类型	说明
UIPos	{X:number,Y:number}	控件坐标系下的坐标

local wPos = Element:GetPosition(ElementId)
local sPos = MiscService:WorldToScreenPoint(wPos)
local Pos = UI:ScreenPositionToUIPosition(sPos,ItemUID)
UI:SetPosition({ItemUID},Pos.X,Pos.Y)

---

SetChatContentVisible

• 描述: 设置聊天内容框是否显示

• 范围: 客户端

• 警告: 游戏开始时立即使用无效

参数列表:

参数	类型	说明
ItemUID	number	控件ID
IsVisible	boolean	是否显示

UI:SetChatContentVisible(ItemUID, false)

---

SetChatInputVisible

• 描述: 设置聊天输入框是否显示

• 范围: 客户端

• 警告: 游戏开始时立即使用无效

参数列表:

参数	类型	说明
ItemUID	number	控件ID
IsVisible	boolean	是否显示

UI:SetChatInputVisible(ItemUID, false)

---

FindChildWithName

• 描述: 根据名字获取子控件ID

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	父控件ID
Name	string	子控件名字

返回字段:

返回字段	字段类型	说明
ChildID	number	子控件ID

local childID = UI:FindChildWithName(ItemUID, Name)

---

FindChildWithIndex

• 描述: 根据索引获取子控件ID

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	父控件ID
Index	number	子控件索引

返回字段:

返回字段	字段类型	说明
ChildID	number	子控件ID

local childID = UI:FindChildWithIndex(ItemUID, Index)

---

FindWidgetWithPath

• 描述: 根据路径获取控件ID

• 范围: 客户端

参数列表:

参数	类型	说明
Path	string	路径（xx.yy…）

返回字段:

返回字段	字段类型	说明
ItemID	number	控件ID

local ItemID = UI:FindWidgetWithPath("组1.控件1")

---

SetProgressBackgroundOverlayColor

• 描述: 设置进度条背景叠加色

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	控件ID
Color	string	十六进制颜色码 Alpha固定FF

UI:SetProgressBackgroundOverlayColor(ItemUID,"#EF1414")

---

SetProgressOverlayColor

• 描述: 设置进度条叠加色

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	控件ID
Color	string	十六进制颜色码 Alpha固定FF

UI:SetProgressOverlayColor(ItemUID,"#EF1414")

---

SetDraggable

• 描述: 设置控件允许拖动

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	控件ID
Draggable	boolean	是否允许拖动

UI:SetDraggable(ItemUID, true)

---

EffectStartPlay

• 描述: 动效控件进行播放

• 范围: 客户端

• 警告: 只有在动效控件没有在进行播放时使用才生效

参数列表:

参数	类型	说明
ItemUID	number	动效控件ID

UI:EffectStartPlay(ItemUID)

---

EffectPausePlay

• 描述: 动效控件暂停播放

• 范围: 客户端

• 警告: 只有在动效控件正在进行播放时使用才生效

参数列表:

参数	类型	说明
ItemUID	number	动效控件ID

UI:EffectPausePlay(ItemUID)

---

EffectResumePlay

• 描述: 动效控件恢复播放

• 范围: 客户端

• 警告: 只有在动效控件处于暂停状态时使用才生效

参数列表:

参数	类型	说明
ItemUID	number	动效控件ID

UI:EffectResumePlay(ItemUID)

---

SetHittable

• 描述: 设置按钮是否接收点击

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	控件ID
Hittable	boolean	是否接收点击

UI:SetHittable(ItemUID, true)

---

SetAllHittable

• 描述: 设置所有按钮是否接收点击

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
Hittable	boolean	是否接收点击

UI:SetAllHittable(true)

---

GetWidgetByLevel

• 描述: 获取指定层级UI

• 描述: 数字越小越靠上 取最上层为1

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
Level	number	层级
GroupID	number	指定组控件ID，填0或不填则默认查找根节点

返回字段:

返回字段	字段类型	说明
ItemID	number	控件ID

local ItemID = UI:GetWidgetByLevel(1,GroupID)

---

SetWidgetZOrder

• 描述: 设置控件叠放顺序

• 描述: 数字越大越靠上，可以先获取需要覆盖上去的控件的ZOrder再设置

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
ItemID	number	控件ID
ZOrder	number	叠放顺序

local ItemID = UI:GetWidgetByLevel(1)
local ZOrder = UI:GetWidgetZOrder(ItemID)
UI:SetWidgetZOrder(OtherItemID,ZOrder+1)

---

GetWidgetZOrder

• 描述: 获取控件叠放顺序

• 描述: 数字越大越靠上

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
ItemID	number	控件ID

返回字段:

返回字段	字段类型	说明
ZOrder	number	叠放顺序

local ItemID = UI:GetWidgetByLevel(1)
local ZOrder = UI:GetWidgetZOrder(ItemID)
UI:SetWidgetZOrder(OtherItemID,ZOrder+1)

---

SetAnchorType

• 描述: 设置锚点类型

• 范围: 客户端

参数列表:

参数	类型	说明
ItemID	number	控件ID
AnchorType	UI.AnchorType	锚点类型

UI:SetAnchorType(ItemID,UI.AnchorType.LeftTop)

---

CheckWidgetByScreenPosition

• 描述: 从屏幕坐标检测首个控件

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

参数列表:

参数	类型	说明
ScreenPos	{X:number,Y:number}	屏幕坐标
IncludeGroup	boolean	是否包含组，如果不包含组，则检测组内部的控件，包含组时则返回组而不是内部的控件
GroupID	number	指定组控件ID，填0或不填则默认检测根节点

返回字段:

返回字段	字段类型	说明
ItemID	number	控件ID

System:RegisterEvent(Events.ON_TOUCH_SCREEN_PRESSED,
function(x,y)
    Log:PrintLog("ON_TOUCH_SCREEN_PRESSED",x,y)
    local id = UI:CheckWidgetByScreenPosition({X=x,Y=y},false,0)
    Log:PrintLog("ON_TOUCH_SCREEN_PRESSED",id)
end)

---

MoveTo

• 描述: 让控件移动到指定位置

• 范围: 客户端

• 警告: 需要控件显示才生效，如需控件在不显示的情况下又能进行其他操作，可以使用SetTransparency将不透明度设为0

• 警告: 不可以在游戏开始时立即使用

参数列表:

参数	类型	说明
ItemUID	number	控件ID
Postion	{X:number,Y:number}	目标位置<X,Y>
Duration	number	运动时间

UI:MoveTo(ItemUID,{X=740,Y = 564},0.5)

---

OpenMidJoinInvitePanel

• 描述: 打开邀请好友界面

• 描述: 不可以在游戏开始时立即使用,仅多人模式下可用，并且地图需要开启中途加入

• 范围: 客户端

UI:OpenMidJoinInvitePanel()

---

InitListView

• 描述: 初始化列表数据

• 范围: 客户端

参数列表:

参数	类型	说明
ListViewId	number	列表控件ID
ItemDataList	any[]	列表Item数据数组，数组值为Item自定义数据

返回字段:

返回字段	字段类型	说明
itemIndexList	number[]	列表Item对应的列表索引数组

local ItemDataList = {}
for i = 1, 10 do
    ItemDataList[i] = {showText = "Item " .. i}
end
local itemIndexList = UI:InitListView(100051, ItemDataList)

---

UpdateListViewItem

• 描述: 更新单个列表数据

• 范围: 客户端

参数列表:

参数	类型	说明
ListViewId	number	列表控件ID
ItemIndex	number	列表Item对应的列表索引
ItemData	table	列表Item新的数据

local ItemDataList = {}
for i = 1, 10 do
    ItemDataList[i] = {showText = "Item " .. i}
end
local itemIndexList = UI:InitListView(100051, ItemDataList)
UI:UpdateListViewItem(100051, itemIndexList[1], {showText = "Item 11"}) --更新第一个Item数据

---

GetListViewItemUID

• 描述: 获取列表中某个Item的控件UID

• 范围: 客户端

参数列表:

参数	类型	说明
ListViewId	number	列表控件ID
ItemIndex	number	列表Item对应的索引
UID	number	Item中指定控件对应的实例Id，如果Item是一个组，则填组里面实际进行操控的控件UID

返回字段:

返回字段	字段类型	说明
UseUId	string	可以对列表Item对应的控件真正进行操控的UID

local UID = UI:GetListViewItemUID(listViewId, itemIndex, 100048) --获取列表中某个Item的控件UID

---

SetListViewItemSetCall

• 描述: 设置列表Item创建回调

• 范围: 客户端

参数列表:

参数	类型	说明
ListViewId	number	列表控件ID
SetCall	function(listViewId:number,itemIndex:number,itemData:any)	Item创建回调，itemData为ItemDataList[index]

local ItemDataList = {}
for i = 1, 10 do
    ItemDataList[i] = {showText = "Item " .. i}
end
local itemIndexList = UI:InitListView(100051, ItemDataList) --初始化列表数据
local SetCall = function(listViewId, itemIndex, itemData)
  local UID = UI:GetListViewItemUID(listViewId, itemIndex, 100048) --获取显示Item的控件UID
  UI:SetText({UID}, itemData.showText) --设置Item控件文本
end
UI:SetListViewItemSetCall(100051, SetCall)

---

SetListViewItemSelectionChangeCall

• 描述: 设置列表Item选中状态变化回调

• 范围: 客户端

参数列表:

参数	类型	说明
ListViewId	number	列表控件ID
SelectionChangeCall	function(listViewId:number,itemIndex:number,itemData:any,select:boolean)	Item选中回调，itemData为ItemDataList[index], select为选中状态

local ItemDataList = {}
for i = 1, 10 do
    ItemDataList[i] = {showText = "Item " .. i}
end
local itemIndexList = UI:InitListView(100051, ItemDataList)
local SelectionChangeCall = function(listViewId, itemIndex, itemData, select)
  local UID = UI:GetListViewItemUID(listViewId, itemId, 100049)
  if select then
      UI:SetImage({UID}, 10000010)
  else
      UI:SetImage({UID}, 10000007)
  end
end
UI:SetListViewItemSelectionChangeCall(100051, SelectionChangeCall)

---

AddToScrollView

• 描述: 向滚动列表中添加控件

• 范围: 客户端

参数列表:

参数	类型	说明
ScrollViewId	number	滚动列表控件ID
UIDs	number[]	要添加进滚动列表的控件ID数组

UI:AddToScrollView(100051, {100052, 100053})

---

RemoveFromScrollView

• 描述: 从滚动列表中移除控件

• 范围: 客户端

参数列表:

参数	类型	说明
ScrollViewId	number	滚动列表控件ID
UIDs	number[]	要从滚动列表中移除的控件ID数组

UI:RemoveFromScrollView(100051, {100052, 100053})

---

UIPositionToScreenPosition

• 描述: UI坐标转为屏幕坐标,需要指定控件，不同控件可能最后转换的结果不同

• 范围: 客户端

参数列表:

参数	类型	说明
UIPos	{X:number,Y:number}	控件坐标系下的坐标
ItemUID	number	控件ID

返回字段:

返回字段	字段类型	说明
ScreenPos	{X:number,Y:number}	屏幕坐标

local Pos = UI:GetPosition(ItemUID)
local sPos = UI:UIPositionToScreenPosition(Pos,ItemUID)

---

GetImageNativeSize

• 描述: 获取图片原生尺寸，自定义图片以设置的压缩尺寸为准

• 范围: 客户端

参数列表:

参数	类型	说明
ImageId	number	图片ID
IsCustomImage	boolean	是否为自定义图片
Callback	function(Width:number,Height:number)	获取图片原生尺寸回调,Width为图像宽，Height为图像高

local img = CustomProperty:GetCustomProperty(971,"Image",CustomProperty.PROPERTY_TYPE.Image)
UI:GetImageNativeSize(img, true, function(Width, Height)
    UI:SetImage({100535},img,true)
    UI:SetSize({100535},Width,Height)
end)

---

SetEffectLoop

• 描述: 设置动效是否循环播放

• 范围: 客户端

• 警告: 仅对可设置循环播放的动效有效

参数列表:

参数	类型	说明
ItemUID	number	动效控件ID
IsLoop	boolean	是否循环播放
LoopTime	number	循环播放时间，单位秒

UI:SetEffectLoop(100235, true, 15)

---

GetUIName

• 描述: 获取UI控件的名称

• 范围: 客户端

参数列表:

参数	类型	说明
ItemUID	number	控件ID

返回字段:

返回字段	字段类型	说明
UIName	string	UI控件名称

local UIName = UI:GetUIName(100235)

---

GetUISize

• 描述: 获取UI系统分辨率

• 范围: 客户端

返回字段:

返回字段	字段类型	说明
UISize	{X:number,Y:number}	UI系统分辨率

local UISize = UI:GetUISize()

---

SetRenderScale

• 描述: 设置UI控件渲染时的整体缩放，Scale不会影响Size属性,只影响最终显示的大小

• 范围: 客户端

• 警告: 缩放后的控件暂时无法使用GetAnchoredPosition和SetPositionByAnchor

参数列表:

参数	类型	说明
ItemUID	number	控件ID
ScaleX	number	X轴缩放
ScaleY	number	Y轴缩放

UI:SetRenderScale(100235,0.9,0.9)

---