We use cookies on this site to enhance your user experience
Collapse Sidebar

BillboardGui

Deprecated

BillboardGui

Deprecated

BillboardGuis are containers for GUI objects that appear in the 3D space. A BillboardGui’s position is determined by the position of it’s BillboardGui/Adornee. If the adornee is set to Part then the BasePart/Position will be used. If it is set to Attachment then the Attachment/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

bool

Active

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

Instance

Adornee

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

bool

AlwaysOnTop

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

bool

ClipsDescendants

When set to true, portions of GuiObjects that fall outside of the BillboardGui’s canvas borders will not be drawn.

Vector3

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.

Vector3

ExtentsOffsetWorldSpace

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

float

LightInfluence

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

float

MaxDistance

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

Instance

PlayerToHideFrom

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

UDim2

Size

Sets the size of the BillboardGui as it’ll appear in the Roblox “world”.

Vector2

SizeOffset

Offsets the BillboardGui relative to it’s AbsoluteSize.

Vector3

StudsOffset

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

Vector3

StudsOffsetWorldSpace

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

Inherited from LayerCollector: Show Hide

ZIndexBehavior

ZIndexBehavior

Changes how ZIndex behaves on all descendants of the LayerCollector.
bool

ResetOnSpawn

Controls how this LayerCollector behaves when its associated `Player` respawns.
bool

Enabled

Toggles the visibility of the LayerCollector.

Inherited from GuiBase2d: Show Hide

LocalizationTable

RootLocalizationTable

A reference to a `LocalizationTable` to be used to apply automated localization to this GuiBase2d and its descendants.
bool

AutoLocalize

When set to true, localization will be applied to this GuiBase2d and its descendants based on the `GuiBase2d/RootLocalizationTable` specified for this GuiBase2d.
Vector2

AbsoluteSize

[ReadOnly] [NotReplicated]
Describes the actual screen size of a UI element, in pixels.
float

AbsoluteRotation

[ReadOnly] [NotReplicated]
Describes the actual screen rotation of a UI element, in degrees.
Vector2

AbsolutePosition

[ReadOnly] [NotReplicated]
Describes the actual screen position of a UI element, in pixels.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

Inherited from Instance: Show Hide

Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.