Scripting/SUI

Members

OpenAppearanceEditor

void OpenAppearanceEditor ()

Opens the Appearance Editor (Outfit)

Space.UI.OpenAppearanceEditor()

AddNotification

void AddNotification (string title, string text)

Shows a notification

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

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

gbClick = function()
  Space.Log("global action button pressed")
  end
  Space.UI.AddGlobalActionButton("The Button","The Tooltip", gbClick)

ClearGlobalActionButton

void ClearGlobalActionButton (string button)

Clears a previously added Global Action Button 'button'

 Space.UI.ClearGlobalActionButton("The Button")

ShowLocation

void ShowLocation (string reason, SVector location)

Shows given location

 Space.UI.ShowLocation("the reason", Vector.New(5,1,0))

ShowPathToLocation

void ShowPathToLocation (string reason, SVector location)

Shows a path to given location

 Space.UI.ShowPathToLocation("the reason", Vector.New(5,1,0))

OpenQuestsWindow

void OpenQuestsWindow ()

Opens the Quests window

Space.UI.OpenQuestsWindow()

--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) 

HideQuestsWindow

void HideQuestsWindow ()

Hides the Quests window

Space.UI.HideQuestsWindow()

--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) 

OpenSettingsWindow

void OpenSettingsWindow ()

Opens the Settings window

Space.UI.OpenSettingsWindow()

--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) 

HideSettingsWindow

void HideSettingsWindow ()

Hides the Settings window

Space.UI.HideSettingsWindow()

--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) 

OpenFriendsWindow

void OpenFriendsWindow ()

Opens the Friends window (white-label grid only)

Space.UI.OpenFriendsWindow()

--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)

HideFriendsWindow

void HideFriendsWindow ()

Hides the Friends window (white-label grid only)

Space.UI.HideFriendsWindow()

--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)

OpenExploreWindow

void OpenExploreWindow ()

Opens the Explore window (white-label grid only)

Space.UI.OpenExploreWindow()

--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) 

HideExploreWindow

void HideExploreWindow ()

Hides the Explore window (white-label grid only)

Space.UI.HideExploreWindow()

--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) 

OpenEventsWindow

void OpenEventsWindow ()

Opens the Events window (white-label grid only)

Space.UI.OpenEventsWindow()

--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)

HideEventsWindow

void HideEventsWindow ()

Hides the Events window (white-label grid only)

Space.UI.HideEventsWindow()

--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)

OpenHomeWindow

void OpenHomeWindow ()

Opens the Home window (white-label grid only)

Space.UI.OpenHomeWindow()

--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)

HideHomeWindow

void HideHomeWindow ()

Hides the Home window (white-label grid only)

Space.UI.HideHomeWindow()

--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)

OpenInventoryWindow

void OpenInventoryWindow ()

Opens the Inventory window (white-label grid only)

Space.UI.OpenInventoryWindow()

--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)

HideInventoryWindow

void HideInventoryWindow ()

Hides the Inventory window (white-label grid only)

Space.UI.HideInventoryWindow()

--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)

OpenOutfitWindow

void OpenOutfitWindow ()

Opens the Outfit window (white-label grid only)

Space.UI.OpenOutfitWindow()

--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)

HideOutfitWindow

void HideOutfitWindow ()

Hides the Outfit window (white-label grid only)

Space.UI.HideOutfitWindow()

--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)

OpenShopWindow

void OpenShopWindow ()

Opens the Shop window (white-label grid only)

Space.UI.OpenShopWindow()

--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)

HideShopWindow

void HideShopWindow ()

Hides the Shop window (white-label grid only)

Space.UI.HideShopWindow()

--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)

OpenSnapshotWindow

void OpenSnapshotWindow ()

Opens the Snapshot window (white-label grid only)

Space.UI.OpenSnapshotWindow()

--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)

HideSnapshotWindow

void HideSnapshotWindow ()

Hides the Snapshot window (white-label grid only)

Space.UI.HideSnapshotWindow()

--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)

OpenHelpWindow

void OpenHelpWindow ()

Opens the Help window (white-label grid only)

Space.UI.OpenHelpWindow()

--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)

HideHelpWindow

void HideHelpWindow ()

Hides the Help window (white-label grid only)

Space.UI.HideHelpWindow()

--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)

OpenProfileWin

void OpenProfileWin ()

Opens the Profile window (white-label grid only)

Space.UI.OpenProfileWin()

--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.HideProfileWin()
  isShown = false
  else
  Space.UI.OpenProfileWin()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)

HideProfileWin

void HideProfileWin ()

Hides the Profile window (white-label grid only)

Space.UI.HideProfileWin()

--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.HideProfileWin()
  isShown = false
  else
  Space.UI.OpenProfileWin()  
  isShown = true
  end
end

theButton.UIButton.OnClick(OnClick)

OpenUpgradeAccountWindow

void OpenUpgradeAccountWindow ()

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

Space.UI.OpenUpgradeAccountWindow()

--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)

HideUpgradeAccountWindow

void HideUpgradeAccountWindow ()

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

Space.UI.HideUpgradeAccountWindow()

--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)

OpenRegionInfoWindow

void OpenRegionInfoWindow ()

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

Space.UI.OpenRegionInfoWindow()

--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)

HideRegionInfoWindow

void HideRegionInfoWindow ()

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

Space.UI.HideRegionInfoWindow()

--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)

OpenExitWindow

void OpenExitWindow ()

Opens the Exit window (white-label grid only)

Space.UI.OpenExitWindow()

--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)

HideExitWindow

void HideExitWindow ()

Hides the Exit window (white-label grid only)

Space.UI.HideExitWindow()

--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)

OpenMailWindow

void OpenMailWindow ()

Opens the Mail window (white-label grid only)

Space.UI.OpenMailWindow()

--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)

HideMailWindow

void HideMailWindow ()

Hides the Mail window (white-label grid only)

Space.UI.HideMailWindow()

--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)

OpenBuyGoldWindow

void OpenBuyGoldWindow ()

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

Space.UI.OpenBuyGoldWindow()

--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)

HideBuyGoldWindow

void HideBuyGoldWindow ()

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

Space.UI.HideBuyGoldWindow()

--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)

OpenChatWindow

void OpenChatWindow ()

Opens the Chat window (white-label grid only)

Space.UI.OpenChatWindow()

--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)

HideChatWindow

void HideChatWindow ()

Hides the Chat window (white-label grid only)

Space.UI.HideChatWindow()

--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)

OpenRoomEditorWindow

void OpenRoomEditorWindow ()

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

Space.UI.OpenRoomEditorWindow()

--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)

HideRoomEditorWindow

void HideRoomEditorWindow ()

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

Space.UI.HideRoomEditorWindow()

--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)

OpenDevicePicker

void OpenDevicePicker ()

Opens the Device Picker (white-label grid only)

Space.UI.OpenDevicePicker()

--This script will make a button open the Device Picker
--(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.OpenDevicePicker()  
end

theButton.UIButton.OnClick(OnClick)

Raycast

SUIRaycastResult Raycast ()

Shoots a UI Raycast and returns the result as SUIRayCastResult

RayCastResult= Space.UI.Raycast()

Properties

ShowAuctionButton

bool ShowAuctionButton { get; set; }

Show the Auction button

Space.UI.ShowAuctionButton = false

--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)

ShowChat

bool ShowChat { get; set; }

Show the Chat

Space.UI.ShowChat = false

--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)

ShowCurrencyButton

bool ShowCurrencyButton { get; set; }

Show the Currency button

Space.UI.ShowCurrencyButton = false

--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)

ShowExploreButton

bool ShowExploreButton { get; set; }

Show the Explore button

Space.UI.ShowExploreButton = false

--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)

ShowFriendsButton

bool ShowFriendsButton { get; set; }

Show the Friends button

Space.UI.ShowFriendsButton = false

--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)

ShowHelpButton

bool ShowHelpButton { get; set; }

Show the Help button

Space.UI.ShowHelpButton = false

--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)

ShowHomeButton

bool ShowHomeButton { get; set; }

Show the Home button

Space.UI.ShowHomeButton = false

--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)

ShowHotBar

bool ShowHotBar { get; set; }

Show the Hot Bar

Space.UI.ShowHotBar = false

--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)

ShowInventoryButton

bool ShowInventoryButton { get; set; }

Show the Inventory button (white-label grid only)

Space.UI.ShowInventoryButton = false

--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)

ShowMiniMap

bool ShowMiniMap { get; set; }

Set to true to show the Minimap (white-label grid only)

Space.UI.ShowMiniMap = false

--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)

ShowOutfitButton

bool ShowOutfitButton { get; set; }

Set to true to show the Outfit button (white-label grid only)

Space.UI.ShowOutfitButton = false

--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)

ShowQuestsButton

bool ShowQuestsButton { get; set; }

Show the Quests button (white-label grid only)

Space.UI.ShowQuestsButton = false

--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)

ShowShopButton

bool ShowShopButton { get; set; }

Show the Shop button (white-label grid only)

Space.UI.ShowShopButton = false

--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)

ShowSnapshotButton

bool ShowSnapshotButton { get; set; }

Show the Snapshot button (white-label grid only)

Space.UI.ShowSnapshotButton = false

ShowUI

bool ShowUI { get; set; }

Show the User Interface

Space.UI.ShowUI = false

--This script will make a UI Toggle show/hide the  User Interface
--(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.ShowUI= true
  else
    Space.UI.ShowUI= false
  end
end

toggle.OnValueChanged(OnValueChanged)

ShowWorldUI

bool ShowWorldUI { get; set; }

Show the World User Interface

Space.UI.ShowUI = false

MusicVolume

int MusicVolume { get; set; }

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

MusicVolume= Space.UI.MusicVolume

--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)

MasterVolume

int MasterVolume { get; set; }

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

MasterVolume= Space.UI.MasterVolume

--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)

SFXVolume

int SFXVolume { get; set; }

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

SFXVolume= Space.UI.SFXVolume

--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)

UIVolume

int UIVolume { get; set; }

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

UIVolume= Space.UI.UIVolume

--This script will make moving a slider control the UI Volume
--and also update a text field with the current UI 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.UIVolume = slider.NormalizedValue * 100
textField.Text = Space.UI.UIVolume
end

slider.OnValueChanged(OnValueChanged)

VOIPVolume

int VOIPVolume { get; set; }

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

VOIPVolume = Space.UI.VOIPVolume

 --This script will make moving a slider control the Voice Volume
--and also update a text field with the current Voice 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.VOIPVolume = slider.NormalizedValue * 100
textField.Text = Space.UI.VOIPVolume
end

slider.OnValueChanged(OnValueChanged) 

ShowEventsButton

bool ShowEventsButton { get; set; }

Show the Events button (white-label grid only)

Space.UI.ShowEventsButton= false

--This script will make a UI Toggle show/hide the  Events 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.ShowEventsButton= true
  else
    Space.UI.ShowEventsButton= false
  end
end

toggle.OnValueChanged(OnValueChanged)

ShowGoldAndBuyButton

bool ShowGoldAndBuyButton { get; set; }

Show the Gold and Buy button (white-label grid only)

Space.UI.ShowGoldAndBuyButton= false

--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)

ShowClock

bool ShowClock { get; set; }

Show the clock (white-label grid only)

Space.UI.ShowClock= false

--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)

ShowActivityPanel

bool ShowActivityPanel { get; set; }

Show the Activity Panel (white-label grid only)

Space.UI.ShowActivityPanel= false

--This script will make a UI Toggle show/hide the Activity Panel
--(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.ShowActivityPanel= true
  else
    Space.UI.ShowActivityPanel= false
  end
end

toggle.OnValueChanged(OnValueChanged)

ShowProfileImage

bool ShowProfileImage { get; set; }

Show the Profile Image (white-label grid only)

Space.UI.ShowProfileImage= false

--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)

ShowRightButtonGroup

bool ShowRightButtonGroup { get; set; }

Show the Right Button Group (white-label grid only)

Space.UI.ShowRightButtonGroup= false

--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)

ShowRoomInfoOption

bool ShowRoomInfoOption { get; set; }

Show the Room Info Option (white-label grid only)

Space.UI.ShowRoomInfoOption= false

--This script will make a UI Toggle show/hide the Room Info Option
--(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.ShowRoomInfoOption= true
  else
    Space.UI.ShowRoomInfoOption= false
  end
end

toggle.OnValueChanged(OnValueChanged)

ShowSearch

bool ShowSearch { get; set; }

Show the Search bar (white-label grid only)

Space.UI.ShowSearch= false

--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)

ShowMailButton

bool ShowMailButton { get; set; }

Show the Mail button (white-label grid only)

Space.UI.ShowMailButton= false

--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)

ShowNotificationButton

bool ShowNotificationButton { get; set; }

Show the Notification button

Space.UI.ShowNotificationButton= false

 --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)