API Reference
Every namespace below is served by TSUKI itself and works in any script, with nothing to declare. The feeds that need the internal have their own section: Internal API Reference.
New to scripting here? Start with Getting Started and Script Structure.
Core
| Page | What it covers |
|---|---|
| Globals | Top-level functions and the game, storage, json and timer namespaces, callable from any script. |
| Player | The player object: health, weapons, bones, hitboxes, modifiers and screen space. |
| Entities | Troopers, jungle camps, the midboss, crates, powerups and other world objects, by class or by curated type. |
| Events | Callbacks TSUKI calls on kills, casts, particles, modifiers and sounds. |
| Game Messages | Subscribe to the game's own network messages: damage, kills, hits and chat. Messages only arrive while the internal is running. |
Aiming
| Page | What it covers |
|---|---|
| Targeting | Target selection helpers and aim math in the targeting.* namespace. |
| Prediction | Projectile leading, ability arcs and motion tracking via solve_linear, solve_ballistic and ability_arc. |
| Camera | Local camera state and world-to-screen conversion. |
Output
| Page | What it covers |
|---|---|
| Draw | 2D and 3D primitives, buffered per tick. |
| Game Icons | The game's own ability, item, status and portrait art. |
| UI | Custom menu widgets (tabs, sliders, checkboxes and color pickers) and panels you draw that take mouse clicks. |
Input and data
| Page | What it covers |
|---|---|
| Input | Keyboard and mouse state, using Windows VK codes. |
| HTTP | Asynchronous GET, POST, PUT, DELETE, PATCH and HEAD requests that never block your script. |
| Memory | Direct memory reads, for offsets you found yourself. |
Constants
| Page | What it covers |
|---|---|
| Types & Constants | Vec2 and vec3 math types, plus modifier_flag, slot, bone, hero_id and the VK key codes. |
| Modifier Flags | Every modifier_flag constant. |
The internal API
These need the internal running and needs_internal = true in your script_info.
| Page | What it covers |
|---|---|
| Internal API Reference | What the flag turns on, when a call returns nil, and how to tell whether the internal is running. |
| Stats | Resolved resists, shields, barrier and your own weapon numbers. |
| Ability Values | The resolved value of an ability property, with upgrades and scaling applied. |
| Hit Events | Per-hit damage events for hits you dealt or took, plus the running tally. |
| Entity Properties | One schema field by name off a player or an entity row. |
| Traces | Ask the game what a line hits. trace.bvh checks a line against the map without the internal. |
| Aim | The scripted aim path: aim.silent, aim.shoot, aim.can_reach. |
| Schema Fields | Read, write and watch any game field by name. |
| Pings | A real map ping on an enemy. |
| Chat and Map | Send a chat message, ping a spot, or draw on the minimap. |
| Commands | Change the buttons in your own game command, including taking one away. |
| Glow | Outline or fill any player or entity. |
| Console Settings | Read and change the game's console settings. |
| HUD | How many interface panels carry a class, for reading the game's cast indicator. |