Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ChatInputBarConfiguration

Configures properties of the default chat input bar.

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

Member index 19

HistoryMember
553AbsolutePosition: Vector2
553AbsoluteSize: Vector2
588AutocompleteEnabled: bool
554BackgroundColor3: Color3
554BackgroundTransparency: double
553Enabled: bool
554FontFace: Font
574IsFocused: bool
575KeyboardKeyCode: KeyCode
554PlaceholderColor3: Color3
553TargetTextChannel: TextChannel
559TextBox: TextBox
554TextColor3: Color3
554TextSize: int64
554TextStrokeColor3: Color3
554TextStrokeTransparency: double
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
486GetChildren(): Objects
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
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
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
647isA(className: string): bool
647Changed(property: string)

Description

Configures properties of the default chat input bar.

It is parented to TextChatService.

History 29

Members 19

AbsolutePosition

TypeDefault
Vector20, 0

Read-only property that provides the screen position of the default chat input bar 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.

History 2

Tags: [ReadOnly, NotReplicated]

AbsoluteSize

TypeDefault
Vector20, 0

Read-only property that provides the screen size of the default chat input bar 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.

History 2

Tags: [ReadOnly, NotReplicated]

AutocompleteEnabled

TypeDefault
booltrue

Determines whether to enable autocomplete for the chat input bar. Set to false to disable autocomplete.

History 1

BackgroundColor3

TypeDefault
Color30.0980392, 0.105882, 0.113725

Determines the background color of the default chat input bar. Default value is Color3.new(25,27,29).

History 1

BackgroundTransparency

TypeDefault
double0.2000000000000000111

Determines the background transparency of the default chat input bar 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 input bar, which may be more opaque than this value set here. Default value is 0.2.

History 1

Enabled

TypeDefault
booltrue

Determines whether to show the default chat input bar.

Set to false to hide the default chat input bar.

History 2

FontFace

TypeDefault
Font

Determines the font used to render text in the default chat input bar.

History 1

IsFocused

TypeDefault
boolfalse

Indicates whether the default chat input bar is focused or not. Useful for firing property changed events so you can implement callback functions that respond to changes in the input bar's focus state.

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.

History 1

Tags: [ReadOnly, NotReplicated]

KeyboardKeyCode

TypeDefault
KeyCodeSlash

Determines an additional key users can press to trigger focusing on the default chat input bar. Useful when you want to have an extra hotkey for focusing in addition to the "/" key.

History 3

PlaceholderColor3

TypeDefault
Color30.698039, 0.698039, 0.698039

Determines the color of the text of the placeholder text in the default chat input bar. Default value is Color3.new(178, 178, 178).

History 1

TargetTextChannel

TypeDefault
TextChannel

A reference to the target TextChannel.

Determines which TextChannel to use when the user sends a message with the default chat input bar.

History 2

TextBox

TypeDefault
TextBox

A reference to a designated TextBox Instance that sends messages on behalf of the user. This property only accepts TextBox instances.

You can use it to further integrate your custom chat input bar UI into your experience by freely manipulating appearance, location, and layout. When opting to set this property to a custom TextBox, you don't need to write any code for the following behavior:

For security, some limitations are imposed on the TextBox when it is promoted to ChatInputBarConfiguration.TextBox. Lua code will not be able to:

History 1

TextColor3

TypeDefault
Color31, 1, 1

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

History 1

TextSize

TypeDefault
int6414

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

History 1

TextStrokeColor3

TypeDefault
Color30, 0, 0

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

History 1

TextStrokeTransparency

TypeDefault
double0.5

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

History 1

Settings