Guide 1 Docs 2 Reference 3

Function of PlayerUi

playerUi.overlay

Puts a canvas in a corner of this player's screen, size screen pixels square at GUI scale 1 (96 by default, 16 to 511), margin from the edges (4 by default); nil where player:supports("overlay") is false.

playerUi.overlay(opts: { corner: ("top_left" | "top_right" | "bottom_left" | "bottom_right")?, size: number?, margin: number? }?) → Overlay?

Parameters

opts{ corner: ("top_left" | "top_right" | "bottom_left" | "bottom_right")?, size: number?, margin: number? }optional

Returns

Overlay?