Reference API Roblox

Engine API

Website

Related

Reference API Roblox

BubbleChatConfiguration

Allows for customization of text chat bubbles through TextChatService.

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

Member index 16

HistoryMember
726AdorneeName: string
726BackgroundColor3: Color3
726BackgroundTransparency: double
726BubbleDuration: float
726BubblesSpacing: float
726Enabled: bool
726FontFace: Font
726LocalPlayerStudsOffset: Vector3
726MaxBubbles: float
726MaxDistance: float
726MinimizeDistance: float
726TailVisible: bool
726TextColor3: Color3
726TextSize: int64
726VerticalStudsOffset: float
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: 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
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Description

Allows for customization of text chat bubbles through TextChatService. See Bubble Chat for implementation details.

History 47

Members 16

AdorneeName

TypeDefault
string

String name of the body part or Attachment that bubbles attach to; if multiple instances of the same name exist, the system attaches to the first instance found. Default is "HumanoidRootPart".

History 3

BackgroundColor3

TypeDefault
Color3

Color3 background color of bubbles. Default is Color3.fromRGB(250, 250, 250).

History 3

BackgroundTransparency

TypeDefault
double

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

History 2

BubbleDuration

TypeDefault
float

Time before a bubble fades out, in seconds. Default is 30.

History 3

BubblesSpacing

TypeDefault
float

Vertical space between stacked bubbles, in pixels. Default is 6.

History 3

Enabled

TypeDefault
bool

Whether text chat bubbles are enabled. Default is false.

History 3

FontFace

TypeDefault
Font

Font of the bubble text. Similar to BubbleChatConfiguration.Font but allows setting fonts that don't exist in Font.

History 3

LocalPlayerStudsOffset

TypeDefault
Vector3

If adorned to the local player, Vector3 offset of bubbles from their adornee, in studs, relative to the camera orientation.

History 3

MaxBubbles

TypeDefault
float

Maximum number of text chat bubbles shown per user. If the number of bubbles exceeds this maximum, the system removes bubbles from the oldest one. Default is 3.

History 2

MaxDistance

TypeDefault
float

Maximum distance from the camera that bubbles are shown. Default is 100.

History 3

MinimizeDistance

TypeDefault
float

Distance from the camera when bubbles turn into a single bubble with an ellipsis () to indicate chatter.

History 3

TailVisible

TypeDefault
bool

Determines if the tail at the bottom of the text chat bubbles is visible. Default is True.

History 2

TextColor3

TypeDefault
Color3

Color3 color of bubble text. Default is Color3.fromRGB(57, 59, 61).

History 3

TextSize

TypeDefault
int64

Size of bubble text. Default is 16.

History 3

VerticalStudsOffset

TypeDefault
float

Extra space between bubbles and their adornee, in studs. Default is 0.

History 3

Settings