game.overlay

Native global — no require.

visible

function · visible(): boolean

True when the Sharp overlay is shown.

Returns

Type	Summary
boolean	—

show

function · show()

Show the host overlay.

hide

function · hide()

Hide every overlay surface (same as Insert).

close

function · close()

Hide the host overlay.

minimize

function · minimize()

Hide the host overlay.

toggle

function · toggle()

Toggle overlay visibility.

maximized

function · maximized(): boolean

True when the host overlay is maximized.

Returns

Type	Summary
boolean	—

maximize

function · maximize()

Maximize the host overlay.

restore

function · restore()

Restore the host overlay from maximized.

toggle_maximized

function · toggle_maximized()

Toggle maximized vs restored.

position

function · position(): number, number

Overlay x, y in screen pixels.

Returns

Type	Summary
number, number	—

size

function · size(): number, number

Overlay width, height in screen pixels.

Returns

Type	Summary
number, number	—

set_position

function · set_position(x: number, y: number)

Move the host overlay.

Parameters

Name	Type	Summary
x	number	—
y	number	—

set_size

function · set_size(width: number, height: number)

Resize the host overlay.

Parameters

Name	Type	Summary
width	number	—
height	number	—

mouse_captured

function · mouse_captured(): boolean

True while the cursor is over a Sharp window.

Returns

Type	Summary
boolean	—

community_store_open

function · community_store_open(): boolean

True while the Community Store window is open.

Returns

Type	Summary
boolean	—

close_community_store

function · close_community_store()

Close the Community Store window.

cavebot_show_route

function · cavebot_show_route(): boolean

True when Visuals/CaveBot "Show Route" is on.

Returns

Type	Summary
boolean	—

set_cavebot_show_route

function · set_cavebot_show_route(enabled: boolean)

Persist the CaveBot route overlay toggle.

Parameters

Name	Type	Summary
enabled	boolean	—