# BillboardGui Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448). - Inherits from, nearest first: [LayerCollector](https://rapi.sleaze.dev/classes/LayerCollector.md), [GuiBase2d](https://rapi.sleaze.dev/classes/GuiBase2d.md), [GuiBase](https://rapi.sleaze.dev/classes/GuiBase.md), [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md) - Memory category: Instances - HTML page: https://rapi.sleaze.dev/classes/BillboardGui/ - Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/BillboardGui A container for `GuiObjects` that renders in 3D space facing the camera. ## Properties ### ClipsDescendants ```luau BillboardGui.ClipsDescendants: boolean = false ``` - Tags: Read capabilities: UI Whether portions of `GuiObjects` that fall outside of the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) canvas borders will be drawn. ### Active ```luau BillboardGui.Active: boolean = false ``` - Tags: Read capabilities: UI Controls whether the descendants will receive input events. ### Adornee ```luau BillboardGui.Adornee: Instance ``` - Tags: Read capabilities: UI Sets the target part or attachment that the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) is positioned relative to. ### AlwaysOnTop ```luau BillboardGui.AlwaysOnTop: boolean = false ``` - Tags: Read capabilities: UI Determines whether the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) will always be rendered on top of other 3D objects. ### Brightness ```luau BillboardGui.Brightness: number = 1 ``` - Tags: Read capabilities: UI Determines the factor by which the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) container's light is scaled when [`LightInfluence`](https://rapi.sleaze.dev/classes/BillboardGui.md) is `0`. ### CurrentDistance ```luau BillboardGui.CurrentDistance: number = 0 ``` - Tags: Read only, Read capabilities: UI The current distance in studs that the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) is from the player's camera. ### DistanceStep ```luau BillboardGui.DistanceStep: number = 0 ``` - Tags: Not replicated, Read capabilities: UI, Load only Determines the size [`CurrentDistance`](https://rapi.sleaze.dev/classes/BillboardGui.md) increments and decrements in studs as the player's camera moves closer and further from the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md). ### ExtentsOffset ```luau BillboardGui.ExtentsOffset: Vector3 = Vector3.zero ``` - Tags: Read capabilities: UI Determines how the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) is offset from its [`Adornee`](https://rapi.sleaze.dev/classes/BillboardGui.md), relative to the [`Camera`](https://rapi.sleaze.dev/classes/Camera.md) orientation, in units half the dimensions of the model's [`Camera`](https://rapi.sleaze.dev/classes/Camera.md)-aligned bounding box. ### ExtentsOffsetWorldSpace ```luau BillboardGui.ExtentsOffsetWorldSpace: Vector3 = Vector3.zero ``` - Tags: Read capabilities: UI Determines how the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) is offset from its [`Adornee`](https://rapi.sleaze.dev/classes/BillboardGui.md), relative to the global axes, in units half the dimensions of the model's axis-aligned bounding box. ### LightInfluence ```luau BillboardGui.LightInfluence: number = 0 ``` - Tags: Read capabilities: UI Controls how much the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) is influenced by environmental lighting. ### MaxDistance ```luau BillboardGui.MaxDistance: number = INF ``` - Tags: Read capabilities: UI Controls how far away the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) can be displayed before it stops rendering. ### PlayerToHideFrom ```luau BillboardGui.PlayerToHideFrom: Instance ``` - Tags: Read capabilities: UI Used by scripts to hide the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) from a specific player. ### Size ```luau BillboardGui.Size: UDim2 = UDim2.new(0, 0, 0, 0) ``` - Tags: Read capabilities: UI Controls the size that the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) will have on screen. ### SizeOffset ```luau BillboardGui.SizeOffset: Vector2 = Vector2.zero ``` - Tags: Read capabilities: UI A 2D offset in size-relative units that acts like an anchor point. ### StudsOffset ```luau BillboardGui.StudsOffset: Vector3 = Vector3.zero ``` - Tags: Read capabilities: UI Determines how the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) is offset from its [`Adornee`](https://rapi.sleaze.dev/classes/BillboardGui.md) in studs, relative to the [`Camera`](https://rapi.sleaze.dev/classes/Camera.md) orientation. ### StudsOffsetWorldSpace ```luau BillboardGui.StudsOffsetWorldSpace: Vector3 = Vector3.zero ``` - Tags: Read capabilities: UI Determines how the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) is offset from its [`Adornee`](https://rapi.sleaze.dev/classes/BillboardGui.md) in studs, relative to the global axes. ### DistanceLowerLimit ```luau BillboardGui.DistanceLowerLimit: number = 0 ``` - Tags: Deprecated, Read capabilities: UI **Deprecated:** Determines the distance in studs at which the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) will stop scaling larger in size. ### DistanceUpperLimit ```luau BillboardGui.DistanceUpperLimit: number = -1 ``` - Tags: Deprecated, Read capabilities: UI **Deprecated:** Determines the distance in studs at which the [`BillboardGui`](https://rapi.sleaze.dev/classes/BillboardGui.md) will stop scaling smaller in size. ## Methods ### GetScreenSpaceBounds ```luau BillboardGui:GetScreenSpaceBounds(): any ``` - Tags: Roblox script security, Capabilities: UI ## Inherited members - From [LayerCollector](https://rapi.sleaze.dev/classes/LayerCollector.md): `Enabled`, `ResetOnSpawn`, `TabKeyboardNavigation`, `ZIndexBehavior`, `GetGuiObjectsAtPosition`, `GetLayoutNodeTree` - From [GuiBase2d](https://rapi.sleaze.dev/classes/GuiBase2d.md): `AbsolutePosition`, `AbsoluteRotation`, `AbsoluteSize`, `ActiveQueryNames`, `ReplicatedInsertionOrder`, `ClippedRect`, `IsNotOccluded`, `RawRect2D`, `TotalGroupScale`, `AutoLocalize`, `RootLocalizationTable`, `Localize`, `SelectionBehaviorDown`, `SelectionBehaviorLeft`, `SelectionBehaviorRight`, `SelectionBehaviorUp`, `SelectionGroup`, `SelectionChanged` - From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded` - From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`