Engine

ChatWindowConfiguration

Show Deprecated
not creatable

Configures properties of the default chat window.

It is parented to TextChatService.

Summary

Properties

Properties

AbsolutePosition

read only
not replicated

Read-only property that provides the screen position of the default chat window in pixels. Behaves similarly to GuiBase2d.AbsolutePosition.

AbsoluteSize

read only
not replicated

Read-only property that provides the screen size of the default chat window in pixels. Behaves similarly to GuiBase2d.AbsoluteSize.

BackgroundColor3

read parallel

Determines the background color of the default chat window. If the background color is not overridden, this value will respect the user's GuiService.PreferredTransparency by making the menu more gray as the transparency of the menu decreases. Default value is Color3.new(25,27,29).

BackgroundTransparency

read parallel

Determines the background transparency of the default chat window in a number between 0 and 1. This value is multiplied with the user's GuiService.PreferredTransparency to create the effective background transparency used by the chat window, which may be more opaque than this value set here. Default value is 0.3.

Enabled

read parallel

Determines whether to show the default chat window.

Set to false to hide the default chat window.

FontFace

read parallel

Determines the font used to render text in the default chat window.

HeightScale

read parallel

Determines by what factor the height of the default chat window should be scaled. Must be a value between 0.5 and 2. Defining a value outside of range clamps the actual value to the closest bound.

HorizontalAlignment

Determines the horizontal alignment of the chat window. Behaves similarly to UIGridStyleLayout.HorizontalAlignment. Setting to Left or Right adding a small padding away from touching the corresponding horizontal edge of the screen. Setting to Center aligns the window in the horizontal middle of the screen. Default value is Left.

TextColor3

read parallel

Determines the color of the text in default chat window. Default value is Color3.new(255, 255, 255) (white).

TextSize

read parallel

Determines the size of the text in default chat window. Default value is 14.

TextStrokeColor3

read parallel

Determines the color of the text stroke of text in default chat window. Default value is Color3.new(0, 0, 0) (black).

TextStrokeTransparency

read parallel

Determines the color of the text stroke of text in default chat window. Default value is 0.5.

VerticalAlignment

Determines the vertical alignment of the chat window. Behaves similarly to UIGridStyleLayout.VerticalAlignment. Setting to Top or Bottom adds a small padding away from touching the corresponding edge of the screen. Setting to Center aligns the window in the vertical middle of the screen. Default value is Top.

WidthScale

read parallel

Determines by what factor the width of the default chat window should be scaled. Must be a value between 0.5 and 2. Defining a value outside of range clamps the actual value to the closest bound.

Methods

Events