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

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

チャットウィンドウ

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

メソッド

チャンネルを追加

• パラメーター: string : channelName
• 説明: ウィンドウに ChatChannelUI を追加します。
• 返り: ChatChannelUI

チャンネルを削除

• パラメーター: string : channelName
• 説明: ChatChannelUI を削除します。channelName のウィンドウから。
• 返す： 無効

GetChannel

• パラメーター: string : channelName
• 説明: チャットチャンネルUIを入手する channelName が存在する場合。
• は戻ります: ChatChannelUI または nil

現在のチャンネルを取得

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

スイッチCurrentChannel

• パラメーター: string : channelName
• 説明: は、現在のチャンネルを ChatChannelUI に切り替えますが、存在する場合は channelName です。
• 返す： 無効

GetVisible

• パラメーター: なし
• 説明: ウィンドウが表示されているかどうかを返します。注: これは、チャットウィンドウが非アクティブであるかどうかに関連します。チャットウィンドウが非アクティブであると、ウィンドウはまだ表示されます。
• 返す： booル

可視にする

• パラメーター: booル : visible
• 説明: チャットウィンドウの可視性を設定します。
• 返す： 無効

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

• パラメーター： float : duration
• 説明: 背景を duration 秒でフェイドアウトします。注:後でフェイドアウトを制御する呼び出しは、以前の呼び出しを上書きします。
• 返す： 無効

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

• パラメーター： float : duration
• 説明: フェイドオーバーバックグラウンドのオーバーライドです。注: 後でフェイドオーバーを制御する呼び出しは、以前の呼び出しを上書きします。
• 返す： 無効

フェイドアウトテキスト

• パラメーター： float : duration
• 説明: 文字の上に表示されるテキストを減少します。注:フェイドアウト後の呼び出しは、以前の呼び出しを上書きします。
• 返す： 無効

フェイドインテキスト

• パラメーター： float : duration
• 説明: テキストの上の経過時間をカウントします。注: 後の呼び出しで経過時間をカウントすると、以前の呼び出しを上書きします。
• 返す： 無効

チャットバー

Luaチャットシステムのクライアント側のテキストエントリを扱う チャットバー は、チャットバーの 2つのキーコンポーネントで構成されています：

• ChatBar 、TextBox、 メッセージとコマンドを入力します (オレンジでハイライト)
• メッセージモード 、TextLabel、メッセージが送信される情報を表示する（緑でハイライトされています）

メソッド

GetTimer

• パラメーター: なし
• 説明: チャットバーの TextBox を返します。
• 戻り値： TextBox

メッセージモードテキストラベルを取得

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

焦点合致

• パラメーター: なし
• 説明: チャットバーの TextBox がフォーカスにあるかどうかを返します (プレイヤーがボックスに入力しています)。結果の Getrix の上で TextBox:IsFocused を呼び出すことに相当します。
• 返す： booル

キャプチャーフォーカス

• パラメーター: なし
• 説明: クライアントにチャットバーの TextBox に集中するように強制します。結果の GetExecutor に同等します。
• 返す： 無効

リリースフォーカス

• パラメーター: booル : submitted = false
• 説明: チャットバーのフォーカスをリリースします TextBox 。如果 submitted が true である場合、これはプレイヤーが Enter0> を押してメッセージを送信したときに挑戦されるようになります。
• 返す： 無効

ResetText

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

Set#{text} テキスト

• パラメーター: string : text
• 説明: チャットバーの Text を指定した TextBox に設定します。
• 返す： 無効

GetTimerText

• パラメーター: なし
• 説明: チャットバーにテキストを戻ります TextBox.Text。
• 返り： string

SetTextLabelText

• パラメーター: string : text
• 説明: メッセージモードの Text を指定した TextLabel に設定します。
• 返す： 無効

GetEnabled

• パラメーター: なし
• 説明: チャットバーが Visible であるかどうかを返します。
• 返す： booル

セット有効化済み

• パラメーター: booル : enabled
• 説明: チャットバーが Visible であるかどうかを設定します。
• 返す： 無効

SetTextSize

• パラメーター： int : textSize
• 説明: は、チャットバーの TextSize とメッセージモードの TextBox の両方の 0> TextSize0> を設定します。
• 返す： 無効

サイズをリセット

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

チャンネルターゲットを設定

• パラメーター: string : channelName
• 説明: 設定ターゲット ChatChannelUI を与える channelName に、チャットバーがメッセージを送信する必要がある。
• 返す： 無効

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

• パラメーター: float : duration 0> duration0>
• 説明: 背景を duration 秒でフェイドアウトします。注:後でフェイドアウトを制御する呼び出しは、以前の呼び出しを上書きします。
• 返す： 無効

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

• パラメーター: float : duration 0> duration0>
• 説明: フェイドオーバーバックグラウンドのオーバーライドです。注: 後でフェイドオーバーを制御する呼び出しは、以前の呼び出しを上書きします。
• 返す： 無効

フェイドアウトテキスト

• パラメーター: float : duration 0> duration0>
• 説明: 文字の上に表示されるテキストを減少します。注:フェイドアウト後の呼び出しは、以前の呼び出しを上書きします。
• 返す： 無効

フェイドインテキスト

• パラメーター: float : duration 0> duration0>
• 説明: テキストの上の経過時間をカウントします。注: 後の呼び出しで経過時間をカウントすると、以前の呼び出しを上書きします。
• 返す： 無効

チャットチャンネルUI

ChatChannelUI は、ChatChannel のクライアント側バージョンです。サーバーから ChatMessages を受信し、ChatMessageLogDisplay にパスします。それに関連付けられた 2>ChatMessageLogDisplayDisplay2> に表示されます。

メソッド

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

• パラメーター: ChatMessage

• 説明: サーバーから受信されたチャットメッセージを ChatMessageLogDisplay に追加します。

• 返す： 無効

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

• パラメーター: なし
• 説明: は、ChatMessageLogDisplay に見つかった最古の ChatMessage を削除します。
• 返す： 無効

クリアメッセージログ

• パラメーター: なし
• 説明: は、チャットメッセージをチャットメッセージログディスプレイ ですべて削除します。
• 返す： 無効

チャットメッセージログディスプレイ

The ChatMessageLogDisplay は、ChatMessages を ChatChannelUI で表示します。

メソッド

メッセージを追加

• パラメーター: チャットメッセージ message
• 説明: メッセージログの表示に message を追加します。
• 返す： 無効

最後のメッセージを削除

• パラメーター: なし
• 説明: メッセージログの表示で最古の ChatMessage を削除します。
• 返す： 無効

すべてのメッセージを再編成する

• パラメーター: なし
• 説明: メッセージの表示をサイズ順に再編成します。これはメッセージログの表示がサイズを変更する場合に呼び出される必要があります。
• 返す： 無効

クリア

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

フェイドアウトテキスト

• パラメーター: float duration
• 説明: 文字の上に表示されるテキストを減少します。注:フェイドアウト後の呼び出しは、以前の呼び出しを上書きします。
• 返す： 無効

フェイドインテキスト

• パラメーター: float duration
• 説明: テキストの上の経過時間をカウントします。注: 後の呼び出しで経過時間をカウントすると、以前の呼び出しを上書きします。
• 返す： 無効

チャットカスタムステート

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

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

コールバック

テキスト更新

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

メッセージを取得

• パラメーター: なし
• 説明: メッセージがビジュアル状態ではなく、単一のコマンドとして書き込まれるように呼び出されます。これは、サーバーがコマンドをテキストとして処理する必要がある場合に使用されます。
• 返り： string

処理完了メッセージ

• パラメーター: なし
• 説明: プレイヤーがカスタムステートによって処理されているメッセージを送信するときに呼び出されます。これは、メッセージが表示されたり、サーバーに送信されたりしないでくださいので、True が返されます。
• 返す： booル

破壊

• パラメーター: なし
• 説明: 「ChatBar」として呼び出され、カスタム状態の変更前にオリジナルの状態に戻されます。
• 返す： 無効

チャット設定

ChatSettings は、Lua Chat System のクライアント側の設定のダイクトリです。 は ModuleScript という名前の チャットhatSettings 、1>Chat1> ゲームサービスの下にある 4>ClientChatModule4> に存在します。モジュー

設定を変更するには、次の方法を使用して LocalScript を使用するモジュールを変更します：

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

チャット動作設定

WindowDraggable

• タイプ: booル
• デフォルト: false
• 説明: チャットウィンドウが Draggable であるかどうかを決定します。

ウィンドウを拡大/縮小できます

• タイプ: booル
• デフォルト: false
• 説明: プレイヤーが チャットウィンドウ をサイズ変更できるかどうかを決定します

ゲームパッドナビゲーション有効化済み

• タイプ: booル
• デフォルト: false
• 説明: ゲームパッドがチャット UI をナビゲートできるかどうかを決定します。

ユーザーがフィルターをかけたメッセージを表示

• タイプ: booル
• デフォルト: true
• 説明: プレイヤーがチャットメッセージのフィルター版を見るか、原始のコンテンツを入力したかを決定します。

チャットオンウィズトップバーオフ

• タイプ: booル
• デフォルト: false
• 説明: トップバーが無効であってもチャット UI が有効であるかどうかを決定します。

バブルチャット有効化済み

• タイプ: booル
• デフォルト: game:GetService("Players").BubbleChat
• 説明: バブルチャットを有効化するかどうかを決定します。

クラシックチャット有効化済み

• タイプ: booル
• デフォルト: game:GetService("Players").ClassicChat
• 説明: クラシックチャットを有効化するかどうかを決定します。

チャットテキストサイズ設定

チャットウィンドウテキストサイズ

• タイプ: int
• デフォルト: 18
• 説明: チャットウィンドウのテキストのサイズを決定します。

チャットバーのテキストサイズ

• タイプ: int
• デフォルト: 18
• 説明: チャットバーのテキストのサイズを決定します。

チャットウィンドウテキストサイズフォン

• タイプ: int
• デフォルト: 14
• 説明: テキストのサイズを チャットウィンドウ の電話のサイズに決定します。

チャットバーテキストサイズフォン

• タイプ: int
• デフォルト: 14
• 説明: 電話の チャットバー にテキストのサイズを決定します。

フォント設定

デフォルトフォント

• タイプ: Enum.Font
• デフォルト: Enum.Font.SourceSansBold
• 説明: は、Font のデフォルトを決定します。

チャットバーフォント

• タイプ: Enum.Font
• デフォルト: Enum.Font.SourceSansBold
• 説明: は、Font のデフォルトの Executor の 0> Executor0> を決定します。

色設定

背景色

• タイプ: Color3
• デフォルト: Color3.new(0, 0, 0)
• 説明: チャットウィンドウの BackgroundColor3 を決定します。

デフォルトメッセージカラー

• タイプ: Color3
• デフォルト: Color3.new(1, 1, 1)
• 説明: は、TextColor3 のデフォルトの チャットメッセージ を決定します。

デフォルト名前カラー

• タイプ: Color3
• デフォルト: Color3.new(1, 1, 1)
• 説明: は、TextColor3 のスピーカー名のデフォルトを決定します。

チャットバーの背景色

• タイプ: Color3
• デフォルト: Color3.new(0, 0, 0)
• 説明: チャットバーの BackgroundColor3 を決定します。

チャットバーボックスの色

• タイプ: Color3
• デフォルト: Color3.new(1, 1, 1)
• 説明: は、BackgroundColor3 の XVァイアウト を決定します。

チャットバーのテキストの色

• タイプ: Color3
• デフォルト: Color3.new(0, 0, 0)
• 説明: チャットバーの TextColor3 を決定します。

エラーメッセージテキストカラー

• タイプ: Color3
• デフォルト: Color3.fromRGB(245, 50, 50)
• 説明: エラーメッセージの TextColor3 を決定します。

ウィンドウ設定

最小ウィンドウサイズ

• タイプ: UDim2
• デフォルト: UDim2.new(0.3, 0, 0.25, 0)
• 説明: チャットウィンドウ （ WindowResizable が有効になっている状態）の最小サイズを決定します。

最大窓サイズ

• タイプ: UDim2
• デフォルト: UDim2.new(1, 0, 1, 0)
• 説明: チャットウィンドウ （ WindowResizable が有効）の最大サイズを決定します。
• 注意: これがフル画面サイズより大きく変更されると、サイズ/位置の制限チェックで奇妙なことが発生する場合があります。

デフォルトのウィンドウポジション

• タイプ: UDim2
• デフォルト: UDim2.new(0, 0, 0, 0)
• 説明: チャットウィンドウのデフォルトポジションを決定します。

デフォルトのウィンドウサイズ電話

• タイプ: UDim2
• デフォルト: UDim2.new(0.5, 0, 0.5, (7 * 2) + (5 * 2))
• 説明: 電話の チャットウィンドウ のデフォルトサイズを決定します。

デフォルトのウィンドウサイズテーブル

• タイプ: UDim2
• デフォルト: UDim2.new(0.4, 0, 0.3, (7 * 2) + (5 * 2))
• 説明: テーブルの チャットウィンドウ のデフォルトサイズを決定します。

デフォルトのウィンドウサイズデスクトップ

• タイプ: UDim2
• デフォルト: UDim2.new(0.3, 0, 0.25, (7 * 2) + (5 * 2))
• 説明: デスクトップの チャットウィンドウ のデフォルトサイズを決定します。

フェイドアウトと設定

チャットウィンドウの背景色

• タイプ: フロート (秒)
• デフォルト: 0.5
• 説明: は、チャットウィンドウ の背景をフェイドアウトするまでにかかる時間を決定します。

チャットウィンドウテキストフェイドアウト時間

• タイプ: フロート (秒)
• デフォルト: 30
• 説明: チャットウィンドウのテキストを消えるまでにかかる時間を決める。

チャットデフォルトフェイド時間

• タイプ: フロート (秒)
• デフォルト: 0.8
• 説明: チャット UI 要素のフェイドアウト時間を決める。

チャットショルダーインフォーメーションからフェイドイン

• タイプ: booル
• デフォルト: false
• 説明: チャットが新しいメッセージを受信したときにフェイドするかどうかを決めます。

チャットアニメーションFPS

• タイプ: フロート
• デフォルト: 20.0
• 説明: チャット UI のフレームレートを決定します。

チャンネル設定

一般チャンネル名

• タイプ: string
• デフォルト:: "All"
• 説明: デフォルトチャンネルの名前を決定します。

エコーメッセージイン ジェネラルチャンネル

• タイプ: booル
• デフォルト: true
• 説明: チャンネル以外のメッセージをデフォルトチャンネルにエコーするかどうかを決定します。

最大チャンネル名長

• タイプ: int
• デフォルト: 12
• 説明: チャンネル名をトリミングする前に、最大長度を決定します。

メッセージの長さ per チャンネル

• タイプ: int
• デフォルト: 50
• 説明: チャットチャンネルに表示できる チャットメッセージ の最大数を決定します。

参加と終了ヘルプテキストを表示

• タイプ: booル
• デフォルト: false
• 説明: チャンネルに参加/抜けるヘルプテキストが表示されるかどうかを決定します。

メッセージ設定

最大メッセージ長

• タイプ: int
• デフォルト: 200
• 説明: チャットメッセージ の最大長度を決定します。

許可されていないホワイトスペース

• タイプ: 配列< string >
• デフォルト: {"\n", "\r", "\t", "\v", "\f"}
• 説明: 不許可された白スペースキャラクターを決定します。

ClickOnPlayerNameToWhisper

• タイプ: booル
• デフォルト: true
• 説明: プレイヤーが他のプレイヤーの名前をクリックして、サードパーティのチャットに参加できるかどうかを決定します。

メインチャンネルを設定するには、ClickOnChannelNameToSetMainChannel

• タイプ: booル
• デフォルト: true
• 説明: プレイヤーがメインチャンネルとして設定するチャンネルのタブをクリックできるかどうかを決定します。

その他の設定

WhisperCommandAutoCompletePlayerNames

• タイプ: booル
• デフォルト: true
• 説明: は、Whisper コマンドがプレイヤーの名前を自動完了するかどうかを決定します。

イベント

変更後の設定

• パラメーター: string settingName 、バリアント0> newValue0>
• 説明: 設定の settingName を変更して newValue にファイアをオンにする。