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

# Exports

### Client

```lua
exports.sb_compass:SetHidden(true)   -- hide the HUD, for cutscenes, cameras and so on
exports.sb_compass:IsHidden()
exports.sb_compass:IsPlayerReady()  -- true when the HUD's ready checks pass
exports.sb_compass:GetSettings()
exports.sb_compass:OpenSettings()
```

### Server

```lua
exports.sb_compass:GetPlayerSettings(source)
```