SUI

Functions

AddNotification

void AddNotification (string title, string text)

Shows a notification

Parameter	Type	Description

Lua

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

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) 

OpenAppearanceEditor

void OpenAppearanceEditor()

Opens the Appearance Editor (Outfit)

Lua

Space.UI.OpenAppearanceEditor()

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) 

ShowPathToLocation

void ShowPathToLocation (string reason, SVector location)

Shows a path to given location

Parameter	Type	Description

Lua

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

ShowLocation

void ShowLocation (string reason, SVector location)

Shows given location

Parameter	Type	Description

Lua

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

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

Lua

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

ClearGlobalActionButton

void ClearGlobalActionButton (string button)

Clears a previously added Global Action Button 'button'

Parameter	Type	Description

Lua

 Space.UI.ClearGlobalActionButton("The Button")

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)

OpenQuestsWindow

void OpenQuestsWindow ()

Opens the Quests window. (white-label grid only)

Lua

Space.UI.OpenQuestsWindow()

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) 

HideQuestsWindow

void HideQuestsWindow ()

Hides the Quests window. (white-label grid only)

Lua

Space.UI.HideQuestsWindow()

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) 

OpenSettingsWindow

void OpenSettingsWindow ()

Opens the Settings window. (white-label grid only)

Lua

Space.UI.OpenSettingsWindow()

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) 

HideSettingsWindow

void HideSettingsWindow ()

Hides the Settings window. (white-label grid only)

Lua

Space.UI.HideSettingsWindow()

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) 

OpenFriendsWindow

void OpenFriendsWindow ()

Opens the Friends window. (white-label grid only)

Lua

Space.UI.OpenFriendsWindow()

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

HideFriendsWindow

void HideFriendsWindow ()

Hides the Friends window. (white-label grid only)

Lua

Space.UI.HideFriendsWindow()

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)

OpenExploreWindow

void OpenExploreWindow ()

Opens the Explore window. (white-label grid only)

Lua

Space.UI.OpenExploreWindow()

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) 

HideExploreWindow

void HideExploreWindow ()

Hides the Explore window (white-label grid only)

Lua

Space.UI.HideExploreWindow()

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) 

OpenEventsWindow

void OpenEventsWindow ()

Opens the Events window (white-label grid only)

Lua

Space.UI.OpenEventsWindow()

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)

HideEventsWindow

void HideEventsWindow ()

Hides the Events window (white-label grid only)

Lua

Space.UI.HideEventsWindow()

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)

OpenHomeWindow

void OpenHomeWindow ()

Opens the Home window (white-label grid only)

Lua

Space.UI.OpenHomeWindow()

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)

HideHomeWindow

void HideHomeWindow ()

Hides the Home window (white-label grid only)

Lua

Space.UI.HideHomeWindow()

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)

OpenInventoryWindow

void OpenInventoryWindow ()

Opens the Inventory window (white-label grid only)

Lua

Space.UI.OpenInventoryWindow()

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)

HideInventoryWindow

void HideInventoryWindow ()

Hides the Inventory window (white-label grid only)

Lua

Space.UI.HideInventoryWindow()

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)

OpenOutfitWindow

void OpenOutfitWindow ()

Opens the Outfit window (white-label grid only)

Lua

Space.UI.OpenOutfitWindow()

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)

HideOutfitWindow

void HideOutfitWindow ()

Hides the Outfit window (white-label grid only)

Lua

Space.UI.HideOutfitWindow()

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)

OpenShopWindow

void OpenShopWindow ()

Opens the Shop window (white-label grid only)

Lua

Space.UI.OpenShopWindow()

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)

HideShopWindow

void HideShopWindow ()

Hides the Shop window (white-label grid only)

Lua

Space.UI.HideShopWindow()

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)

OpenSnapshotWindow

void OpenSnapshotWindow ()

Opens the Snapshot window (white-label grid only)

Lua

Space.UI.OpenSnapshotWindow()

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)

HideSnapshotWindow

void HideSnapshotWindow ()

Hides the Snapshot window (white-label grid only)

Lua

Space.UI.HideSnapshotWindow()

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)

OpenHelpWindow

void OpenHelpWindow ()

Opens the Help window (white-label grid only)

Lua

Space.UI.OpenHelpWindow()

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)

HideHelpWindow

void HideHelpWindow ()

Hides the Help window (white-label grid only)

Lua

Space.UI.HideHelpWindow()

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)

OpenProfileWin

void OpenProfileWin ()

Opens the Profile window (white-label grid only)

Lua

Space.UI.OpenProfileWin()

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)

HideProfileWindow

void HideProfileWindow()

Hides the Profile window (white-label grid only)

Lua

Space.UI.HideProfileWindow()

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)

OpenUpgradeAccountWindow

void OpenUpgradeAccountWindow ()

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

Lua

Space.UI.OpenUpgradeAccountWindow()

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)

HideUpgradeAccountWindow

void HideUpgradeAccountWindow ()

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

Lua

Space.UI.HideUpgradeAccountWindow()

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)

OpenRegionInfoWindow

void OpenRegionInfoWindow ()

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

Lua

Space.UI.OpenRegionInfoWindow()

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)

HideRegionInfoWindow

void HideRegionInfoWindow ()

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

Lua

Space.UI.HideRegionInfoWindow()

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)

OpenExitWindow

void OpenExitWindow ()

Opens the Exit window (white-label grid only)

Lua

Space.UI.OpenExitWindow()

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)

HideExitWindow

void HideExitWindow ()

Hides the Exit window (white-label grid only)

Lua

Space.UI.HideExitWindow()

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)

OpenMailWindow

void OpenMailWindow ()

Opens the Mail window (white-label grid only)

Lua

Space.UI.OpenMailWindow()

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)

HideMailWindow

void HideMailWindow ()

Hides the Mail window (white-label grid only)

Lua

Space.UI.HideMailWindow()

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)

OpenFeedbackWindow

void OpenFeedbackWindow ()

Shows the Feedback window (white-label grid only)

Lua

Space.UI.OpenFeedbackWindow()

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)

HideFeedbackWindow

void HideFeedbackWindow ()

Hides the Feedback window (white-label grid only)

Lua

Space.UI.HideFeedbackWindow()

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)

OpenBuyGoldWindow

void OpenBuyGoldWindow ()

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

Lua

Space.UI.OpenBuyGoldWindow()

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)

HideBuyGoldWindow

void HideBuyGoldWindow ()

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

Lua

Space.UI.HideBuyGoldWindow()

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)

OpenChatWindow

void OpenChatWindow ()

Opens the Chat window (white-label grid only)

Lua

Space.UI.OpenChatWindow()

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)

HideChatWindow

void HideChatWindow ()

Hides the Chat window (white-label grid only)

Lua

Space.UI.HideChatWindow()

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)

OpenRoomEditorWindow

void OpenRoomEditorWindow ()

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

Lua

Space.UI.OpenRoomEditorWindow()

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)

HideRoomEditorWindow

void HideRoomEditorWindow ()

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

Lua

Space.UI.HideRoomEditorWindow()

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)

OpenDevicePicker

void OpenDevicePicker ()

Opens the Device Picker (white-label grid only)

Lua

Space.UI.OpenDevicePicker()

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)

OpenDeviceTester

void OpenDeviceTester ()

Opens the Device Tester (white-label grid only)

Lua

Space.UI.OpenDeviceTester()

Raycast

SUIRaycastResult Raycast ()

Shoots a UI Raycast and returns the result as SUIRayCastResult

Lua

RayCastResult = Space.UI.Raycast()

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)

Properties

ShowUI

bool ShowUI get set

Show the User Interface

Lua

Space.UI.ShowUI = false

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)

ShowWorldUI

bool ShowWorldUI get set

Show the World User Interface.

Lua

Space.UI.ShowWorldUI = false

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)

MusicVolume

int MusicVolume get set

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

Lua

MusicVolume = Space.UI.MusicVolume

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)

MasterVolume

int MasterVolume get set

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

Lua

MasterVolume = Space.UI.MasterVolume

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)

SFXVolume

int SFXVolume get set

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

Lua

SFXVolume = Space.UI.SFXVolume

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)

UIVolume

int UIVolume get set

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

Lua

UIVolume = Space.UI.UIVolume

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)

VOIPVolume

int VOIPVolume get set

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

Lua

VOIPVolume = Space.UI.VOIPVolume

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) 

ShowFriendsButton

bool ShowFriendsButton get set

Show the Friends button. (white-label grid only)

Lua

Space.UI.ShowFriendsButton = false

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)

ShowExploreButton

bool ShowExploreButton get set

Show the Explore button. (white-label grid only)

Lua

Space.UI.ShowExploreButton = false

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)

ShowQuestsButton

bool ShowQuestsButton get set

Show the Quests button. (white-label grid only)

Lua

Space.UI.ShowQuestsButton = false

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)

ShowInventoryButton

bool ShowInventoryButton get set

Show the Inventory button. (white-label grid only)

Lua

Space.UI.ShowInventoryButton = false

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)

ShowOutfitButton

bool ShowOutfitButton get set

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

Lua

Space.UI.ShowOutfitButton = false

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)

ShowShopButton

bool ShowShopButton get set

Show the Shop button. (white-label grid only)

Lua

Space.UI.ShowShopButton = false

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)

ShowAuctionButton

bool ShowAuctionButton get set

Show the Auction button. (white-label grid only)

Lua

Space.UI.ShowAuctionButton = false

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)

ShowSnapshotButton

bool ShowSnapshotButton get set

Show the Snapshot button.(white-label grid only)

Lua

Space.UI.ShowSnapshotButton = false

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)

ShowHelpButton

bool ShowHelpButton get set

Show the Help button. (white-label grid only)

Lua

Space.UI.ShowHelpButton = false

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)

ShowCurrencyButton

bool ShowCurrencyButton get set

Show the Currency button. (white-label grid only)

Lua

Space.UI.ShowCurrencyButton = false

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)

ShowGoldAndBuyButton

bool ShowGoldAndBuyButton get set

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

Lua

Space.UI.ShowGoldAndBuyButton = false

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)

ShowChat

bool ShowChat get set

Show the Chat. (white-label grid only)

Lua

Space.UI.ShowChat = false

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)

ShowMiniMap

bool ShowMiniMap get set

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

Lua

Space.UI.ShowMiniMap = false

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)

ShowHotBar

bool ShowHotBar get set

Show the Hot Bar. (white-label grid only)

Lua

Space.UI.ShowHotBar = false

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)

ShowEventsButton

bool ShowEventsButton get set

Show the Events button. (white-label grid only)

Lua

Space.UI.ShowEventsButton = false

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)

ShowHomeButton

bool ShowHomeButton get set

Show the Home button. (white-label grid only)

Lua

Space.UI.ShowHomeButton = false

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)

ShowActivityPanel

bool ShowActivityPanel get set

Show the Activity Panel. (white-label grid only)

Lua

Space.UI.ShowActivityPanel = false

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)

ShowProfileImage

bool ShowProfileImage get set

Show the Profile Image. (white-label grid only)

Lua

Space.UI.ShowProfileImage = false

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)

ShowRightButtonGroup

bool ShowRightButtonGroup get set

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

Lua

Space.UI.ShowRightButtonGroup = false

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)

ShowRoomInfoOption

bool ShowRoomInfoOption get set

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

Lua

Space.UI.ShowRoomInfoOption = false

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)

ShowSearch

bool ShowSearch get set

Show the Search bar. (white-label grid only)

Lua

Space.UI.ShowSearch = false

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)

ShowMailButton

bool ShowMailButton get set

Show the Mail button. (white-label grid only)

Lua

Space.UI.ShowMailButton = false

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)

ShowNotificationButton

bool ShowNotificationButton get set

Show the Notification button. (white-label grid only)

Lua

Space.UI.ShowNotificationButton = false

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) 

ShowClock

bool ShowClock get set

Show the clock. (white-label grid only)

Lua

Space.UI.ShowClock = false

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)