SurfaceGui

SurfaceGui : SurfaceGuiBase

Overview

The SurfaceGui class is a type of GuiObject that allows developers to render 2D user interface elements directly onto the surfaces of 3D objects in the game world. This enables the creation of interactive and dynamic interfaces that are integrated into the environment, rather than being confined to the player's screen.

Description

The SurfaceGui class provides a versatile way to display GUI elements on physical parts, making it possible to create immersive and interactive interfaces that players can interact with as part of the game world.

Properties

AlwaysOnTop

bool

AlwaysOnTop determines whether the GUI element remains on top of other elements.

Code Samples

local SurfaceGui = script.Parent

print(SurfaceGui.AlwaysOnTop)

LightInfluence

number

Adjusts how much the GUI is affected by lighting in the game world.

Code Samples

local SurfaceGui = script.Parent

print(SurfaceGui.LightInfluence)

MaxDistance

number

Controls the maximum distance from which the SurfaceGui can be seen, allowing developers to optimize performance by limiting rendering distance.

Code Samples

local SurfaceGui = script.Parent

print(SurfaceGui.MaxDistance)

Methods

Events