wolfhacklua API 1.1 Forum

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 wantStatus
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 vectorsNot in the snapshot. A player has x, y, z, yaw, pitch, speed and the flags listed in data.
Players of teams whose ESP is offThe snapshot only contains teams whose ESP is switched on.
Adding controls to the overlay's built-in pagesNot available. A script gets its own tabs, windows and widgets (at most 8 of each).
Changing a widget's size after it is registeredNot available. size is fixed at registration.
More control types: multi-select, list box, number box, text area, colour-only swatchNot 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 folderNot available.
Console variables and commandsNot available through the script API.
Sending input (keys, clicks)Not available, deliberately.
WebSockets, redirects, non-HTTPS, other methods than GET and POSTNot available in net.
Native code, FFI, DLLsRefused. A manifest with "native": true is rejected.
An unload hook for a script stopped by the hostNot called; the script is no longer running.

Memory API (1.1)#

You might wantStatus
Reading unsigned 64-bit integersNot available as a type; use read_ptr for addresses, read_i64 for 64-bit values.
Allocating memory in the game, calling game functions, hooks, trampolinesNot available.
Struct or array readersNot available; read blocks with read_bytes and unpack with string.unpack.
A write that outlives the scriptNot available by design. Writes are undone when the script stops.
Finding an offset the overlay does not knowmem.offset only knows the overlay's schema table; use mem.scan and your own arithmetic otherwise.
mem.global names beyond the ten listedNot 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's rate, and the default spring and tween easing details beyond the names.
  • The default segment count of draw.circle and draw.arc ("automatic").
  • The meaning of the numbers in media.get().repeat.
  • The exact set of characters ui.input accepts, and its maximum length.
  • Which key name strings c.key_down accepts 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#

ClaimHow it was checked
Every documented function and field existsCompared with the host's own inventory (docs-src/api-inventory.txt) by tools/docs/check.js.
The example scripts runRun 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 limitsWritten 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 matchNot 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 windowNot 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, theme and assets pictures 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.

API 1.1 · source docs-src/pages/help/gaps.md