Class
BasePlayerGui
NotCreatable
BasePlayerGui is an abstract class which the GUI drawing storage classes
inherit from.
BasePlayerGui is an abstract class that all GUI drawing storage classes
inherit from.
Methods 1#
| GetGuiObjectsAtPosition | Returns a list of all GuiObject instances occupying the given |
GetGuiObjectsAtPosition(x: int, y: int): Instances#
Takes a screen position and returns a list of all the GuiObject
instances which are occupying that screen position, sorted in the order
they appear on screen from top to bottom as the first and last index,
respectively. The main use case is to get GUI objects under the player's
mouse or touch inputs to allow for selection or highlighting.
Since the child classes of BasePlayerGui inherit this function, it
can be fired by container classes such as PlayerGui and
StarterGui.
| Name | Type | Default | Description |
|---|---|---|---|
x | int | The X position on the screen relative to the top-left corner after
the GUI inset is applied (see GuiService:GetGuiInset()). | |
y | int | The Y position on the screen relative to the top-left corner after
the GUI inset is applied (see GuiService:GetGuiInset()). |
Returns
Instances— A table of theGuiObjectinstances that occupy the given screen space.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild