RBX.lua.BillboardGui (Object)
From Legacy Roblox Wiki
Derived Classes
None
A BillboardGui is a GUI object that can 'stick to' Part objects in what appears to be 3D space. It always faces the camera, and appears to get smaller as the camera gets farther away from it. Unlike the text that appears above models with Humanoids' heads, this does not disappear or resize. Also, unlike BubbleChat, this object does not give big text to its descendants.
Usage
Example (in LocalScript)
local player = game.Players.LocalPlayer
local character = player.Character
local bg = Instance.new("BillboardGui")
bg.Parent = player.PlayerGui
bg.Adornee = character.Head
-- Same size as Head
bg.Size = UDim2.new(1, 0, 1, 0)
-- Above (defaults to inside)
bg.StudsOffset = Vector3.new(0, 2, 0)
local frame = Instance.new("Frame")
frame.Parent = bg
frame.Size = UDim2.new(1, 0, 1, 0)
frame.BackgroundTransparency = 0.7
frame.BackgroundColor3 = Color3.new(1, 1, 1)
local text = Instance.new("TextLabel")
text.Parent = frame
text.Position = UDim2.new(0.25, 0, 0.25, 0)
text.Size = UDim2.new(0.5, 0, 0.5, 0)
text.Text = "Hello"
 Clone( )
| |
| Returns | Instance |
| Description: | Returns a clone of the object and its children, unless its Archivable property is false. The clone will have the same properties as the original object and the same descendants (except those with an Archivable property set to false). The clone's Parent will be nil. |
| Member of: | Instance |
| FindFirstChild( string name, bool recursive = false )
| |
| Returns | Instance |
| Description: | Returns the first child found with a name of name. Returns nil if no such child exists. If the optional recursive argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object. |
| Member of: | Instance |
| GetChildren( )
| |
| Returns | table |
| Description: | Returns a read-only table of the object's children. |
| Member of: | Instance |
 GetDebugId( int scopeLength )
| |
| Returns | string |
| Description: | Returns a coded string of the object's DebugId used internally by Roblox. |
| Member of: | Instance |
| GetFullName( )
| |
| Returns | String path to object |
| Description: | Returns a string with a dot (.) character separating a path of object hierarchy excluding "game". |
| Member of: | Instance |
| IsA( string className )
| |
| Returns | bool |
| Description: | Returns true if the Instance is that class or a subclass. |
| Member of: | Instance |
| IsAncestorOf( Instance descendant )
| |
| Returns | boolean is ancestor |
| Description: | Returns true if the object is an ancestor of descendant. |
| Member of: | Instance |
| IsDescendantOf( Instance ancestor )
| |
| Returns | bool |
| Description: | Returns true if the object is an descendant of ancestor. |
| Member of: | Instance |
| Destroy( )
| |
| Returns | nil |
| Description: | Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children. |
| Member of: | Instance |
| ClearAllChildren( )
| |
| Returns | nil |
| Description: | Removes all descendants of the Instance, but leaves the Instance itself. |
| Member of: | Instance |
 Active
| |
| Type | bool |
| Description | true will react to mouse events, and pass them to any objects layered underneath, while false won't. |
| Member of | BillboardGui, GuiObject, HopperBin |
| Adornee
| |
| Type | Instance |
| Description | Sets the object in which to adorn to. |
| Member of | BillboardGui, PartAdornment, PVAdornment |
| AlwaysOnTop
| |
| Property | bool |
| Description | Defines whether the BillboardGui will always be on top or not. |
| Member of | BillboardGui |
| Enabled
| |
| Property | Bool Enabled |
| Description | Enables the functionality of an object |
| Member of | Flag, Sparkles, Tool, Fire, StudioTool |
| ExtentsOffset
| |
| Property | UDim2 ExtentsOffset |
| Description | GUI Offset scaled to ??? |
| Member of | BillboardGui |
| PlayerToHideFrom
| |
| Property | Player |
| Description | The BillboardGui will not be shown to this player. |
| Member of | BillboardGui |
| Size
| |
| Property | UDim2 Size |
| Description | Sets the size of the GUI object in object coordinates. |
| Member of | GuiObject |
| SizeOffset
| |
| Property | Vector2 SizeOffset |
| Description | GUI Offset scaled to Size of Adornee |
| Member of | BillboardGui |
| StudsOffset
| |
| Property | Vector3 Offset |
| Description | Sets the offset of a GUI in studs. |
| Member of | BillboardGui |
| AbsolutePosition
| |
| Type | Vector2 |
| Description | The distance, in pixels, from the top left corner of the game window. |
| Member of | GuiBase |
| AbsoluteSize
| |
| Type | Vector2 |
| Description | Size of the render window in pixels. |
| Member of | GuiBase |
| Name
| |
| Type | string |
| Description | The name of the object, which is often used to identify it in the context of its parent. Note that names are not unique identifiers; multiple children of an object may share the same name. In a script where you want to access an object using a name, for example, game.Workspace["Brick"], the first object found with that name is that object. This "first object" can be found in the Explorer menu.Names are great for showing a very brief title or summary of an object. |
| Member of | Instance |
| Parent
| |
| Type | Instance |
| Description | The hierarchical parent of the object. When no scripts hold references to an object, it will still be maintained as long as it's parent is set to an object which does have references to it, either by other objects or scripts. The toplevel DataModel object (the one referred to as the "game" by scripts) has no parent, but always has a reference held to it by the game engine, and exists for the duration of a session. |
| Member of | Instance |
| Archivable
| |
| Type | bool |
| Description | Sets whether or not the object is saved when publishing or saving to file. Also sets whether or not the object is clonable. |
| Member of | Instance |
| ClassName
| |
| Type | string |
| Description | A unique string per type of Instance. Should only be used as a unique identifier, as it does not reveal any information about nature of the type hierarchy the type is in. For this use, see IsA. |
| Member of | Instance |
 RobloxLocked
| |
| Type | bool |
| Description | If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted. |
| Member of | Instance |
| DataCost
| |
| Type | int |
| Description | How much saving this instance with SaveInstance will add to DataComplexity |
| Member of | Instance |
 AncestryChanged ( Instance child, Instance parent )
| |
| Description | Fired when an ancestor of the Instance the event which is a member of child has its parent changed to parent. |
|---|---|
| Member of: | Instance |
| Changed ( Property property )
| |
| Description | Fired whenever a property of the object changes. |
|---|---|
| Member of: | Instance |
| ChildAdded ( Instance child )
| |
| Description | Fired after a child is added. |
|---|---|
| Member of: | Instance |
| ChildRemoved ( Instance child )
| |
| Description | Fired when a child is removed from the object. |
|---|---|
| Member of: | Instance |
| DescendantAdded ( Instance descendant )
| |
| Description | Fired when a descendant is added to the object. |
|---|---|
| Member of: | Instance |
| DescendantRemoving ( Instance descendant )
| |
| Description | Fired when a descendant is being removed. |
|---|---|
| Member of: | Instance |
