CanvasGroup

Afficher les obsolètes

CanvasGroup renders descendants as a group with color and transparency applied to the render result. GuiEffect (UICorner and UIGradient) under CanvasGroup will also apply to the whole group. CanvasGroup always has GuiObject.ClipsDescendants set to true and all descendants will render within CanvasGroup's viewport.

Important notes:

Descendants of CanvasGroup will be rendered as a flattened texture only when the ancestor LayerCollector has its LayerCollector.ZIndexBehavior set to Enum.ZIndexBehavior.Sibling.
CanvasGroup consumes extra texture memory. The quality of the texture and total memory usage is limited by the Enum.QualityLevel of the client. When exceeding the memory cap, CanvasGroup will render as a blank texture.
We recommend using CanvasGroup with static sizes, otherwise a new texture would need to be created to accommodate new sizes.

Résumé

Propriétés

GroupColor3:Color3
lecture parallèle
Color tint that applies to all descendants.
GroupTransparency:number
lecture parallèle
Transparency that applies to all descendants.

Propriétés hérités de GuiObject

Active:bool
lecture parallèle
Determines whether a UI element sinks input.
AnchorPoint:Vector2
lecture parallèle
Determines the origin point of a GuiObject, relative to its absolute size.
AutomaticSize:Enum.AutomaticSize
lecture parallèle
Determines whether resizing occurs based on child content.
BackgroundColor3:Color3
lecture parallèle
Determines the GuiObject background color.
BackgroundTransparency:number
lecture parallèle
Determines the transparency of the GuiObject background and border.
BorderColor3:Color3
lecture parallèle
Determines the color of the GuiObject border.
BorderMode:Enum.BorderMode
lecture parallèle
Determines in what manner the GuiObject border is laid out relative to its dimensions.
BorderSizePixel:number
lecture parallèle
Determines the pixel width of a GuiObject border.
ClipsDescendants:bool
lecture parallèle
Determines if descendant GUIs outside of the bounds of a parent GUI element should render.
GuiState:Enum.GuiState
lecture uniquement
non répliqué
lecture parallèle
Interactable:bool
lecture parallèle
LayoutOrder:number
lecture parallèle
Controls the sort order of a GUI when used with a UIGridStyleLayout.
NextSelectionDown:GuiObject
lecture parallèle
Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction.
NextSelectionLeft:GuiObject
lecture parallèle
Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction.
NextSelectionRight:GuiObject
lecture parallèle
Sets the GUI which will be selected when the Enum.Gamepad selector is moved in this direction.
NextSelectionUp:GuiObject
lecture parallèle
Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction.
Position:UDim2
lecture parallèle
Determines the pixel and scalar position of the GuiObject.
Rotation:number
lecture parallèle
Determines the number of degrees by which a UI element is rotated.
Selectable:bool
lecture parallèle
Determine whether the GUI can be selected by a gamepad.
SelectionImageObject:GuiObject
lecture parallèle
Overrides the default selection adornment used for gamepads.
SelectionOrder:number
lecture parallèle
The order of GuiObjects selected by the gamepad UI selection.
Size:UDim2
lecture parallèle
Determine the pixel and scalar size of a GUI.
SizeConstraint:Enum.SizeConstraint
lecture parallèle
Selects the GuiObject.Size axes that a GUI will be based relative to the size of its parent.
Transparency:number
caché
non répliqué
lecture parallèle
obsolète
A mixed property of BackgroundTransparency and TextTransparency.
Visible:bool
lecture parallèle
Determines whether a GuiObject.GUI and its descendants will be rendered.
ZIndex:number
lecture parallèle
Determines the order in which a GUI renders relative to other GUIs.

Propriétés hérités de GuiBase2d

AbsolutePosition:Vector2
lecture uniquement
non répliqué
Describes the actual screen position of a UI element, in pixels.
AbsoluteRotation:number
lecture uniquement
non répliqué
Describes the actual screen rotation of a UI element, in degrees.
AbsoluteSize:Vector2
lecture uniquement
non répliqué
Describes the actual screen size of a UI element, in pixels.
AutoLocalize:bool
lecture parallèle
When set to true, localization will be applied to this GuiBase2d and its descendants based on the GuiBase2d.RootLocalizationTable specified for this GuiBase2d.
RootLocalizationTable:LocalizationTable
lecture parallèle
A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants.
SelectionBehaviorDown:Enum.SelectionBehavior
lecture parallèle
Customizes gamepad selection behavior in the down direction.
SelectionBehaviorLeft:Enum.SelectionBehavior
lecture parallèle
Customizes gamepad selection behavior in the left direction.
SelectionBehaviorRight:Enum.SelectionBehavior
lecture parallèle
Customizes gamepad selection behavior in the right direction.
SelectionBehaviorUp:Enum.SelectionBehavior
lecture parallèle
Customizes gamepad selection behavior in the up direction.
SelectionGroup:bool
lecture parallèle
Allows customization of gamepad selection movement.

Afficher tous les hérités de Instance

Méthodes

Méthodes hérités de 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.

Afficher tous les hérités de Instance

Évènements

Évènements hérités de GuiObject

InputBegan(input : InputObject):RBXScriptSignal
Fired when a user begins interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).
InputChanged(input : InputObject):RBXScriptSignal
Fired when a user changes how they're interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).
InputEnded(input : InputObject):RBXScriptSignal
Fired when a user stops interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).
MouseEnter(x : number,y : number):RBXScriptSignal
Fires when a user moves their mouse into a GUI element.
MouseLeave(x : number,y : number):RBXScriptSignal
Fires when a user moves their mouse out of a GUI element.
MouseMoved(x : number,y : number):RBXScriptSignal
Fires whenever a user moves their mouse while it is inside a GUI element.
MouseWheelBackward(x : number,y : number):RBXScriptSignal
Fires when a user scrolls their mouse wheel back when the mouse is over a GUI element.
MouseWheelForward(x : number,y : number):RBXScriptSignal
Fires when a user scrolls their mouse wheel forward when the mouse is over a GUI element.
SelectionGained():RBXScriptSignal
Fired when the GuiObject is being focused on with the Gamepad selector.
SelectionLost():RBXScriptSignal
Fired when the Gamepad selector stops focusing on the GuiObject.
TouchLongPress(touchPositions : Array,state : Enum.UserInputState):RBXScriptSignal
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.
TouchSwipe(swipeDirection : Enum.SwipeDirection,numberOfTouches : number):RBXScriptSignal
Fires when the player performs a swipe gesture on the UI element.
TouchTap(touchPositions : Array):RBXScriptSignal
Fires when the player performs a tap gesture on the UI element.

Évènements hérités de GuiBase2d

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.