Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ChatWindowConfiguration

Configures properties of the default chat window.

This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable]

Member index 17

HistoryMember
553AbsolutePosition: Vector2
553AbsoluteSize: Vector2
553BackgroundColor3: Color3
553BackgroundTransparency: double
553Enabled: bool
553FontFace: Font
553HeightScale: float
553HorizontalAlignment: HorizontalAlignment
553TextColor3: Color3
553TextSize: int64
553TextStrokeColor3: Color3
553TextStrokeTransparency: double
553VerticalAlignment: VerticalAlignment
553WidthScale: float
645DeriveNewMessageProperties(): ChatWindowMessageProperties
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

Configures properties of the default text chat window. It is parented to TextChatService.

History 39

Members 17

AbsolutePosition

TypeDefault
Vector20, 0

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

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyUnsafe
CategoryData
Loaded/Savedfalse

History 2

Tags: [ReadOnly, NotReplicated]

AbsoluteSize

TypeDefault
Vector20, 0

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

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyUnsafe
CategoryData
Loaded/Savedfalse

History 2

Tags: [ReadOnly, NotReplicated]

BackgroundColor3

TypeDefault
Color30.0980392, 0.105882, 0.113725

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).

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 2

BackgroundTransparency

TypeDefault
double0.2999999999999999889

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.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 2

DeriveNewMessageProperties

Parameters (0)
No parameters.
Returns (1)
ChatWindowMessageProperties

Creates a new ChatWindowMessageProperties instance that can be used to customize the appearance of messages in the chat window. ChatWindowMessageProperties inherits from TextChatMessageProperties.

Thread safetyUnsafe

History 1

Enabled

TypeDefault
booltrue

Whether to show the default chat window. Set to false to hide.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 2

FontFace

TypeDefault
Font

Font used to render text in the default chat window. Default is Font.BuilderSansMedium.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 2

HeightScale

TypeDefault
float1

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.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 2

HorizontalAlignment

TypeDefault
HorizontalAlignmentLeft

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.

Thread safetyUnsafe
CategoryData
Loaded/Savedtrue

History 4

TextColor3

TypeDefault
Color31, 1, 1

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

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 2

TextSize

TypeDefault
int6414

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

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 2

TextStrokeColor3

TypeDefault
Color30, 0, 0

Color of the text stroke for text in default chat window. Default value is Color3.new(0, 0, 0).

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 2

TextStrokeTransparency

TypeDefault
double0.5

Transparency of the text stroke for text in default chat window. Default value is 0.5.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 2

VerticalAlignment

TypeDefault
VerticalAlignmentTop

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.

Thread safetyUnsafe
CategoryData
Loaded/Savedtrue

History 4

WidthScale

TypeDefault
float1

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.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 2

Settings