> For the complete documentation index, see [llms.txt](https://docs.gamesense.biz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gamesense.biz/guides-and-examples/examples.md).

# Examples

Examples of common Lua API operations.

Examples of common operations using the GameSense Lua API.

## Show settings conditionally

```lua
local enabled = menu.checkbox("Advanced options", false)
local amount = menu.slider_int("Amount", 0, 100, 50)

amount:set_visible(enabled:get())
enabled:on_change(function()
    amount:set_visible(enabled:get())
end)
```

## Choose a mode

```lua
local modes = {"Off", "Normal", "Fast"}
local mode = menu.combo("Mode", modes, 2)
local label = menu.label("Mode: Normal")

mode:on_change(function()
    label:set("Mode: " .. modes[mode:get()])
end)
```

## Count game updates

```lua
local updates = 0
local status = menu.label("Updates: 0")

register_callback("on_update", function()
    updates = updates + 1
    status:set("Updates: " .. updates)
end)
```

## Read a binary buffer

```lua
local ffi = require("ffi")
local data = ffi.buffer(8)
data:set_u32(0, 125)

local value = data:get_u32(0)
```

## Display an object class

```lua
local status = menu.label("Class: unknown")

register_callback("on_update", function()
    if not il2cpp.available() then return end

    local avatar = il2cpp.root("local_avatar")
    if avatar and avatar:valid() then
        status:set("Class: " .. avatar:class():name())
    end
end)
```

IL2CPP handles must not be stored across callbacks. See [IL2CPP](/api-reference/il2cpp.md).


---

# 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://docs.gamesense.biz/guides-and-examples/examples.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.