PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

SurfaceGui

Show deprecated

SurfaceGui

Show deprecated

Note: SurfaceGuis must be descendants of PlayerGui in order to know the player who is interacting with it.Allows for the rendering of GUI elements onto a part’s surface in the 3D world, whilst allowing for basic user interaction to occur.


Properties

bool

Active

Whether or not mouse events will be passed to objects layered below.

Instance

Adornee

Sets the object that the SurfaceGui is adorned too. In other words, this defines which BasePart the SurfaceGui is attached to.

bool

AlwaysOnTop

Determines whether the SurfaceGui will always be rendered on top of other objects.

Vector2

CanvasSize

The size of a ‘virtual screen’, in ‘virtual pixels’, which makes SurfaceGuis pixel-to-pixel compatible with ScreenGuis.

bool

ClipsDescendants

When set to true, portions of GuiObjects that fall outside of the SurfaceGui’s canvas borders will not be drawn.

NormalId

Face

The face that the SurfaceGui is rendered on.

float

LightInfluence

Controls how much the SurfaceGui is influenced by the lighting in the game world.

float

PixelsPerStud

SurfaceGuiSizingMode

SizingMode

float

ToolPunchThroughDistance

Sets the distance left clicking starts acting on the surface gui instead of the held tool.

float

ZOffset

Offsets the SurfaceGui relative to the normal of the surface it is attached to.

Functions

Events