> For the complete documentation index, see [llms.txt](https://izaap-studios.gitbook.io/izaap-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://izaap-studios.gitbook.io/izaap-scripts/arenapvp/exports-list.md).

# Exports List

## <mark style="color:$primary;">CLIENT-SIDE</mark>

### IsPlayerInMatch

Checks whether the local player is currently inside an ArenaPVP match.

```lua
exports['izaap_arenapvp']:IsPlayerInMatch()
```

**Returns**

* `boolean` — `true` if the player is in a match.

> Example Usage

```lua
local inMatch = exports['izaap_arenapvp']:IsPlayerInMatch()

if inMatch then
    print('The player is currently in a match.')
end
```

***

### GetPlayerMatchState

Returns the current ArenaPVP match state for the local player.

```lua
exports['izaap_arenapvp']:GetPlayerMatchState()
```

**Returns**

* `table`
  * `inMatch` — `boolean`
  * `roomId` — `number|string`
  * `team` — `string|number`
  * `mode` — `string`
  * `round` — `number`

> Example Usage

```lua
local state = exports['izaap_arenapvp']:GetPlayerMatchState()

if state.inMatch then
    print(('Room: %s | Team: %s | Mode: %s | Round: %s'):format(
        state.roomId,
        state.team,
        state.mode,
        state.round
    ))
end
```