FANDOM


A SurfaceGui is an Instance that can be added to any part. This class can display TextLabels and TextButtons. This class was added on December 4, 2013.

Properties

Pubfield bool Active

If true, this GuiObject can fire mouse events and will pass them to any GuiObjects layered underneath, while false will do neither.

Category: Data.

Serialization: can save and load.

Pubfield Instance Adornee

The Object the surface 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.

Category: Data.

Serialization: can save and load.

Pubfield bool AlwaysOnTop

Category: Data.

Serialization: can save and load.

Pubfield Vector2 CanvasSize

Category: Sizing.

Serialization: can save and load.

Pubfield bool ClipsDescendants

Category: Behavior.

Serialization: can save and load.

Pubfield NormalId Face

Category: Data.

Serialization: can save and load.

Pubfield float LightInfluence

Specifies the amount of influence lighting has on the surface gui. A value of 0 is unlit, 1 is fully lit. Fractional values blend from unlit to lit.

Category: Data.

Serialization: can save and load.

Pubfield float PixelsPerStud

Category: Sizing.

Serialization: can save and load.

Pubfield SurfaceGuiSizingMode SizingMode

Category: Sizing.

Serialization: can save and load.

Pubfield float ToolPunchThroughDistance

Category: Data.

Serialization: can save and load.

Pubfield float ZOffset

Category: Appearance.

Serialization: can save and load.


External links

Community content is available under CC-BY-SA unless otherwise noted.