-- This one script placed on a multiple number of objects will track the number-- of clicks user has made using a Global Variable-- note: the GetGlobal/SetGlobal functions are client sidethisObject = Space.Host.ExecutingObjectnamespace ="com.example.shared" key ="clicktracker"OnClick=function()local currentClicks = Space.Shared.GetGlobal(namespace, key)if currentClicks ==nilthen currentClicks =1else currentClicks = currentClicks +1endSpace.Shared.SetGlobal(namespace, key, currentClicks)Space.Log("Total Clicks = " .. currentClicks)endthisObject.AddClickable()thisObject.Clickable.OnClick(OnClick)
-- This one script placed on a multiple number of objects will track the number-- of clicks user has made using a Global Variable-- note: the GetGlobal/SetGlobal functions are client sidethisObject = Space.Host.ExecutingObjectnamespace ="com.example.shared" key ="clicktracker"OnClick=function()local currentClicks = Space.Shared.GetGlobal(namespace, key)if currentClicks ==nilthen currentClicks =1else currentClicks = currentClicks +1endSpace.Shared.SetGlobal(namespace, key, currentClicks)Space.Log("Total Clicks = " .. currentClicks)endthisObject.AddClickable()thisObject.Clickable.OnClick(OnClick)
GetSuperGlobal
DynValue GetSuperGlobal(string ns, string key)
Retrieves a previously set super global variable, or returns nil.
--these two scripts are in two different regions but script B will know that you came from A--REGION A scriptusername = Space.Scene.PlayerAvatar.Usernameregion = Space.Scene.NameSpace.Shared.SetSuperGlobal (username, "Last Location", region)--REGION B scriptusername = Space.Scene.PlayerAvatar.Usernameregion = Space.Shared.GetSuperGlobal (username, "Last Location")Space.Dialogues.SendLocalChat ("You have arrived from ".. region, "Last Location")
--Script placed on object A will allow other objects to call one of it's registered functions when clicked--Script in Object AthisObject = Space.Host.ExecutingObjectnamespace ="com.example.shared" LogFunction=function(Parameter)Space.Log("I've been called with parameter: " .. Parameter) endSpace.Shared.RegisterFunction(namespace, "Log", LogFunction)-- Script in Other ObjectsthisObject = Space.Host.ExecutingObjectnamespace ="com.example.shared" OnClick=function()Space.Shared.CallFunction(namespace, "Log", {"Example"}) endthisObject.AddClickable()thisObject.Clickable.OnClick(OnClick)
--Script placed on object A will allow other objects to call one of it's registered functions when clicked--Script in Object AthisObject = Space.Host.ExecutingObjectnamespace ="com.example.shared" LogFunction=function(Parameter)Space.Log("I've been called with parameter: " .. Parameter) endSpace.Shared.RegisterFunction(namespace, "Log", LogFunction)-- Script in Other ObjectsthisObject = Space.Host.ExecutingObjectnamespace ="com.example.shared" OnClick=function()Space.Shared.CallFunction(namespace, "Log", {"Example"}) endthisObject.AddClickable()thisObject.Clickable.OnClick(OnClick)
Vibrates the controller (or phone, or gamepad) if a rumble device is present.
Properties
ScrollWheel
float ScrollWheelget
Returns a non-0 value if the mouse wheel is being scrolled, value usually ranges from -1 to 1**.**
MousePosition
Returns the current position of the mouse in screen pixels. If on a touch screen device, this will also return the location of the first finger being pressed.
MovementAxis
Returns left/right (A/D) movement on X, forward/back (W/S) on Y, and up/down (E/C) on Z.
TurnAxis
Returns the Turn Axis (-1 to 1 on Vector's X value).
MouseLook
bool MouseLookgetset
Enable or disable Mouse Look feature.
MouseX
float MouseXget
Returns a float representing the Mouse/Right Joystick horizontal movement. If the value is positive the movement is upwards. If the value is negative the movement is downwards. The value is derived by multiplying mouse delta with axis sensitivity. This is frame-rate independent; you do not need to be concerned about varying frame-rates when using this value.
MouseY
float MouseYget
Returns a float representing the Mouse/Right Joystick vertical movement. If the value is positive the movement is to the right. If the value is negative the movement is to the left. The value is derived by multiplying mouse delta with axis sensitivity. This is frame-rate independent; you do not need to be concerned about varying frame-rates when using this value.
ClickToWalk
Returns the Turn Axis (-1 to 1 on Vector's X value).
Fire
bool Fireget
Return true if primary fire is pressed (Mouselook Mode).
AltFire
bool AltFireget
Return true if alternative fire is pressed (Mouselook Mode)
CursorInUI
bool CursorInUIget
Returns true if the cursor is over the Sinespace UI.
IsVRAvailable
bool IsVRAvailableget
Returns true if VR is available.
IsVRActive
bool IsVRActiveget
Returns true if VR is active.
VRLeftControllerPosition
Returns position of Left VR Controller.
VRRightControllerPosition
Returns position of Right VR Controller.
VRLeftControllerRotation
Returns rotation of Left VR Controller.
VRRightControllerRotation
Returns rotation of Right VR Controller.
Input Key Names
Key names follow these naming conventions:
Mouse buttons are named mouse 0, mouse 1, mouse 2, and so on.
Joystick buttons follow these naming conventions:
Function Name
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
MousePositionget
MovementAxisget
? TurnAxisget
? TurnAxisget
? VRLeftControllerPositionget
? VRRightControllerPositionget
? VRLeftControllerRotationget
? VRRightControllerRotationget
title
string
The title of the color picker window. Choose something brief and appropriate like 'Select a wall color'.
okbutton
string
The title of the 'OK' button. Should indicate the action e.g. 'Adjust Wall'.
onChange
Action<SColor> or Closure
Any color change while the color picker is open will trigger onChange(SColor).
onSelect
Action<SColor> or Closure
Triggers onSelect(SColor) once the "ok" button is pressed.
onCancel
Action<SColor> or Closure
The title of the 'OK' button. Should indicate the action e.g. 'Adjust Wall'.
defaultColor
SColor
The color to open the colour picker with.
title
string
The question to be asked of the user. Should be a simple statement, e.g. "Save room changes?"
okbutton
string
The text on the OK button, should indicate the action, e.g. "Save Room"
cancelButton
string
The text on the cancel button, should indicate the action, e.g. "Not now"
result
Action<bool>
Will fire a callback event depending on the status of the users actions
title
string
The accompanying text. Should be something ala "Enter your username".
okButton
string
The text displayed on the OK button, should be descriptive, e.g. "Change Username".
result
Action< string >
Triggers result(string) once the "Ok" button is pressed.
url
string
The web address to open.
newTab
bool
Does the URL open in a new browser tab?
message
string
The message to appear in the channel.
from
string
The 'from' username for the message.
button
int
button values are 0 for the primary button (often the left button), 1 for secondary button, and 2 for the middle button.
button
int
button values are 0 for the primary button (often the left button), 1 for secondary button, and 2 for the middle button.
button
int
button values are 0 for the primary button (often the left button), 1 for secondary button, and 2 for the middle button.
intensity
float
Intensity of the vibration from 0.0 to 1.0
duration
float
Duration of the vibration. Maximum 1.0 second.
leftHand
bool
If true the vibration will be on the left hand and if false on the right hand (where applicable)
Key family
Naming convention
Letter keys
a, b, c…
Number keys
1, 2, 3…
Arrow keys
up, down, left, right
Numpad keys
[1], [2], [3], [+], [equals]…
Modifier keys
right shift, left shift, right ctrl, left ctrl, right alt, left alt, right cmd, left cmd
--clicking the object will open a color picker that changes the object's colorthisGameObject = Space.Host.ExecutingObjectoriginalColor = thisGameObject.Renderer.Material.GetColor("_Color")OnChange=function(SColor) thisGameObject.Renderer.Material.SetColor("_Color",SColor)endOnSelect=function(SColor) thisGameObject.Renderer.Material.SetColor("_Color",SColor)endOnCancel=function() thisGameObject.Renderer.Material.SetColor("_Color",originalColor)endOnClick=function() Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)endthisGameObject.AddClickable()thisGameObject.Clickable.OnClick(OnClick)
hostObject = Space.Host.ExecutingObjectlocal deltaPos = Vector.New(0,100,0)local teleportTo = hostObject.WorldPosition + deltaPosfunctionteleportMeUp (b)if b then Space.Scene.PlayerAvatar.Teleport(teleportTo)endendfunctionopenDialogue () Space.Dialogues.YesNoInput ("Ready for a teleport?", "Yes", "No", teleportMeUp)endhostObject.SubscribeToEvents()hostObject.OnMouseDown(openDialogue)
-- when the object is clicked, the "sine.space" website is openedhostObject = Space.Host.ExecutingObjectfunctionopenTheWebsite () Space.Dialogues.OpenURL("http://sine.space/")endhostObject.OnMouseDown(openTheWebsite)
hostObject = Space.Host.ExecutingObjectfunctionchatMessage () Space.Dialogues.SendLocalChat ("I've been clicked", "Clickable Object")endhostObject.OnMouseDown(chatMessage)
thisGameObject = Space.Host.ExecutingObjectOnUpdate=function()if Space.Input.GetKeyDown("space") then Space.Log("Jump Key Down")endendthisGameObject.OnUpdate(OnUpdate)
thisGameObject = Space.Host.ExecutingObjectOnUpdate=function()if Space.Input.GetKeyUp("space") then Space.Log("Jump Key Released")endendthisGameObject.OnUpdate(OnUpdate)
thisGameObject = Space.Host.ExecutingObjectOnUpdate=function()if Space.Input.GetKey("space") then Space.Log("Jump Key Held")endendthisGameObject.OnUpdate(OnUpdate)
if Space.Input.GetMouseDown(1) then Space.Log("Right Mouse button pressed in this frame")end
--this script will make this object jump to wherever you right clickthisGameObject = Space.Host.ExecutingObjectOnUpdate=function()if Space.Input.GetMouseDown(1) then clickRay = Space.Camera.ScreenCoordinatesToRay(Space.Input.MousePosition) rayCastHit = Space.Physics.RayCastSingle(clickRay.Origin, clickRay.Direction, 50.0) thisGameObject.WorldPosition = rayCastHit.PositionendendthisGameObject.OnUpdate(OnUpdate)
if Space.Input.GetMouseUp(1) then Space.Log("Right Mouse button was just unpressed")end
if Space.Input.GetMouseHold(1) then Space.Log("Right Mouse button being held")end
--this script will make this object will follow your ovement while holding right clickthisGameObject = Space.Host.ExecutingObjectOnUpdate=function()if Space.Input.GetMouseHold(1) then clickRay = Space.Camera.ScreenCoordinatesToRay(Space.Input.MousePosition) rayCastHit = Space.Physics.RayCastSingle(clickRay.Origin, clickRay.Direction, 50.0) thisGameObject.WorldPosition = rayCastHit.PositionendendthisGameObject.OnUpdate(OnUpdate)
Space.Input.Vibrate(1,1,false)
scrollWheel = Space.Input.ScrollWheel
--Object will move up and down with scroll wheel movementthisGameObject = Space.Host.ExecutingObjectOnUpdate=function() thisGameObject.WorldPosition = thisGameObject.WorldPosition + (thisGameObject.Up * Space.Input.ScrollWheel)endthisGameObject.OnUpdate(OnUpdate)
currentMousePos = Space.Input.MousePosition
--Object will follow your mouse movement while holding right clickthisGameObject = Space.Host.ExecutingObjectOnUpdate=function()if Space.Input.GetMouseHold(1) then clickRay = Space.Camera.ScreenCoordinatesToRay(Space.Input.MousePosition) rayCastHit = Space.Physics.RayCastSingle(clickRay.Origin, clickRay.Direction, 50.0) thisGameObject.WorldPosition = rayCastHit.PositionendendthisGameObject.OnUpdate(OnUpdate)
--makes this object color red if player is turning left--and color green if player is turning right--and blue if player is not turningthisGameObject = Space.Host.ExecutingObjectOnUpdate=function()if Space.Input.TurnAxis.X >0then thisGameObject.Renderer.Material.SetColor("_Color",Color.Red)elseif Space.Input.TurnAxis.X <0then thisGameObject.Renderer.Material.SetColor("_Color",Color.Green)elseif Space.Input.TurnAxis.X ==0then thisGameObject.Renderer.Material.SetColor("_Color",Color.Blue)endendthisGameObject.OnUpdate(OnUpdate)
Space.Input.MouseLook =true
--the below script will put your player into MouseLook mode if you are near the object --and return you to normal mode if you are far from the object thisGameObject = Space.Host.ExecutingObjectfunctionOnUpdate() positionAvatar = Space.Scene.PlayerAvatar.GameObject.WorldPosition positionObject = thisGameObject.WorldPositionif positionAvatar.InRange(positionObject, 5.0) thenif Space.Input.MouseLook ==falsethen Space.Input.MouseLook =trueendelseif Space.Input.MouseLook ==truethen Space.Input.MouseLook =falseendendendthisGameObject.OnUpdate(OnUpdate)
MouseX = Space.Input.MouseX
--the below script will rotate this object along the Y axis --according to your mouse/right joystick horizontal movementthisGameObject = Space.Host.ExecutingObjectfunctionOnUpdate() currentY = thisGameObject.WorldRotation.EulerAngles.Y newY = currentY + Space.Input.MouseX thisGameObject.WorldRotation = Quaternion.Euler(0, newY, 0)endthisGameObject.OnUpdate(OnUpdate)
MouseY = Space.Input.MouseY
--the below script will rotate this object along the Y axis --according to your mouse/right joystick vertical movementthisGameObject = Space.Host.ExecutingObjectfunctionOnUpdate() currentX = thisGameObject.WorldRotation.EulerAngles.X newX = currentX + Space.Input.MouseY thisGameObject.WorldRotation = Quaternion.Euler(newX , 0, 0)endthisGameObject.OnUpdate(OnUpdate)
turnAxis = Space.Input.TurnAxis
--makes this object color red if player is turning left
fireIsPressed = Space.Input.Fire
--Create a GameObject from resource when Primary Fire button is pressed--[Add resource "bullet" as a resource in scripting runtime component]thisGameObject = Space.Host.ExecutingObjectbullet = Space.GetResource("bullet") OnUpdate=function()if Space.Input.Fire then Space.Scene.CreateGameObject(bullet) endendthisGameObject.OnUpdate(OnUpdate)
altFireIsPressed = Space.Input.AltFire
--Create a GameObject from resource when Alternate Fire button is pressed--[Add resource "bullet" as a resource in scripting runtime component]thisGameObject = Space.Host.ExecutingObjectbullet = Space.GetResource("bullet") OnUpdate=function()if Space.Input.AltFire then Space.Scene.CreateGameObject(bullet) endendthisGameObject.OnUpdate(OnUpdate)
cursorInUI = Space.Input.CursorInUI
--this object is going to listen to your scroll wheel movement and move accordingly--UNLESS your cursor is on the sinespace UI--(Example: Scrolling chat won't also move the object)thisGameObject = Space.Host.ExecutingObjectOnUpdate=function()if Space.Input.CursorInUI ==falsethen thisGameObject.WorldPosition = thisGameObject.WorldPosition + (thisGameObject.Up * Space.Input.ScrollWheel)endendthisGameObject.OnUpdate(OnUpdate)
Space.UI.AddNotification('Warning','This is a notification')
--This script will send a notification every time a new player joins region--including the users namefunctionsendNotification(Av) Space.UI.AddNotification("New User","User joined: " .. Av.Username)endSpace.Scene.OnPlayerJoin(sendNotification)
OpenAppearanceEditor
void OpenAppearanceEditor()
Opens the Appearance Editor (Outfit)
Space.UI.OpenAppearanceEditor()
--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() endtheButton.UIButton.OnClick(OnClick)
Clears a previously added Global Action Button 'button'
Space.UI.ClearGlobalActionButton("The Button")
--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.ExecutingObjectdanceAnim = Space.GetResource("dance")isDancing =falsegbClick=function() Space.Scene.PlayerAvatar.StopCustomAnimation() Space.UI.ClearGlobalActionButton("Stop Dance") isDancing =falseendOnClick=function()ifnot isDancing then Space.Scene.PlayerAvatar.PlayCustomAnimation(danceAnim) Space.UI.AddGlobalActionButton("Stop Dance","", gbClick) isDancing =trueendendthisObj.AddClickable()thisObj.Clickable.OnClick(OnClick)
OpenQuestsWindow
void OpenQuestsWindow ()
Opens the Quests window. (white-label grid only)
Space.UI.OpenQuestsWindow()
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 =falseOnClick=function()if isShown then Space.UI.HideQuestsWindow() isShown =falseelse Space.UI.OpenQuestsWindow() isShown =trueendendtheButton.UIButton.OnClick(OnClick)
HideQuestsWindow
void HideQuestsWindow ()
Hides the Quests window. (white-label grid only)
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 =falseOnClick=function()if isShown then Space.UI.HideQuestsWindow() isShown =falseelse Space.UI.OpenQuestsWindow() isShown =trueendendtheButton.UIButton.OnClick(OnClick)
OpenSettingsWindow
void OpenSettingsWindow ()
Opens the Settings window. (white-label grid only)
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 =falseOnClick=function()if isShown then Space.UI.HideSettingsWindow() isShown =falseelse Space.UI.OpenSettingsWindow() isShown =trueendendtheButton.UIButton.OnClick(OnClick)
HideSettingsWindow
void HideSettingsWindow ()
Hides the Settings window. (white-label grid only)
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 =falseOnClick=function()if isShown then Space.UI.HideSettingsWindow() isShown =falseelse Space.UI.OpenSettingsWindow() isShown =trueendendtheButton.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 = 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)
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 =falseOnClick=function()if isShown then Space.UI.HideFriendsWindow() isShown =falseelse Space.UI.OpenFriendsWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideExploreWindow() isShown =falseelse Space.UI.OpenExploreWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideExploreWindow() isShown =falseelse Space.UI.OpenExploreWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideEventsWindow() isShown =falseelse Space.UI.OpenEventsWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideEventsWindow() isShown =falseelse Space.UI.OpenEventsWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideHomeWindow() isShown =falseelse Space.UI.OpenHomeWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideHomeWindow() isShown =falseelse Space.UI.OpenHomeWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideInventoryWindow() isShown =falseelse Space.UI.OpenInventoryWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideInventoryWindow() isShown =falseelse Space.UI.OpenInventoryWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideOutfitWindow() isShown =falseelse Space.UI.OpenOutfitWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideOutfitWindow() isShown =falseelse Space.UI.OpenOutfitWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideShopWindow() isShown =falseelse Space.UI.OpenShopWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideShopWindow() isShown =falseelse Space.UI.OpenShopWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideSnapshotWindow() isShown =falseelse Space.UI.OpenSnapshotWindow() isShown =trueendendtheButton.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 =falseOnClick=function()if isShown then Space.UI.HideSnapshotWindow() isShown =falseelse Space.UI.OpenSnapshotWindow() isShown =trueendendtheButton.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.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)
Space.UI.HideProfileWindow()
--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)
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)
OpenFeedbackWindow
void OpenFeedbackWindow ()
Shows the Feedback window (white-label grid only)
Space.UI.OpenFeedbackWindow()
--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)
Space.UI.HideFeedbackWindow()
--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)
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
--[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)
Space.UI.OpenDeviceTester()
Raycast
SUIRaycastResult Raycast ()
Shoots a UI Raycast and returns the result as SUIRayCastResult
RayCastResult = Space.UI.Raycast()
--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 ShowUIgetset
Show the User Interface
Space.UI.ShowUI = false
--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 ShowWorldUIgetset
Show the World User Interface.
Space.UI.ShowWorldUI = false
--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 MusicVolumegetset
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 MasterVolumegetset
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 SFXVolumegetset
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 UIVolumegetset
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
--[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 VOIPVolumegetset
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
--[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 ShowFriendsButtongetset
Show the Friends button. (white-label grid only)
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)
ShowExploreButton
bool ShowExploreButtongetset
Show the Explore button. (white-label grid only)
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)
ShowQuestsButton
bool ShowQuestsButtongetset
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)
ShowInventoryButton
bool ShowInventoryButtongetset
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)
ShowOutfitButton
bool ShowOutfitButtongetset
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)
ShowShopButton
bool ShowShopButtongetset
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)
ShowAuctionButton
bool ShowAuctionButtongetset
Show the Auction button. (white-label grid only)
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)
ShowSnapshotButton
bool ShowSnapshotButtongetset
Show the Snapshot button.(white-label grid only)
Space.UI.ShowSnapshotButton = false
--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 ShowHelpButtongetset
Show the Help button. (white-label grid only)
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)
ShowCurrencyButton
bool ShowCurrencyButtongetset
Show the Currency button. (white-label grid only)
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)
ShowGoldAndBuyButton
bool ShowGoldAndBuyButtongetset
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)
ShowChat
bool ShowChatgetset
Show the Chat. (white-label grid only)
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)
ShowMiniMap
bool ShowMiniMapgetset
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)
ShowHotBar
bool ShowHotBargetset
Show the Hot Bar. (white-label grid only)
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)
ShowEventsButton
bool ShowEventsButtongetset
Show the Events button. (white-label grid only)
Space.UI.ShowEventsButton = false
--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 ShowHomeButtongetset
Show the Home button. (white-label grid only)
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)
ShowActivityPanel
bool ShowActivityPanelgetset
Show the Activity Panel. (white-label grid only)
Space.UI.ShowActivityPanel = false
--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 ShowProfileImagegetset
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 ShowRightButtonGroupgetset
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 ShowRoomInfoOptiongetset
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
--[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 ShowSearchgetset
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 ShowMailButtongetset
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 ShowNotificationButtongetset
Show the Notification button. (white-label grid only)
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)
ShowClock
bool ShowClockgetset
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)