Known gaps
This page lists what scripts cannot do, what is not specified, and what has not been verified. It is part of the documentation on purpose: nothing here is planned or promised, and nothing documented elsewhere depends on it.
Missing functionality#
| You might want | Status |
|---|---|
| Key events (a callback when a key is pressed) | Not available. Poll with input.key_down (needs input) and detect the edge yourself. |
| Game events (player hurt, killed, round start, weapon fire) | Not available. Only ingame, map and bomb events exist. |
| Per-entity drawing hooks (adding to the overlay's own player ESP) | Not available. Scripts draw on top with draw.* and data.world_to_screen. |
| Bones, hitboxes, weapon lists, inventory, per-player view vectors, velocity vectors | Not in the snapshot. A player has x, y, z, yaw, pitch, speed and the flags listed in data. |
| Players of teams whose ESP is off | The snapshot only contains teams whose ESP is switched on. |
| Adding controls to the overlay's built-in pages | Not available. A script gets its own tabs, windows and widgets (at most 8 of each). |
| Changing a widget's size after it is registered | Not available. size is fixed at registration. |
| More control types: multi-select, list box, number box, text area, colour-only swatch | Not available. The controls are toggle, checkbox, slider, dropdown, colour, keybind, one-line input and button. ui.input has no tip option. |
| Sound, clipboard, notifications, opening links, files outside the data folder | Not available. |
| Console variables and commands | Not available through the script API. |
| Sending input (keys, clicks) | Not available, deliberately. |
| WebSockets, redirects, non-HTTPS, other methods than GET and POST | Not available in net. |
| Native code, FFI, DLLs | Refused. A manifest with "native": true is rejected. |
| An unload hook for a script stopped by the host | Not called; the script is no longer running. |
Memory API (1.1)#
| You might want | Status |
|---|---|
| Reading unsigned 64-bit integers | Not available as a type; use read_ptr for addresses, read_i64 for 64-bit values. |
| Allocating memory in the game, calling game functions, hooks, trampolines | Not available. |
| Struct or array readers | Not available; read blocks with read_bytes and unpack with string.unpack. |
| A write that outlives the script | Not available by design. Writes are undone when the script stops. |
| Finding an offset the overlay does not know | mem.offset only knows the overlay's schema table; use mem.scan and your own arithmetic otherwise. |
mem.global names beyond the ten listed | Not available. |
Behaviour that is not specified exactly#
These work, but the documentation cannot state exact numbers because the host's reference does not:
- The formulas behind
anim.approach'srate, and the default spring and tween easing details beyond the names. - The default segment count of
draw.circleanddraw.arc("automatic"). - The meaning of the numbers in
media.get().repeat. - The exact set of characters
ui.inputaccepts, and its maximum length. - Which key name strings
c.key_downaccepts beyond the list given in ui. - Behaviour when two scripts register a theme or widget with the same id (ids are per script).
Undocumented host functions#
anim.ease_check exists in the host (it appears in the generated inventory) but is an internal helper, not part of the supported API; it is deliberately not documented, and listed in docs-src/inventory-ignore.json so the checker accepts it.
What has been verified, and what has not#
| Claim | How it was checked |
|---|---|
| Every documented function and field exists | Compared with the host's own inventory (docs-src/api-inventory.txt) by tools/docs/check.js. |
| The example scripts run | Run through the real script host in the overlay's --lua-test, with a fake game and fake game memory: no errors, no warnings, no budget strikes, tab built, widgets drawn. |
| Argument names, types, defaults and limits | Written from the host's source and its API reference; spot-checked, not machine-verified. A wrong default is a documentation bug: report it. |
| Behaviour in a real match | Not verified. The snapshot in tests is a fake with the same structure. The mem module has been tested against a fake game made of real memory pages, not against the running game. |
| Look in the overlay's real window | Not verified (z-order, click-through, DPI). |
Documentation gaps#
- No changelog of the API before 1.1; everything not marked since 1.1 is simply "1.0".
- The reference does not list every error message a function can raise; troubleshooting lists the common ones.
- There is no tutorial for shaders or the 3D mesh functions beyond their reference entries.
- Examples for
net,media,themeandassetspictures are only in the reference, not as complete scripts. - The reference is English only.
Things that are not available#
io, package, debug, loadfile, dofile, string.dump, ffi, os.execute, os.remove, os.getenv and bytecode loading are removed on purpose; see what this Lua has and lacks.