> For the complete documentation index, see [llms.txt](https://zsx-development.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zsx-development.gitbook.io/docs/resources/user-interface/functions.md).

# Functions

<details>

<summary>Getters</summary>

### GetUIState

Retrieving the state of the interface. The available states are Welcome, Configuration, and Game. It returns an object if no argument is passed.

```lua
exports['ZSX_UI']:GetUIState(state)
```

### GetPlayerSettings

Retrieving player settings. It returns an object if no argument is passed.

```lua
exports['ZSX_UI']:GetPlayerSettings(setting)
```

</details>

<details>

<summary>Setters</summary>

### SetUIState

Setting the UI state of the interface. It interacts with the variable, not the interface itself.

```lua
exports['ZSX_UI']:SetUIState(element, bool)
```

</details>

<details>

<summary>For developers</summary>

### ForceCloseMenu

Hides the configuration menu using the \[F9] key.

```lua
exports['ZSX_UI']:ForceCloseMenu()
```

### HideUI

Hides the entire interface.

```lua
exports['ZSX_UI']:HideUI(state)
```

</details>