Lua scripting

LuaJIT API reference, setup instructions and script examples for aqua!v2.

Getting startedDownload raw docs for LLMs ↓

main.lua

function on_draw()
    aqua.draw.text(24, 24, "yo, what's up?", { 1, 1, 1 }, { size = 18 })
end

Save as main.lua and run it from Scripts.

API reference

User commandsCreateMove callbacks, command fields and input requests.Drawing and overlayShapes, text, fonts, images and screen geometry.TracingRay and hull traces, hit results and filters.Players and matchPlayers, weapons, items and current match state.Config and UISaved config, temporary overrides and script controls.PanoramaQueued JavaScript and panel cache management.Events and callbacksScript lifecycle, game events and shot notifications.Sound and musicSound playback and music streams.NetworkingShared script state, Aqua peers and outbound UDP.Engine and utilitiesEngine commands, ConVars, logging and time helpers.

i

Read lifecycle callbacks and callback rules for callback timing and allowed operations.