Class
SurfaceGuiBase
NotCreatable
Base class for containers that render GuiObjects onto a face
of a BasePart in the 3D world.
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.
Properties 3#
Activeboolean | Determines whether the SurfaceGui sinks user input; true by
default.ReadSafe |
AdorneeInstance | BasePart on which to apply the SurfaceGui, overriding the
default parent association.ReadSafe |
FaceNormalId | NormalId face upon which to apply the SurfaceGui.ReadSafe |
Active: boolean#
ReadSafe
This property determines whether the SurfaceGui will sink input,
for example if the parent or Adornee part
contains a ClickDetector class like DragDetector.
Note that interactive UI elements like ImageButtons
and TextButtons inside a SurfaceGui will only
receive user input if they are parented to the PlayerGui (the
SurfaceGui.Adorneee property can be used to target a part in the
3D world while the SurfaceGui itself remains in the
PlayerGui). Additionally, the part's
CanQuery property must be true for the
interactive UI element to receive input.
Adornee: Instance#
ReadSafe
BasePart on which to apply the SurfaceGui, overriding the
default parent association.
Face: NormalId#
ReadSafe
NormalId face of the SurfaceGui parent (or its
Adornee) upon which to apply the
SurfaceGui.
Inherited members#
Inherited from GuiBase2d 12
Properties (11)
AbsolutePosition, AbsoluteRotation, AbsoluteSize, AutoLocalize, Localize, RootLocalizationTable, SelectionBehaviorDown, SelectionBehaviorLeft, SelectionBehaviorRight, SelectionBehaviorUp, SelectionGroup
Events (1)
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild