BillboardGui

Show Deprecated

BillboardGui is a container for UI objects to appear in the 3D space but always face the camera. The container's position is relative to the parent BasePart or Attachment (or the Adornee). For BaseParts, the Position property is used, while for Attachments, the WorldPosition property is used.

BillboardGui with a TextLabel describing the screen console it floats above.

A billboard's Size property works slightly differently than GuiObject.Size. While the offset components work the same, the scale components are used as stud sizes in 3D space.

When creating a size-scaled BillboardGui that contains a TextLabel, it's useful to enable the label's TextScaled property so that its text scales along with the billboard canvas as the camera distance changes.

Note that interactive UI elements like ImageButtons and TextButtons inside a BillboardGui will only receive user input if they are parented to the PlayerGui, typically via placing the BillboardGui inside StarterGui. The Adornee property can be used to target a part or attachment in the 3D world while the BillboardGui itself remains in the PlayerGui.

See In-Experience UI for a guide on working with BillboardGui containers.

Caching Behavior

To help improve performance, the appearance of a BillboardGui is cached until one of the following occurs, after which its appearance will be recomputed on the next rendering frame.

Summary

Properties

Properties inherited from LayerCollector

Properties

Properties inherited from GuiBase2d

Properties

Events

Events inherited from GuiBase2d

Events

Properties

Active

Read Parallel

Adornee

Read Parallel

AlwaysOnTop

Read Parallel

Brightness

Read Parallel

ClipsDescendants

Read Parallel

CurrentDistance

Read Only
Not Replicated
Read Parallel

DistanceLowerLimit

Read Parallel

DistanceStep

Read Parallel

DistanceUpperLimit

Read Parallel

ExtentsOffset

Read Parallel

ExtentsOffsetWorldSpace

Read Parallel

LightInfluence

Read Parallel

MaxDistance

Read Parallel

PlayerToHideFrom

Read Parallel

Size

Read Parallel

SizeOffset

Read Parallel

StudsOffset

Read Parallel

StudsOffsetWorldSpace

Read Parallel

Methods

Events