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 731 Enabled : bool 731 ResetOnSpawn : bool 731 TabKeyboardNavigation : bool 731 ZIndexBehavior : ZIndexBehavior 648 GetGuiObjectsAtPosition ( x: int , y: int ) : Instances 462 GetLayoutNodeTree ( ) : Dictionary 18 members731 AbsolutePosition : Vector2 731 AbsoluteRotation : float 731 AbsoluteSize : Vector2 731 ActiveQueryNames : string 731 AutoLocalize : bool 731 ClippedRect : Rect 731 IsNotOccluded : bool 731 Localize : bool 731 RawRect2D : Rect 731 ReplicatedInsertionOrder : int 731 RootLocalizationTable : LocalizationTable 731 SelectionBehaviorDown : SelectionBehavior 731 SelectionBehaviorLeft : SelectionBehavior 731 SelectionBehaviorRight : SelectionBehavior 731 SelectionBehaviorUp : SelectionBehavior 731 SelectionGroup : bool 731 TotalGroupScale : float 525 SelectionChanged ( amISelected: bool , previousSelection: GuiObject , newSelection: GuiObject ) 68 members731 Archivable : bool 731 Attributes : string 731 AttributesReplicate : string 731 AttributesSerialize : BinaryString 731 Capabilities : SecurityCapabilities 731 DataCost : int 731 DefinesCapabilities : bool 731 HistoryId : UniqueId 731 IsInSandbox : bool 731 Name : string 731 Parent : Instance 731 PredictionMode : PredictionMode 731 PropertyStatusStudio : PropertyStatus 731 RobloxLocked : bool 731 Sandboxed : bool 731 SourceAssetId : int64 731 Tags : SharedString 731 UniqueId : UniqueId 731 archivable : bool 731 numExpectedDirectChildren : int 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 731 children ( ) : Instances 731 clone ( ) : Instance 731 destroy ( ) : null 731 findFirstChild ( name: string , recursive: bool = false ) : Instance 731 getChildren ( ) : Instances 731 isDescendantOf ( ancestor: Instance ) : bool 731 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 ( ) 731 childAdded ( child: Instance ) 6 members731 ClassName : string 731 className : string 647 GetPropertyChangedSignal ( property: string ) : RBXScriptSignal 647 IsA ( className: string ) : bool 731 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 8
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 6
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 6 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 6