BillboardGui

BillboardGui
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Category	GUI
Memory category	Instances
Inheritance
Object Instance GuiBase GuiBase2d LayerCollector BillboardGui

A GUI that adorns an object in the 3D world. Add Frames/Labels/Buttons to this object to have them rendered while attached to a 3D object.

Properties

Active: bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/Active.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

Adornee: Instance

Determines the BasePart or Attachment a BillboardGui is positioned and displayed relative to. When no Adornee is set, the BillboardGui's parent is used if it is a BasePart or Attachment.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

AlwaysOnTop: bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/AlwaysOnTop.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

Brightness: float

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/Brightness.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

ClipsDescendants: bool

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/ClipsDescendants.

• Category: Behavior.
• Serialization: can save and load.
• Thread safety: read safe

CurrentDistance: float

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/CurrentDistance.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

DistanceLowerLimit: float

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/DistanceLowerLimit.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

DistanceStep: float

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/DistanceStep.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

DistanceUpperLimit: float

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/DistanceUpperLimit.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

ExtentsOffset: Vector3

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/ExtentsOffset.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

ExtentsOffsetWorldSpace: Vector3

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/ExtentsOffsetWorldSpace.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

LightInfluence: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/LightInfluence.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

MaxDistance: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/MaxDistance.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

PlayerToHideFrom: Instance

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/PlayerToHideFrom.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

Size: UDim2

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/Size.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

SizeOffset: Vector2

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/SizeOffset.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

StudsOffset: Vector3

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/StudsOffset.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

StudsOffsetWorldSpace: Vector3

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/StudsOffsetWorldSpace.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

Methods

GetScreenSpaceBounds(): Variant

This class member is missing documentation. Create or add to its subpage at Class:BillboardGui/GetScreenSpaceBounds.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Removed members

Properties

• Enabled

External links

• BillboardGui in the Roblox Creator Documentation
• BillboardGui in the Roblox API Reference