wolfhacklua API 1.1 Forum

app

The overlay itself: its size, whether the menu is open, and how fast it is drawing.

since 1.0no permission needed

Reference#

app.screen_size#since 1.0

app.screen_size(): number, number

The size of the overlay, which covers the game picture. Read it every frame instead of caching it: the window can change size.

ReturnsDescription
numberWidth in pixels.
numberHeight in pixels.
lua
local w, h = app.screen_size()
log.info(w .. "x" .. h)

app.menu_open#since 1.0

app.menu_open(): boolean

While the menu is open the overlay takes the mouse; with it closed the mouse goes to the game.

ReturnsDescription
booleantrue while the overlay menu is open.

app.fps#since 1.0

app.fps(): number

The overlay's own frame rate, not the game's.

ReturnsDescription
numberFrames the overlay draws per second.
API 1.1 · source docs-src/api/app.json