CoreGui¶
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.
Description¶
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.
Inheritance¶
Object → Instance → BasePlayerGui → CoreGui
Nova inheritance: Instance → BasePlayerGui → CoreGui
Properties¶
SelectionImageObject Supported Property Overrides the default selection adornment used for gamepad selection in the CoreGui.
Overrides the default selection adornment used for gamepad selection in the CoreGui.
This property is not accessible through scripts but is viewable in the Properties window. It overrides the default selection adornment used for gamepad selection across all CoreGui elements.
RobloxScriptSecurityVersion Supported Property The current version of the CoreGui. Every time the CoreGui is majorly changed, this number is increased.
The current version of the CoreGui. Every time the CoreGui is majorly changed, this number is increased.
Inherited members¶
Inherited from BasePlayerGui: 8 properties, 36 methods, 7 events. They are documented on the base class page.
4 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's CoreGui class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
SetUserGuiRendering |
CoreGui:SetUserGuiRendering(enabled: bool, guiAdornee: Instance, faceId: NormalId, horizontalCurvature: float = 0): null |
Not yet | — | RobloxScriptSecurity |
TakeScreenshot |
CoreGui:TakeScreenshot(): null |
Not yet | — | RobloxScriptSecurity |
ToggleRecording |
CoreGui:ToggleRecording(): null |
Not yet | — | RobloxScriptSecurity |
Events¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
UserGuiRenderingChanged |
UserGuiRenderingChanged(enabled: bool, guiAdornee: Instance, faceId: NormalId, horizontalCurvature: float) |
Not yet | — | RobloxScriptSecurity |
Roblox reference: CoreGui
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.