Skip to content

Core Documentation

UI

UI¶

The UI namespace contains a set of class functions allowing you to get information about a Player's display and push information to their HUD. Most functions require the script to be inside a ClientContext and execute for the local Player.

Class Functions¶

Class Function Name	Return Type	Description	Tags
`UI.ShowFlyUpText(string message, Vector3 worldPosition, [table parameters])`	`None`	Shows a quick text on screen that tracks its position relative to a world position. The last parameter is an optional table containing additional parameters: duration (number) - How long the text should remain on the screen. Default duration is 0.5 seconds; color (Color) - The color of the Text. Default is white; font (string) - Asset ID for the font to use; isBig (boolean) - When true, larger text is used.	Client-Only
`UI.ShowDamageDirection(Vector3 worldPosition)`	`None`	Local player sees an arrow pointing towards some damage source. Lasts for 5 seconds.	Client-Only
`UI.ShowDamageDirection(CoreObject source)`	`None`	Local player sees an arrow pointing towards some CoreObject. Multiple calls with the same CoreObject reuse the same UI indicator, but refreshes its duration.	Client-Only
`UI.ShowDamageDirection(Player source)`	`None`	Local player sees an arrow pointing towards some other Player. Multiple calls with the same Player reuse the same UI indicator, but refreshes its duration. The arrow points to where the source was at the moment `ShowDamageDirection` is called and does not track the source Player's movements.	Client-Only
`UI.GetCursorPosition()`	`Vector2`	Returns a Vector2 with the `x`, `y` coordinates of the mouse cursor on the screen. Only gives results from a client context. May return `nil` if the cursor position cannot be determined.	None
`UI.GetScreenPosition(Vector3 worldPosition)`	`Vector2`	Calculates the location that worldPosition appears on the screen. Returns a Vector2 with the `x`, `y` coordinates, or `nil` if worldPosition is behind the camera. Only gives results from a client context.	None
`UI.GetScreenSize()`	`Vector2`	Returns a Vector2 with the size of the Player's screen in the `x`, `y` coordinates. Only gives results from a client context. May return `nil` if the screen size cannot be determined.	None
`UI.PrintToScreen(string message, [Color])`	`None`	Draws a message on the corner of the screen. Second optional Color parameter can change the color from the default white.	Client-Only
`UI.IsCursorVisible()`	`boolean`	Returns whether the cursor is visible.	Client-Only
`UI.SetCursorVisible(boolean isVisible)`	`None`	Sets whether the cursor is visible.	Client-Only
`UI.IsCursorLockedToViewport()`	`boolean`	Returns whether to lock cursor in viewport.	Client-Only
`UI.SetCursorLockedToViewport(boolean isLocked)`	`None`	Sets whether to lock cursor in viewport.	Client-Only
`UI.CanCursorInteractWithUI()`	`boolean`	Returns whether the cursor can interact with UI elements like buttons.	Client-Only
`UI.SetCanCursorInteractWithUI(boolean)`	`None`	Sets whether the cursor can interact with UI elements like buttons.	Client-Only
`UI.IsReticleVisible()`	`boolean`	Check if reticle is visible.	Client-Only
`UI.SetReticleVisible(boolean show)`	`None`	Shows or hides the reticle for the Player.	Client-Only
`UI.GetCursorHitResult()`	`HitResult`	Return hit result from local client's view in direction of the Projected cursor position. Meant for client-side use only, for Ability cast, please use `ability:GetTargetData():GetHitPosition()`, which would contain cursor hit position at time of cast, when in top-down camera mode.	Client-Only
`UI.GetCursorPlaneIntersection(Vector3 pointOnPlane, [Vector3 planeNormal])`	`Vector3`	Return intersection from local client's camera direction to given plane, specified by point on plane and optionally its normal. Meant for client-side use only. Example usage: `local hitPos = UI.GetCursorPlaneIntersection(Vector3.New(0, 0, 0))`.	Client-Only

Events¶

Event Name	Return Type	Description	Tags
`UI.coreModalChangedEvent`	<`CoreModalType>`	Fired when the local player pauses the game or opens one of the built-in modal dialogs, such as the emote or mount picker. The modal parameter will be `nil` when the player has closed all built-in modals.	Client-Only

Examples¶

Example using:

`coreModalChangedEvent`¶

This client script listens for changes in the local player's modal and prints to the Event Log information about which modal was opened, or if modals were closed.

-- Converts the enum CoreModalType into a string, to make the log more readable
function ToStringModaltype(modalType)
    -- The pause menu opened by pressing the Escape key, or other minor pause states
    if modalType == CoreModalType.PAUSE_MENU then return "PAUSE" end

    -- Popup when the player is choosing a character
    if modalType == CoreModalType.CHARACTER_PICKER then return "CHARACTER PICKER" end

    -- Popup when the player is choosing a mount
    if modalType == CoreModalType.MOUNT_PICKER then return "MOUNT PICKER" end

    -- Popup when the player is choosing an emote
    if modalType == CoreModalType.EMOTE_PICKER then return "EMOTE PICKER" end

    -- Fallback, future-proof
    return "???" .. tostring(modalType)
end

function OnModalChanged(modalType)
    if modalType ~= nil then
        print("Modal changed to: " .. ToStringModaltype(modalType))
    else
        print("Closed modal.")
    end
end
UI.coreModalChangedEvent:Connect(OnModalChanged)

See also: CoreModalType

Tutorials¶

Last update: May 17, 2021