---
name: "leaderboardState"
type: command
status: ok
groups: ["Leaderboards"]
arma3_since: "1.42"
locality: {"argument": null, "effect": null, "server_exec": false}
source: https://community.bistudio.com/wiki/leaderboardState
revid: 339110
updated: 2023-04-26T10:54:35Z
---

# leaderboardState

*Command · Leaderboards · Arma 3 v1.42*

## Description

Returns the state of the board with the given name.

## Syntax

```sqf
leaderboardState boardname
```

**Parameters:**

- `boardname`: [String](../topics/String.md)

**Returns:** [Number](../topics/Number.md)
- 0: Busy (async. operation in progress)
- 1: Async. operation ended with success
- 2: Async. operation ended with error
- 3: Invalid board (bad board name, not initialised etc)

## Examples

### Example 1

```sqf
leaderboardState "TT01";
```

## See also

[leaderboardsRequestUploadScoreKeepBest](../commands/leaderboardsRequestUploadScoreKeepBest.md) · [leaderboardsRequestUploadScore](../commands/leaderboardsRequestUploadScore.md)

<sub>Source: [BI Community Wiki — leaderboardState](https://community.bistudio.com/wiki/leaderboardState) (revision 339110).</sub>