extends LayerCollector
Class fields
| Field | XML type | Value |
|---|---|---|
Name | string | BillboardGui |
summary | string | A GUI that adorns an object in the 3D world. Add Frames/Labels/Buttons to this object to have them rendered while attached to a 3D object |
ExplorerOrder | string | 14 |
ExplorerImageIndex | string | 64 |
PreferredParent | string | StarterGui |
Properties
9Active
bool| Field | XML type | Value |
|---|---|---|
Name | string | Active |
summary | string | If true, this GuiObject can fire mouse events and will pass them to any GuiObjects layered underneath, while false will do neither. |
Adornee
Object| Field | XML type | Value |
|---|---|---|
Name | string | Adornee |
summary | string | The Object the billboard gui uses as its base to render from. Currently, the only way to set this property is thru a script, and must exist in the workspace. This will only render if the object assigned derives from BasePart. |
AlwaysOnTop
bool| Field | XML type | Value |
|---|---|---|
Name | string | AlwaysOnTop |
summary | string | If true, billboard gui does not get occluded by 3D objects, but always renders on the screen. |
Enabled
bool| Field | XML type | Value |
|---|---|---|
Name | string | Enabled |
summary | string | If true, billboard gui will render, otherwise rendering will be skipped. |
ExtentsOffset
Vector3| Field | XML type | Value |
|---|---|---|
Name | string | ExtentsOffset |
summary | string | A Vector3 (x,y,z) defined in studs that will offset the gui from the extents of the 3d object it is rendering from. |
PlayerToHideFrom
Object| Field | XML type | Value |
|---|---|---|
Name | string | PlayerToHideFrom |
summary | string | Specifies a Player that the BillboardGui will not render to. |
Size
UDim2| Field | XML type | Value |
|---|---|---|
Name | string | Size |
summary | string | A UDim2 value describing the size of the BillboardGui. More information on UDim2 is available <a href="http://wiki.roblox.com/index.php/UDim2" target="_blank">here</a>. Relative values are defined as one-to-one with studs. |
SizeOffset
Vector2| Field | XML type | Value |
|---|---|---|
Name | string | SizeOffset |
summary | string | A Vector2 (x,y) defined in studs that will offset the gui size from it's current size. |
StudsOffset
Vector3| Field | XML type | Value |
|---|---|---|
Name | string | StudsOffset |
summary | string | A Vector3 (x,y,z) defined in studs that will offset the gui from the centroid of the 3d object it is rendering from |