SurfaceGui
Displays 2D GUI children on a BasePart face.
Properties
| Property | Type | Default |
|---|---|---|
Name | string | "SurfaceGui" |
Enabled | boolean | true |
Adornee | any | nil |
Face | EnumItem | Enum.NormalId.Front |
CanvasSize | Vector2 | Vector2.new(800, 600) |
PixelsPerStud | number | 50 |
SizingMode | EnumItem | Enum.SurfaceGuiSizingMode.FixedSize |
AlwaysOnTop | boolean | false |
LightInfluence | number | 1 |
Brightness | number | 1 |
ZIndexBehavior | EnumItem | Enum.ZIndexBehavior.Sibling |
ZOffset | number | 0 |
Size | UDim2 | UDim2.new(0, 800, 0, 600) |
RenderOffset | Vector2 | Vector2.new(0, 0) |
Functions
`getAdornee`
`enumIs`
`getFaceSize`
`getFaceCFrame`
`desiredCanvasSize`
`destroyResources`
`ensureResources`
`instance.GetRelativeMousePosition`
getAdornee
Arguments
instanceReturns
This function returns nothing.
enumIs
Arguments
value, enumValue, nameReturns
This function returns nothing.
getFaceSize
Arguments
size, faceReturns
This function returns nothing.
getFaceCFrame
Arguments
cf, size, face, zOffsetReturns
This function returns nothing.
desiredCanvasSize
Arguments
This function takes no arguments.
Returns
This function returns nothing.
destroyResources
Arguments
This function takes no arguments.
Returns
This function returns nothing.
ensureResources
Arguments
This function takes no arguments.
Returns
This function returns nothing.
instance.GetRelativeMousePosition
Arguments
This function takes no arguments.
Returns
This function returns nothing.
API
instance:getAdornee(instance)
instance:enumIs(value, enumValue, name)
instance:getFaceSize(size, face)
instance:getFaceCFrame(cf, size, face, zOffset)
instance:desiredCanvasSize()
instance:destroyResources()
instance:ensureResources()
instance:GetRelativeMousePosition()