> 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-v2/exports/other/getcurrentscreen.md).

# GetCurrentScreen

Returns string of the current screen.\
If screen was not listed - it will return:

```ssml
ROUTE_WAS_NOT_DEFINED
```

List of screens:

<table><thead><tr><th width="187">String Return</th><th>Information</th></tr></thead><tbody><tr><td>pausemenu</td><td>Pause Menu</td></tr><tr><td>game_menu</td><td>In-game UI Settings</td></tr><tr><td>position</td><td>Position Screen</td></tr><tr><td>preview</td><td>Preview Screen (After configuration screen)</td></tr><tr><td>welcome</td><td>Welcome (Music/UI Presets)</td></tr><tr><td>game</td><td>Default screen where player see his UI</td></tr><tr><td>mainmenu</td><td>Main Menu (The first screen with spectacular view of in-game world)</td></tr><tr><td>cinematic_mode</td><td>Cinematic Mode</td></tr></tbody></table>
