SurfaceGuiBase
CreatorHub

Instances of this class cannot be created with Instance.new.

Memory category	Instances

Tags: [NotCreatable]

Member index 3

History		Member
726		Active: bool
726		Adornee: Instance
726		Face: NormalId
6 members inherited from LayerCollector
726		Enabled: bool
726		ResetOnSpawn: bool
726		TabKeyboardNavigation: bool
726		ZIndexBehavior: ZIndexBehavior
648		GetGuiObjectsAtPosition(x: int, y: int): Instances
462		GetLayoutNodeTree(): Dictionary
16 members inherited from GuiBase2d
726		AbsolutePosition: Vector2
726		AbsoluteRotation: float
726		AbsoluteSize: Vector2
726		AutoLocalize: bool
726		ClippedRect: Rect
726		IsNotOccluded: bool
726		Localize: bool
726		RawRect2D: Rect
726		RootLocalizationTable: LocalizationTable
726		SelectionBehaviorDown: SelectionBehavior
726		SelectionBehaviorLeft: SelectionBehavior
726		SelectionBehaviorRight: SelectionBehavior
726		SelectionBehaviorUp: SelectionBehavior
726		SelectionGroup: bool
726		TotalGroupScale: float
525		SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject)
60 members inherited from Instance
726		Archivable: bool
726		Capabilities: SecurityCapabilities
726		DataCost: int
726		IsInSandbox: bool
726		Name: string
726		Parent: Instance
726		PredictionMode: PredictionMode
726		RobloxLocked: bool
726		Sandboxed: bool
726		SourceAssetId: int64
726		UniqueId: UniqueId
726		archivable: bool
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
726		children(): Instances
726		clone(): Instance
726		destroy(): null
726		findFirstChild(name: string, recursive: bool = false): Instance
726		getChildren(): Instances
726		isDescendantOf(ancestor: Instance): bool
726		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
726		childAdded(child: Instance)
6 members inherited from Object
726		ClassName: string
726		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
726		isA(className: string): bool
647		Changed(property: string)

Description

History 10
Hide member changes

726 Change Default of Face from to
726 Change Default of Adornee from to
726 Change Default of Active from to
553 Change Default of Face from to
553 Change Default of Adornee from to
553 Change Default of Active from to
540 Add Face
540 Add Adornee
540 Add Active
540 Add SurfaceGuiBase

Members 3

Active
CreatorHub

Type		Default
bool

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.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 3

726 Change Default of Active from to
553 Change Default of Active from to
540 Add Active

Adornee
CreatorHub

Type		Default
Instance

BasePart on which to apply the SurfaceGui, overriding the default parent association.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 3

726 Change Default of Adornee from to
553 Change Default of Adornee from to
540 Add Adornee

Face
CreatorHub

Type		Default
NormalId

NormalId face of the SurfaceGui parent (or its Adornee) upon which to apply the SurfaceGui.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 3

726 Change Default of Face from to
553 Change Default of Face from to
540 Add Face

Reference API Roblox

Engine API

Website

Related

Reference API Roblox

SurfaceGuiBase
CreatorHub

Member index 3

Description

History 10
Hide member changes

Members 3

Active
CreatorHub

History 3

Adornee
CreatorHub

History 3

Face
CreatorHub

History 3

Settings