クライアント側のチャットモジュール

このガイドでは、レガシーチャットシステムのクライアント側チャットモジュールをカバーし、使用が廃止され、より簡単で現代的なチャット設定で新規ユーザーのオンボードが行われなくなったため、TextChatService でより簡単でより現代的なチャット設定に変更しました。デフォルトのチャットシステム TextChatService によって駆動されている場合は、体験内テキストチャットを参照してください。

次のチャットモジュールを使用して、レガシーチャットシステムのクライアント側の動作をサポートできます。

チャットウィンドウ

チャットウィンドウはレガシーチャットシステムのクライアント側のメインチャットモジュールです。

手法

チャンネルを追加する

パラメータ: string : channelName
説明: 指定された ChatChannelUI をウィンドウに追加します。
返却: ChatChannelUI

チャネルを削除

パラメータ: string : channelName
説明: 指定された ChatChannelUI をウィンドウから削除します。
返り値: 無効

Get Channel を取得

パラメータ: string : channelName
説明: 指定された ChatChannelUI を入手します。存在する場合。
返却: ChatChannelUI または nil

GetCurrentチャネル

パラメータ: string : channelName
説明: 現在の ChatChannelUI を返します。
返却: ChatChannelUI

切り替え現在のチャネル

パラメータ: string : channelName
説明: 現在のチャネルを、指定された ChatChannelUI に切り替えます。存在する場合は、channelName 。
返り値: 無効

可視化する GetVisible

パラメータ: なし
説明: ウィンドウが表示されているかどうかを返します。注: これは一全般的なチャット UI に言及します; チャットウィンドウが非アクティブにより透明になったとき、ウィンドウはまだ見えると考えられます。
返す: ブール

可視性を設定する

パラメータ: bool : visible
説明: チャットウィンドウの表示を設定します。
返り値: 無効

フェードアウトバックグラウンド

パラメータ: float : duration
説明: 秒で指定された背景を消します。 duration注: 後でフェードイン/アウトを制御する呼び出しは、以前の呼び出しを上書きします。
返り値: 無効

フェードインバックグラウンド

パラメータ: float : duration
説明: 秒で背景に消える duration が指定されます。注: 後でフェードイン/アウトを制御する呼び出しは、以前の呼び出しを上書きします。
返り値: 無効

フェードアウトテキスト

パラメータ: float : duration
説明: 秒で指定された duration のテキストを消します。注: 後でフェードイン/アウトを制御する呼び出しは、以前の呼び出しを上書きします。
返り値: 無効

フェードインテキスト

パラメータ: float : duration
説明: 秒で指定された duration のテキストにフェードします。注: 後でフェードイン/アウトを制御する呼び出しは、以前の呼び出しを上書きします。
返り値: 無効

チャットBar

The チャットバーは、Lua チャットシステムのクライアント側のテキスト入力を処理します。チャットバーには 2つの重要なコンポーネントがあります：

チャットバー、a TextBox) 、プレイヤーがメッセージとコマンドを入力する場所 (オレンジで強調)
メッセージモード、送信中のメッセージに関する情報を表示できる TextLabel 、（緑で強調）

手法

TextBox を取得

パラメータ: なし
説明: チャットバーの TextBox を返す。
返却: TextBox

GetMessageModeTextLabel

パラメータ: なし
説明: メッセージモードを返します TextLabel。
返却: TextLabel

焦点合致

パラメータ: なし
説明: チャットバーの TextBox が焦点にあるかどうかを返します (プレイヤーが箱に入力しています)。GetTextBox の結果に TextBox:IsFocused を呼び出すことと同等
返す: ブール

キャプチャフォーカス

パラメータ: なし
説明: クライアントにチャットバーのに焦点を合わせるように強制します。GetTextBox の結果を呼び出すことと同等です。
返り値: 無効

リリースフォーカス

パラメータ: bool : submitted = false
説明: チャットバーの焦点をリリースします TextBox。if submitted が true である場合、これはプレイヤーが Enter を押してメッセージを送信するように動作します。
返り値: 無効

リセットテキスト

パラメータ: なし
説明: チャットバーのを空の文字列に設定します。
返り値: 無効

テキストボックステキストを設定

パラメータ: string : text
説明: チャットバーのを指定されたに設定します。
返り値: 無効

TextBoxText を取得

パラメータ: なし
説明: チャットバーのテキストを返します TextBox.Text。
返却: string

SetTextLabelText を設定

パラメータ: string : text
説明: メッセージモードを指定されたに設定します。
返り値: 無効

GetInitialized を取得

パラメータ: なし
説明: チャットバーが Visible かどうかを返します。
返す: ブール

セット有効化済み

パラメータ: bool : enabled
説明: チャットバーが Visible かどうかを設定します。
返り値: 無効

SetTextSizeを設定

パラメータ: int : textSize
説明: チャットバーのとメッセージモードの両方を設定します。
返り値: 無効

サイズをリセット

パラメータ: なし
説明: チャットバーのサイズを 1行のテキストにリセットします。
返り値: 無効

セットチャンネルターゲット

パラメータ: string : channelName
説明: ターゲットの ChatChannelUI を設定し、チャットバーにメッセージを送信することを指示する channelName を指定します。
返り値: 無効

フェードアウトバックグラウンド

パラメータ: float : duration duration
説明: 秒で指定された背景を消します。 duration注: 後でフェードイン/アウトを制御する呼び出しは、以前の呼び出しを上書きします。
返り値: 無効

フェードインバックグラウンド

パラメータ: float : duration duration
説明: 秒で背景に消える duration が指定されます。注: 後でフェードイン/アウトを制御する呼び出しは、以前の呼び出しを上書きします。
返り値: 無効

フェードアウトテキスト

パラメータ: float : duration duration
説明: 秒で指定された duration のテキストを消します。注: 後でフェードイン/アウトを制御する呼び出しは、以前の呼び出しを上書きします。
返り値: 無効

フェードインテキスト

パラメータ: float : duration duration
説明: 秒で指定された duration のテキストにフェードします。注: 後でフェードイン/アウトを制御する呼び出しは、以前の呼び出しを上書きします。
返り値: 無効

チャットChannelUI

The ChatChannelUI は ChatChannel のクライアント側バージョンです。サーバーからチャットメッセージを受信し、ChatMessageLogDisplay にパスします。それに関連しています。

手法

チャネルにメッセージを追加する AddMessageToChannel

パラメータ: ChatMessage
説明: サーバーから受信したチャットメッセージを ChatMessageLogDisplay に追加します。
返り値: 無効

チャネルから最後のメッセージを削除する

パラメータ: なし
説明: 最古の ChatMessage を ChatMessageLogDisplay で見つかったものを削除します。
返り値: 無効

クリアメッセージログ

パラメータ: なし
説明: チャットメッセージログディスプレイのすべての ChatMessage を削除します。
返り値: 無効

チャットメッセージログ表示

The ChatMessageLogDisplay は、ChatMessages のレンダリングを ChatChannelUI で管理します。

手法

添加メッセージ

パラメータ: ChatMessage message
説明: メッセージログの表示に message を追加します。
返り値: 無効

LastMessageを削除

パラメータ: なし
説明: メッセージログの表示で最も古いチャットメッセージを削除します。
返り値: 無効

すべてのメッセージを再順序化する

パラメータ: なし
説明: メッセージ表示のサイズに対して、メッセージ表示すべてを上昇順に再排列します。メッセージログの表示が再設定された場合、これを呼び出す必要があります。
返り値: 無効

クリア

パラメータ: なし
説明: メッセージログの表示からすべてのチャットメッセージを削除します。
返り値: 無効

フェードアウトテキスト

パラメータ: float duration
説明: 秒で指定された duration のテキストを消します。注: 後でフェードイン/アウトを制御する呼び出しは、以前の呼び出しを上書きします。
返り値: 無効

フェードインテキスト

パラメータ: float duration
説明: 秒で指定された duration のテキストにフェードします。注: 後でフェードイン/アウトを制御する呼び出しは、以前の呼び出しを上書きします。
返り値: 無効

チャットカスタム状態

The ChatCustomState は、チャットバーでカスタムチャットステートを作成するときに使用されるコールバックのインターフェイスです。

ささやきチャットとチームチャットは、ChatCustomState を使用してプレイヤーにメッセージが送信される場所を示します。

コールバック

テキスト更新済み

パラメータ: なし
説明: チャットバーのテキストが更新されたときに呼び出されます。
返り値: 無効

メッセージを取得する

パラメータ: なし
説明: 単一のコマンドとして書かれるメッセージのテキストを回収するために呼び出されます。これは、サーバーがコマンドを視覚化された状態ではなく、テキストとして処理する必要がある場合に使用されます。
返却: string

プロセス完了メッセージ

パラメータ: なし
説明: プレイヤーが処理中のカスタム状態によって送信されたメッセージを呼び出すとき。メッセージを表示またはサーバーに送信しない場合は、これが true を返すべきです。
返す: ブール

破壊

パラメータ: なし
説明: ChatBar がカスタム状態の修正前に元の状態にリセットされているため、呼び出されます。
返り値: 無効

チャットSettings

The ChatSettings は、Lua チャットシステムのクライアント側の設定の辞書です。彼らは ModuleScript という名前の ChatSettings に保存され、Chat ゲームサービスの内部で見つけることができ、Folder という名前の ClientChatModules の下で。モジュールが必須であり、実行時にプロパティが変更される可能性があります。

設定を変更するには、次の方法でこのモジュールを要求し、LocalScript で必須です：


-- チャット設定モジュールを要求 (ロードするまで待読み込む)
local Chat = game:GetService("Chat")
local ClientChatModules = Chat:WaitForChild("ClientChatModules")
local ChatSettings = require(ClientChatModules:WaitForChild("ChatSettings"))
-- 他のテーブルと同じように設定を変更します。
ChatSettings.MaximumMessageLength = 100