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
553AdorneeName: string
553BackgroundColor3: Color3
553BackgroundTransparency: double
553BubbleDuration: float
553BubblesSpacing: float
553Enabled: bool
553FontFace: Font
553LocalPlayerStudsOffset: Vector3
580MaxBubbles: float
553MaxDistance: float
553MinimizeDistance: float
580TailVisible: bool
553TextColor3: Color3
553TextSize: int64
553VerticalStudsOffset: float
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

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

History 31

Members 16

AdorneeName

TypeDefault
stringHumanoidRootPart

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 2

BackgroundColor3

TypeDefault
Color30.980392, 0.980392, 0.980392

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

History 2

BackgroundTransparency

TypeDefault
double0.10000000000000000555

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 1

BubbleDuration

TypeDefault
float15

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

History 2

BubblesSpacing

TypeDefault
float6

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

History 2

Enabled

TypeDefault
booltrue

Whether text chat bubbles are enabled. Default is false.

History 2

FontFace

TypeDefault
Font

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

History 2

LocalPlayerStudsOffset

TypeDefault
Vector30, 0, 0

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

History 2

MaxBubbles

TypeDefault
float3

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 1

MaxDistance

TypeDefault
float100

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

History 2

MinimizeDistance

TypeDefault
float40

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

History 2

TailVisible

TypeDefault
booltrue

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

History 1

TextColor3

TypeDefault
Color30.223529, 0.231373, 0.239216

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

History 2

TextSize

TypeDefault
int6416

Size of bubble text. Default is 16.

History 2

VerticalStudsOffset

TypeDefault
float0

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

History 2

Settings