# SUI

## Functions

### AddNotification

void **AddNotification** (string title, string text)

*Shows a notification*

| Parameter | Type | Description |
| --------- | ---- | ----------- |
|           |      |             |

{% tabs %}
{% tab title="Lua" %}

```lua
 Space.UI.AddNotification('Warning','This is a notification')
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will send a notification every time a new player joins region
--including the users name

function sendNotification(Av) 
Space.UI.AddNotification("New User","User joined: " .. Av.Username)
end

Space.Scene.OnPlayerJoin(sendNotification) 
```

{% endtab %}
{% endtabs %}

### OpenAppearanceEditor

void **OpenAppearanceEditor**()

*Opens the Appearance Editor (Outfit)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenAppearanceEditor()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button open the Appearance Editor
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')


OnClick = function()
  Space.UI.OpenAppearanceEditor()  
end

theButton.UIButton.OnClick(OnClick) 
```

{% endtab %}
{% endtabs %}

### ShowPathToLocation

void **ShowPathToLocation** (string reason, [SVector](https://docs.breakroom.tech/scripting/client-scripting-api-reference/types/svector) location)

*Shows a path to given location*

| Parameter | Type | Description |
| --------- | ---- | ----------- |
|           |      |             |

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowPathToLocation("A Reason", aLocation)
```

{% endtab %}
{% endtabs %}

### ShowLocation

void **ShowLocation** (string reason, [SVector](https://docs.breakroom.tech/scripting/client-scripting-api-reference/types/svector) location)

*Shows given location*

| Parameter | Type | Description |
| --------- | ---- | ----------- |
|           |      |             |

{% tabs %}
{% tab title="Lua" %}

```lua
 Space.UI.ShowLocation("the reason", aLocation)
```

{% endtab %}
{% endtabs %}

### AddGlobalActionButton

void **AddGlobalActionButton** (string button, string tooltip, Closure action)

Adds a "Global Action Button" which is a custom button you add to the UI that calls an action of your choice then clears after being clicked

| Parameter | Type | Description |
| --------- | ---- | ----------- |
|           |      |             |

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.AddGlobalActionButton("Button 1", "Stand Up", aFunction)
```

{% endtab %}
{% endtabs %}

### ClearGlobalActionButton

void **ClearGlobalActionButton** (string button)

*Clears a previously added Global Action Button 'button'*

| Parameter | Type | Description |
| --------- | ---- | ----------- |
|           |      |             |

{% tabs %}
{% tab title="Lua" %}

```lua
 Space.UI.ClearGlobalActionButton("The Button")
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make this object make you dance when clicked
--and also show a Global Action button to let you stop the dance (and clear that button)
--[required: Add the dance animation to the Scripting Runtime's "Resources" section with name "dance"]

thisObj = Space.Host.ExecutingObject
danceAnim = Space.GetResource("dance")
isDancing = false

gbClick = function()
 Space.Scene.PlayerAvatar.StopCustomAnimation()
 Space.UI.ClearGlobalActionButton("Stop Dance")
 isDancing = false
end

OnClick = function()
    if not isDancing then
    Space.Scene.PlayerAvatar.PlayCustomAnimation(danceAnim)  
    Space.UI.AddGlobalActionButton("Stop Dance","", gbClick)
    isDancing = true
    end
end


thisObj.AddClickable()
thisObj.Clickable.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenQuestsWindow

void **OpenQuestsWindow** ()

*Opens the Quests window. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenQuestsWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
example --This script will make a button show/hide the Quests Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideQuestsWindow()
  isShown = false
  else
  Space.UI.OpenQuestsWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick) 
```

{% endtab %}
{% endtabs %}

### HideQuestsWindow

void **HideQuestsWindow** ()

*Hides the Quests window. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideQuestsWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Quests Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideQuestsWindow()
  isShown = false
  else
  Space.UI.OpenQuestsWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick) 
```

{% endtab %}
{% endtabs %}

### OpenSettingsWindow

void **OpenSettingsWindow** ()

*Opens the Settings window. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenSettingsWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Settings Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideSettingsWindow()
  isShown = false
  else
  Space.UI.OpenSettingsWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick) 
```

{% endtab %}
{% endtabs %}

### HideSettingsWindow

void **HideSettingsWindow** ()

*Hides the Settings window. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideSettingsWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Settings Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideSettingsWindow()
  isShown = false
  else
  Space.UI.OpenSettingsWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick) 
```

{% endtab %}
{% endtabs %}

### OpenFriendsWindow

void **OpenFriendsWindow** ()

*Opens the Friends window. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenFriendsWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Friends Window--(example: tools for user to customize UI)--[You need to add a UI Button as a reference in the Scripting Runtime Component]theButton  = Space.Host.GetReference('TheButton')local isShown = falseOnClick = function()  if isShown then  Space.UI.HideFriendsWindow()  isShown = false  else  Space.UI.OpenFriendsWindow()    isShown = true  endendtheButton.UIButton.OnClick(OnClick)
HideFriendsWindow
```

{% endtab %}
{% endtabs %}

### HideFriendsWindow

void **HideFriendsWindow** ()

*Hides the Friends window. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideFriendsWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Friends Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideFriendsWindow()
  isShown = false
  else
  Space.UI.OpenFriendsWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenExploreWindow

void **OpenExploreWindow** ()

*Opens the Explore window. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenExploreWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Explore Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideExploreWindow()
  isShown = false
  else
  Space.UI.OpenExploreWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick) 
```

{% endtab %}
{% endtabs %}

### HideExploreWindow

void **HideExploreWindow** ()

*Hides the Explore window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideExploreWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Explore Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideExploreWindow()
  isShown = false
  else
  Space.UI.OpenExploreWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick) 
```

{% endtab %}
{% endtabs %}

### OpenEventsWindow

void **OpenEventsWindow** ()

*Opens the Events window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenEventsWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Events Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideEventsWindow()
  isShown = false
  else
  Space.UI.OpenEventsWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideEventsWindow

void **HideEventsWindow** ()

*Hides the Events window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideEventsWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Events Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideEventsWindow()
  isShown = false
  else
  Space.UI.OpenEventsWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenHomeWindow

void **OpenHomeWindow** ()

*Opens the Home window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenHomeWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Home Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideHomeWindow()
  isShown = false
  else
  Space.UI.OpenHomeWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideHomeWindow

void **HideHomeWindow** ()

*Hides the Home window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideHomeWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Home Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideHomeWindow()
  isShown = false
  else
  Space.UI.OpenHomeWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenInventoryWindow

void **OpenInventoryWindow** ()

*Opens the Inventory window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenInventoryWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Inventory Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideInventoryWindow()
  isShown = false
  else
  Space.UI.OpenInventoryWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideInventoryWindow

void **HideInventoryWindow** ()

*Hides the Inventory window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideInventoryWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Inventory Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideInventoryWindow()
  isShown = false
  else
  Space.UI.OpenInventoryWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenOutfitWindow

void **OpenOutfitWindow** ()

*Opens the Outfit window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenOutfitWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Outfit Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideOutfitWindow()
  isShown = false
  else
  Space.UI.OpenOutfitWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideOutfitWindow

void **HideOutfitWindow** ()

*Hides the Outfit window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideOutfitWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Outfit Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideOutfitWindow()
  isShown = false
  else
  Space.UI.OpenOutfitWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenShopWindow

void **OpenShopWindow** ()

*Opens the Shop window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenShopWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Shop Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideShopWindow()
  isShown = false
  else
  Space.UI.OpenShopWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideShopWindow

void **HideShopWindow** ()

*Hides the Shop window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideShopWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Shop Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideShopWindow()
  isShown = false
  else
  Space.UI.OpenShopWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenSnapshotWindow

void **OpenSnapshotWindow** ()

*Opens the Snapshot window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenSnapshotWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Snapshot Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideSnapshotWindow()
  isShown = false
  else
  Space.UI.OpenSnapshotWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideSnapshotWindow

void **HideSnapshotWindow** ()

*Hides the Snapshot window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideSnapshotWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Snapshot Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideSnapshotWindow()
  isShown = false
  else
  Space.UI.OpenSnapshotWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenHelpWindow

void **OpenHelpWindow** ()

*Opens the Help window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenHelpWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Help Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideHelpWindow()
  isShown = false
  else
  Space.UI.OpenHelpWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideHelpWindow

void **HideHelpWindow** ()

*Hides the Help window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideHelpWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Help Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideHelpWindow()
  isShown = false
  else
  Space.UI.OpenHelpWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenProfileWin

void **OpenProfileWin** ()

*Opens the Profile window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenProfileWin()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Profile Win
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideProfileWindow()
  isShown = false
  else
  Space.UI.OpenProfileWin()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideProfileWindow

void **HideProfileWindow**()

*Hides the Profile window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideProfileWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Profile Win
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideProfileWindow()
  isShown = false
  else
  Space.UI.OpenProfileWin()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenUpgradeAccountWindow

void **OpenUpgradeAccountWindow** ()

*Opens the Upgrade Account window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenUpgradeAccountWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Upgrade Account Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideUpgradeAccountWindow()
  isShown = false
  else
  Space.UI.OpenUpgradeAccountWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideUpgradeAccountWindow

void **HideUpgradeAccountWindow** ()

*Hides the Upgrade Account window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideUpgradeAccountWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Upgrade Account Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideUpgradeAccountWindow()
  isShown = false
  else
  Space.UI.OpenUpgradeAccountWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenRegionInfoWindow

void **OpenRegionInfoWindow** ()

*Opens the Region Info window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenRegionInfoWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Region Info Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideRegionInfoWindow()
  isShown = false
  else
  Space.UI.OpenRegionInfoWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideRegionInfoWindow

void **HideRegionInfoWindow** ()

*Hides the Region Info window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideRegionInfoWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Region Info Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideRegionInfoWindow()
  isShown = false
  else
  Space.UI.OpenRegionInfoWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenExitWindow

void **OpenExitWindow** ()

*Opens the Exit window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenExitWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Exit Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideExitWindow()
  isShown = false
  else
  Space.UI.OpenExitWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideExitWindow

void **HideExitWindow** ()

*Hides the Exit window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideExitWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Exit Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideExitWindow()
  isShown = false
  else
  Space.UI.OpenExitWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenMailWindow

void **OpenMailWindow** ()

*Opens the Mail window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenMailWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Mail Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideMailWindow()
  isShown = false
  else
  Space.UI.OpenMailWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideMailWindow

void **HideMailWindow** ()

*Hides the Mail window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideMailWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Mail Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideMailWindow()
  isShown = false
  else
  Space.UI.OpenMailWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenFeedbackWindow

void **OpenFeedbackWindow** ()

*Shows the Feedback window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenFeedbackWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Feedback Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideFeedbackWindow()
  isShown = false
  else
  Space.UI.OpenFeedbackWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideFeedbackWindow

void **HideFeedbackWindow** ()

*Hides the Feedback window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideFeedbackWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Mail Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideFeedbackWindow()
  isShown = false
  else
  Space.UI.OpenFeedbackWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenBuyGoldWindow

void **OpenBuyGoldWindow** ()

*Opens the Buy Gold window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenBuyGoldWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Buy Gold Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideBuyGoldWindow()
  isShown = false
  else
  Space.UI.OpenBuyGoldWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideBuyGoldWindow

void **HideBuyGoldWindow** ()

*Hides the Buy Gold window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideBuyGoldWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Buy Gold Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideBuyGoldWindow()
  isShown = false
  else
  Space.UI.OpenBuyGoldWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenChatWindow

void **OpenChatWindow** ()

*Opens the Chat window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenChatWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Chat Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideChatWindow()
  isShown = false
  else
  Space.UI.OpenChatWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideChatWindow

void **HideChatWindow** ()

*Hides the Chat window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideChatWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Chat Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = true

OnClick = function()
  if isShown then
  Space.UI.HideChatWindow()
  isShown = false
  else
  Space.UI.OpenChatWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenRoomEditorWindow

void **OpenRoomEditorWindow** ()

*Opens the Room Editor window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenRoomEditorWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Room Editor Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideRoomEditorWindow()
  isShown = false
  else
  Space.UI.OpenRoomEditorWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### HideRoomEditorWindow

void **HideRoomEditorWindow** ()

*Hides the Room Editor window (white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.HideRoomEditorWindow()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button show/hide the Room Editor Window
--(example: tools for user to customize UI)
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')
local isShown = false

OnClick = function()
  if isShown then
  Space.UI.HideRoomEditorWindow()
  isShown = false
  else
  Space.UI.OpenRoomEditorWindow()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenDevicePicker

void **OpenDevicePicker** ()

*Opens the Device Picker*&#x20;

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenDevicePicker()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a button open the Device Picker
--[You need to add a UI Button as a reference in the Scripting Runtime Component]

theButton  = Space.Host.GetReference('TheButton')

OnClick = function()
  Space.UI.OpenDevicePicker()  
end

theButton.UIButton.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### OpenDeviceTester

void **OpenDeviceTester** ()

*Opens the Device Tester*&#x20;

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.OpenDeviceTester()
```

{% endtab %}
{% endtabs %}

### Raycast

SUIRaycastResult **Raycast** ()

*Shoots a UI Raycast and returns the result as SUIRayCastResult*

{% tabs %}
{% tab title="Lua" %}

```lua
RayCastResult = Space.UI.Raycast()
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will update a UIText element with the result of a UIRaycast whenever...
--the player clicks on a Sinespace UI element
thisObject = Space.Host.ExecutingObject
uiText = Space.Host.GetReference("text").UIText --Add this object with UIText component as reference in Scripting Runtime



OnUpdate = function()

  if Space.Input.GetMouseDown(0) == true then
  result = Space.UI.Raycast()	
    if result.IsValid then 
      uiText = result.ToString()
    end
  end
end


thisObject.OnUpdate(OnUpdate)
```

{% endtab %}
{% endtabs %}

## Properties

### ShowUI

bool **ShowUI** `get` `set`

*Show the User Interface*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowUI = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide theUser Interface
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowUI= true
  else
    Space.UI.ShowUI= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowWorldUI

bool **ShowWorldUI** `get` `set`

*Show the World User Interface.*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowWorldUI = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the World UI
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowWorldUI= true
  else
    Space.UI.ShowWorldUI= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### MusicVolume

int **MusicVolume** `get` `set`

*Set/Get the Music volume (set: white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
MusicVolume = Space.UI.MusicVolume
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make moving a slider control the Music Volume
--and also update a text field with the current Music Volume
--(example: custom UI)
--[You need to add the slider and text field as a reference]

slider = Space.Host.GetReference("Slider").UISlider
textField = Space.Host.GetReference("Text Field").UIText


OnValueChanged = function()
Space.UI.MusicVolume = slider.NormalizedValue * 100
textField.Text = Space.UI.MusicVolume
end

slider.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### MasterVolume

int **MasterVolume** `get` `set`

*Set/Get the Master volume (set: white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
MasterVolume = Space.UI.MasterVolume
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make moving a slider control the Master Volume
--and also update a text field with the current Master Volume
--(example: custom UI)
--[You need to add the slider and text field as a reference]

slider = Space.Host.GetReference("Slider").UISlider
textField = Space.Host.GetReference("Text Field").UIText


OnValueChanged = function()
Space.UI.MasterVolume = slider.NormalizedValue * 100
textField.Text = Space.UI.MasterVolume
end

slider.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### SFXVolume

int **SFXVolume** `get` `set`

*Set/Get the SFX volume (set: white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
SFXVolume = Space.UI.SFXVolume
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make moving a slider control the SFX Volume
--and also update a text field with the current SFX Volume
--(example: custom UI)
--[You need to add the slider and text field as a reference]

slider = Space.Host.GetReference("Slider").UISlider
textField = Space.Host.GetReference("Text Field").UIText


OnValueChanged = function()
Space.UI.SFXVolume = slider.NormalizedValue * 100
textField.Text = Space.UI.SFXVolume
end

slider.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### UIVolume

int **UIVolume** `get` `set`

*Set/Get the UI volume (set: white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
UIVolume = Space.UI.UIVolume
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make moving a slider control the UI Volume
--and also update a text field with the current UI Volume
--[You need to add the slider and text field as a reference]

slider = Space.Host.GetReference("Slider").UISlider
textField = Space.Host.GetReference("Text Field").UIText


OnValueChanged = function()
Space.UI.UIVolume = slider.NormalizedValue * 100
textField.Text = Space.UI.UIVolume
end

slider.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### VOIPVolume

int **VOIPVolume** `get` `set`

*Set/Get the VOIP volume (set: white-label grid only)*

{% tabs %}
{% tab title="Lua" %}

```lua
VOIPVolume = Space.UI.VOIPVolume
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
 --This script will make moving a slider control the Voice Volume
--and also update a text field with the current Voice Volume
--[You need to add the slider and text field as a reference]

slider = Space.Host.GetReference("Slider").UISlider
textField = Space.Host.GetReference("Text Field").UIText


OnValueChanged = function()
Space.UI.VOIPVolume = slider.NormalizedValue * 100
textField.Text = Space.UI.VOIPVolume
end

slider.OnValueChanged(OnValueChanged) 
```

{% endtab %}
{% endtabs %}

### ShowFriendsButton

bool **ShowFriendsButton** `get` `set`

*Show the Friends button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowFriendsButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Friends Button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowFriendsButton = true
  else
    Space.UI.ShowFriendsButton = false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowExploreButton

bool **ShowExploreButton** `get` `set`

*Show the Explore button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowExploreButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Explore Button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowExploreButton = true
  else
    Space.UI.ShowExploreButton = false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowQuestsButton

bool **ShowQuestsButton** `get` `set`

*Show the Quests button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowQuestsButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Quests button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowQuestsButton= true
  else
    Space.UI.ShowQuestsButton= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowInventoryButton

bool **ShowInventoryButton** `get` `set`

*Show the Inventory button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowInventoryButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Inventory Button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowInventoryButton= true
  else
    Space.UI.ShowInventoryButton= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowOutfitButton

bool **ShowOutfitButton** `get` `set`

*Set to true to show the Outfit button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowOutfitButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Outfit Button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowOutfitButton= true
  else
    Space.UI.ShowOutfitButton= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowShopButton

bool **ShowShopButton** `get` `set`

*Show the Shop button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowShopButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Shop Button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowShopButton= true
  else
    Space.UI.ShowShopButton= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowAuctionButton

bool **ShowAuctionButton** `get` `set`

*Show the Auction button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowAuctionButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Auction Button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowAuctionButton = true
  else
    Space.UI.ShowAuctionButton = false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowSnapshotButton

bool **ShowSnapshotButton** `get` `set`

*Show the Snapshot button.<mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowSnapshotButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Snapshot Button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowSnapshotButton= true
  else
    Space.UI.ShowSnapshotButton= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowHelpButton

bool **ShowHelpButton** `get` `set`

*Show the Help button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowHelpButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Help Button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowHelpButton= true
  else
    Space.UI.ShowHelpButton= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowCurrencyButton

bool **ShowCurrencyButton** `get` `set`

*Show the Currency button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowCurrencyButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Currency Button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowCurrencyButton= true
  else
    Space.UI.ShowCurrencyButton= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowGoldAndBuyButton

bool **ShowGoldAndBuyButton** `get` `set`

*Show the Gold and Buy button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowGoldAndBuyButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Gold and Buy button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowGoldAndBuyButton= true
  else
    Space.UI.ShowGoldAndBuyButton= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowChat

bool **ShowChat** `get` `set`

*Show the Chat. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowChat = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Chat
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowChat= true
  else
    Space.UI.ShowChat= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowMiniMap

bool **ShowMiniMap** `get` `set`

*Set to true to show the Minimap. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowMiniMap = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Minimap
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowMiniMap= true
  else
    Space.UI.ShowMiniMap= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowHotBar

bool **ShowHotBar** `get` `set`

*Show the Hot Bar. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowHotBar = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Hot Bar
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowHotBar= true
  else
    Space.UI.ShowHotBar= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowEventsButton

bool **ShowEventsButton** `get` `set`

*Show the Events button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowEventsButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the  Events button
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowEventsButton= true
  else
    Space.UI.ShowEventsButton= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowHomeButton

bool **ShowHomeButton** `get` `set`

*Show the Home button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowHomeButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Home Button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowHomeButton= true
  else
    Space.UI.ShowHomeButton= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowActivityPanel

bool **ShowActivityPanel** `get` `set`

*Show the Activity Panel. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowActivityPanel = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Activity Panel
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle

OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowActivityPanel= true
  else
    Space.UI.ShowActivityPanel= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowProfileImage

bool **ShowProfileImage** `get` `set`

*Show the Profile Image. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowProfileImage = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Profile Image
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowProfileImage= true
  else
    Space.UI.ShowProfileImage= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowRightButtonGroup

bool **ShowRightButtonGroup** `get` `set`

*Show the Right Button Group. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowRightButtonGroup = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Right Button Group
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowRightButtonGroup= true
  else
    Space.UI.ShowRightButtonGroup= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowRoomInfoOption

bool **ShowRoomInfoOption** `get` `set`

*Show the Room Info Option. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowRoomInfoOption = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Room Info Option
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowRoomInfoOption= true
  else
    Space.UI.ShowRoomInfoOption= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowSearch

bool **ShowSearch** `get` `set`

*Show the Search bar. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowSearch = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Search Bar
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowSearch= true
  else
    Space.UI.ShowSearch= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowMailButton

bool **ShowMailButton** `get` `set`

*Show the Mail button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowMailButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Mail Button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowMailButton = true
  else
    Space.UI.ShowMailButton = false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}

### ShowNotificationButton

bool **ShowNotificationButton** `get` `set`

*Show the Notification button. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowNotificationButton = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
 --This script will make a UI Toggle show/hide the Notification Button
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowNotificationButton= true
  else
    Space.UI.ShowNotificationButton= false
  end
end

toggle.OnValueChanged(OnValueChanged) 
```

{% endtab %}
{% endtabs %}

### ShowClock

bool **ShowClock** `get` `set`

*Show the clock. <mark style="color:red;">(white-label grid only)</mark>*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.UI.ShowClock = false
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--This script will make a UI Toggle show/hide the Clock
--(example: tools for user to customize UI)
--[You need to add an object with UI Toggle as a reference (scripting runtime)]

toggle = Space.Host.GetReference("Toggle").UIToggle


OnValueChanged = function()
  if toggle.IsOn then
    Space.UI.ShowClock= true
  else
    Space.UI.ShowClock= false
  end
end

toggle.OnValueChanged(OnValueChanged)
```

{% endtab %}
{% endtabs %}