Reference API Roblox

Engine API

Website

Related

Reference API Roblox

CoreGuiConfiguration

Service that groups the configuration objects controlling Roblox's built-in CoreGui elements.

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.
Memory categoryInstances
Tags: [NotCreatable, Service, NotReplicated]

Member index 3

HistoryMember
705CapturesViewConfiguration: CapturesViewConfiguration
705PlayerListConfiguration: PlayerListConfiguration
705SelfViewConfiguration: SelfViewConfiguration
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
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
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

CoreGuiConfiguration is a service that groups the per-element configuration objects controlling Roblox's built-in CoreGui elements. When it is added to the data model, it automatically creates one child of each configuration type — PlayerListConfiguration, CapturesViewConfiguration, and SelfViewConfiguration — and exposes each of them through a property of the same name.

Each child configuration object inherits Enabled to toggle whether its corresponding core GUI element is displayed.

History 4

Members 3

CapturesViewConfiguration

TypeDefault
CapturesViewConfiguration

References the CapturesViewConfiguration object that controls the built-in captures view — the CoreGui element that lets players browse and manage the screenshots and video captures they take within an experience. The service creates this child automatically, so the property refers to that instance for the lifetime of the service.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

PlayerListConfiguration

TypeDefault
PlayerListConfiguration

References the PlayerListConfiguration object that controls the built-in player list — the CoreGui element that displays the players currently in the experience. The service creates this child automatically, so the property refers to that instance for the lifetime of the service.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

SelfViewConfiguration

TypeDefault
SelfViewConfiguration

References the SelfViewConfiguration object that controls the built-in self view — the CoreGui element that shows players a preview of their own camera feed. The service creates this child automatically, so the property refers to that instance for the lifetime of the service.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

Settings