> For the complete documentation index, see [llms.txt](https://docs.xeutrino.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xeutrino.com/api-reference/option-state.md).

# Option state

Options added with the `add_*` functions are keyed by the string `id` you passed in. These functions read and write that state from your main loop.

## `get_opt(id)` → integer

Returns the current state of an option. For checkboxes/buttons this is `0` or `1`; for int scrollers it's the current value. Returns `0` if the `id` is unknown.

| Param | Type   | Description              |
| ----- | ------ | ------------------------ |
| `id`  | string | The option's unique key. |

## `set_opt(id, value)`

Overwrites the state of an option. The most common use is resetting a button after you've handled its press so it doesn't fire every frame.

| Param   | Type    | Description              |
| ------- | ------- | ------------------------ |
| `id`    | string  | The option's unique key. |
| `value` | integer | New value.               |

## Typical pattern

```lua
if get_opt("btn_heal") == 1 then
    set_opt("btn_heal", 0)          -- reset before handling
    -- do the thing
end
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xeutrino.com/api-reference/option-state.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.