SurfaceGui

SurfaceGui : SurfaceGuiBase

Overview

SurfaceGui is a UI container used to make the 2D UI elements (GuiObject) placed in 3D space face the camera at all times. The position of this container is determined by the connected BasePart or a specified Adornee.

In addition, SurfaceGui internally caches rendering results and reuse them when there are no changes to optimize performance. However, if the properties of SurfaceGui itself are changed, the properties of child elements are changed, or child elements are added or removed, the screen information is recalculated in the next rendering frame.

SurfaceGui can be controlled only in client environment.

Properties

Face

Enum.NormalId

Specifies on which side of rendering object SurfaceGui should be displayed.

Code Samples

local SurfaceGui = script.Parent

SurfaceGui.Face = Enum.NormalId.Top

ZOffset

number

Specifies the overlapping order of SurfaceGuis placed on the same side.

Code Samples

Methods

Events

See also

GUI

Last updated