GuiService
Controls interface focus, selection, navigation, and engine UI state.
- Service
game:GetService("GuiService")- Inherits
- Instance
- Replication
- Never
Behavior
GuiService controls interface focus, selection, navigation, and engine UI state.
Summary
Whether the engine automatically selects an interface element when navigation begins.
Whether directional navigation can select built-in interfaces.
Whether directional interface navigation is enabled.
Whether the engine menu is open.
The currently selected GuiObject.
Whether the built-in touch controls are enabled.
Registers a parent whose descendants form a selection group.
Registers an explicit group of selectable interface elements.
Returns this instance if it is an ExecutionGroup.
Returns the screen insets reserved by the engine interface.
Returns the current screen resolution in pixels.
Returns whether the engine uses the large-screen interface mode.
Returns whether the current platform is Windows.
Removes a registered selection group.
Selects an interface element for navigation.
Sets the insets reserved for the engine interface.
Opens or closes the engine menu.
Fires when the engine menu closes.
Fires when the engine menu opens.
Properties
AutoSelectGuiEnabled
GuiService.AutoSelectGuiEnabled: boolean = trueWhether the engine automatically selects an interface element when navigation begins.
CoreGuiNavigationEnabled
GuiService.CoreGuiNavigationEnabled: boolean = trueWhether directional navigation can select built-in interfaces.
GuiNavigationEnabled
GuiService.GuiNavigationEnabled: boolean = trueWhether directional interface navigation is enabled.
MenuIsOpen
GuiService.MenuIsOpen: boolean = falseWhether the engine menu is open.
SelectedObject
GuiService.SelectedObject: GuiObject? = nilThe currently selected GuiObject.
TouchControlsEnabled
GuiService.TouchControlsEnabled: boolean = trueWhether the built-in touch controls are enabled.
Methods
AddSelectionParent
GuiService:AddSelectionParent(selectionName: string, selectionParent: GuiObject): ()Registers a parent whose descendants form a selection group.
AddSelectionTuple
GuiService:AddSelectionTuple(selectionName: string, args: ...GuiObject): ()Registers an explicit group of selectable interface elements.
GetExecutionGroup
GuiService:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
GetGuiInset
Returns the screen insets reserved by the engine interface.
GetScreenResolution
GuiService:GetScreenResolution(): Vector2Returns the current screen resolution in pixels.
IsTenFootInterface
GuiService:IsTenFootInterface(): booleanReturns whether the engine uses the large-screen interface mode.
IsWindows
GuiService:IsWindows(): booleanReturns whether the current platform is Windows.
RemoveSelectionGroup
GuiService:RemoveSelectionGroup(selectionName: string): ()Removes a registered selection group.
Select
GuiService:Select(selectionParent: Instance): ()Selects an interface element for navigation.
SetGlobalGuiInset
GuiService:SetGlobalGuiInset(x1: number, y1: number, x2: number, y2: number): ()Sets the insets reserved for the engine interface.
SetMenuIsOpen
GuiService:SetMenuIsOpen(open: boolean): ()Opens or closes the engine menu.
Events
MenuClosed
GuiService.MenuClosed: RBXScriptSignalFires when the engine menu closes.
MenuOpened
GuiService.MenuOpened: RBXScriptSignalFires when the engine menu opens.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying