SurfaceGuiBase¶
Base class for containers that render GuiObjects onto a face of a BasePart in the 3D world.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
Description¶
SurfaceGuiBase is the LayerCollector base class for containers that render their GuiObject descendants onto a face of a BasePart in the 3D world. SurfaceGui and AdGui inherit from it.
The target part is set through the Adornee property; if no adornee is specified, the container renders on its parent when that parent is a BasePart. The Face property selects which surface of the part the UI is projected onto.
Inheritance¶
Object → Instance → GuiBase → GuiBase2d → LayerCollector → SurfaceGuiBase
Known subclasses: AdGui, SurfaceGui
Properties¶
| Member | Signature | Summary |
|---|---|---|
Active |
Active: bool |
Determines whether the SurfaceGui sinks user input; true by default. |
Adornee |
Adornee: Instance |
BasePart on which to apply the SurfaceGui, overriding the default parent association. |
Face |
Face: NormalId |
NormalId face upon which to apply the SurfaceGui. |
Roblox reference: SurfaceGuiBase
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.