An abstract class for interactive 2D user interface elements.
- Memory category
- Gui
- Own members
- 20
- Inherited members
- 156
- Subclasses
- 2
- Siblings
- 12
Properties91
Property categoryBehavior
- Determines if an
Instanceand its descendants can be cloned usingInstance:Clone(), and can be saved/published. - Deprecated: This deprecated property is a variant of
Instance.Archivablewhich should be used instead.Use Archivable instead.
Property categoryData
Property categoryPermissions
- The set of capabilities allowed to be used for scripts inside this container.
- Indicates whether the instance is inside a sandboxed container.
- When enabled, the instance can only access abilities in its
Capabilitieslist.
Property categoryData
Property categoryDebugging
Property categoryLocalization
- When set to
true, localization will be applied to thisGuiBase2dand its descendants. - A reference to a
LocalizationTableto be used to apply automated localization to thisGuiBase2dand its descendants. - Deprecated: This item is deprecated. Do not use it for new work.
Automatically set to true when a localization table'sLocalizationTable.Roottargets this object, or an ancestor of this object.Use AutoLocalize instead.
Property categorySelection
- Customizes gamepad selection behavior in the down direction.
- Customizes gamepad selection behavior in the left direction.
- Customizes gamepad selection behavior in the right direction.
- Customizes gamepad selection behavior in the up direction.
- Allows customization of gamepad selection movement.
Property categoryAppearance
- Overrides the default selection adornment used for gamepads.
Property categoryBehavior
- Determines if descendant
GuiObjectsoutside of the bounds of a parent GUI element should render. - Deprecated: This property is deprecated. Use
UIDragDetectorinstead, as it supports more input types and can be better customized.
Determines whether aGuiObject(and its descendants) can be dragged around the screen.
Property categoryData
- Determines whether this UI element sinks input.
- Determines the origin point of a
GuiObject, relative to its absolute size. - Determines whether resizing occurs based on child content.
- Determines the
GuiObjectbackground color. - Determines the transparency of the
GuiObjectbackground and border. - Determines the color of the
GuiObjectborder. - Determines in what manner the
GuiObjectborder is laid out relative to its dimensions. - Determines the pixel width of the
GuiObjectborder. - Controls whether, and how, the
GuiObjectsinks input that occurs over it. - Controls the sort order of the
GuiObjectwhen used with aUIGridStyleLayout. - Determines the pixel and scalar position of the
GuiObject. - Determines the number of degrees by which the
GuiObjectis rotated. - Determines the pixel and scalar size of the
GuiObject. - Determines whether the
GuiObjectand its descendants will be rendered. - Determines the order in which a
GuiObjectrenders relative to others. - Deprecated: This property is deprecated in favor of the
Color3propertyGuiObject.BackgroundColor3, which should be used in new work instead.
Determines the color of theGuiObjectbackground. - Deprecated: This property is deprecated and indexing it will return
BackgroundTransparency.
A mixed property ofBackgroundTransparencyandTextTransparency.
Property categoryEventReplicator
Property categorySelection
- Sets the
GuiObjectwhich will be selected when the gamepad selector is moved downward. - Sets the
GuiObjectwhich will be selected when the gamepad selector is moved to the left. - Sets the
GuiObjectwhich will be selected when the gamepad selector is moved to the right. - Sets the
GuiObjectwhich will be selected when the gamepad selector is moved upward. - Determine whether the
GuiObjectcan be selected by a gamepad. - The order of
GuiObjectsselected by the gamepad UI selection.
Defined byGuiButton12
Property categoryData
GuiButton.AutoButtonColor: boolean Determines whether the button automatically changes color when the mouse hovers over or clicks on it.GuiButton.Modal: boolean Iftruewhile the GUI element is visible, the mouse will not be locked unless the right mouse button is down.GuiButton.Style: Enum.ButtonStyle Sets the style of theGuiButtonbased on a list of pre-determined styles.
Property categoryEventReplicator
Property categoryHaptic
GuiButton.HoverHapticEffect: HapticEffect AHapticEffectinstance that will play when theGuiButtonis being hovered.GuiButton.PressHapticEffect: HapticEffect AHapticEffectinstance that will play when theGuiButtonis being pressed.
No properties match the filters.
Methods48
Object:GetPropertyChangedSignal( property: string): RBXScriptSignal Get an event that fires when a given property of the object changes.Parameters Parameter Description property: stringThe property to connect to.Returns Type Description RBXScriptSignalA signal that fires whenever the property changes.- Returns true if an object's class matches or inherits from a given class.
Parameters Parameter Description className: stringThe class against which the Object's class will be checked. Case-sensitive.Returns Type Description booleanDescribes whether the Object's class matched or is a subclass of the given class. - Deprecated: This deprecated function is a variant of
Object:IsA()which should be used instead.Parameters Parameter className: stringReturns Type booleanUse IsA instead.
- Applies a tag to the instance.
Parameters Parameter Description tag: stringThe tag to apply to the instance. - This method destroys all of an instance's children.
- Create a copy of an instance and all its descendants, ignoring instances that are not
Archivable.Returns Type Description InstanceA copy of the instance, ornilif the instance is notArchivable. - Sets the
Instance.Parentproperty tonil, locks theInstance.Parentproperty, disconnects all connections, and callsDestroy()on all children. Instance:FindFirstAncestor( name: string): Instance Returns the first ancestor of theInstancewhoseInstance.Nameis equal to the given name.Parameters Parameter Description name: stringTheInstance.Nameto be looked for.Instance:FindFirstAncestorOfClass( className: string): Instance Returns the first ancestor of theInstancewhoseObject.ClassNameis equal to the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstAncestorWhichIsA( className: string): Instance Returns the first ancestor of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChild( name: string, recursive: boolean? = false): Instance Returns the first child of theInstancefound with the given name.Parameters Parameter Description name: stringTheInstance.Nameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstChildOfClass( className: string): Instance Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance Returns the first child of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstDescendant( name: string): Instance Returns the first descendant found with the givenInstance.Name.Parameters Parameter Description name: stringTheInstance.Nameto search for.- Returns the
Actorassociated with the Instance, if any. Instance:GetAttribute( attribute: string): any Returns the value which has been assigned to the given attribute name.Parameters Parameter Description attribute: stringThe name of the attribute being retrieved.Returns Type Description anyThe value which has been assigned to the given attribute name. If no attribute has been assigned,nilis returned.Instance:GetAttributeChangedSignal( attribute: string): RBXScriptSignal Returns an event that fires when the given attribute changes.Parameters Parameter Description attribute: stringThe name of the specified attribute for which the change signal is being returned.Returns Type Description RBXScriptSignalAn event that fires when the given attribute changes.- Returns a dictionary of the instance's attributes.
Returns Type Description { [string]: any }A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value. - Returns an array containing all of the instance's children.
Returns Type Description { Instance }An array containing the instance's children. Instance:GetDebugId( scopeLength: number? = 4): string Returns a coded string of the debug ID used internally by Roblox.Parameters Parameter Description scopeLength: number? = 4The scope length.Returns Type Description stringThe Debug ID string.- Returns an array containing all of the descendants of the instance.
Returns Type Description { Instance }An array containing the instance's descendants. - Returns a string describing the instance's ancestry.
- Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters Parameter Description name: stringName of the property to query.selector: string?Optional selector for the pseudo instance you are targeting on the instance.Returns Type Description anyThe styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. Instance:GetStyledPropertyChangedSignal( property: string): RBXScriptSignal Returns an event that fires when the given style property changes on the instance.Parameters Parameter Description property: stringName of the style property for which to listen for changes.Returns Type Description RBXScriptSignalEvent that fires when the given style property changes.- Gets an array of all tags applied to the instance.
Returns Type Description { any }An array of strings, each representing a tag applied to the instance. - Check whether the instance has a given tag.
Parameters Parameter Description tag: stringThe tag to check for on the instance.Returns Type Description booleantrueif the instance has the given tag,falseotherwise. Instance:IsAncestorOf( descendant: Instance): boolean Returns true if anInstanceis an ancestor of the given descendant.Instance:IsDescendantOf( ancestor: Instance): boolean Returnstrueif anInstanceis a descendant of the given ancestor.Instance:IsPropertyModified( property: string): boolean Returnstrueif the value stored in the specified property is not equal to the code-instantiated default.Parameters Parameter Description property: stringName of the property to query.Returns Type Description booleanBoolean indicating whether the property is modified from its code‑instantiated default.Instance:QueryDescendants( selector: string): { Instance } Returns an array containing all descendants of the instance that match theselectorstring.Parameters Parameter Description selector: stringSelector string used to filter elements.Returns Type Description { Instance }An array of instances (empty if nothing matched the selector).- Removes a tag from the instance.
Parameters Parameter Description tag: stringThe tag to remove from the instance. Instance:ResetPropertyToDefault( property: string) Resets a property to its default value.Parameters Parameter Description property: stringName of the property to reset.Instance:SetAttribute( attribute: string, value: any) Sets the attribute with the given name to the given value.Instance:WaitForChild( childName: string, timeOut: number): Instance Returns the child of theInstancewith the given name. If the child does not exist, it will yield the current thread until it does.Parameters Parameter Description childName: stringTheInstance.Nameto be looked for.timeOut: numberAn optional time out parameter.- Deprecated: This item is deprecated in favor of
Instance:Destroy()andInstance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set itsParentproperty tonilinstead of using this method.
Sets the object'sParenttonil, and does the same for all its descendants. - Deprecated: This item has been superseded by
Instance:GetChildren()which should be used in all new work.
Returns an array of the object's children.Returns Type Description { Instance }Array of child objects/instances.Use GetChildren instead.
- Deprecated: This deprecated function is a variant of
Instance:Clone()which should be used instead.Returns Type InstanceUse Clone instead.
- Deprecated: This deprecated function is a variant of
Instance:Destroy()which should be used instead.Use Destroy instead.
Instance:findFirstChild( name: string, recursive: boolean? = false): Instance Deprecated: This deprecated function is a variant ofInstance:FindFirstChild()which should be used instead.Returns Type InstanceUse FindFirstChild instead.
- Deprecated: This deprecated function is a variant of
Instance:GetChildren()which should be used instead.Returns Type { Instance }Use GetChildren instead.
Instance:isDescendantOf( ancestor: Instance): boolean Deprecated: This deprecated function is a variant ofInstance:IsDescendantOf()which should be used instead.Parameters Parameter ancestor: InstanceReturns Type booleanUse IsDescendantOf instead.
- Deprecated: This deprecated function is a variant of
Instance:Remove()which has also been deprecated. Neither function should be used in new work.Use Remove instead.
GuiObject:TweenPositionInternal(endPosition: UDim2,easingDirection: Enum.EasingDirection? = Enum.EasingDirection.Out,easingStyle: Enum.EasingStyle? = Enum.EasingStyle.Quad,time: number? = 1,override: boolean? = false,callback: ((...any) -> ...any)? = nil,): boolean Parameters Parameter endPosition: UDim2easingDirection: Enum.EasingDirection? = Enum.EasingDirection.OuteasingStyle: Enum.EasingStyle? = Enum.EasingStyle.Quadtime: number? = 1override: boolean? = falsecallback: ((...any) -> ...any)? = nilReturns Type booleanGuiObject:TweenSizeAndPositionInternal(endSize: UDim2,endPosition: UDim2,easingDirection: Enum.EasingDirection? = Enum.EasingDirection.Out,easingStyle: Enum.EasingStyle? = Enum.EasingStyle.Quad,time: number? = 1,override: boolean? = false,callback: ((...any) -> ...any)? = nil,): boolean Parameters Parameter endSize: UDim2endPosition: UDim2easingDirection: Enum.EasingDirection? = Enum.EasingDirection.OuteasingStyle: Enum.EasingStyle? = Enum.EasingStyle.Quadtime: number? = 1override: boolean? = falsecallback: ((...any) -> ...any)? = nilReturns Type booleanGuiObject:TweenSizeInternal(endSize: UDim2,easingDirection: Enum.EasingDirection? = Enum.EasingDirection.Out,easingStyle: Enum.EasingStyle? = Enum.EasingStyle.Quad,time: number? = 1,override: boolean? = false,callback: ((...any) -> ...any)? = nil,): boolean Parameters Parameter endSize: UDim2easingDirection: Enum.EasingDirection? = Enum.EasingDirection.OuteasingStyle: Enum.EasingStyle? = Enum.EasingStyle.Quadtime: number? = 1override: boolean? = falsecallback: ((...any) -> ...any)? = nilReturns Type booleanGuiObject:TweenPosition(endPosition: UDim2,easingDirection: Enum.EasingDirection? = Enum.EasingDirection.Out,easingStyle: Enum.EasingStyle? = Enum.EasingStyle.Quad,time: number? = 1,override: boolean? = false,callback: ((...any) -> ...any)? = nil,): boolean Deprecated: This function is deprecated in favor of usingTweenService, which allows for better customization using an object-oriented and event-based approach.- The
easingDirection,easingStyle, andtimeparameters are handled by aTweenInfo - The
overrideparameter is no longer relevant; tweens always override previous tweens on the same property. - The
callbackparameter is better suited by theTween.Completedevent. ThePlaybackStateenum passed by that event provides a more detailed description of the tween's completion state.
Smoothly moves a GUI to a newUDim2.
Parameters Parameter Description endPosition: UDim2Where the GUI should move to.easingDirection: Enum.EasingDirection? = Enum.EasingDirection.OutThe direction in which to ease the GUI to the endPosition.easingStyle: Enum.EasingStyle? = Enum.EasingStyle.QuadThe style in which to ease the GUI to the endPosition.time: number? = 1How long, in seconds, the tween should take to complete.override: boolean? = falseWhether the tween will override an in-progress tween.callback: ((...any) -> ...any)? = nilA callback function to execute when the tween completes.Returns Type Description booleanWhether the tween will play.- The
GuiObject:TweenSize(endSize: UDim2,easingDirection: Enum.EasingDirection? = Enum.EasingDirection.Out,easingStyle: Enum.EasingStyle? = Enum.EasingStyle.Quad,time: number? = 1,override: boolean? = false,callback: ((...any) -> ...any)? = nil,): boolean Deprecated: This function is deprecated in favor of usingTweenService, which allows for better customization using an object-oriented and event-based approach.- The
easingDirection,easingStyle, andtimeparameters are handled by aTweenInfo - The
overrideparameter is no longer relevant; tweens always override previous tweens on the same property. - The
callbackparameter is better suited by theTween.Completedevent. ThePlaybackStateenum passed by that event provides a more detailed description of the tween's completion state.
Smoothly resizes aGuiObjectto a newUDim2.
Parameters Parameter Description endSize: UDim2The size that the GUI should resize.easingDirection: Enum.EasingDirection? = Enum.EasingDirection.OutThe direction in which to ease the GUI to the endSize.easingStyle: Enum.EasingStyle? = Enum.EasingStyle.QuadThe style in which to ease the GUI to the endSize.time: number? = 1How long, in seconds, the tween should take to complete.override: boolean? = falseWhether the tween will override an in-progress tween.callback: ((...any) -> ...any)? = nilA callback function to execute when the tween completes.Returns Type Description booleanWhether the tween will play.- The
GuiObject:TweenSizeAndPosition(endSize: UDim2,endPosition: UDim2,easingDirection: Enum.EasingDirection? = Enum.EasingDirection.Out,easingStyle: Enum.EasingStyle? = Enum.EasingStyle.Quad,time: number? = 1,override: boolean? = false,callback: ((...any) -> ...any)? = nil,): boolean Deprecated: This function is deprecated in favor of usingTweenService, which allows for better customization using an object-oriented and event-based approach.- The
easingDirection,easingStyle, andtimeparameters are handled by aTweenInfo - The
overrideparameter is no longer relevant; tweens always override previous tweens on the same property. - The
callbackparameter is better suited by theTween.Completedevent. ThePlaybackStateenum passed by that event provides a more detailed description of the tween's completion state.
Smoothly moves a GUI to a new size and position.
Parameters Parameter Description endSize: UDim2The size that the GUI should resize.endPosition: UDim2Where the GUI should move to.easingDirection: Enum.EasingDirection? = Enum.EasingDirection.OutThe direction in which to ease the GUI to the endSize and endPosition.easingStyle: Enum.EasingStyle? = Enum.EasingStyle.QuadThe style in which to ease the GUI to the endSize and endPosition.time: number? = 1How long, in seconds, the tween should take to complete.override: boolean? = falseWhether the tween will override an in-progress tween.callback: ((...any) -> ...any)? = nilA callback function to execute when the tween completes.Returns Type Description booleanWhether the tween will play.- The
No methods match the filters.
Events37
Object.Changed: RBXScriptSignal<( property: string)> Fires immediately after a property of the object changes, with some limitations.Parameters Parameter property: string
Instance.AncestryChanged: RBXScriptSignal<( child: Instance, parent: Instance)> Fires when theInstance.Parentproperty of this object or one of its ancestors is changed.Instance.AttributeChanged: RBXScriptSignal<( attribute: string)> Fires whenever an attribute is changed on theInstance.Parameters Parameter attribute: stringInstance.ChildAdded: RBXScriptSignal<( child: Instance)> Fires after an object is parented to thisInstance.Parameters Parameter child: InstanceInstance.ChildRemoved: RBXScriptSignal<( child: Instance)> Fires after a child is removed from thisInstance.Parameters Parameter child: InstanceInstance.DescendantAdded: RBXScriptSignal<( descendant: Instance)> Fires after a descendant is added to theInstance.Parameters Parameter descendant: InstanceInstance.DescendantRemoving: RBXScriptSignal<( descendant: Instance)> Fires immediately before a descendant of theInstanceis removed.Parameters Parameter descendant: Instance- Fires immediately before (or is deferred until after) the instance is destroyed via
Instance:Destroy(). - Fires whenever any style property is changed on the instance, including when a property is set to
nil. Instance.childAdded: RBXScriptSignal<( child: Instance)> Deprecated: This deprecated event is a variant ofInstance.ChildAddedwhich should be used instead.Parameters Parameter child: InstanceUse ChildAdded instead.
GuiBase2d.SelectionChanged: RBXScriptSignal<(amISelected: boolean,previousSelection: GuiObject,newSelection: GuiObject,)> Fires when the gamepad selection moves to, leaves, or changes within the connectedGuiBase2dor any descendantGuiObjects.
GuiObject.InputBegan: RBXScriptSignal<( input: InputObject)> Fired when a user begins interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).Parameters Parameter input: InputObjectGuiObject.InputChanged: RBXScriptSignal<( input: InputObject)> Fired when a user changes how they're interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).Parameters Parameter input: InputObjectGuiObject.InputEnded: RBXScriptSignal<( input: InputObject)> Fired when a user stops interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).Parameters Parameter input: InputObjectGuiObject.MouseEnter: RBXScriptSignal<( x: number, y: number)> Fires when a user moves their mouse into a GUI element.GuiObject.MouseLeave: RBXScriptSignal<( x: number, y: number)> Fires when a user moves their mouse out of a GUI element.GuiObject.MouseMoved: RBXScriptSignal<( x: number, y: number)> Fires whenever a user moves their mouse while it is inside a GUI element.GuiObject.MouseWheelBackward: RBXScriptSignal<( x: number, y: number)> Fires when a user scrolls their mouse wheel back when the mouse is over a GUI element.GuiObject.MouseWheelForward: RBXScriptSignal<( x: number, y: number)> Fires when a user scrolls their mouse wheel forward when the mouse is over a GUI element.- Fired when the GuiObject is being focused on with the Gamepad selector.
- Fired when the Gamepad selector stops focusing on the GuiObject.
GuiObject.TouchLongPress: RBXScriptSignal<(touchPositions: { any },state: Enum.UserInputState,)> Fires when the player starts, continues and stops long-pressing the UI element.Parameters Parameter touchPositions: { any }state: Enum.UserInputStateGuiObject.TouchPan: RBXScriptSignal<(touchPositions: { any },totalTranslation: Vector2,velocity: Vector2,state: Enum.UserInputState,)> Fires when the player moves their finger on the UI element.Parameters Parameter touchPositions: { any }totalTranslation: Vector2velocity: Vector2state: Enum.UserInputStateGuiObject.TouchPinch: RBXScriptSignal<(touchPositions: { any },scale: number,velocity: number,state: Enum.UserInputState,)> Fires when the player performs a pinch or pull gesture using two fingers on the UI element.Parameters Parameter touchPositions: { any }scale: numbervelocity: numberstate: Enum.UserInputStateGuiObject.TouchRotate: RBXScriptSignal<(touchPositions: { any },rotation: number,velocity: number,state: Enum.UserInputState,)> Fires when the player performs a rotation gesture using two fingers on the UI element.Parameters Parameter touchPositions: { any }rotation: numbervelocity: numberstate: Enum.UserInputStateGuiObject.TouchSwipe: RBXScriptSignal<(swipeDirection: Enum.SwipeDirection,numberOfTouches: number,)> Fires when the player performs a swipe gesture on the UI element.Parameters Parameter swipeDirection: Enum.SwipeDirectionnumberOfTouches: numberGuiObject.TouchTap: RBXScriptSignal<( touchPositions: { any })> Fires when the player performs a tap gesture on the UI element.Parameters Parameter touchPositions: { any }GuiObject.DragBegin: RBXScriptSignal<( initialPosition: UDim2)> Deprecated: This property is deprecated. UseUIDragDetectorinstead, as it supports more input types and can be better customized.
Fired when a player begins dragging the object.Parameters Parameter initialPosition: UDim2GuiObject.DragStopped: RBXScriptSignal<( x: number, y: number)> Deprecated: This property is deprecated. UseUIDragDetectorinstead, as it supports more input types and can be better customized.
Fired when a player stops dragging the object.
Defined byGuiButton8
GuiButton.Activated: RBXScriptSignal<(inputObject: InputObject,clickCount: number,)> Fires when the button is activated.Parameters Parameter inputObject: InputObjectclickCount: numberGuiButton.MouseButton1Click: RBXScriptSignal<( )> Fires when the user's mouse fully left clicks theGuiButton.GuiButton.MouseButton1Down: RBXScriptSignal<( x: number, y: number)> Fires when the user presses their left mouse button down on theGuiButton.GuiButton.MouseButton1Up: RBXScriptSignal<( x: number, y: number)> Fires when the user releases their left mouse button off of theGuiButton.GuiButton.MouseButton2Click: RBXScriptSignal<( )> Fires when the user's mouse fully right clicks theGuiButton.GuiButton.MouseButton2Down: RBXScriptSignal<( x: number, y: number)> Fires when the user presses their right mouse button down on theGuiButton.GuiButton.MouseButton2Up: RBXScriptSignal<( x: number, y: number)> Fires when the user releases their right mouse button off of theGuiButton.GuiButton.SecondaryActivated: RBXScriptSignal<( inputObject: InputObject)> Fires when the button's "secondary" input is activated.Parameters Parameter inputObject: InputObject
No events match the filters.