代表 TextService:FilterStringAsync() 的結果。用於按照該結果分配過濾字串。
概要
方法
以正確過濾的方式返回指定的 Player.UserId 。
為所有用戶以正確過濾的方式返回文字。
以正確過濾的方式返回指定的 Player.UserId 基於年齡和其他細節。
屬性
方法
GetChatForUserAsync
此方法使用 Player.UserId 對指定 Chat 的文字以正確過濾的方式返回,並且在使用 Class.Chat 隱私設定的兩個用戶強制執行 2>Class.Player.2> 的過濾。這應該在玩家之間的聊天中使用,雖然有一些其他情況下需要過濾文字。
返回的字串只應該顯示給目標使用者,因為它可能不適合所有使用者。
如果此方法發生錯誤,字串應該不會顯示給用戶。錯誤的情況包括:
- 兩個用戶不允許聊天,例如如果 Chat:CanUserChatAsync() 將返回 false 給指定的發件人和接收人。
- 使用者沒有在當前服務伺服器上線上。
此功能在大多數情況下即可立即返回,雖然它會在目標用戶加入伺服器並且尚未載入過濾資訊時輸出。
參數
Player.UserId 的用戶正在聊天。
返回
過濾的文字字串。
GetNonChatStringForBroadcastAsync
為所有用戶以正確過濾的方式返回文字。這應該在每個用戶都可以看到的非聊天文字上使用,例如發送一個對話框,讓用戶在標誌上輸入一個訊息,並且在伺服器上的所有用戶都能看到。
返回
過濾的文字字串。
GetNonChatStringForUserAsync
以正確過濾的方式返回指定的 Player.UserId 文字,根據年齡和其他細節。這應該在特定用戶可以看到的非聊語文本中使用,例如寵物的名稱。
參數
Player.UserId 的玩家,即將看到/收到文字。
返回
過濾的文字字串。