mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
373 lines
10 KiB
YAML
373 lines
10 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: ChatInputBarConfiguration
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
Configures properties of the default chat input bar.
|
|
description: |
|
|
Configures properties of the default text chat input bar. It is parented to
|
|
`Class.TextChatService`.
|
|
code_samples: []
|
|
inherits:
|
|
- TextChatConfigurations
|
|
descendants: []
|
|
tags:
|
|
- NotCreatable
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: ChatInputBarConfiguration.AbsolutePosition
|
|
summary: |
|
|
Actual screen position of the default chat input bar in pixels.
|
|
description: |
|
|
Read-only property that provides the screen position of the default chat
|
|
input bar in pixels. Behaves similarly to
|
|
`Class.GuiBase2d.AbsolutePosition`.
|
|
code_samples: []
|
|
type: Vector2
|
|
tags:
|
|
- ReadOnly
|
|
- NotReplicated
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: Unsafe
|
|
category: Data
|
|
serialization:
|
|
can_load: false
|
|
can_save: false
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.AbsoluteSize
|
|
summary: |
|
|
Actual screen size of the default chat input bar in pixels.
|
|
description: |
|
|
Read-only property that provides the screen size of the default chat input
|
|
bar in pixels. Behaves similarly to `Class.GuiBase2d.AbsoluteSize`.
|
|
code_samples: []
|
|
type: Vector2
|
|
tags:
|
|
- ReadOnly
|
|
- NotReplicated
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: Unsafe
|
|
category: Data
|
|
serialization:
|
|
can_load: false
|
|
can_save: false
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.AutocompleteEnabled
|
|
summary: |
|
|
Whether to enable autocomplete for the chat input bar.
|
|
description: |
|
|
Whether to enable autocomplete for the chat input bar. Set to `false` to
|
|
disable autocomplete.
|
|
code_samples: []
|
|
type: boolean
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Behavior
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.BackgroundColor3
|
|
summary: |
|
|
Background color of the default chat input bar.
|
|
description: |
|
|
Background color of the default chat input bar. Default value is
|
|
`Datatype.Color3|Color3.new(25, 27, 29)`.
|
|
code_samples: []
|
|
type: Color3
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Appearance
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.BackgroundTransparency
|
|
summary: |
|
|
Background transparency of the default chat input bar.
|
|
description: |
|
|
Background transparency of the default chat input bar as a number between
|
|
`0` and `1`. This value is multiplied with the user's
|
|
`Class.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`.
|
|
code_samples: []
|
|
type: double
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Appearance
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.Enabled
|
|
summary: |
|
|
Whether to show the default chat input bar.
|
|
description: |
|
|
Whether to show the default chat input bar. Set to `false` to hide.
|
|
code_samples: []
|
|
type: boolean
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Behavior
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.FontFace
|
|
summary: |
|
|
Font used to render text in the default chat input bar.
|
|
description: |
|
|
Font used to render text in the default chat input bar. Default is
|
|
`Enum.Font.BuilderSansMedium`.
|
|
code_samples: []
|
|
type: Datatype.Font
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Appearance
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.IsFocused
|
|
summary: |
|
|
Whether the default chat input bar is focused or not.
|
|
description: |
|
|
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.
|
|
code_samples:
|
|
- ChatInputBarConfiguration-Typing-Indicator
|
|
type: boolean
|
|
tags:
|
|
- ReadOnly
|
|
- NotReplicated
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: Unsafe
|
|
category: Data
|
|
serialization:
|
|
can_load: false
|
|
can_save: false
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.KeyboardKeyCode
|
|
summary: |
|
|
Additional key users can press to trigger focusing on the default chat
|
|
input bar.
|
|
description: |
|
|
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 <kbd>/</kbd> key.
|
|
code_samples: []
|
|
type: KeyCode
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Behavior
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.PlaceholderColor3
|
|
summary: |
|
|
Color of the text of the placeholder text in the default chat input bar.
|
|
description: |
|
|
Color of the text of the placeholder text in the default chat input bar.
|
|
Default value is `Datatype.Color3|Color3.new(178, 178, 178)`.
|
|
code_samples: []
|
|
type: Color3
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Appearance
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.TargetTextChannel
|
|
summary: |
|
|
A reference to the target `Class.TextChannel`.
|
|
description: |
|
|
Determines which `Class.TextChannel` to use when the user sends a message
|
|
with the default chat input bar.
|
|
code_samples: []
|
|
type: TextChannel
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.TextBox
|
|
summary: |
|
|
Reference to a designated `Class.TextBox` instance that sends messages on
|
|
behalf of the user.
|
|
description: |
|
|
Reference to a designated `Class.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
|
|
`Class.TextBox`, you don't need to write any code for the following
|
|
behavior:
|
|
|
|
- When a user types a message and presses `Enum.KeyCode.Return`, the
|
|
message will be sent to
|
|
`Class.ChatInputBarConfiguration.TargetTextChannel`.
|
|
- When a message is sent, `Class.TextBox.Text` will automatically clear.
|
|
|
|
For security, some limitations are imposed on the `Class.TextBox` when it
|
|
is promoted to `Class.ChatInputBarConfiguration.TextBox`. Luau code will
|
|
not be able to:
|
|
|
|
- Change the `Class.TextBox.Text` property.
|
|
- Use the `Class.TextBox:CaptureFocus()` or `Class.TextBox:ReleaseFocus()`
|
|
methods.
|
|
code_samples: []
|
|
type: TextBox
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: false
|
|
can_save: false
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.TextColor3
|
|
summary: |
|
|
Color of the text in default chat input bar.
|
|
description: |
|
|
Color of the text in default chat input bar. Default value is
|
|
`Datatype.Color3|Color3.new(255, 255, 255)`.
|
|
code_samples: []
|
|
type: Color3
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Appearance
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.TextSize
|
|
summary: |
|
|
Size of the text in default chat input bar.
|
|
description: |
|
|
Size of the text in default chat input bar. Default value is `14`.
|
|
code_samples: []
|
|
type: int64
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Appearance
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.TextStrokeColor3
|
|
summary: |
|
|
Color of the text stroke for text in default chat input bar.
|
|
description: |
|
|
Color of the text stroke for text in default chat input bar. Default value
|
|
is `Datatype.Color3|Color3.new(0, 0, 0)`.
|
|
code_samples: []
|
|
type: Color3
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Appearance
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
- name: ChatInputBarConfiguration.TextStrokeTransparency
|
|
summary: |
|
|
Transparency of the text stroke for text in default chat input bar.
|
|
description: |
|
|
Transparency of the text stroke for text in default chat input bar.
|
|
Default value is `0.5`.
|
|
code_samples: []
|
|
type: double
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Appearance
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
methods: []
|
|
events: []
|
|
callbacks: []
|