> For the complete documentation index, see [llms.txt](https://docs.cuxial.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cuxial.com/scripts/interface/cuxial-pausemenu/developers.md).

# Exports & events

Public API of Cuxial Pause Menu: the player state that tells whether someone has the menu or the map open.

Cuxial Pause Menu has no exports and no events for other resources. What it offers is one player state you can read.

## Player state: pauseState

The server keeps a replicated state bag on each player that tells whether they have the menu or the map open. Use it to skip actions on a player who is not looking at the game.

| Value            | Meaning                                |
| ---------------- | -------------------------------------- |
| `'menu'`         | The menu or the GTA settings are open. |
| `'map'`          | The GTA map is open.                   |
| `false` or `nil` | Nothing open.                          |

{% tabs %}
{% tab title="Client" %}

```lua
local state = Player(serverId).state.pauseState

if state == 'menu' or state == 'map' then
    -- that player is paused
end
```

{% endtab %}

{% tab title="Server" %}

```lua
local state = Player(source).state.pauseState

if state then
    -- that player is paused
end
```

{% endtab %}
{% endtabs %}

To react when it changes:

```lua
AddStateBagChangeHandler('pauseState', nil, function(bagName, _, value)
    local player = GetPlayerFromStateBagName(bagName)
    if player == 0 then return end
    print(player, value)
end)
```

{% hint style="warning" %}
The state is only written with `aura.enabled = true`. It is not set while the player is dead or downed with `aura.clearOnDeath = true`. Read it only; the resource overwrites any other value.
{% endhint %}


---

# 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.cuxial.com/scripts/interface/cuxial-pausemenu/developers.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.