API:Class/BillboardGui

BillboardGui icon.pngBillboardGui : Object Icon.pngLayerCollector : Object Icon.pngGuiBase2d : Object Icon.pngGuiBase : Object Icon.pngInstance

BillboardGuis are containers for GUI objects that appear in the 3D space. A BillboardGui's position is determined by the position of it's Adornee. If the adornee is set to Part then the Position will be used. If it is set to Attachment then the WorldPosition will be used. BillboardGui always faces the camera, and can change its size with distance or remain the same size on the screen. Unlike the text that appears above models with Humanoids' heads, this does not disappear with distance.

Properties

PropertiesmemberhiddenProperties [toggle]

boolActive

Whether or not mouse events will be passed to objects layered below.

|RMD member="API:Class/BillboardGui/Active"|Whether or not mouse events will be passed to objects layered below.|/RMD|
Ref<Attachment, BasePart>Adornee

Sets the part or attachment that the BillboardGui is adorned too.

|RMD member="API:Class/BillboardGui/Adornee"|Sets the part or attachment that the BillboardGui is adorned too.|/RMD|
boolAlwaysOnTop

Determines whether the BillboardGui will always be rendered on top of other objects.

|RMD member="API:Class/BillboardGui/AlwaysOnTop"|Determines whether the BillboardGui will always be rendered on top of other objects.|/RMD|
Vector3ExtentsOffset

A Vector3 (x,y,z) defined in studs that will offset the GUI from the extents of the 3D object it is rendering from.

|RMD member="API:Class/BillboardGui/ExtentsOffset"|A Vector3 (x,y,z) defined in studs that will offset the GUI from the extents of the 3D object it is rendering from.|/RMD|
Vector3ExtentsOffsetWorldSpace

Offsets the BillboardGui relative to it's Adornee's orientation and size.

|RMD member="API:Class/BillboardGui/ExtentsOffsetWorldSpace"|Offsets the BillboardGui relative to it's Adornee's orientation and size.|/RMD|
floatLightInfluence

Controls how much the BillboardGui is influenced by the lighting in the game world.

|RMD member="API:Class/BillboardGui/LightInfluence"|Controls how much the BillboardGui is influenced by the lighting in the game world.|/RMD|
floatMaxDistance

Sets the maximum distance a billboard can be from the camera and still be drawn.

|RMD member="API:Class/BillboardGui/MaxDistance"|Sets the maximum distance a billboard can be from the camera and still be drawn.|/RMD|
Ref<Player>PlayerToHideFrom

Allows you to define a player who is unable to see the BillboardGui.

|RMD member="API:Class/BillboardGui/PlayerToHideFrom"|Allows you to define a player who is unable to see the BillboardGui.|/RMD|
UDim2Size

Sets the size of the BillboardGui as it'll appear in the Roblox "world".

|RMD member="API:Class/BillboardGui/Size"|Sets the size of the BillboardGui as it'll appear in the Roblox "world".|/RMD|
Vector2SizeOffset

Offsets the BillboardGui relative to it's AbsoluteSize.

|RMD member="API:Class/BillboardGui/SizeOffset"|Offsets the BillboardGui relative to it's AbsoluteSize.|/RMD|
Vector3StudsOffset

The offset of the BillboardGui in studs, relative to the Camera's orientation.

|RMD member="API:Class/BillboardGui/StudsOffset"|The offset of the BillboardGui in studs, relative to the Camera's orientation.|/RMD|
Vector3StudsOffsetWorldSpace

Offsets the BillboardGui relative to it's Adornee's orientation, in studs.

|RMD member="API:Class/BillboardGui/StudsOffsetWorldSpace"|Offsets the BillboardGui relative to it's Adornee's orientation, in studs.|/RMD|
Whether or not mouse events will be passed to objects layered below.
Sets the part or attachment that the BillboardGui is adorned too.
Determines whether the BillboardGui will always be rendered on top of other objects.
A Vector3 (x,y,z) defined in studs that will offset the GUI from the extents of the 3D object it is rendering from.
Offsets the BillboardGui relative to it's Adornee's orientation and size.
Controls how much the BillboardGui is influenced by the lighting in the game world.
Sets the maximum distance a billboard can be from the camera and still be drawn.
Allows you to define a player who is unable to see the BillboardGui.
Sets the size of the BillboardGui as it'll appear in the Roblox "world".
Offsets the BillboardGui relative to it's AbsoluteSize.
The offset of the BillboardGui in studs, relative to the Camera's orientation.
Offsets the BillboardGui relative to it's Adornee's orientation, in studs.
Inherited from Object Icon.pngLayerCollector:
boolEnabled

Toggles the visibility of the LayerCollector.

|RMD member="API:Class/LayerCollector/Enabled"|Toggles the visibility of the LayerCollector.|/RMD|
ZIndexBehaviorZIndexBehavior

No documentation found.

|RMD member="API:Class/LayerCollector/ZIndexBehavior"|No documentation found.|/RMD|
Toggles the visibility of the LayerCollector.
No documentation found.
Inherited from Object Icon.pngGuiBase2d:
Vector2AbsolutePosition [readonly]

The distance, in pixels, from the top left corner of the game window under the Topbar.

|RMD member="API:Class/GuiBase2d/AbsolutePosition"|The distance, in pixels, from the top left corner of the game window under the Topbar.|/RMD|
floatAbsoluteRotation [readonly]

The absolute rotation of this gui object.

|RMD member="API:Class/GuiBase2d/AbsoluteRotation"|The absolute rotation of this gui object.|/RMD|
Vector2AbsoluteSize [readonly]

Size of the GUI element in pixels.

|RMD member="API:Class/GuiBase2d/AbsoluteSize"|Size of the GUI element in pixels.|/RMD|
boolLocalize [hidden]

Automatically set to true when a LocalizationTable's Root targets this object, or an ancestor of this object.

|RMD member="API:Class/GuiBase2d/Localize"|Automatically set to true when a LocalizationTable's Root targets this object, or an ancestor of this object.|/RMD|
AbsolutePosition [readonly]
The distance, in pixels, from the top left corner of the game window under the Topbar.
AbsoluteRotation [readonly]
The absolute rotation of this gui object.
AbsoluteSize [readonly]
Size of the GUI element in pixels.
Localize [hidden]
Automatically set to true when a LocalizationTable's Root targets this object, or an ancestor of this object.
Inherited from Object Icon.pngInstance:
boolArchivable

Determines if an object can be Clone or saved to file.

|RMD member="API:Class/Instance/Archivable"|Determines if an object can be Clone or saved to file.|/RMD|
stringClassName [readonly]

The unique name of this type of Instance.

|RMD member="API:Class/Instance/ClassName"|The unique name of this type of Instance.|/RMD|
stringName

A non-unique identifier for the object.

|RMD member="API:Class/Instance/Name"|A non-unique identifier for the object.|/RMD|
Ref<Instance>Parent

The hierarchical parent of the object.

|RMD member="API:Class/Instance/Parent"|The hierarchical parent of the object.|/RMD|
intDataCost [LocalUserSecurity] [deprecated] [readonly]

Deprecated. Do not use.

|RMD member="API:Class/Instance/DataCost"|Deprecated. Do not use.|/RMD|
boolRobloxLocked [PluginSecurity]

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.

|RMD member="API:Class/Instance/RobloxLocked"|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.|/RMD|
boolarchivable [deprecated] [hidden]

Deprecated in favor of Archivable.

|RMD member="API:Class/Instance/archivable"|Deprecated in favor of Archivable.|/RMD|
stringclassName [deprecated] [readonly]

Deprecated in favor of ClassName.

|RMD member="API:Class/Instance/className"|Deprecated in favor of ClassName.|/RMD|
Determines if an object can be Clone or saved to file.
ClassName [readonly]
The unique name of this type of Instance.
A non-unique identifier for the object.
The hierarchical parent of the object.
DataCost [LocalUserSecurity] [deprecated] [readonly]
Deprecated. Do not use.
RobloxLocked [PluginSecurity]
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.
archivable [deprecated] [hidden]
Deprecated in favor of Archivable.
className [deprecated] [readonly]
Deprecated in favor of ClassName.

Functions

FunctionsmemberhiddenFunctions [toggle]

Inherited from Object Icon.pngInstance:
voidClearAllChildren ( )

Removes all descendants of the object.

|RMD member="API:Class/Instance/ClearAllChildren"|Removes all descendants of the object.|/RMD|
Ref<Instance>Clone ( )

Returns a copy of the object, including descendants, but only if the object is Archivable.

|RMD member="API:Class/Instance/Clone"|Returns a copy of the object, including descendants, but only if the object is Archivable.|/RMD|
voidDestroy ( )

Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.

|RMD member="API:Class/Instance/Destroy"|Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.|/RMD|
Ref<Instance>FindFirstAncestor ( string name )

Returns the first ancestor whose Name is equal to name, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestor"|Returns the first ancestor whose Name is equal to name, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorOfClass ( string className )

Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorOfClass"|Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorWhichIsA"|Returns the first ancestor that inherits the class className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstChild ( string name, bool recursive = false )

Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.

|RMD member="API:Class/Instance/FindFirstChild"|Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.|/RMD|
Ref<Instance>FindFirstChildOfClass ( string className )

Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.

|RMD member="API:Class/Instance/FindFirstChildOfClass"|Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.|/RMD|
Ref<Instance>FindFirstChildWhichIsA ( string className, bool recursive = false )

Returns the first child that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstChildWhichIsA"|Returns the first child that inherits the class className, or nil if none can be found.|/RMD|
array<Instance>GetChildren ( )

Returns an array of the object's children.

|RMD member="API:Class/Instance/GetChildren"|Returns an array of the object's children.|/RMD|
array<Instance>GetDescendants ( )

Returns an array containing all of the descendants of the instance.

|RMD member="API:Class/Instance/GetDescendants"|Returns an array containing all of the descendants of the instance.|/RMD|
stringGetFullName ( )

Returns a string which shows the object's ancestry chain.

|RMD member="API:Class/Instance/GetFullName"|Returns a string which shows the object's ancestry chain.|/RMD|
RBXScriptSignalGetPropertyChangedSignal ( string property )

Returns a signal that is fired when the specified property is changed on this object.

|RMD member="API:Class/Instance/GetPropertyChangedSignal"|Returns a signal that is fired when the specified property is changed on this object.|/RMD|
boolIsA ( string className )

Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.

|RMD member="API:Class/Instance/IsA"|Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.|/RMD|
boolIsAncestorOf ( Instance descendant )

Returns true if the object is an ancestor of the given descendant.

|RMD member="API:Class/Instance/IsAncestorOf"|Returns true if the object is an ancestor of the given descendant.|/RMD|
boolIsDescendantOf ( Instance ancestor )

Returns true if the object is a descendant of the given ancestor.

|RMD member="API:Class/Instance/IsDescendantOf"|Returns true if the object is a descendant of the given ancestor.|/RMD|
Ref<Instance>WaitForChild ( string childName, double timeOut )

Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.

|RMD member="API:Class/Instance/WaitForChild"|Yields the current thread until a child with the given name is found, then returns the child.

If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.|/RMD|

stringGetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]

Returns a coded string of the object's DebugId used internally by Roblox.

|RMD member="API:Class/Instance/GetDebugId"|Returns a coded string of the object's DebugId used internally by Roblox.|/RMD|
voidRemove ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Instance/Remove"|Deprecated. Do not use.|/RMD|
array<Instance>children ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/children"|Deprecated in favor of GetChildren.|/RMD|
Instanceclone ( ) [deprecated]

Deprecated in favor of Clone.

|RMD member="API:Class/Instance/clone"|Deprecated in favor of Clone.|/RMD|
voiddestroy ( ) [deprecated]

Deprecated in favor of Destroy.

|RMD member="API:Class/Instance/destroy"|Deprecated in favor of Destroy.|/RMD|
InstancefindFirstChild ( string name, bool recursive = false ) [deprecated]

Deprecated in favor of FindFirstChild.

|RMD member="API:Class/Instance/findFirstChild"|Deprecated in favor of FindFirstChild.|/RMD|
array<Instance>getChildren ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/getChildren"|Deprecated in favor of GetChildren.|/RMD|
boolisA ( string className ) [deprecated]

Deprecated in favor of IsA.

|RMD member="API:Class/Instance/isA"|Deprecated in favor of IsA.|/RMD|
boolisDescendantOf ( Instance ancestor ) [deprecated]

Deprecated in favor of IsDescendantOf.

|RMD member="API:Class/Instance/isDescendantOf"|Deprecated in favor of IsDescendantOf.|/RMD|
voidremove ( ) [deprecated]

Deprecated in favor of Remove.

|RMD member="API:Class/Instance/remove"|Deprecated in favor of Remove.|/RMD|
Removes all descendants of the object.
Clone ( )
Returns a copy of the object, including descendants, but only if the object is Archivable.
Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Returns the first ancestor whose Name is equal to name, or nil if none can be found.
Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.
Returns the first ancestor that inherits the class className, or nil if none can be found.
FindFirstChild ( string name, bool recursive = false )
Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.
Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.
FindFirstChildWhichIsA ( string className, bool recursive = false )
Returns the first child that inherits the class className, or nil if none can be found.
Returns an array of the object's children.
Returns an array containing all of the descendants of the instance.
Returns a string which shows the object's ancestry chain.
Returns a signal that is fired when the specified property is changed on this object.
IsA ( string className )
Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.
IsAncestorOf ( Instance descendant )
Returns true if the object is an ancestor of the given descendant.
Returns true if the object is a descendant of the given ancestor.
WaitForChild ( string childName, double timeOut )
Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.
GetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]
Returns a coded string of the object's DebugId used internally by Roblox.
Remove ( ) [deprecated]
Deprecated. Do not use.
children ( ) [deprecated]
Deprecated in favor of GetChildren.
clone ( ) [deprecated]
Deprecated in favor of Clone.
destroy ( ) [deprecated]
Deprecated in favor of Destroy.
findFirstChild ( string name, bool recursive = false ) [deprecated]
Deprecated in favor of FindFirstChild.
getChildren ( ) [deprecated]
Deprecated in favor of GetChildren.
isA ( string className ) [deprecated]
Deprecated in favor of IsA.
isDescendantOf ( Instance ancestor ) [deprecated]
Deprecated in favor of IsDescendantOf.
remove ( ) [deprecated]
Deprecated in favor of Remove.


Events

EventsmemberhiddenEvents [toggle]

Inherited from Object Icon.pngInstance:
AncestryChanged ( Instance child, Instance parent )

Fires when the Parent property of the object or one of its ancestors is changed.

|RMD member="API:Class/Instance/AncestryChanged"|Fires when the Parent property of the object or one of its ancestors is changed.|/RMD|
Changed ( string property )

Fires after a property of the object changes.

|RMD member="API:Class/Instance/Changed"|Fires after a property of the object changes.|/RMD|
ChildAdded ( Instance child )

Fires when a child is added to the object.

|RMD member="API:Class/Instance/ChildAdded"|Fires when a child is added to the object.|/RMD|
ChildRemoved ( Instance child )

Fires when a child is removed from the object.

|RMD member="API:Class/Instance/ChildRemoved"|Fires when a child is removed from the object.|/RMD|
DescendantAdded ( Instance descendant )

Fires when a descendant is added to the object.

|RMD member="API:Class/Instance/DescendantAdded"|Fires when a descendant is added to the object.|/RMD|
DescendantRemoving ( Instance descendant )

Fires before a descendant of the object is removed.

|RMD member="API:Class/Instance/DescendantRemoving"|Fires before a descendant of the object is removed.|/RMD|
childAdded ( Instance child ) [deprecated]

Deprecated in favor of ChildAdded.

|RMD member="API:Class/Instance/childAdded"|Deprecated in favor of ChildAdded.|/RMD|
Fires when the Parent property of the object or one of its ancestors is changed.
Changed ( string property )
Fires after a property of the object changes.
Fires when a child is added to the object.
Fires when a child is removed from the object.
DescendantAdded ( Instance descendant )
Fires when a descendant is added to the object.
Fires before a descendant of the object is removed.
childAdded ( Instance child ) [deprecated]
Deprecated in favor of ChildAdded.

|RMD member="API:Class/BillboardGui"|BillboardGuis are containers for GUI objects that appear in the 3D space. A BillboardGui's position is determined by the position of it's Adornee. If the adornee is set to Part then the Position will be used. If it is set to Attachment then the WorldPosition will be used. BillboardGui always faces the camera, and can change its size with distance or remain the same size on the screen. Unlike the text that appears above models with Humanoids' heads, this does not disappear with distance. |/RMD|