ChatWindowConfiguration

非推奨を表示

*このコンテンツは、ベータ版のAI(人工知能)を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。

作成できません

デフォルトのテキストチャットウィンドウのプロパティを構成します。親は TextChatService です。

概要

プロパティ

  • 読み取り専用
    複製されていません

    デフォルトのチャットウィンドウの実際のスクリーンポジション、ピクセルで。

  • 読み取り専用
    複製されていません

    デフォルトのチャットウィンドウの実際の画面サイズ、ピクセルで。

  • 並列読み取り

    デフォルトのチャットウィンドウの背景色。

  • 並列読み取り

    デフォルトのチャットウィンドウの背景透明度。

  • 並列読み取り

    デフォルトのチャットウィンドウを表示するかどうか。

  • 並列読み取り

    デフォルトのチャットウィンドウでテキストをレンダリングするフォント。

  • 並列読み取り

    デフォルトのチャットウィンドウの高さがスケールする必要のある要因。

  • チャットウィンドウの横向き配置。

  • 並列読み取り

    デフォルトのチャットウィンドウのテキストの色。

  • 並列読み取り

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

  • 並列読み取り

    デフォルトのチャットウィンドウでのテキストのストロークの色。

  • 並列読み取り

    デフォルトのチャットウィンドウでのテキストストロークの透明性。

  • チャットウィンドウの垂直配置。

  • 並列読み取り

    デフォルトのチャットウィンドウの幅がスケールする必要のある要因。

方法

プロパティ

AbsolutePosition

読み取り専用
複製されていません

デフォルトのチャットウィンドウのスクリーンポジションをピクセルで提供する読み取り専用プロパティ。GuiBase2d.AbsolutePosition と同様に動作します。

AbsoluteSize

読み取り専用
複製されていません

デフォルトのチャットウィンドウの画面サイズをピクセルで提供する読み取り専用プロパティ。GuiBase2d.AbsoluteSize と同じように動作します。

BackgroundColor3

並列読み取り

デフォルトのチャットウィンドウの背景色。背景色が上書きされない場合、この値は、メニューの透明度が低下するにつれて、メニューをよりグレーにすることでユーザーの GuiService.PreferredTransparency を尊重します。デフォルト値は Color3.new(25, 27, 29) です。

BackgroundTransparency

並列読み取り

デフォルトのチャットウィンドウの背景透明度は、01 の間の数字です。この値は、ユーザーの GuiService.PreferredTransparency と掛け算して、チャットウィンドウで使用される有効なバックグラウンド透明度を作成し、この値セットよりも不透明になる可能性があります。デフォルト値は 0.3 です。

Enabled

並列読み取り

デフォルトのチャットウィンドウを表示するかどうか。隠すには、false に設定します。

FontFace

並列読み取り

デフォルトのチャットウィンドウでテキストをレンダリングするフォント。デフォルトは Enum.Font.BuilderSansMedium です。

HeightScale

並列読み取り

デフォルトのチャットウィンドウの高さがスケールする必要のある要因。値は 0.52 の間でなければなりません。範囲外の値を定義すると、実際の値が最も近いバインドにクランプされます。

HorizontalAlignment

チャットウィンドウの横向き配置。Behaves は同様に UIGridStyleLayout.HorizontalAlignment に行動します。設定を Left または Right にして、画面の相応しい縦方向の端に触れるのを避けるための軽いパッドを追加します。設定を Center にすると、ウィンドウが画面の横中央に配置されます。デフォルト値は Left です。

TextColor3

並列読み取り

デフォルトのチャットウィンドウのテキストの色。デフォルト値は Color3.new(255, 255, 255) です。

TextSize

並列読み取り

デフォルトのチャットウィンドウのテキストのサイズ。デフォルト値は 14 です。

TextStrokeColor3

並列読み取り

デフォルトのチャットウィンドウでのテキストのストロークの色。デフォルト値は Color3.new(0, 0, 0) です。

TextStrokeTransparency

並列読み取り

デフォルトのチャットウィンドウでのテキストストロークの透明度。デフォルト値は 0.5 です。

VerticalAlignment

チャットウィンドウの垂直配置。Behaves は同様に UIGridStyleLayout.VerticalAlignment に行動します。設定を Top または Bottom にすると、画面の対応する端に触れるのを避けるための薄いパッドが追加されます。設定を Center にすると、ウィンドウが画面の縦の中央に配置されます。デフォルト値は Top です。

WidthScale

並列読み取り

デフォルトのチャットウィンドウの幅がスケールする必要のある要因。値は 0.52 の間でなければなりません。範囲外の値を定義すると、実際の値が最も近いバインドにクランプされます。

方法

DeriveNewMessageProperties

チャットウィンドウでメッセージの外観をカスタマイズするために使用できる新しい ChatWindowMessageProperties インスタンスを作成します。ChatWindowMessagePropertiesTextChatMessageProperties から継承します。

これはカスタム TextChatService.OnChatWindowAdded コールバック中に使用することを目的としています。


local TextChatService = game:GetService("TextChatService")
local ChatWindowConfiguration = TextChatService.ChatWindowConfiguration
TextChatService.OnChatWindowAdded = function(textChatMessage)
local properties = ChatWindowConfiguration:DeriveNewMessageProperties()
if textChatMessage.Metadata == "Important" then
properties.TextColor3 = Color3.fromRGB(255, 0, 0)
end
return properties
end

戻り値

コードサンプル

This example checks if two users can chat, creates a new TextChannel, and adds them to it.

CanUsersDirectChatAsync

local TextChatService = game:GetService("TextChatService")
local directChatParticipants = TextChatService:CanUsersDirectChatAsync(userId1, { userId2 })
-- Check for eligible participants
if #directChatParticipants > 0 then
local directChannel = Instance.new("TextChannel")
directChannel.Parent = TextChatService
for _, participant in directChatParticipants do
directChannel:AddUserAsync(participant)
end
return directChannel
end
warn("Could not create TextChannel. Not enough eligible users.")
return nil

イベント