The base class of 2D UI containers which render GuiObjects
in layers.
Instances of this class cannot be created with Instance.new.
It is not visible in Studio's object browser.
Tags: [NotCreatable, NotBrowsable]
History Member 726 Enabled : bool 726 ResetOnSpawn : bool 726 TabKeyboardNavigation : bool 726 ZIndexBehavior : ZIndexBehavior 648 GetGuiObjectsAtPosition ( x: int , y: int ) : Instances 462 GetLayoutNodeTree ( ) : Dictionary 16 members726 AbsolutePosition : Vector2 726 AbsoluteRotation : float 726 AbsoluteSize : Vector2 726 AutoLocalize : bool 726 ClippedRect : Rect 726 IsNotOccluded : bool 726 Localize : bool 726 RawRect2D : Rect 726 RootLocalizationTable : LocalizationTable 726 SelectionBehaviorDown : SelectionBehavior 726 SelectionBehaviorLeft : SelectionBehavior 726 SelectionBehaviorRight : SelectionBehavior 726 SelectionBehaviorUp : SelectionBehavior 726 SelectionGroup : bool 726 TotalGroupScale : float 525 SelectionChanged ( amISelected: bool , previousSelection: GuiObject , newSelection: GuiObject ) 60 members726 Archivable : bool 726 Capabilities : SecurityCapabilities 726 DataCost : int 726 IsInSandbox : bool 726 Name : string 726 Parent : Instance 726 PredictionMode : PredictionMode 726 RobloxLocked : bool 726 Sandboxed : bool 726 SourceAssetId : int64 726 UniqueId : UniqueId 726 archivable : bool 576 AddTag ( tag: string ) : null 573 ClearAllChildren ( ) : null 462 Clone ( ) : Instance 573 Destroy ( ) : null 486 FindFirstAncestor ( name: string ) : Instance 486 FindFirstAncestorOfClass ( className: string ) : Instance 486 FindFirstAncestorWhichIsA ( className: string ) : Instance 486 FindFirstChild ( name: string , recursive: bool = false ) : Instance 486 FindFirstChildOfClass ( className: string ) : Instance 486 FindFirstChildWhichIsA ( className: string , recursive: bool = false ) : Instance 486 FindFirstDescendant ( name: string ) : Instance 563 GetActor ( ) : Actor 486 GetAttribute ( attribute: string ) : Variant 462 GetAttributeChangedSignal ( attribute: string ) : RBXScriptSignal 631 GetAttributes ( ) : Dictionary 648 GetChildren ( ) : Instances 462 GetDebugId ( scopeLength: int = 4 ) : string 707 GetDescendants ( ) : Instances 486 GetFullName ( ) : string 706 GetStyled ( name: string , selector: string? ) : Variant 657 GetStyledPropertyChangedSignal ( property: string ) : RBXScriptSignal 576 GetTags ( ) : Array 576 HasTag ( tag: string ) : bool 486 IsAncestorOf ( descendant: Instance ) : bool 486 IsDescendantOf ( ancestor: Instance ) : bool 664 IsPropertyModified ( property: string ) : bool 698 QueryDescendants ( selector: string ) : Instances 573 Remove ( ) : null 576 RemoveTag ( tag: string ) : null 664 ResetPropertyToDefault ( property: string ) : null 573 SetAttribute ( attribute: string , value: Variant ) : null 462 WaitForChild ( childName: string , timeOut: double ) : Instance 726 children ( ) : Instances 726 clone ( ) : Instance 726 destroy ( ) : null 726 findFirstChild ( name: string , recursive: bool = false ) : Instance 726 getChildren ( ) : Instances 726 isDescendantOf ( ancestor: Instance ) : bool 726 remove ( ) : null 462 AncestryChanged ( child: Instance , parent: Instance ) 462 AttributeChanged ( attribute: string ) 462 ChildAdded ( child: Instance ) 462 ChildRemoved ( child: Instance ) 462 DescendantAdded ( descendant: Instance ) 462 DescendantRemoving ( descendant: Instance ) 500 Destroying ( ) 657 StyledPropertiesChanged ( ) 726 childAdded ( child: Instance ) 6 members726 ClassName : string 726 className : string 647 GetPropertyChangedSignal ( property: string ) : RBXScriptSignal 647 IsA ( className: string ) : bool 726 isA ( className: string ) : bool 647 Changed ( property: string )
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. Toggles the visibility of this LayerCollector . When false, the
UI contents will not render, process user input, or update in response to
changes.
History 7
It exists only for backward compatibility, and should not be used for new work.
History 2 Tags: [Deprecated]
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.
History 5
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 5 Tags: [Hidden, NotReplicated]
Controls how GuiObject.ZIndex behaves on all descendants of this
LayerCollector .
With 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.
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.
History 5