Lua API Reference

Timing and frame information from the Source 2 engine global variables.

Engine queries, view control, and console commands.

Entity access and queries. Indices 1–64 are player controllers in CS2 — this module transparently resolves them to pawns so scripts get position, health, and team data from the correct entity.

local players = entity.GetPlayers()
for _, ply in ipairs(players) do
  if entity.IsEnemy(ply) and entity.IsAlive(ply) then
    local name = entity.GetName(ply)
    local hp   = entity.GetHealth(ply)
    local x, y, z = entity.GetPosition(ply)
    print(name .. " has " .. hp .. "hp at " .. x .. ", " .. y)
  end
end

local ent = entity.GetByIndex(1)
if ent then
  local kills = entity.GetPropInt(ent, "CCSPlayerController", "m_iKills")
  local ping  = entity.GetPropInt(ent, "CCSPlayerController", "m_iPing")
  print("Kills: " .. kills .. "  Ping: " .. ping)
end

2D rendering API. All drawing functions must be called inside a paint event handler. Colors can be Color() objects, {r, g, b, a} tables, or packed integers.

events.On("paint", function()
  local w, h = renderer.ScreenSize()
  local cx, cy = w / 2, h / 2

  -- crosshair
  renderer.Line(cx - 8, cy, cx + 8, cy, Color(0, 255, 0, 200))
  renderer.Line(cx, cy - 8, cx, cy + 8, Color(0, 255, 0, 200))

  -- velocity display
  local me = entity.GetLocalPlayer()
  if me then
    local vx, vy, vz = entity.GetVelocity(me)
    local speed = math.floor(math.sqrt(vx*vx + vy*vy))
    renderer.Text(cx, cy + 20, speed .. " u/s",
      Color(255, 255, 255, 180), 14, "mono")
  end
end)

Keyboard and mouse state. Key codes are exposed as constants on the input table (e.g. input.KEY_A, input.MOUSE_LEFT, input.F1–input.F12).

Tab / Group / Widget hierarchy for building script configuration UIs. Values persist automatically across script reloads.

local tab = ui.Tab("Aim Helper")
local g = tab:Group("Settings")

local enabled = g:Checkbox("Enabled", true)
local fov     = g:SliderFloat("FOV", 1.0, 30.0, 5.0)
local style   = g:Combo("Style", {"Circle", "Cross", "Dot"}, 1)
local hotkey  = g:Keybind("Toggle Key", input.KEY_X)
local color   = g:ColorPicker("Color", {1, 0, 0, 1})

g:Separator("Info")
local status = g:Label("Status: idle")

enabled:OnChange(function(val)
  status:Set(val and "Status: active" or "Status: idle")
end)

g:Button("Reset Defaults", function()
  fov:Set(5.0)
  style:Set(1)
  color:Set({1, 0, 0, 1})
end)

Event subscription system with typed event names.

local myKills = 0

-- CS2 game events pass a single table with named fields
events.On("player_death", function(e)
  local me = entity.GetLocalPlayer()
  if me and e.attacker == entity.GetIndex(me) then
    myKills = myKills + 1
    cheat.Notify("Kill #" .. myKills .. " with " .. e.weapon .. "!")
    system.PlaySound("scripts/ding.wav")
  end
end)

events.On("round_start", function(e)
  myKills = 0
end)

-- Platform events pass individual arguments
events.On("key", function(key, down)
  if key == input.KEY_H and down then
    cheat.Notify("Kills this round: " .. myKills)
  end
end)

Named hook management — bridges hook names to the event system. Supports both PascalCase and snake_case hook names.

-- hooks.Add uses named IDs (can replace/remove by name)
hooks.Add("Paint", "my_watermark", function()
  renderer.Text(10, 10, "gamesense.cloud", Color(100, 200, 255), 16)
end)

-- remove later by name
hooks.Remove("Paint", "my_watermark")

-- events.On uses numeric handles
local h = events.On("paint", function()
  renderer.Text(10, 10, "hello", Color(255,255,255))
end)
events.Off(h)  -- remove by handle

ESP override and custom element system. Store per-entity overrides, custom text, and custom bars that a renderer can consume.

HTTP client via WinHTTP. Supports HTTPS. Requests are synchronous — use timer.After(0, fn) to avoid blocking paint. 10-second timeout.

-- simple GET
local body, err = http.Get("https://api.example.com/data")
if body then
  local data = json.Decode(body)
  print("Got " .. #data .. " items")
end

-- POST JSON (non-blocking via timer)
timer.After(0, function()
  local payload = json.Encode({ name = cheat.GetUsername() })
  local res = http.Request({
    url = "https://api.example.com/submit",
    method = "POST",
    body = payload,
  })
  if res.ok then print("Submitted!") end
end)

Cheat identity, control, and utility functions.

OS-level utilities — clipboard, timing, audio.

Extended math utilities for angle and vector operations. Augments the standard Lua math table — all functions are accessed via math.AngleNormalize() etc.

JSON encoding and decoding. Both PascalCase and lowercase names are supported.

Aliases: json.decode, json.encode, json.valid

Per-script persistent key-value storage. Data is saved as JSON and survives script reloads.

-- load saved config or use defaults
local config = store.get("config") or {
  enabled = true,
  color = {255, 0, 0, 255},
  key = input.KEY_H,
}

-- update and save on change
events.On("key", function(key, down)
  if key == input.F2 and down then
    config.enabled = not config.enabled
    store.set("config", config)
    cheat.Notify("Toggled: " .. tostring(config.enabled))
  end
end)

Filesystem access sandboxed to the scripts root directory. All paths are relative to the root; attempts to escape via .. are rejected.

Deferred execution and periodic tasks.

-- auto-save config every 30 seconds
timer.Every(30, function()
  store.save()
  return true  -- keep running (return false to stop)
end)

-- delayed notification
timer.After(3, function()
  cheat.Notify("Script loaded!")
end)

-- do something next frame (avoids blocking paint)
timer.NextFrame(function()
  http.Get("https://example.com/check")
end)

Logging API. print() is redirected to log.info, so standard Lua prints appear in the console.

LuaJIT-compatible FFI subset for calling Windows API functions directly from Lua. Works on x64 Windows — all calling conventions collapse to Microsoft x64 ABI.

local result = ffi.C.MessageBoxA(0, "Hello", "Title", 0)

-- allocate a buffer and call GetModuleFileNameA
local buf = ffi.new("char[260]")
ffi.C.GetModuleFileNameA(0, buf, 260)
print("Exe: " .. ffi.string(buf))

-- load a DLL and call an export
local ntdll = ffi.load("ntdll")
local ticks = ntdll.NtGetTickCount()
print("Ticks: " .. ticks)

-- MessageBox popup
ffi.C.MessageBoxA(0, "Hello from Lua!", "gscloud", 0)

Console variable access — read and write cvars directly.

Ray tracing queries. Currently returns default results (no hit, fraction 1.0). The API signature is stable — implementations will be added when the engine trace interface is hooked.

Panorama UI scripting bridge. Currently a no-op — requires hooking the Panorama JS engine.

Global constructors for common value types. These are available without a module prefix.