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.

Summary

Properties

Controls the order that multiple ScreenGuis are drawn.

When set to true, the GUI Inset imposed by Roblox's CoreGuis will be ignored by the ScreenGui and its descendants.

ScreenInsets: ScreenInsets
NOT BROWSABLE

Events

Methods

Properties

ClipToDeviceSafeArea

Not Browsable

DisplayOrder

This property controls the order that multiple ScreenGuis are drawn. ScreenGuis with a higher DisplayOrder will be drawn on top of ScreenGuis with a lower DisplayOrder. DisplayOrder can have any integer value and defaults to 0.

IgnoreGuiInset

IgnoreGuiInset is a boolean property of ScreenGuis that, when set to true, will force the GUI Inset imposed by Roblox's CoreGuis to be ignored by this ScreenGui and its descendants. This means that an element with a UDim2 size of {1,0},{1,0} will fill up the entire screen, without a 36 pixel gap reserved for Roblox's top bar.

OnTopOfCoreBlur

SafeAreaCompatibility

Not Browsable

ScreenInsets

ScreenInsets
Not Browsable

Events

Methods