Reference API Roblox

Engine API

Website

Related

Reference API Roblox

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.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service, NotReplicated]

Member index 6

HistoryMember
553SelectionImageObject: GuiObject
553Version: int
573SetUserGuiRendering(enabled: bool, guiAdornee: Instance, faceId: NormalId, horizontalCurvature: float = 0): null
573TakeScreenshot(): null
573ToggleRecording(): null
561UserGuiRenderingChanged(enabled: bool, guiAdornee: Instance, faceId: NormalId, horizontalCurvature: float)
inherited from BasePlayerGui
462GetGuiObjectsAtPosition(x: int, y: int): Objects
462GetGuiObjectsInCircle(position: Vector2, radius: float): Objects
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

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.

History 27

Members 6

SelectionImageObject

TypeDefault
GuiObject

History 7

SetUserGuiRendering

Parameters (4)Default
enabledbool
guiAdorneeInstance
faceIdNormalId
horizontalCurvaturefloat0
Returns (1)
null

History 4

TakeScreenshot

Parameters (0)
No parameters.
Returns (1)
null

History 3

ToggleRecording

Parameters (0)
No parameters.
Returns (1)
null

History 3

UserGuiRenderingChanged

Parameters (4)
enabledbool
guiAdorneeInstance
faceIdNormalId
horizontalCurvaturefloat

History 1

Version

TypeDefault
int

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

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

Settings