CoreGui

Show Deprecated
Not Creatable
Service
Not Replicated

The CoreGui is a service used to store Guis created in-game by Roblox for the core user interface found in every game (such as the game menu, the playerlist, the backpack, etc.). It can also be used by Plugins in Roblox Studio.

You can use the StarterGui:SetCoreGuiEnabled() and StarterGui:GetCoreGuiEnabled() methods in a LocalScript to enable and disable most elements of the CoreGui. You can also use PlayerGui:SetTopbarTransparency() to set the transparency of the top bar.

Summary

Properties

The current version of the CoreGui. Everytime the CoreGui is majorly changed, this number is increased.

READ ONLY
NOT REPLICATED

Methods

SetUserGuiRendering(enabled: boolean, guiAdornee: Instance, faceId: NormalId, horizontalCurvature: number): void  


TakeScreenshot(): void  


ToggleRecording(): void  


Events

UserGuiRenderingChanged(enabled: boolean, guiAdornee: Instance, faceId: NormalId, horizontalCurvature: number): RBXScriptSignal  


Properties

SelectionImageObject

Roblox Script Security
Roblox Script Security

Version

Read Only
Not Replicated

The current version of the CoreGui. Everytime the CoreGui is majorly changed, this number is increased.

Methods

SetUserGuiRendering

void
Roblox Script Security

Parameters

enabled: boolean
guiAdornee: Instance
faceId: NormalId
horizontalCurvature: number
Default Value: "0"

Returns

void

TakeScreenshot

void
Roblox Script Security

Returns

void

ToggleRecording

void
Roblox Script Security

Returns

void

Events

UserGuiRenderingChanged

Roblox Script Security

Parameters

enabled: boolean
guiAdornee: Instance
faceId: NormalId
horizontalCurvature: number