代表向 TextService:FilterStringAsync() 的调用结果。用于根据过滤的字符串进行分配。
概要
方法
以正确过滤的方式返回指定的 Player.UserId 的文本。
为所有用户以正确过滤的方式返回文本。
以正确过滤的方式返回指定的 Player.UserId 文本,基于年龄和其他细节。
属性
方法
GetChatForUserAsync
该方法以适当的方式返回指定的 文本,使用最适合该用户的最限制性过滤器,同时强制两个用户的隐私设置。这应该在玩家之间的聊天上使用,虽然也有一些其他情况需要文本过滤。
返回的字符串只应该显示给目标用户,因为它可能不适合所有用户。
如果此方法抛出错误,该字符串不应该显示给用户。错误案例包括:
- 两个用户不允许聊天,例如如果 Chat:CanUserChatAsync() 将返回给定发送者和接收者的 false。
- ID为toUserId的用户当前服务器上未在线。
在大多数情况下,此函数会立即返回,即使目标用户刚刚加入服务器,其筛选信息尚未加载。
部分过时警告
从客户端调用此函数已过时,将在未来中禁用以返回空字符串。与聊天相关的文本筛选应通过 TextChatService 和经验完成,不正确筛选玩家生成的聊天文本可能会受到审核。
参数
Player.UserId 用户正在聊天。
返回
已过滤的文本字符串。
GetNonChatStringForBroadcastAsync
为所有用户以正确过滤的方式返回文本。这应该在每个用户都可以看到的非聊天文本的上下文中使用,例如用于允许用户在标志上写消息的对话,即使作者离开服务器后也对所有用户可见。
返回
已过滤的文本字符串。
GetNonChatStringForUserAsync
以正确过滤的方式返回指定的 Player.UserId 文本,基于年龄和其他细节。这应该在特定用户可以看到的非聊天文本的上下文中使用,例如宠物的名称。
参数
Player.UserId 用户想要查看/接收文本。
返回
已过滤的文本字符串。