ChatInputBarConfiguration
Configures properties of the default chat input bar.
Memory category | Instances |
---|
Member index 19
Description
Configures properties of the default text chat input bar. It is parented to TextChatService.
History 29
- 588 Add AutocompleteEnabled
- 575 Change Tags of KeyboardKeyCode from [Hidden] to []
- 575 Change Default of KeyboardKeyCode from to Slash
- 574 Add KeyboardKeyCode
- 574 Add
- 574 Add IsFocused
- 559 Add TextBox
- 554 Add TextStrokeTransparency
- 554 Add TextStrokeColor3
- 554 Add TextSize
- 554 Add TextColor3
- 554 Add PlaceholderColor3
- 554 Add FontFace
- 554 Add BackgroundTransparency
- 554 Add BackgroundColor3
- 553 Change Default of TargetTextChannel from to
- 553 Change Default of Enabled from to true
- 553 Change Default of from to Vector2(0, 0)
- 553 Change Default of AbsoluteSize from to Vector2(0, 0)
- 553 Change Default of from to Vector2(0, 0)
- 553 Change Default of AbsolutePosition from to Vector2(0, 0)
- 540 Add
- 540 Add AbsoluteSize
- 540 Add
- 540 Add AbsolutePosition
- 533 Change Tags of ChatInputBarConfiguration from [NotCreatable, NotBrowsable] to [NotCreatable]
- 514 Add TargetTextChannel
- 514 Add Enabled
- 514 Add ChatInputBarConfiguration
Members 19
AbsolutePosition
Type | Default | |
---|---|---|
Vector2 | 0, 0 |
Read-only property that provides the screen position of the default chat input bar in pixels. Behaves similarly to GuiBase2d.AbsolutePosition.
Thread safety | Unsafe |
---|---|
Category | Data |
Loaded/Saved | false |
History 2
- 553 Change Default of AbsolutePosition from to Vector2(0, 0)
- 540 Add AbsolutePosition
AbsoluteSize
Type | Default | |
---|---|---|
Vector2 | 0, 0 |
Read-only property that provides the screen size of the default chat input bar in pixels. Behaves similarly to GuiBase2d.AbsoluteSize.
Thread safety | Unsafe |
---|---|
Category | Data |
Loaded/Saved | false |
History 2
- 553 Change Default of AbsoluteSize from to Vector2(0, 0)
- 540 Add AbsoluteSize
AutocompleteEnabled
Type | Default | |
---|---|---|
bool | true |
Whether to enable autocomplete for the chat input bar. Set to false
to
disable autocomplete.
Thread safety | ReadSafe |
---|---|
Category | Behavior |
Loaded/Saved | true |
History 1
BackgroundColor3
Type | Default | |
---|---|---|
Color3 | 0.0980392, 0.105882, 0.113725 |
Background color of the default chat input bar. Default value is Color3.new(25, 27, 29).
Thread safety | ReadSafe |
---|---|
Category | Appearance |
Loaded/Saved | true |
History 1
- 554 Add BackgroundColor3
BackgroundTransparency
Type | Default | |
---|---|---|
double | 0.2000000000000000111 |
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
.
Thread safety | ReadSafe |
---|---|
Category | Appearance |
Loaded/Saved | true |
History 1
Enabled
Type | Default | |
---|---|---|
bool | true |
Whether to show the default chat input bar. Set to false
to hide.
Thread safety | ReadSafe |
---|---|
Category | Behavior |
Loaded/Saved | true |
FontFace
Type | Default | |
---|---|---|
Font |
Font used to render text in the default chat input bar. Default is Font.BuilderSansMedium.
Thread safety | ReadSafe |
---|---|
Category | Appearance |
Loaded/Saved | true |
IsFocused
Type | Default | |
---|---|---|
bool | false |
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.
Thread safety | Unsafe |
---|---|
Category | Data |
Loaded/Saved | false |
KeyboardKeyCode
Type | Default | |
---|---|---|
KeyCode | Slash |
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.
Thread safety | ReadSafe |
---|---|
Category | Behavior |
Loaded/Saved | true |
History 3
- 575 Change Tags of KeyboardKeyCode from [Hidden] to []
- 575 Change Default of KeyboardKeyCode from to Slash
- 574 Add KeyboardKeyCode
PlaceholderColor3
Type | Default | |
---|---|---|
Color3 | 0.698039, 0.698039, 0.698039 |
Color of the text of the placeholder text in the default chat input bar. Default value is Color3.new(178, 178, 178).
Thread safety | ReadSafe |
---|---|
Category | Appearance |
Loaded/Saved | true |
History 1
- 554 Add PlaceholderColor3
TargetTextChannel
Type | Default | |
---|---|---|
TextChannel |
Determines which TextChannel to use when the user sends a message with the default chat input bar.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | true |
History 2
- 553 Change Default of TargetTextChannel from to
- 514 Add TargetTextChannel
TextBox
Type | Default | |
---|---|---|
TextBox |
Reference to a designated TextBox instance that sends messages on behalf of the user. 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:
- When a user types a message and presses KeyCode.Return, the message will be sent to ChatInputBarConfiguration.TargetTextChannel.
- When a message is sent, TextBox.Text will automatically clear.
For security, some limitations are imposed on the TextBox when it is promoted to ChatInputBarConfiguration.TextBox. Lua code will not be able to:
- Change the TextBox.Text property.
- Use the TextBox:CaptureFocus() or TextBox:ReleaseFocus() methods.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |
TextColor3
Type | Default | |
---|---|---|
Color3 | 1, 1, 1 |
Color of the text in default chat input bar. Default value is Color3.new(255, 255, 255).
Thread safety | ReadSafe |
---|---|
Category | Appearance |
Loaded/Saved | true |
History 1
- 554 Add TextColor3
TextSize
Type | Default | |
---|---|---|
int64 | 14 |
Size of the text in default chat input bar. Default value is 14
.
Thread safety | ReadSafe |
---|---|
Category | Appearance |
Loaded/Saved | true |
TextStrokeColor3
Type | Default | |
---|---|---|
Color3 | 0, 0, 0 |
Color of the text stroke for text in default chat input bar. Default value is Color3.new(0, 0, 0).
Thread safety | ReadSafe |
---|---|
Category | Appearance |
Loaded/Saved | true |
History 1
- 554 Add TextStrokeColor3
TextStrokeTransparency
Type | Default | |
---|---|---|
double | 0.5 |
Transparency of the text stroke for text in default chat input bar.
Default value is 0.5
.
Thread safety | ReadSafe |
---|---|
Category | Appearance |
Loaded/Saved | true |