SurfaceGui
Displays an interface on a face of a world-space Part.
- Creatable
Instance.new("SurfaceGui")- Inherits
- GuiLayerCollectorGuiBase2dGuiBaseInstance
- Replication
- Standard
Behavior
SurfaceGui displays an interface on a face of a world-space Part.
Summary
Whether this interface accepts and consumes input.
The Instance used to position or size this world-space interface or adornment.
Whether the world-space interface renders over occluding geometry.
The brightness multiplier applied to the surface interface.
The dimensions of the scrollable or surface-rendered canvas.
Whether this interface root and its descendants are displayed.
The Part face on which the surface texture, light, or interface is placed.
The amount of scene lighting applied to the rendered effect.
Whether this interface is recreated when the player's character respawns.
Returns this instance if it is an ExecutionGroup.
Properties
Active
SurfaceGui.Active: boolean = trueWhether this interface accepts and consumes input.
Adornee
SurfaceGui.Adornee: Instance? = nilThe Instance used to position or size this world-space interface or adornment.
AlwaysOnTop
SurfaceGui.AlwaysOnTop: boolean = falseWhether the world-space interface renders over occluding geometry.
Brightness
SurfaceGui.Brightness: number = 1The brightness multiplier applied to the surface interface.
CanvasSize
SurfaceGui.CanvasSize: Vector2 = Vector2.new(800, 600)The dimensions of the scrollable or surface-rendered canvas.
Enabled
SurfaceGui.Enabled: boolean = trueWhether this interface root and its descendants are displayed.
Face
SurfaceGui.Face: Enum.NormalId = Enum.NormalId.FrontThe Part face on which the surface texture, light, or interface is placed.
LightInfluence
SurfaceGui.LightInfluence: number = 0The amount of scene lighting applied to the rendered effect.
ResetOnSpawn
SurfaceGui.ResetOnSpawn: boolean = trueWhether this interface is recreated when the player's character respawns.
Methods
GetExecutionGroup
SurfaceGui:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying