LayerCollector
LayerCollector is the base class of 2D UI containers which render GuiObject descendants, such as ScreenGui.
For performance improvements, the appearance of a LayerCollector is cached until one of the following events occurs:
- A descendant is added to or removed from it.
- A property of a descendant changes.
- A property of the LayerCollector itself changes.
Summary
Properties
Toggles the visibility of this LayerCollector.
Determines if the LayerCollector resets (deletes itself and re-clones into the player's PlayerGui) every time the player's character respawns.
Controls how GuiObject.ZIndex behaves on all descendants of this LayerCollector.
Describes the actual screen position of a GuiBase2d element, in pixels.
Describes the actual screen rotation of a GuiBase2d element, in degrees.
Describes the actual screen size of a GuiBase2d element, in pixels.
When set to true, localization will be applied to this GuiBase2d and its descendants.
A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants.
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.
Events
Events inherited from 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 descendant GuiObjects.
Properties
Enabled
Toggles the visibility of this LayerCollector. When false, the UI contents will not render, process user input, or update in response to changes.
ResetOnSpawn
When set to false and this LayerCollector is a direct child of StarterGui, it will only be cloned into each player's PlayerGui once and it will not be deleted when the player's character respawns.
When set to true (default), or if this LayerCollector is an indirect descendant of StarterGui, it will be cloned into each player's PlayerGui when their character respawns, and it will delete itself when the player's character respawns again.
ZIndexBehavior
Controls how GuiObject.ZIndex behaves on all descendants of this LayerCollector.
With Enum.ZIndexBehavior.Sibling (default), children always render above their parents, and the ZIndex is used to decide the order in which children of a single UI object will render over each other.
Enum.ZIndexBehavior.Global sorts all descendants according to the ZIndex, then breaks ties using the hierarchy order. As a result, descendants of a GuiObject need to have a ZIndex value that's at least as high as the parent, or they will render underneath their parent.