Chat

聊天系统

 可以对玩家的语音和文本聊天进行控制

---

函数列表

SetVoiceChatRange

• 描述: 设置语音接收范围

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
PlayerIds	number[]	玩家ID数组
Range	number	接收范围,单位是米

local playerIdList = {}
table.insert(playerIdList, playerId)
Chat:SetVoiceChatRange(playerIdList, 10)

---

SetCanReceivePlayersVoiceChat

• 描述: 设置角色可接收的语音来源

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
ReceivePlayers	number[]	接收语音来源玩家ID数组
SendPlayers	number[]	发送语音的目标玩家ID数组

local ReceivePlayers = {Character:GetPlayerBySideAndIndex(0,1)}
local SendPlayers = {Character:GetPlayerBySideAndIndex(0,2)}
Chat:SetCanReceivePlayersVoiceChat(ReceivePlayers, SendPlayers)

---

SetCanReceivePlayersTextChat

• 描述: 设置角色可接收的文本聊天来源

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
ReceivePlayers	number[]	接收文本信息来源玩家ID数组
SendPlayers	number[]	发送文本信息的目标玩家ID数组

local ReceivePlayers = {Character:GetPlayerBySideAndIndex(0,1)}
local SendPlayers = {Character:GetPlayerBySideAndIndex(0,2)}
Chat:SetCanReceivePlayersTextChat(ReceivePlayers, SendPlayers)

---

SetCustomChatName

• 描述: 设置玩家昵称

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
PlayerId	number	玩家ID
Name	string	昵称

local playerId = Character:GetPlayerBySideAndIndex(0,1)
Chat:SetCustomChatName(playerId, "冠军")

---

SetNameVisible

• 描述: 设置昵称可见性

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
Visible	boolean	是否可见

Chat:SetNameVisible(false)

---

SetCustomHeadIcon

• 描述: 设置玩家头像

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
PlayerId	number	玩家ID
HeadIcon	string	头像ID

Chat:SetCustomHeadIcon(playerId, "T_UGC_UIEditor_YuanMeng_32")

---

GetCustomName

• 描述: 获取角色昵称

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
PlayerId	number	玩家ID

返回字段:

返回字段	字段类型	说明
Name	string	玩家昵称

local name = Chat:GetCustomName(playerId)

---

GetPlayerVoiceChatRange

• 描述: 获取角色语音接收范围

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
PlayerId	number	玩家ID

返回字段:

返回字段	字段类型	说明
Range	number	语音接收范围,单位米

local range = Chat:GetPlayerVoiceChatRange(playerId)

---

GetCustomHeadIcon

• 描述: 获取角色头像

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
PlayerId	number	玩家ID

返回字段:

返回字段	字段类型	说明
HeadIcon	string	角色头像ID

local icon = Chat:GetCustomHeadIcon(playerId)

---

SetNativeUIVisible

• 描述: 设置原生控件是否可见

• 范围: 客户端

参数列表:

参数	类型	说明
Visible	boolean	是否可见

Chat:SetNativeUIVisible(false)

---