PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar

ScreenGui

Show deprecated

ScreenGui

Show deprecated

The main storage object for 2D GuiObject displayed on the player’s screen. ScreenGuis will only be shown if parented to a player’s PlayerGui.
To make sure a ScreenGui is displayed to your player, it should be parented into the StarterGui, as that service will clone it’s contents into each player’s PlayerGui when they join the game.

Caching static UI for performance improvements
A Gui’s appearance is cached until one of the following events occurs:
  • A descendant is added to the Gui.
  • A descendant is removed from the Gui.
  • A property of a descendant of the Gui changes.
  • A property of the Gui changes.
  • If any of these events occur, the Gui’s appearance will be recomputed the next frame it gets rendered.

    Properties

    int

    DisplayOrder

    Controls the order that multiple ScreenGuis are drawn.

    bool

    IgnoreGuiInset

    When set to true, the GuiService/GetGuiInset|GUI Inset imposed by Roblox’s CoreGuis will be ignored by the ScreenGui and its descendants.

    Inherited from LayerCollector: Show Hide

    bool

    Enabled

    Toggles the visibility of the LayerCollector.

    bool

    ResetOnSpawn

    Controls how this LayerCollector behaves when its associated Player respawns.

    ZIndexBehavior

    ZIndexBehavior

    Changes how ZIndex behaves on all descendants of the LayerCollector.

    Inherited from GuiBase2d: Show Hide

    Vector2

    AbsolutePosition

    [ReadOnly] [NotReplicated]

    Describes the actual screen position of a UI element, in pixels.

    float

    AbsoluteRotation

    [ReadOnly] [NotReplicated]

    Describes the actual screen rotation of a UI element, in degrees.

    Vector2

    AbsoluteSize

    [ReadOnly] [NotReplicated]

    Describes the actual screen size of a UI element, in pixels.

    bool

    AutoLocalize

    When set to true, localization will be applied to this GuiBase2d and its descendants based on the GuiBase2d/RootLocalizationTable specified for this GuiBase2d.

    bool

    Localize

    [Hidden] [NotReplicated] [Deprecated]

    Automatically set to true when a LocalizationTable’s Root targets this object, or an ancestor of this object.

    LocalizationTable

    RootLocalizationTable

    A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants.

    Inherited from Instance: Show Hide

    bool

    Archivable

    Determines if an Instance can be cloned using /Instance/Clone or saved to file.

    string

    ClassName

    [ReadOnly] [NotReplicated]

    A read-only string representing the class this Instance belongs to

    int

    DataCost

    [Hidden] [ReadOnly] [NotReplicated] [Deprecated]

    The cost of saving the instance using data persistence.

    string

    Name

    A non-unique identifier of the Instance

    Instance

    Parent

    [NotReplicated]

    Determines the hierarchical parent of the Instance

    bool

    RobloxLocked

    [Hidden]

    A deprecated property that used to protect CoreGui objects

    bool

    archivable

    [Hidden] [NotReplicated] [Deprecated]
    string

    className

    [ReadOnly] [NotReplicated] [Deprecated]

    Functions

    Inherited from Instance: Show Hide

    void

    ClearAllChildren ( )

    This function destroys all of an Instance’s children.

    Instance

    Clone ( )

    Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable

    void

    Destroy ( )

    Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.

    Instance

    FindFirstAncestor ( string name )

    Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.

    Instance

    FindFirstAncestorOfClass ( string className )

    Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.

    Instance

    FindFirstAncestorWhichIsA ( string className )

    Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.

    Instance

    FindFirstChild ( string name , bool recursive )

    Returns the first child of the Instance found with the given name.

    Instance

    FindFirstChildOfClass ( string className )

    Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.

    Instance

    FindFirstChildWhichIsA ( string className , bool recursive )

    Returns the first child of the Instance for whom Instance/IsA returns true for the given className.

    Instance

    FindFirstDescendant ( string name )

    Actor

    GetActor ( )

    Variant

    GetAttribute ( string attribute )

    Returns the attribute which has been assigned to the given name

    RBXScriptSignal

    GetAttributeChangedSignal ( string attribute )

    Returns an event that fires when the given attribute changes

    Dictionary

    GetAttributes ( )

    Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes

    Objects

    GetChildren ( )

    Returns an array containing all of the Instance’s children.

    string

    GetDebugId ( int scopeLength )

    [NotBrowsable]

    Returns a coded string of the Instances DebugId used internally by Roblox.

    Array

    GetDescendants ( )

    [CustomLuaState]

    Returns an array containing all of the descendants of the instance

    string

    GetFullName ( )

    Returns a string describing the Instance’s ancestry.

    RBXScriptSignal

    GetPropertyChangedSignal ( string property )

    Get an event that fires when a given property of an object changes.

    bool

    IsA ( string className )

    [CustomLuaState]

    Returns true if an Instance’s class matches or inherits from a given class

    bool

    IsAncestorOf ( Instance descendant )

    Returns true if an Instance is an ancestor of the given descendant.

    bool

    IsDescendantOf ( Instance ancestor )

    Returns true if an Instance is a descendant of the given ancestor.

    void

    Remove ( )

    [Deprecated]

    Sets the object’s Parent to nil, and does the same for all its descendants.

    void

    SetAttribute ( string attribute , Variant value )

    Sets the attribute with the given name to the given value

    Instance

    WaitForChild ( string childName , double timeOut )

    [CustomLuaState] [CanYield]

    Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

    Objects

    children ( )

    [Deprecated]

    Returns an array of the object’s children.

    Instance

    clone ( )

    [Deprecated]
    void

    destroy ( )

    [Deprecated]
    Instance

    findFirstChild ( string name , bool recursive )

    [Deprecated]
    Objects

    getChildren ( )

    [Deprecated]
    bool

    isA ( string className )

    [Deprecated] [CustomLuaState]
    bool

    isDescendantOf ( Instance ancestor )

    [Deprecated]
    void

    remove ( )

    [Deprecated]

    Events

    Inherited from Instance: Show Hide

    RBXScriptSignal

    AncestryChanged ( Instance child , Instance parent )

    Fires when the Instance/Parent property of the object or one of its ancestors is changed.

    RBXScriptSignal

    AttributeChanged ( string attribute )

    Fires whenever an attribute is changed on the Instance

    RBXScriptSignal

    Changed ( string property )

    Fired immediately after a property of an object changes.

    RBXScriptSignal

    ChildAdded ( Instance child )

    Fires when an object is parented to this Instance.

    RBXScriptSignal

    ChildRemoved ( Instance child )

    Fires when a child is removed from this Instance.

    RBXScriptSignal

    DescendantAdded ( Instance descendant )

    Fires when a descendant is added to the Instance

    RBXScriptSignal

    DescendantRemoving ( Instance descendant )

    Fires immediately before a descendant of the Instance is removed.

    RBXScriptSignal

    childAdded ( Instance child )

    [Deprecated]