> For the complete documentation index, see [llms.txt](https://scripter-sm.gitbook.io/elite-zone/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://scripter-sm.gitbook.io/elite-zone/api-reference.md).

# API reference

Every table, function and hook the api global exposes.

```lua
api
├─ register(name, type)   -- returns your handle
├─ active(slot)           -- handle that owns "ragebot" / "misc"
├─ ui          -- the menu: find, change, build
├─ ragebot     -- planner hooks, desync, healing, presets
├─ targeting   -- aimbot / flickbot / silent aim / triggerbot targets
└─ game        -- players, weapons, deflects, round state
```

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-id-badge">:id-badge:</i></h3></td><td><strong>Lua handle</strong></td><td>What <code>register</code> returns: override, unload, connections, tabs, boxes, hooks.</td><td></td></tr><tr><td><h3><i class="fa-sliders">:sliders:</i></h3></td><td><strong>api.ui</strong></td><td>Read, set and remove any setting, and build your own menus.</td><td></td></tr><tr><td><h3><i class="fa-crosshairs">:crosshairs:</i></h3></td><td><strong>api.ragebot</strong></td><td>Hooks, custom strafe &#x26; shooting methods, desync, healing and presets.</td><td></td></tr><tr><td><h3><i class="fa-bullseye">:bullseye:</i></h3></td><td><strong>api.targeting</strong></td><td>See and override aimbot, flickbot, silent aim and triggerbot targets.</td><td></td></tr><tr><td><h3><i class="fa-users">:users:</i></h3></td><td><strong>api.game</strong></td><td>Players, equipped weapons, deflect state and round status.</td><td></td></tr><tr><td><h3><i class="fa-gear">:gear:</i></h3></td><td><strong>Settings reference</strong></td><td>Every ragebot setting: backend name, values, ranges and defaults.</td><td></td></tr></tbody></table>

## Conventions

* `idx` means a menu element's **backend name**, e.g. `ragebot_enabled`. See the Settings reference.
* A **ragebot target** is `{ player, head, root }`. An **aim target** (api.targeting) is `{ player, character, part, position, distance }`.
* Functions that can't produce a result return `nil` rather than erroring.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://scripter-sm.gitbook.io/elite-zone/api-reference.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.