GuiLabel
GuiLabel is an abstract class that inherits from GuiObject. It is the base class for ImageLabel and TextLabel. Unlike GuiButton, objects of this type will not register click events, but instead serve as non-interactive labels. It does not implement any further properties, events or methods.
Summary
Properties
Properties inherited from GuiObjectDetermines whether a UI element sinks input.
- read parallel
Determines the origin point of a GuiObject, relative to its absolute size.
- read parallel
Determines whether resizing occurs based on child content.
- read parallel
Determines aGUI's background color.
- read parallel
Determines the transparency of the GUI's background and border.
- read parallel
Determines the color of a GUI's border.
- read parallel
Determines in what manner the GuiObject border is laid out relative to its dimensions.
- read parallel
Determines the pixel width of a GuiObject border.
- read parallel
Determines if descendant GUIs outside of the bounds of a parent GUI element should render.
- read onlynot replicatedread parallel
- read parallel
- read parallel
Controls the sort order of a GUI when used with a UIGridStyleLayout.
- read parallel
Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction.
- read parallel
Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction.
- read parallel
Sets the GUI which will be selected when the Enum.Gamepad selector is moved in this direction.
- read parallel
Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction.
Determines the pixel and scalar position of a GUI.
Determines the number of degrees by which a UI element is rotated.
- read parallel
Determine whether the GUI can be selected by a gamepad.
- read parallel
Overrides the default selection adornment used for gamepads.
- read parallel
The order of GuiObjects selected by the gamepad UI selection.
Determine the pixel and scalar size of a GUI.
- read parallel
Selects the GuiObject.Size axes that a GUI will be based relative to the size of its parent.
- hiddennot replicatedread paralleldeprecated
A mixed property of BackgroundTransparency and TextTransparency.
Determines whether a GuiObject.GUI and its descendants will be rendered.
Determines the order in which a GUI renders relative to other GUIs.
- read onlynot replicated
Describes the actual screen position of a UI element, in pixels.
- read onlynot replicated
Describes the actual screen rotation of a UI element, in degrees.
- read onlynot replicated
Describes the actual screen size of a UI element, in pixels.
- read parallel
When set to true, localization will be applied to this GuiBase2d and its descendants based on the GuiBase2d.RootLocalizationTable specified for this GuiBase2d.
- read parallel
A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants.
- read parallel
Customizes gamepad selection behavior in the down direction.
- read parallel
Customizes gamepad selection behavior in the left direction.
- read parallel
Customizes gamepad selection behavior in the right direction.
- read parallel
Customizes gamepad selection behavior in the up direction.
- read parallel
Allows customization of gamepad selection movement.
Methods
Methods inherited from GuiObject- TweenPosition(endPosition: UDim2,easingDirection: Enum.EasingDirection,easingStyle: Enum.EasingStyle,time: number,override: bool,callback: function):bool
Smoothly moves a GUI to a new UDim2.
- TweenSize(endSize: UDim2,easingDirection: Enum.EasingDirection,easingStyle: Enum.EasingStyle,time: number,override: bool,callback: function):bool
Smoothly resizes a GUI to a new UDim2.
- TweenSizeAndPosition(endSize: UDim2,endPosition: UDim2,easingDirection: Enum.EasingDirection,easingStyle: Enum.EasingStyle,time: number,override: bool,callback: function):bool
Smoothly moves a GUI to a new size and position.
Events
Events inherited from GuiObjectFired when a user begins interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).
Fired when a user changes how they're interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).
Fired when a user stops interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).
Fires when a user moves their mouse into a GUI element.
Fires when a user moves their mouse out of a GUI element.
Fires whenever a user moves their mouse while it is inside a GUI element.
Fires when a user scrolls their mouse wheel back when the mouse is over a GUI element.
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.
Fires when the player starts, continues and stops long-pressing the UI element.
- TouchPan(touchPositions: Array,totalTranslation: Vector2,velocity: Vector2,state: Enum.UserInputState):RBXScriptSignal
Fires when the player moves their finger on the UI element.
- TouchPinch(touchPositions: Array,scale: number,velocity: number,state: Enum.UserInputState):RBXScriptSignal
Fires when the player performs a pinch or pull gesture using two fingers on the UI element.
- TouchRotate(touchPositions: Array,rotation: number,velocity: number,state: Enum.UserInputState):RBXScriptSignal
Fires when the player performs a rotation gesture using two fingers on the UI element.
Fires when the player performs a swipe gesture on the UI element.
Fires when the player performs a tap gesture on the UI element.
- SelectionChanged(amISelected: bool,previousSelection: GuiObject,newSelection: GuiObject):RBXScriptSignal
Fires when the gamepad selection moves to, leaves, or changes within the connected GuiBase2d or any descendent GuiObjects.