Class
ChatWindowConfiguration
NotCreatable
Configures properties of the default chat window.
Configures properties of the default text chat window. It is parented to
TextChatService.
Chat UI composition#
The default chat UI is composed of two separate elements: the chat window
(message list) configured by this object, and the chat input bar
configured by ChatInputBarConfiguration. Each element reports its own
AbsoluteSize and AbsolutePosition independently. To determine the total
screen bounds of the entire chat UI, combine values from both configurations
by computing the union of the two rectangles.
Properties 14#
AbsolutePositionVector2 | Actual screen position of the default chat window, in pixels.ReadOnlyNotReplicated |
AbsoluteSizeVector2 | Actual screen size of the default chat window, in pixels.ReadOnlyNotReplicated |
BackgroundColor3Color3 | Background color of the default chat window.ReadSafe |
BackgroundTransparencydouble | Background transparency of the default chat window.ReadSafe |
Enabledboolean | Whether to show the default chat window.ReadSafe |
FontFaceDatatype.Font | Font used to render text in the default chat window.ReadSafe |
HeightScalefloat | Factor by which the height of the default chat window should be scaled.ReadSafe |
HorizontalAlignmentHorizontalAlignment | Horizontal alignment of the chat window. |
TextColor3Color3 | Color of the text in default chat window.ReadSafe |
TextSizeint64 | Size of the text in default chat window.ReadSafe |
TextStrokeColor3Color3 | Color of the text stroke for text in default chat window.ReadSafe |
TextStrokeTransparencydouble | Transparency of the text stroke for text in default chat window.ReadSafe |
VerticalAlignmentVerticalAlignment | Vertical alignment of the chat window. |
WidthScalefloat | Factor by which the width of the default chat window should be scaled.ReadSafe |
AbsolutePosition: Vector2#
ReadOnlyNotReplicated
Read-only property that provides the screen position of the default chat
window (message list) in pixels. Behaves similarly to
GuiBase2d.AbsolutePosition.
This value represents only the message list portion of the chat UI, not
the entire chat interface. To get the total bounds including the input
bar, see ChatInputBarConfiguration.AbsolutePosition and combine
both regions. See the code example in the class description above.
AbsoluteSize: Vector2#
ReadOnlyNotReplicated
Read-only property that provides the screen size of the default chat
window (message list) in pixels. Behaves similarly to
GuiBase2d.AbsoluteSize.
This value represents only the message list portion of the chat UI, not
the entire chat interface. To get the total bounds including the input
bar, see ChatInputBarConfiguration.AbsoluteSize and combine both
regions. See the code example in the class description above.
BackgroundColor3: Color3#
ReadSafe
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: double#
ReadSafe
Background transparency of the default chat window as 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: boolean#
ReadSafe
Whether to show the default chat window. Set to false to hide.
FontFace: Datatype.Font#
ReadSafe
Font used to render text in the default chat window. Default is
Font.BuilderSansMedium.
HeightScale: float#
ReadSafe
Factor by which 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: HorizontalAlignment#
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: Color3#
ReadSafe
Color of the text in default chat window. Default value is
Color3.new(255, 255, 255).
TextSize: int64#
ReadSafe
Size of the text in default chat window. Default value is 14.
TextStrokeColor3: Color3#
ReadSafe
Color of the text stroke for text in default chat window. Default value is
Color3.new(0, 0, 0).
TextStrokeTransparency: double#
ReadSafe
Transparency of the text stroke for text in default chat window. Default
value is 0.5.
VerticalAlignment: VerticalAlignment#
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: float#
ReadSafe
Factor by which 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 1#
| DeriveNewMessageProperties | Creates a new ChatWindowMessageProperties instance that can be
used to customize the appearance of messages in the chat window. |
DeriveNewMessageProperties(): ChatWindowMessageProperties#
Creates a new ChatWindowMessageProperties instance that can be
used to customize the appearance of messages in the chat window.
ChatWindowMessageProperties inherits from
TextChatMessageProperties.
This is intended to be used during custom
TextChatService.OnChatWindowAdded callbacks.
Returns
ChatWindowMessageProperties— A newChatWindowMessagePropertiesinstance whose values you can modify and return from aTextChatService.OnChatWindowAddedcallback to customize how individual messages appear in the chat window.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild