BillboardGui
Displays a camera-facing interface at a world position.
- Creatable
Instance.new("BillboardGui")- Inherits
- GuiLayerCollectorGuiBase2dGuiBaseInstance
- Replication
- Standard
Behavior
BillboardGui displays a camera-facing interface at a world position.
Summary
Whether this interface accepts and consumes input.
The Instance used to position or size this world-space interface or adornment.
Whether the world-space interface renders over occluding geometry.
Whether this interface root and its descendants are displayed.
The offset from the adorned bounds, expressed relative to those bounds.
The player for whom this BillboardGui is hidden.
Whether this interface is recreated when the player's character respawns.
The element size relative to its parent.
The normalized offset applied to a BillboardGui's displayed size.
The offset of a world-space interface, in studs.
Returns this instance if it is an ExecutionGroup.
Properties
Active
BillboardGui.Active: boolean = falseWhether this interface accepts and consumes input.
Adornee
BillboardGui.Adornee: Instance? = nilThe Instance used to position or size this world-space interface or adornment.
AlwaysOnTop
BillboardGui.AlwaysOnTop: boolean = falseWhether the world-space interface renders over occluding geometry.
Enabled
BillboardGui.Enabled: boolean = trueWhether this interface root and its descendants are displayed.
ExtentsOffset
BillboardGui.ExtentsOffset: Vector3 = Vector3.new(0, 0, 0)The offset from the adorned bounds, expressed relative to those bounds.
PlayerToHideFrom
BillboardGui.PlayerToHideFrom: Player? = nilThe player for whom this BillboardGui is hidden.
ResetOnSpawn
BillboardGui.ResetOnSpawn: boolean = trueWhether this interface is recreated when the player's character respawns.
Size
The element size relative to its parent. Scale components use the parent size; offsets are in pixels.
SizeOffset
BillboardGui.SizeOffset: Vector2 = Vector2.new(0, 0)The normalized offset applied to a BillboardGui's displayed size.
StudsOffset
BillboardGui.StudsOffset: Vector3 = Vector3.new(0, 0, 0)The offset of a world-space interface, in studs.
Methods
GetExecutionGroup
BillboardGui:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying