1 of 65

Components

SAudioReactiveAnimation

Index

Properties Index

Property Name

Properties

Enabled

bool Enabled get set

Returns true if the Audio Reactive Animation Enabled.

Target

Target get set

The target Animator which the Audio Reactive Animation is affecting.

Parameter

string Parameter get set

The Parameter value which the Audio Reactive Animation is affecting in the target Animator.

GameObject

GameObject get

Returns a reference to the GameObject of this component.

SAudioReactiveMaterial

Index

Properties Index

Property Name

Properties

Enabled

bool Enabled get set

Returns true if the Audio Reactive Material Enabled.

Target

Target get set

Property Description

OriginalMaterial

OriginalMaterial get set

Property Description

TargetMaterial

TargetMaterial get set

Property Description

GameObject

GameObject get

Returns a reference to the GameObject of this component.

SAudioReactiveParticleSystem

Index

Properties Index

Property Name

SBoxCollider

Index

Properties Index

Property Name

SCanvasGroup

Index

Properties Index

Property Name

SCollider

Index

Properties Index

Property Name

SContentSizeFitter

Index

Functions Index

Function Name

SEventCalendar

Index

Functions Index

Function Name

SFurniture

Index

Functions Index

Function Name

SPlayableDirector

Index

Functions Index

Function Name

SPostProcessVolume

Index

Properties Index

Property Name

SReflectionProbe

Index

Functions Index

Function Name

SRoomFloor

Index

Properties Index

Property Name

SScriptingData

Index

Functions Index

Function Name

SUICanvas

Index

Properties Index

Property Name

SUIToolTipHint

Index

Properties Index

Property Name

--clicking this object toggles between two Audio Reactive Animation targets

thisObject = Space.Host.ExecutingObject
animator1 = Space.Host.GetReference("object1").Animator --add this reference to Scripting Runtime component
animator2 = Space.Host.GetReference("object2").Animator --add this reference to Scripting Runtime component

OnClick = function()
if thisObject.AudioReactiveAnimation.Target == animator1 then
  thisObject.AudioReactiveAnimation.Target = animator2
else
  thisObject.AudioReactiveAnimation.Target = animator1
end

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object toggles between two Audio Reactive Animation parameters

thisObject = Space.Host.ExecutingObject
parameter1 = "theParamName"
parameter2 = "theParamName2"

OnClick = function()
if thisObject.AudioReactiveAnimation.Parameter == parameter1 then
  thisObject.AudioReactiveAnimation.Parameter = parameter2
else
  thisObject.AudioReactiveAnimation.Parameter = parameter1
end

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object will Enable/Disable it's Audio Reactive Animation component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.AudioReactiveAnimation


OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will Enable/Disable it's Audio Reactive Material component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.AudioReactiveMaterial


OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object moves it's Box Collider's center one unit upwards

thisObject = Space.Host.ExecutingObject

OnClick = function()
center = thisObject.BoxCollider.Center

thisObject.BoxCollider.Center = Vector.New(center.X,center.Y + 1, center.Z)

--clicking this object increases it's Box Collider's size by one unit

thisObject = Space.Host.ExecutingObject

OnClick = function()
size = thisObject.BoxCollider.Size

thisObject.BoxCollider.Size = Vector.New(size.X + 1,size.Y + 1, size.Z + 1)

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object toggles it's Box Collider On/Off

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.BoxCollider.Enabled = not thisObject.BoxCollider.Enabled

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object toggles it's Box Collider between being a Collider and Trigger Collider

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.BoxCollider.IsTrigger = not thisObject.BoxCollider.IsTrigger

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object toggles it's Collider On/Off

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.Collider.Enabled = not thisObject.Collider.Enabled

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick

--clicking this object will Enable/Disable it's Post Process Volume component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.PostProcessVolume

OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()

--clicking this object will Enable/Disable it's Audio Reactive Particle System component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.AudioReactiveParticleSystem


OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object toggles it's collider between being a Collider vs Trigger Collider

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.Collider.IsTrigger = not thisObject.Collider.IsTrigger

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object will Enable/Disable it's Scripting Data component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.Data

OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

local trans = Space.Host.ExecutingObject
local canvas = Space.Host.GetReference("Canvas")
local gr = canvas.GraphicRaycaster
function Update()
    local raycast = gr.Raycast()
    Space.Log(raycast.ToString())
end
trans.OnUpdate(Update)

--clicking this object moves it's Sphere Collider's center one unit upwards

thisObject = Space.Host.ExecutingObject

OnClick = function()
center = thisObject.SphereCollider.Center

thisObject.SphereCollider.Center = Vector.New(center.X,center.Y + 1, center.Z)

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object increments it's Sphere Collider's radius by one unit 

thisObject = Space.Host.ExecutingObject

OnClick = function()

thisObject.SphereCollider.Radius = thisObject.SphereCollider.Radius + 1

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object toggles it's Sphere Collider On/Off

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.SphereCollider.Enabled = not thisObject.SphereCollider.Enabled

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object toggles it's Sphere Collider between being a Collider vs Trigger Collider

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.SphereCollider.IsTrigger = not thisObject.SphereCollider.IsTrigger

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object will Enable/Disable it's Cloth component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.Cloth

OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object moves it's Capsule Collider's center one unit upwards

thisObject = Space.Host.ExecutingObject

OnClick = function()
center = thisObject.CapsuleCollider.Center

thisObject.CapsuleCollider.Center = Vector.New(center.X,center.Y + 1, center.Z)

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object will Enable/Disable it's Audio Reactive Transform component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.AudioReactiveTransform


OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will toggle between two different Audio Reactive Transform targets
thisObject = Space.Host.ExecutingObject
target1 = Space.Host.GetReference("theTarget1") --add this reference to Scripting Runtime component
target2 = Space.Host.GetReference("theTarget2") --add this reference to Scripting Runtime component

function OnClickFunction()
  if thisObject.AudioReactiveTransform.Target == target1 then
    thisObject.AudioReactiveTransform.Target = target2
  else
    thisObject.AudioReactiveTransform.Target = target1
  end
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object will toggle it's Audio Reactive Transform Position property 
thisObject = Space.Host.ExecutingObject

function OnClickFunction()
   thisObject.AudioReactiveTransform.Position = not thisObject.AudioReactiveTransform.Position
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object will toggle it's Audio Reactive Transform Rotation property 
thisObject = Space.Host.ExecutingObject

function OnClickFunction()
   thisObject.AudioReactiveTransform.Rotation= not thisObject.AudioReactiveTransform.Rotation
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object will toggle it's Audio Reactive Transform Scale property 
thisObject = Space.Host.ExecutingObject

function OnClickFunction()
   thisObject.AudioReactiveTransform.Scale= not thisObject.AudioReactiveTransform.Scale
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object increases it's Capsule Collider's direction by one unit

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.CapsuleCollider.Direction

thisObject.CapsuleCollider.Direction = thisObject.CapsuleCollider.Direction + 1

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object increases it's Capsule Collider's height by one unit

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.CapsuleCollider.Height

thisObject.CapsuleCollider.Height= thisObject.CapsuleCollider.Height+ 1.0

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object increments it's Capsule Collider's radius by one unit 

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.CapsuleCollider.Radius = thisObject.CapsuleCollider.Radius + 1

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object toggles it's Capsule Collider On/Off

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.CapsuleCollider.Enabled = not thisObject.CapsuleCollider.Enabled

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

--clicking this object toggles it's Capsule Collider between being a Collider vs Trigger Collider

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.CapsuleCollider.IsTrigger = not thisObject.CapsuleCollider.IsTrigger

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)

hostObject = Space.Host.ExecutingObject
hostObject.AddClickable()

function ClickMe ()
Space.Log("I was clicked!")
end
function ClickAndClear ()
Space.Log("No more actions!")
hostObject.Clickable.ClearActions ()
end

hostObject.Clickable.AddExtraAction ("LogButton", "Prints I was clicked! to the console", ClickMe)
hostObject.Clickable.AddExtraAction ("ClearButton", "Clears all actions", ClickAndClear)
-- Now, when the latter option is chosen, the script clears the Clickable component of all actions.

hostObject = Space.Host.ExecutingObject
hostObject.AddClickable()
deltaPos = Vector.New(0,0,1)

function MakeMeMove ()
hostObject.WorldPosition = hostObject.WorldPosition + deltaPos
end

hostObject.Clickable.OnClick (MakeMeMove);
-- Now, every time an object is clicked, it moves by 1 in the positive Z direction.

--Clicking the object will disable the component, making it only clickable once
thisGameObject = Space.Host.ExecutingObject


OnClick = function()
 thisGameObject.Clickable.Enabled = false
end


thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click to activate"
thisGameObject.Clickable.OnClick(OnClick)

--Clicking the object will toggle between two different tooltips
thisGameObject = Space.Host.ExecutingObject


OnClick = function()
  if thisGameObject.Clickable.Tooltip == "Turn On" then
    thisGameObject.Clickable.Tooltip = "Turn Off"
  else
    thisGameObject.Clickable.Tooltip = "Turn On"
  end
end


thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Turn On"
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will Enable/Disable it's Virtual Camera component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.VirtualCamera

OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make the object Enable/Disable it's Light component
--[Add "light" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
light = Space.Host.GetReference("light").Light


OnClick = function()
light.Enabled =  not light.Enabled

--clicking this object will Enable/Disable it's Audio Reactive Base component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.AudioReactive


OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make a slider change an Audio Reactive Component's Band Min property
--[Add "theslider" and "theaudioreactive" reference to the Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider
ar = Space.Host.GetReference("theaudioreactive").AudioReactive


OVC = function()
ar.BandMin = (slider.Value * 12.0) -- from 0 to 12
end

slider.OnValueChanged(OVC)

--the below script will make a slider change an Audio Reactive Component's Band Max property
--[Add "theslider" and "theaudioreactive" reference to the Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider
ar = Space.Host.GetReference("theaudioreactive").AudioReactive


OVC = function()
ar.BandMax = (slider.Value * 12.0) -- from 0 to 12
end

slider.OnValueChanged(OVC)

--the below script will make a slider change an Audio Reactive Component's BPM Window property
--[Add "theslider" and "theaudioreactive" reference to the Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider
ar = Space.Host.GetReference("theaudioreactive").AudioReactive


OVC = function()
ar.BPMWindow = (slider.Value * 50) - 50   -- from -50 to 50
end

slider.OnValueChanged(OVC)

--the below script will make a slider change an Audio Reactive Component's Limit Increase property.
--[Add "theslider" and "theaudioreactive" reference to the Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider
ar = Space.Host.GetReference("theaudioreactive").AudioReactive


OVC = function()
ar.LimitIncrease= (slider.Value * 50) - 50   -- from -50 to 50
end

slider.OnValueChanged(OVC)

--the below script will make a slider change an Audio Reactive Component's Limit Decrease property.
--[Add "theslider" and "theaudioreactive" reference to the Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider
ar = Space.Host.GetReference("theaudioreactive").AudioReactive


OVC = function()
ar.LimitDecrease= (slider.Value * 50) - 50   -- from -50 to 50
end

slider.OnValueChanged(OVC)

--the below script will make a slider change an Audio Reactive Component's Min Value property.
--[Add "theslider" and "theaudioreactive" reference to the Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider
ar = Space.Host.GetReference("theaudioreactive").AudioReactive


OVC = function()
ar.MinValue= (slider.Value * 50) - 50   -- from -50 to 50
end

slider.OnValueChanged(OVC)

--the below script will make a slider change an Audio Reactive Component's Max Value property.
--[Add "theslider" and "theaudioreactive" reference to the Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider
ar = Space.Host.GetReference("theaudioreactive").AudioReactive


OVC = function()
ar.MaxValue= (slider.Value * 50) - 50   -- from -50 to 50
end

slider.OnValueChanged(OVC)

--clicking this object will toggle between it's two Audio Reactive Modes

thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.AudioReactive


OnClick = function()
  if component.Mode == 0 then
    component.Mode = 1
  else
    component.Mode = 0
  end
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make a slider set the Light's range
--[Add "slider" and "light" references to the Scripting Runtime component]

light = Space.Host.GetReference("light").Light
slider = Space.Host.GetReference("slider").UISlider

OVC = function()
light.Range = (slider.Value * 100) --(from 0 to 100)
end

slider.OnValueChanged(OVC)

--the below script will make a slider set the Light's Spot Angle
--[Add "slider" and "light" references to the Scripting Runtime component]

light = Space.Host.GetReference("light").Light
slider = Space.Host.GetReference("slider").UISlider

light.Type = 2 --it has to be Spot type 

OVC = function()
light.SpotAngle = (slider.Value * 178) + 1 --(from 1 to 179)
end

slider.OnValueChanged(OVC)

--the below script will make a slider set the Light's Intensity
--[Add "slider" and "light" references to the Scripting Runtime component]

light = Space.Host.GetReference("light").Light
slider = Space.Host.GetReference("slider").UISlider


OVC = function()
light.Intensity = (slider.Value * 8) --(from 0 to 8)
end

slider.OnValueChanged(OVC)

--clicking the object will open a color picker that changes Light's color
----[Add "light" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
light = Space.Host.GetReference("light").Light

OnChange = function(SColor) 
 light.Color = SColor
end

OnSelect = function(SColor)
 light.Color = SColor
end

OnCancel = function()
end

OnClick = function()
Space.Dialogues.ColorPicker("Pick a color","Ok", OnChange, OnSelect, OnCancel, Color.Red)
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--Clicking the object toggles between the 4 different light types
--[Add "light" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
light = Space.Host.GetReference("light").Light

OnClick = function()
  
  if light.Type == 3 then
    light.Type = 0
  else light.Type = light.Type + 1
  end
  
end

thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will toggle Enable/Disable an object's Button component

thisGameObject = Space.Host.ExecutingObject
button = Space.Host.GetReference("button").UIButton 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
button.Enabled =  not button.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will toggle Interactable status on an object's Button component

thisGameObject = Space.Host.ExecutingObject
button = Space.Host.GetReference("button").UIButton 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
button.Interactable=  not button.Interactable
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will Enable/Disable an object's SkinnedMeshRenderer component
--[Add "skinnedmeshrenderer" reference to scripting runtime component]
thisGameObject = Space.Host.ExecutingObject
skinnedmeshrenderer = Space.Host.GetReference("skinnedmeshrenderer").SkinnedMeshRenderer


OnClick = function()
skinnedmeshrenderer.Enabled =  not skinnedmeshrenderer.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

SAnimation

Index

Functions Index

Function Name

Properties Index

Property Name

Functions

GetState

GetState () GetState (string state)

Returns the SAnimationState for the default animation clip.

Parameter

Type

Description

Blend

void Blend (string animation, float targetWeight=1.0F, float fadeLength=0.3F)

Blends the animation named animation towards targetWeight over the next time seconds. Playback of other animations will not be affected.

Parameter

Type

Description

CrossFade

void CrossFade (string animation, float fadeLength=0.3F)

Fades the animation with name animation in over a period of time seconds and fades other animations out.

If mode is PlayMode.StopSameLayer, animations in the same layer as animation will be faded out while animation is faded in. if mode is PlayMode.StopAll, all animations will be faded out while animation is faded in.

If the animation is not set to be looping it will be stopped and rewound after playing.

Parameter

Type

Description

CrossFadeQueued

CrossFadeQueued (string animation, float fadeLength=0.3F, bool playNow=false)

Returns a duplicated SAnimationState. This duplicate will self-destruct after it is finished playing. Referencing it after it has completed will result in an error.

Parameter

Type

Description

GetClipCount

int GetClipCount ()

Get the number of clips currently assigned to this animation.

IsPlaying

bool IsPlaying (string animation)

Is the animation named name playing?

Parameter

Type

Description

Play

bool Play () bool Play (string animation)

Plays an animation without any blending.

If no name is supplied then the default animation will be played. In cases where the animation can't be played (ie, there is no default animation or no animation with the specified name), the function will return false.

The optional playMode lets you choose how this animation will affect others already playing.

If the specified animation is already playing then other animations will be stopped but the animation will not rewind to the beginning.

When the end of the animation is reached it will automatically be stopped and rewound to the start unless the PlayMode is set to Loop.

Note that if you call Animation.Play on an object during a frame update where the object is also deactivated then the call will effectively be cancelled; the animation will not start playing when the object is later reactivated. However, if you make the call on a subsequent frame (ie, while the object is still inactive) then the animation will start playing after reactivation.

Parameter

Type

Description

PlayQueued

PlayQueued (string animation, bool playNow=false)

Returns a duplicated SAnimationState. This duplicate will self-destruct after it is finished playing. Referencing it after it has completed will result in an error.

Parameter

Type

Description

Rewind

void Rewind (string animation)

Rewinds the animation named name.

Parameter

Type

Description

Sample

void Sample ()

Samples animations at the current state.

This is useful when you explicitly want to set up some animation state, and sample it once.

Parameter

Type

Description

Stop

void Stop () void Stop (string animation)

Stops all playing animations that were started with this Animation.

Stopping an animation also Rewinds it to the Start.

Parameter

Type

Description

Properties

Enabled

bool Enabled get set

Whether this component is enabled or not.

States

IDictionary< string, > States get

Returns a table of names and references

GameObject

GameObject get

Returns a reference to the GameObject of this component.

--clicking this object will Enable/Disable it's Camera component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.Camera

OnClick = function()
component.Enabled =  not component.Enabled
end

thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--this object will move forward only if visible on a camera

thisObject = Space.Host.ExecutingObject


function OnUpdateFunction()
  
  if thisObject.MeshRenderer.IsVisible then
thisObject.WorldPosition = thisObject.WorldPosition + (thisObject.Forward * Space.DeltaTime * 0.2)
 end

end

thisObject.OnUpdate(OnUpdateFunction)

--clicking this object will Enable/Disable it's Mesh Renderer component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.MeshRenderer

OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will toggle it's material's color between Red and Black color when clicked
thisObject = Space.Host.ExecutingObject


function OnClickFunction()
  if thisObject.MeshRenderer.Material.GetColor("_Color") == Color.Black then
    thisObject.MeshRenderer.Material.SetColor("_Color", Color.Red)
  else
    thisObject.MeshRenderer.Material.SetColor("_Color", Color.Black)
  end

end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object will toggle it's shared material's color between Red and Black color when clicked
thisObject = Space.Host.ExecutingObject


function OnClickFunction()
  if thisObject.MeshRenderer.SharedMaterial.GetColor("_Color") == Color.Black then
    thisObject.MeshRenderer.SharedMaterial.SetColor("_Color", Color.Red)
  else
    thisObject.MeshRenderer.SharedMaterial.SetColor("_Color", Color.Black)
  end

end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object will toggle it's shared material's color between Red and Black color when clicked
thisObject = Space.Host.ExecutingObject

function OnClickFunction()
  if thisObject.MeshRenderer.SharedMaterial.GetColor("_Color") == Color.Black then
    thisObject.MeshRenderer.SharedMaterial.SetColor("_Color", Color.Red)
  else
    thisObject.MeshRenderer.SharedMaterial.SetColor("_Color", Color.Black)
  end

end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--this object will move forward only if visible on a camera

thisObject = Space.Host.ExecutingObject


function OnUpdateFunction()
  
  if thisObject.Renderer.IsVisible then
thisObject.WorldPosition = thisObject.WorldPosition + (thisObject.Forward * Space.DeltaTime * 0.2)
 end

end

thisObject.OnUpdate(OnUpdateFunction)

--clicking this object will make it disappear/reappear

thisGameObject = Space.Host.ExecutingObject


OnClick = function()
thisGameObject.Renderer.Enabled = not thisGameObject.Renderer.Enabled
end

thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will toggle it's material's color between Red and Black color when clicked
thisObject = Space.Host.ExecutingObject


function OnClickFunction()
  if thisObject.Renderer.Material.GetColor("_Color") == Color.Black then
    thisObject.Renderer.Material.SetColor("_Color", Color.Red)
  else
    thisObject.Renderer.Material.SetColor("_Color", Color.Black)
  end

end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object will toggle it's shared material's color between Red and Black color when clicked
thisObject = Space.Host.ExecutingObject


function OnClickFunction()
  if thisObject.Renderer.SharedMaterial.GetColor("_Color") == Color.Black then
    thisObject.Renderer.SharedMaterial.SetColor("_Color", Color.Red)
  else
    thisObject.Renderer.SharedMaterial.SetColor("_Color", Color.Black)
  end

end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object will toggle a Layout's Enabled status

thisGameObject = Space.Host.ExecutingObject
layout = Space.Host.GetReference("layout").UILayout 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
layout.Enabled=  not layout.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

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

toggle.OnValueChanged(OnValueChanged)

--clicking this object will toggle a Toggles's Enabled status

thisGameObject = Space.Host.ExecutingObject
toggle = Space.Host.GetReference("toggle").UIToggle 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
toggle.Enabled =  not toggle.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will toggle a Toggles's Interactable status

thisGameObject = Space.Host.ExecutingObject
toggle = Space.Host.GetReference("toggle").UIToggle 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
toggle.Interactable=  not toggle.Interactable
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

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

toggle.OnValueChanged(OnValueChanged)

--clicking this object will Enable/Disable it's Animation component
thisGameObject = Space.Host.ExecutingObject
animation = thisGameObject.Animation


OnClick = function()
animation.Enabled =  not animation.Enabled
end

thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--get embedded video component on your video player 
video = Space.Scene.Find("VidepPlayer").EmbeddedVideo
function GetClosure()
return function (a,b,c)
log(a.URL..b..c)
end
end
video.OnStateChange(GetClosure())
video.Pause()

--clicking this object will Enable/Disable it's Audio Reactive Light component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.AudioReactiveLight


OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking the object will toggle between two different AudioReactiveLight targets
--[Add "light1" and "light2" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
light1 = Space.Host.GetReference("light1").Light
light2 = Space.Host.GetReference("light2").Light


OnClick = function()
if thisGameObject.AudioReactiveLight.Target == light1 then
  thisGameObject.AudioReactiveLight.Target = light2
else
  thisGameObject.AudioReactiveLight.Target = light1
end

end



thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make the object toggle it's AudioReactiveLight's Range property
--[Add "arlight" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
arlight = Space.Host.GetReference("arlight").AudioReactiveLight


OnClick = function()
arlight.Range=  not arlight.Range
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make a slider set the Audio Reactive Light's MinRange
--[Add "slider" and "arlight" references to the Scripting Runtime component]

arlight = Space.Host.GetReference("arlight").AudioReactiveLight
slider = Space.Host.GetReference("slider").UISlider
 

OVC = function()
arlight.MinRange = (slider.Value * 9) + 1 --(from 1 to 10)
end

slider.OnValueChanged(OVC)

--the below script will make a slider set the Audio Reactive Light's MaxRange
--[Add "slider" and "arlight" references to the Scripting Runtime component]

arlight = Space.Host.GetReference("arlight").AudioReactiveLight
slider = Space.Host.GetReference("slider").UISlider
 

OVC = function()
arlight.MaxRange= (slider.Value * 10) + 10 --(from 10 to 20)
end

slider.OnValueChanged(OVC)

--the below script will make the object Enable/Disable it's AudioReactiveLight's AnimateColor property
--[Add "arlight" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
arlight = Space.Host.GetReference("arlight").AudioReactiveLight


OnClick = function()
arlight.AnimateColor =  not arlight.AnimateColor
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking the object will open a color picker that changes AudioReactiveLight's MinColor
--[Add "arlight" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
arlight = Space.Host.GetReference("arlight").AudioReactiveLight
originalColor = nil

OnChange = function(SColor) 
 arlight.MinColor = SColor
end

OnSelect = function(SColor)
 arlight.MinColor = SColor
end

OnCancel = function()
 arlight.MinColor = originalColor
end

OnClick = function()
originalColor = arlight.MinColor
Space.Dialogues.ColorPicker("Pick a color","Ok", OnChange, OnSelect, OnCancel, originalColor)
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking the object will open a color picker that changes AudioReactiveLight's MaxColor
--[Add "arlight" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
arlight = Space.Host.GetReference("arlight").AudioReactiveLight
originalColor = nil

OnChange = function(SColor) 
 arlight.MaxColor= SColor
end

OnSelect = function(SColor)
 arlight.MaxColor= SColor
end

OnCancel = function()
 arlight.MaxColor= originalColor
end

OnClick = function()
originalColor = arlight.MaxColor
Space.Dialogues.ColorPicker("Pick a color","Ok", OnChange, OnSelect, OnCancel, originalColor)
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make the object Enable/Disable it's AudioReactiveLight's Intensity property
--[Add "arlight" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
arlight = Space.Host.GetReference("arlight").AudioReactiveLight


OnClick = function()
arlight.Intensity =  not arlight.Intensity
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make a slider set the Audio Reactive Light's MinIntensity
--[Add "slider" and "arlight" references to the Scripting Runtime component]

arlight = Space.Host.GetReference("arlight").AudioReactiveLight
slider = Space.Host.GetReference("slider").UISlider
 

OVC = function()
arlight.MinIntensity= (slider.Value * 1) --(from 0 to 1)
end

slider.OnValueChanged(OVC)

--the below script will make a slider set the Audio Reactive Light's MaxIntensity
--[Add "slider" and "arlight" references to the Scripting Runtime component]

arlight = Space.Host.GetReference("arlight").AudioReactiveLight
slider = Space.Host.GetReference("slider").UISlider
 

OVC = function()
arlight.MaxIntensity= (slider.Value * 2) + 1 --(from 1 to 3)
end

slider.OnValueChanged(OVC)

 --this script will let us click a radio to make it start playing
--(Example: clicking a light switch toggle's a parent light bulb's intensity)
--[Requires a "Shoutcast Streaming" component on the parent of this object]

thisGameObject = Space.Host.ExecutingObject
IsPlaying = false


StartPlaying = function()
thisGameObject.Radio.Play()
IsPlaying = true
end

StopPlaying = function()
thisGameObject.Radio.Stop()
IsPlaying = false
end


OnClick = function()
    if IsPlaying then
      StopPlaying()
    else
      StartPlaying()
    end
end

thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip="Toggle Play/Stop"
thisGameObject.Clickable.OnClick(OnClick)

--this script will let us click a radio to make it start playing
--(Example: clicking a light switch toggle's a parent light bulb's intensity)
--[Requires a "Shoutcast Streaming" component on the parent of this object]

thisGameObject = Space.Host.ExecutingObject
IsPlaying = false


StartPlaying = function()
thisGameObject.Radio.Play()
IsPlaying = true
end

StopPlaying = function()
thisGameObject.Radio.Stop()
IsPlaying = false
end


OnClick = function()
    if IsPlaying then
      StopPlaying()
    else
      StartPlaying()
    end
end

thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip="Toggle Play/Stop"
thisGameObject.Clickable.OnClick(OnClick)

--this script will update a UIText object with the track title on track change
--[this GameObject needs a "Shoutcast Streaming"/"SceneBackgroundMusic" component]

thisObj = Space.Host.ExecutingObject

text = Space.Host.GetReference("Text") -- set in Scripting Runtime references

otc = function(trackInfo)
text.UIText.Text = "Track: " .. trackInfo.Title .. " by " .. trackInfo.Artist
end

thisObj.Radio.OnTrackChange(otc)

--this script will update a UIText object with the track title on upcoming track change
--[this GameObject needs a "Shoutcast Streaming"/"SceneBackgroundMusic" component]

thisObj = Space.Host.ExecutingObject

text = Space.Host.GetReference("Text") -- set in Scripting Runtime references

outc = function(upcomingTrackInfo)
text.UIText.Text = "Track: " .. upcomingTrackInfo.Title .. " by " .. upcomingTrackInfo.Artist
end

thisObj.Radio.OnUpcomingTrackChange(outc)

--clicking this object will Enable/Disable it's Scene Background Music component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.Radio

OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--this script will update a UIText object with the current stream URL
--[this GameObject needs a "Shoutcast Streaming"/"SceneBackgroundMusic" component]

thisObj = Space.Host.ExecutingObject

text = Space.Host.GetReference("Text") -- set in Scripting Runtime references


OnUpdate = function()
text.UIText.Text = thisObj.Radio.URL
end

thisObj.OnUpdate(OnUpdate)

SUIImage

Index

Properties Index

Property Name

Properties

Color

Color get set

Default Color of UIImage

Sprite

Sprite get set

The sprite that is used to render this image.

PreserveAspect

bool PreserveAspect get set

Whether this image should preserve its Sprite aspect ratio.

FillCenter

bool FillCenter get set

Whether or not to render the center

FillAmount

float FillAmount get set

Amount of the Image shown

FillClockwise

bool FillClockwise get set

Whether the Image should be filled clockwise (true) or counter-clockwise (false).

FillOrigin

int FillOrigin get set

Controls the origin point of the Fill process.

AlphaHitTestMinimumThreshold

float AlphaHitTestMinimumThreshold get set

The alpha threshold specifies the minimum alpha a pixel must have for the event to considered a "hit" on the Image. Alpha values less than the threshold will cause raycast events to pass through the Image. An value of 1 would cause only fully opaque pixels to register raycast events on the Image. The alpha tested is retrieved from the image sprite only, while the alpha of the Image Graphic.color is disregarded.

alphaHitTestMinimumThreshold defaults to 0; all raycast events inside the Image rectangle are considered a hit. In order for greater than 0 to values to work, the sprite used by the Image must have readable pixels. This can be achieved by enabling Read/Write enabled in the advanced Texture Import Settings for the sprite and disabling atlassing for the sprite.

HasBorder

bool HasBorder get

True if the sprite used has borders.

PixelsPerUnit

float PixelsPerUnit get

Provides information about how fonts are scale to the screen.

For dynamic fonts, the value is equivalent to the scale factor of the canvas. For non-dynamic fonts, the value is calculated from the requested text size and the size from the font.

Material

Material get set

The specified Material used by this Image. The default Material is used instead if one wasn't specified.

MinWidth

float MinWidth get

The minimum width this UIImage may be allocated. (Used by the Layout system).

PreferredWidth

float PreferredWidth get

The preferred width this UIImage should be allocated if there is sufficient space. (Used by the Layout system)

FlexibleWidth

float FlexibleWidth get

The extra relative width this UIImage should be allocated if there is additional available space. (Used by the Layout system)

MinHeight

float MinHeight get

The minimum height this UIImage may be allocated.(Used by the Layout system).

PreferredHeight

float PreferredHeight get

The preferred height this UIImage should be allocated if there is sufficient space. (Used by the Layout system)

FlexibleHeight

float FlexibleHeight get

The extra relative height this UIImage should be allocated if there is additional available space. (Used by the Layout system)

LayoutPriority

int LayoutPriority get

The layout priority of this UIText component.(Used by the Layout system.)

GameObject

GameObject get

Property Description

--clicking this object will Enable/Disable it's Voice Zone component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.VoiceZone

OnClick = function()
component.Enabled =  not component.Enabled
end

thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--Populating a UIDropdown and making a selection using value's text
dropDown=Space.Host.GetReference("DropDown").UIDropdown
options = {"Room 1", "Room 2", "Room 3", "Room 4"}
dropDown.AddOptions(options)
dropDown.SetValueByText("Room 3")

--clicking this object will toggle a UIDropdown's interactable status

thisGameObject = Space.Host.ExecutingObject
dropdown = Space.Host.GetReference("dropdown").UIDropdown 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
dropdown.Interactable =  not dropdown.Interactable
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below scipt makes this object set Browser URL according to what's written in text field
--(Example: Set URL button)
--[Required: This object needs a Browser and InputField objects to be added as reference to references section in Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
webBrowser = Space.Host.GetReference("Browser")
urlField = Space.Host.GetReference("URL Field")

OnClick = function()

webBrowser.Browser.SetURL(urlField.UIInputField.Text)

end

urlField.UIInputField.Text = "https://www.youtube.com"
thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click to set URL"
thisGameObject.Clickable.OnClick(OnClick)

--the below scipt makes this object a clickable that navigates Back
--(Example: Browser navigation )
--[Required: Browser surface object needs to be added as a reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
browser = Space.Host.GetReference("Browser Surface Object").Browser

OnClick = function()
browser.Back()
end

thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click to Enable/Disable browser Input"
thisGameObject.Clickable.OnClick(OnClick)

--the below scipt makes this object a clickable that navigates Forward
--(Example: Browser navigation )
--[Required: Browser surface object needs to be added as a reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
browser = Space.Host.GetReference("Browser Surface Object").Browser

OnClick = function()
browser.Forward()
end

thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click to Enable/Disable browser Input"
thisGameObject.Clickable.OnClick(OnClick)

 --the below scipt makes this object a clickable that reloads the page
--(Example: Browser navigation )
--[Required: Browser surface object needs to be added as a reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
browser = Space.Host.GetReference("Browser Surface Object").Browser

OnClick = function()
browser.Reload()
end

thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click to Enable/Disable browser Input"
thisGameObject.Clickable.OnClick(OnClick)

--the below scipt makes this object clear the an InputField whenever URL changes
--(Example: URL Bar)
--[Required: This object needs a Browser and InputField objects to be added as reference to references section in Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
webBrowser = Space.Host.GetReference("Browser")
urlField = Space.Host.GetReference("URL Field")

OnURLChanged  ()

urlField.UIInputField.Text = " "

end

webBrowser.Browser.OnURLChanged(OnURLChanged)

 --the below scipt makes this object toggle Networking on it's parent browser
--(Example: browser controls)
--[Required: This object needs its parent to have the browser component]

thisGameObject = Space.Host.ExecutingObject

OnClick = function()

  if thisGameObject.Parent.Browser.Networked then
   thisGameObject.Parent.Browser.Networked = false
    Space.Log("Browser will not be networked")
  else
    thisGameObject.Parent.Browser.Networked = true
    Space.Log("Browser will be networked")
  end

end

thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click to toggle Networking on Browser"
thisGameObject.Clickable.OnClick(OnClick)

--the below scipt makes this object a clickable that mutes/unmutes a browser surface
--(Example: Browser Mute button )
--[Required: This object's parent needs to be an object with BrowserSurface component in it]

thisGameObject = Space.Host.ExecutingObject


OnClick = function()

  if thisGameObject.Parent.Browser.Muted then
   thisGameObject.Parent.Browser.Muted = false
    Space.Log("Browser unmuted")
  else
    thisGameObject.Parent.Browser.Muted = true
    Space.Log("Browser muted")
  end

end

thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click to Mute/Unmute Browser"
thisGameObject.Clickable.OnClick(OnClick)

 --the below scipt makes this Browser object show/hide it's Forward and Back
--buttons according to wether the actions are possible or not
--(Example: browser navigation )
--[Required: This object needs the forward and back objects added to the references section in scripting runtime]

thisGameObject = Space.Host.ExecutingObject
forwardButton = Space.Host.GetReference("Forward Button")
backButton = Space.Host.GetReference("Back Button")

OnUpdate = function()
 
 if thisGameObject.Browser.CanGoBack then
   backButton.Active = true
  else backButton.Active = false
end

if thisGameObject.Browser.CanGoForward then
  forwardButton.Active = true
else forwardButton.Active = false
end

  
end

thisGameObject.OnUpdate(OnUpdate)

 --the below scipt makes this Browser object show/hide it's Forward and Back
--buttons according to wether the actions are possible or not
--(Example: browser navigation )
--[Required: This object needs the forward and back objects added to the references section in scripting runtime]

thisGameObject = Space.Host.ExecutingObject
forwardButton = Space.Host.GetReference("Forward Button")
backButton = Space.Host.GetReference("Back Button")

OnUpdate = function()
 
 if thisGameObject.Browser.CanGoBack then
   backButton.Active = true
  else backButton.Active = false
end

if thisGameObject.Browser.CanGoForward then
  forwardButton.Active = true
else forwardButton.Active = false
end

  
end

thisGameObject.OnUpdate(OnUpdate)

--the below scipt makes this object a clickable that toggle Enable Input a browser surface
--(Example: Brower Enable Input toggle button )
--[Required: Browser surface object needs to be added as a reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
browser = Space.Host.GetReference("Browser Surface Object").Browser

OnClick = function()

  if browser.EnableInput then
   browser.EnableInput = false
    Space.Log("Browser input disabled")
  else
    browser.EnableInput = true
    Space.Log("Browser input enabled")
  end

end

thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click to Enable/Disable browser Input"
thisGameObject.Clickable.OnClick(OnClick)

--the below scipt make a slider control the zoom in of a browser surface
--(Example: browser zoom controls)
--[Required: This object needs a Browser and slider objects to be added as reference to references section in Scripting Runtime component]
slider = Space.Host.GetReference("Slider").UISlider
browser = Space.Host.GetReference("Browser")

browser.Browser.SetURL("https://www.yahoo.com")


OnValueChanged = function()
browser.Browser.Zoom = slider.NormalizedValue * 5
end

slider.OnValueChanged(OnValueChanged)

--clicking this object will toggle a Character Controller's Detect Collisions property

thisObject = Space.Host.ExecutingObject
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController --add Reference to Scripting Runtime


function OnClickFunction()
ccontroller.DetectCollisions = not ccontroller.DetectCollisions
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object will toggle a Character Controller's Enable Overlap Recovery property

thisObject = Space.Host.ExecutingObject
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController --add Reference to Scripting Runtime


function OnClickFunction()
ccontroller.EnableOverlapRecovery = not ccontroller.EnableOverlapRecovery
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--the below script will make a slider change a Character Controller Height property
--[Add "theslider" and "thecharactercontroller" to the Object References section in Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider 
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController 


OVC = function()
ccontroller.Height = (slider.Value * 10.0) -- from 0.0 to 10.0
end

slider.OnValueChanged(OVC)

--this script will make a slider change a Character Controller Min Move Distance property
--[Add "theslider" and "thecharactercontroller" to the Object References section in Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider 
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController 


OVC = function()
ccontroller.MinMoveDistance= (slider.Value * 10.0) -- from 0.0 to 10.0
end

slider.OnValueChanged(OVC)

--this script will make a slider change a Character Controller Radius property
--[Add "theslider" and "thecharactercontroller" to the Object References section in Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider 
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController 


OVC = function()
ccontroller.Radius= (slider.Value * 10.0) -- from 0.0 to 10.0
end

slider.OnValueChanged(OVC)

--this script will make a slider change a Character Controller SkinWidth property
--[Add "theslider" and "thecharactercontroller" to the Object References section in Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider 
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController 


OVC = function()
ccontroller.SkinWidth= (slider.Value * 10.0) -- from 0.0 to 10.0
end

slider.OnValueChanged(OVC)

--this script will make a slider change a Character Controller Slope Limit property
--[Add "theslider" and "thecharactercontroller" to the Object References section in Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider 
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController 


OVC = function()
ccontroller.SlopeLimit= (slider.Value * 180.0) -- from 0.0 to 180.0
end

slider.OnValueChanged(OVC)

--this script will make a slider change a Character Controller Step Offset property
--[Add "theslider" and "thecharactercontroller" to the Object References section in Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider 
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController 


OVC = function()
ccontroller.StepOffset= (slider.Value * 10.0) -- from 0.0 to 10.0
end

slider.OnValueChanged(OVC)

--the below script will teleport the player above the seat after standing up
--so that they do not go back to original position, but rather be standing next to the seat
--(Example: if the seat moves - such as in a vehicle- and we want to stand up next to it)
--[Requires Seat Component in the GameObject running this script]

thisGameObject = Space.Host.ExecutingObject

OnPlayerStandUp = function()
seatPosition = thisGameObject.WorldPosition
teleportPosition = Vector.New(seatPosition.X, seatPosition.Y + 1, seatPosition.Z)
Space.Scene.PlayerAvatar.Teleport(teleportPosition)
end

thisGameObject.Seat.OnPlayerStandUp(OnPlayerStandUp)

--the below script will check if the player sitting is the owner of the seat
--if they are not, we will remove them from the seat
--(Example: if the seat is a vehicle which the owner wants no one else to use)
--[Requires Seat Component in the GameObject running this script]
--<Note: ID match may not succeed in Editor but will succeed in SS client>

thisGameObject = Space.Host.ExecutingObject

OnPlayerSit = function()
  if Space.Scene.PlayerAvatar.ID ~= thisGameObject.Owner then
    thisGameObject.Seat.UnseatPlayer()
    Space.Log("You do not have permission to sit in this vehicle")
  end
  
end

thisGameObject.Seat.OnPlayerSit(OnPlayerSit)

--clicking this object will Enable/Disable it's Seat component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.Seat

OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

 --this script will play a looping sound only if someone is using the seat
 --and will stop the sound if someone is not
--(Example: carnival game )
--[Object must contain a Seat component and AudioSource component]

thisGameObject = Space.Host.ExecutingObject


OnUpdate = function()
  if thisGameObject.Seat.InUse then
        if not thisGameObject.Audio.IsPlaying then
        thisGameObject.Audio.Play()
        end
  else
       if thisGameObject.Audio.IsPlaying then
        thisGameObject.Audio.Stop()
        end
  end
end

thisGameObject.Audio.Loop = true
thisGameObject.SubscribeToEvents()
thisGameObject.OnUpdate(OnUpdate)

--the below script will toggle between two seat animations every 30 seconds
--(Example: a couch where the player sitting periodically changes pose)
--[Requires Seat Component in the GameObject running this script]
--[Requires adding 2 animations as "Resources" at the bottom of the Scripting Runtime Component]

thisGameObject = Space.Host.ExecutingObject

anim1 = Space.GetResource("anim1")
anim2 = Space.GetResource("anim2")

thisGameObject.Seat.Animation = anim1
animIndex = 1


AnimationAlternate = function()
  while true do
    Space.Log(thisGameObject.Seat.Animation)
       if animIndex == 1 then
         thisGameObject.Seat.Animation = anim2
         animIndex = 2
        else
          thisGameObject.Seat.Animation = anim1
          animIndex = 1
        end
    
    
    -- next part unseats then seats the player to reflect animation change (its too fast to notice)
    -- we also make sure we are running this part on the specific player sitting (if any), not everyone else
   if thisGameObject.Seat.InUse then 
      if thisGameObject.Seat.PlayerSeated == Space.Scene.PlayerAvatar.ID then
       thisGameObject.Seat.UnseatPlayer()
       thisGameObject.Seat.SitPlayer()
      end
    end
        
     
    Space.Log("yielding") 
    coroutine.yield(5)
    
  end
  
  
  
end

Space.Host.StartCoroutine(AnimationAlternate)

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

slider.OnValueChanged(OnValueChanged)

--clicking this object will toggle a Sliders's Enabled status

thisGameObject = Space.Host.ExecutingObject
slider = Space.Host.GetReference("slider").UISlider 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
slider.Enabled =  not slider.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will toggle a Sliders's Interactable status

thisGameObject = Space.Host.ExecutingObject
slider = Space.Host.GetReference("slider").UISlider 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
slider.Interactable =  not slider.Interactable
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will toggle a Sliders's Whole Numbers status

thisGameObject = Space.Host.ExecutingObject
slider = Space.Host.GetReference("slider").UISlider 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
slider.WholeNumbers =  not slider.WholeNumbers
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

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

--the below script will make a UIToggle disable/enable Rich Text support in the UIText
--[Add "toggle" and "text" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
text = Space.Host.GetReference("text").UIText 
text.Text = "<b> Bold Test </b>"
OVC = function()
  if toggle.IsOn then
    text.SupportRichText = true
  else
    text.SupportRichText = false
  end
end

toggle.OnValueChanged(OVC)

--the below script will make a UIToggle disable/enable the Best Fit feature in the UIText
--[Add "toggle" and "text" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
text = Space.Host.GetReference("text").UIText 
text.Text = "A very long text a very long text a very long text a very long text"
OVC = function()
  if toggle.IsOn then
    text.ResizeTextForBestFit = true
  else
    text.ResizeTextForBestFit = false
  end
end

toggle.OnValueChanged(OVC)

--the below script will make a slider change the UIText's Best Fit Min Size
--[Add "slider" and "text" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
text = Space.Host.GetReference("text").UIText 
text.Text = "Best Fit Min Size"
text.ResizeTextForBestFit = true

OVC = function()
text.ResizeTextMinSize  = (slider.Value * 20) + 10 -- from 10 to 30
end

slider.OnValueChanged(OVC)

--the below script will make a slider change the UIText's Best Fit Max Size
--[Add "slider" and "text" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
text = Space.Host.GetReference("text").UIText 
text.Text = "Best Fit Max Size"
text.ResizeTextForBestFit = true

OVC = function()
text.ResizeTextMaxSize  = (slider.Value * 50) + 20 -- from 50 to 70
end

slider.OnValueChanged(OVC)

--the below script will make a UIToggle disable/enable the Align By Geometry feature in the UIText
--[Add "toggle" and "text" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
text = Space.Host.GetReference("text").UIText 
text.Text = "Align By Geometry"
OVC = function()
  if toggle.IsOn then
    text.AlignByGeometry  = true
  else
    text.AlignByGeometry  = false
  end
end

toggle.OnValueChanged(OVC)

--the below script will make a slider change the UIText's Font Size
--[Add "slider" and "text" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
text = Space.Host.GetReference("text").UIText 
text.Text = "Text Size Test"

OVC = function()
text.FontSize  = (slider.Value * 40) + 10 -- from 10 to 50
end

slider.OnValueChanged(OVC)

--the below script will make a slider change the UIText's Line Spacing
--[Add "slider" and "text" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
text = Space.Host.GetReference("text").UIText 
text.Text = "Line Spacing Line Spacing Line Spacing Line Spacing Line Spacing"

OVC = function()
text.LineSpacing  = (slider.Value * 2) -- from 0 to 2
end

slider.OnValueChanged(OVC)

thisObject = Space.Host.ExecutingObject
 --get a reference to our object
thisObjectText = thisObject.UIText
 --get a reference to the UIText component in our object 

Space.Log(thisObjectText.PixelsPerUnit)
--Prints the PixelsPerUnit value of this UIText component to the console

thisObject = Space.Host.ExecutingObject
 --get a reference to our object
thisObjectText = thisObject.UIText
 --get a reference to the UIText component in our object 
 
Space.Log(thisObjectText.MinWidth)
--Prints the MinWidth value of this UIText component to the console

--this below script will make clicking this object disable/enable a UIText component

thisGameObject = Space.Host.ExecutingObject

text = Space.Host.GetReference("text").UIText
 
OnClick = function()

  if text.Enabled then
    text.Enabled = false
  else
    text.Enabled = true
  end
  
end

thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "click to hide/show text"
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make a UIText element with this script
--constantly update itself to show the local time
--(Example: UI Text element that shows local clock)
--[This object needs to be a UI Text object. In Unity, Heirarchy -> Create -> UI -> Text]
--<Note: UI Text element could also be in world space if it's canvas is a world space canvas>

thisGameObject = Space.Host.ExecutingObject

OnUpdate = function()
thisGameObject.UIText.Text = Space.LocalTime
end

thisGameObject.SubscribeToEvents()
thisGameObject.OnUpdate(OnUpdate)

--This script dynamically changes the text's color of a GameObject with UIText component.
--For example in a text sign over your shop that you want to make more visually stand out
--or perhaps text decoration during a celebration or a text element in your User Interface or HUD.

thisObject = Space.Host.ExecutingObject
 --get a reference to our object
thisObjectText = thisObject.UIText
 --get a reference to the SUIText component in our object 
colors = {Color.Red, Color.Black, Color.White, Color.Blue, Color.Green, Color.Yellow}
 --here we are holding 6 predefined colors in a Lua Table which we will go through


function ColorChanger()

    while true do
    --infinite loop
    
        for i=1,#colors do
        --For Loop to cycle through all the table items
        thisObjectText.color = colors[i] 
        --this will set the color based on which item in the table we are now at
        coroutine.yield(0.1)
        --this will pause for a tenth of a second before we change to the next color
        end

    end
end


Space.Host.StartCoroutine(ColorChanger) 
--this coroutine will now call our ColorChanger() function which is infinitely changing our text colors between a select range.

SAudioSource

Index

Functions Index

Function Name

Properties Index

Property Name

Functions

Play

void Play ()

Starts playing the audio clip.

Stop

void Stop ()

Stops playing the audio clip.

Pause

void Pause ()

Pauses the audio clip.

UnPause

void UnPause ()

Pauses the audio clip.

PlayOneShot

void PlayOneShot ( clip, float volume)

Plays the audio clip just ones at a desired volume.

Parameter

Type

Description

PlayClipAtPoint

void PlayClipAtPoint ( clip, position, float volume=1f)

Function Description

Parameter

Type

Description

Properties

Enabled

bool Enabled get set

Is the Audio Source component enabled?

Loop

bool Loop get set

Is looping of the sound clip enabled?

DopplerLevel

float DopplerLevel get set

The Doppler level of the Audio Source. (See: Doppler Effect)

Volume

float Volume get set

The Volume level of the Audio Source.

Pitch

float Pitch get set

The Pitch level for the Audio Source.

Time

float Time get set

Playback position in seconds.

TimeSamples

int TimeSamples get set

Playback position in PCM samples.

Length

float Length get

Return Audio Length.

Samples

int Samples get

Return Audio Samples.

IsPlaying

bool IsPlaying get

Is the sound clip playing right now?

PanStereo

float PanStereo get set

Pans the sound to the left or right. Values range from -1 to 1: 0 is the middle, -1 is full left, 1 is full right.

SpatialBlend

float SpatialBlend get set

The level of impact 3D effects make on the AudioSource. 0 - no impact (full 2D sound), 1 - maximum impact (full 3D sound).

Spatialize

bool Spatialize get set

Is spatialization enabled?

SpatializePostEffects

bool SpatializePostEffects get set

Is spatialization enabled before or after other filters are in action?

ReverbZoneMix

float ReverbZoneMix get set

The level at which the audio coming from this Audio Source will be mixed into the global reverb of the scene (accomplished with Reverb Zones).

BypassEffects

bool BypassEffects get set

When true, none of global sound effects (reverbs, filters, etc.) are applied to the audio from this Audio Source.

BypassListenerEffects

bool BypassListenerEffects get set

When true, whichever global effects are set on the Audio Listener will not be applied to the audio from this Audio Source.

BypassReverbZones

bool BypassReverbZones get set

When true, the audio from this Audio Source is not mixed into the global reverb generated through Reverb Zones.

Spread

float Spread get set

The angle of spread of the audio channels in the 3D space (only works for stereo and multichannel audio). 0 by default - all channels are concentrated at the same speaker location, making it "mono".

Priority

int Priority get set

The priority of this Audio Source: when there are more Audio Sources playing than channels available, Priority defines which channels will be discarded in favour of those with a higher priority. 0 is the highest priority, 255 - the lowest.

Mute

bool Mute get set

Is the audio muted? If True, the Volume is set to 0. If False, the Volume is restored to the original level.

MinDistance

float MinDistance get set

At which distance from the Audio Source the sound will begin ceasing? The sound will be heard at its maximum volume within this distance. (Spatial Blend should not be equal to 0 for this property to take effect.)

MaxDistance

float MaxDistance get set

At which distance from the Audio Source the sound will no longer be heard? (Spatial Blend should not be equal to 0 for this property to take effect.)

AudioClip

AudioClip get set

The audio clip that is or will be played by this Audio Source.

GameObject

GameObject get

Returns a reference to the GameObject of this component.

SNavMeshAgent

Index

Functions Index

Function Name

Properties Index

Property Name

Functions

GetAreaCost

float GetAreaCost (int areaIndex)

Function Description

Parameter

Type

Description

Move

void Move ( movement)

Apply relative movement to current position.

Parameter

Type

Description

Resume

void Resume ()

Resume the NavMesh agent.

SetAreaCost

void SetAreaCost (int areaIndex, float cost)

Sets the cost for traversing over areas of the area type.

Parameter

Type

Description

Stop

void Stop ()

To stop the NavMesh agent.

SetDestination

void SetDestination ( position)

Set or update the destination.

Parameter

Type

Description

Warp

void Warp ( position)

Warp to the position you want, also you can set agent's world position and vector to make this act as Move(SVector position).

Parameter

Type

Description

Properties

Enabled

bool Enabled get set

Enable or disable this component.

Accelleration

float Accelleration get set

The maximum acceleration of an agent as it follows a path.

AngularSpeed

float AngularSpeed get set

Maximum turning speed in while following a path.

AreaMask

int AreaMask get set

Specifies which NavMesh area is passable.

AutoRepath

bool AutoRepath get set

Set the agent attempt to acquire a new path if the existing path becomes invalid.

AutoBraking

bool AutoBraking get set

Set the agent brake automatically to avoid overshooting the destination point.

AutoTraverseOffMeshLink

bool AutoTraverseOffMeshLink get set

Set the agent move across OffMeshLinks automatically.

AvoidancePriority

int AvoidancePriority get set

The avoidance priority level.

BaseOffset

float BaseOffset get set

The relative vertical displacement of the GameObject.

DesiredVelocity

DesiredVelocity get

The desired velocity of the agent including any potential contribution from avoidance.

Destination

Destination get set

The desired velocity of the agent including any potential contribution from avoidance.

HasPath

bool HasPath get

Does the agent currently have a path?

Height

float Height get set

The height of the agent for purposes of passing under obstacles, etc.

IsOnNavMesh

bool IsOnNavMesh get

Is the agent currently bound to the navmesh?

IsOnOffMeshLink

bool IsOnOffMeshLink get

Is the agent currently positioned on an OffMeshLink?

IsPathStale

bool IsPathStale get

Is the current path stale?

NextPosition

NextPosition get set

Get or set the simulation position of the navmesh agent.

PathEndPosition

PathEndPosition get

End positon of navigation.

PathPending

bool PathPending get

Is a path in the process of being computed but not yet ready?

Radius

float Radius get set

The avoidance radius for the agent.

RemainingDistance

float RemainingDistance get

The distance between the agent's position and the destination on the current path.

Speed

float Speed get set

Maximum movement speed when following a path.

SteeringTarget

SteeringTarget get

Get the current steering target along the path.

StoppingDistance

float StoppingDistance get set

Stop within this distance from the target position.

UpdatePosition

bool UpdatePosition get set

Get or set whether the transform position is synchronized with the simulated agent position.

UpdateRotation

bool UpdateRotation get set

Should the agent update the transform orientation?

Velocity

Velocity get

access the current velocity of the NavMeshAgent component, or set a velocity to control the agent manually.

GameObject

GameObject get

Property Description

--This script will make an input field update a text field 
--with character count in real-time every time a character is typed/removed
--[Text field and Input fields need to be added as references (scripting runtime)]

thisObject = Space.Host.ExecutingObject
inputField = Space.Host.GetReference("The Input Field").UIInputField
textField = Space.Host.GetReference("The Text Field").UIText

OnValueChanged = function()
 textField.Text =  "Count= " .. string.len(inputField.Text)
end

thisObject.UIInputField.OnValueChanged(OnValueChanged)

--This script will make an input field update a text field 
--as soon as someone has finished typing in it
--Text field and Input fields need to be added as references (scripting runtime)

thisObject = Space.Host.ExecutingObject
inputField = Space.Host.GetReference("The Input Field").UIInputField
textField = Space.Host.GetReference("The Text Field").UIText

OnEndEdit = function()
 textField.Text = inputField.Text
end

Space.Host.ExecutingObject.UIInputField.OnEndEdit(OnEndEdit)

--the below script makes this object set Browser URL according to what's written in text field
--[Required: This object needs a Browser and InputField objects to be added as reference to references section in Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
webBrowser = Space.Host.GetReference("Browser")
urlField = Space.Host.GetReference("URL Field")

OnClick = function()

webBrowser.Browser.SetURL = urlField.UIInputField.Text

end

urlField.UIInputField.Text = https://www.youtube.com
thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click to set URL"
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will toggle a UIInputField's Enabled status

thisGameObject = Space.Host.ExecutingObject
inputfield = Space.Host.GetReference("inputfield").UIInputField 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
inputfield.Enabled =  not inputfield.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will toggle a UIInputField's interactable status
thisGameObject = Space.Host.ExecutingObject
inputfield = Space.Host.GetReference("inputfield").UIInputField 
--make sure to add this reference to the Scripting Runtime component



OnClick = function()
inputfield.Interactable =  not inputfield.Interactable
end



thisGameObject.AddClickable()


thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will toggle a UIInputField's ReadOnly status

thisGameObject = Space.Host.ExecutingObject
inputfield = Space.Host.GetReference("inputfield").UIInputField 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
inputfield.ReadOnly =  not inputfield.ReadOnly
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

-- For example, we have a short chime that we want to play every time a new avatar joins the scene.
hostObject = Space.Host.ExecutingObject

function welcomeSound ()
hostObject.Audio.Play()
end

Space.Scene.OnPlayerJoin(welcomeSound)

hostObject = Space.Host.ExecutingObject;

function audioOnOff ()
if hostObject.Audio.IsPlaying then
hostObject.Audio.Stop();
else
hostObject.Audio.Play();
end
Space.Log(hostObject.Audio.IsPlaying);
end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(audioOnOff);
-- Now, we can make the sound play or stop playing just by clicking the object.

hostObject = Space.Host.ExecutingObject;

function pauseOnOff ()
if hostObject.Audio.IsPlaying then
hostObject.Audio.Pause();
else
hostObject.Audio.UnPause();
end
Space.Log(hostObject.Audio.IsPlaying);
end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(pauseOnOff);
-- Now, every time an object is clicked, the sound clip is paused/unpaused

hostObject = Space.Host.ExecutingObject;

function pauseOnOff ()
if hostObject.Audio.IsPlaying then
hostObject.Audio.Pause();
else
hostObject.Audio.UnPause();
end
Space.Log(hostObject.Audio.IsPlaying);
end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(pauseOnOff);
-- Now, every time an object is clicked, the sound clip is paused/unpaused

hostObject = Space.Host.ExecutingObject;

function playOnce ()
hostObject.Audio.PlayOneShot(Space.Resources[0],0.5);
end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(playOnce);
-- Now, every time the object is clicked, a sound clip we have in Scripting Runtime Resources is played at half the volume.

-- This happens regardless if the audio clip in the AudioClip property is playing or not.

hostObject = Space.Host.ExecutingObject;

function audioOnOff ()
hostObject.Audio.Enabled = not hostObject.Audio.Enabled;
Space.Log(hostObject.Audio.Enabled);
end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(audioOnOff);
-- When the host object is clicked, the Audio Source component gets enabled, if it was disabled,
-- or disabled, if it was enabled, and its new state is printed to the console.

--the below script will make the object toggle it's Loop option OnClick
--[Add "audio" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
audio = Space.Host.GetReference("audio").Audio


OnClick = function()
audio.Loop =  not audio.Loop
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make a slider change the Audio Source's Doppler Level
--[Add "slider" and "audio" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
audio = Space.Host.GetReference("audio").Audio


OVC = function()
audio.DopplerLevel = slider.Value * 5 --0 to 5
end

slider.OnValueChanged(OVC)

hostObject = Space.Host.ExecutingObject;
Space.Log(hostObject.Audio.Volume);
-- 1 by default

function audioVolumeDecr ()
if hostObject.Audio.Volume > 0 then
hostObject.Audio.Volume = hostObject.Audio.Volume - 0.2;
end
Space.Log(hostObject.Audio.Volume);
end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(audioVolumeDecr);
-- Now, every time we click this object, the Volume level is decreased by 0.2, until it reaches 0.

hostObject = Space.Host.ExecutingObject;
Space.Log(hostObject.Audio.Pitch);
-- 1 by default

function audioPitchChange ()
if hostObject.Audio.Pitch < 3 then
hostObject.Audio.Pitch = hostObject.Audio.Pitch + 0.5;
end
Space.Log(hostObject.Audio.Pitch);
end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(audioPitchChange);
-- Now, every time we click this object, the Pitch level is increased by 0.5, until it reaches 3.

--the below script will make a slider set Audio Source's playback position (using seconds)
--[Add "slider" and "audio" references to the Scripting Runtime component]


slider = Space.Host.GetReference("slider").UISlider
audio = Space.Host.GetReference("audio").Audio


OVC = function()
audio.Time = slider.Value * audio.Length -- from 0 to Length of clip
end

slider.OnValueChanged(OVC)

--the below script will make a slider set Audio Source's playback position (using PCM Samples)
--[Add "slider" and "audio" references to the Scripting Runtime component]

slider = Space.Host.GetReference("slider").UISlider
audio = Space.Host.GetReference("audio").Audio


OVC = function()
audio.TimeSamples = slider.Value * audio.Samples -- from 0 to number of samples
end


slider.OnValueChanged(OVC)

--the below script will make a slider set Audio Source's playback position (using seconds)
--[Add "slider" and "audio" references to the Scripting Runtime component]


slider = Space.Host.GetReference("slider").UISlider
audio = Space.Host.GetReference("audio").Audio


OVC = function()
audio.Time = slider.Value * audio.Length -- from 0 to Length of clip
end

slider.OnValueChanged(OVC)

--the below script will make a slider set Audio Source's playback position (using PCM Samples)
--[Add "slider" and "audio" references to the Scripting Runtime component]

slider = Space.Host.GetReference("slider").UISlider
audio = Space.Host.GetReference("audio").Audio


OVC = function()
audio.TimeSamples = slider.Value * audio.Samples -- from 0 to number of samples
end


slider.OnValueChanged(OVC)

 --this script will play a looping sound only if someone is using the seat
 --and will stop the sound if someone is not
--(Example: carnival game )
--[Object must contain a Seat component and AudioSource component]

thisGameObject = Space.Host.ExecutingObject


OnUpdate = function()
  if thisGameObject.Seat.InUse then
        if not thisGameObject.Audio.IsPlaying then
        thisGameObject.Audio.Play()
        end
  else
       if thisGameObject.Audio.IsPlaying then
        thisGameObject.Audio.Stop()
        end
  end
end

thisGameObject.Audio.Loop = true
thisGameObject.SubscribeToEvents()
thisGameObject.OnUpdate(OnUpdate)

--the below script will make a slider set the Stereo Pan 
--[Add "slider" and "audio" references to the Scripting Runtime component]


slider = Space.Host.GetReference("slider").UISlider
audio = Space.Host.GetReference("audio").Audio


OVC = function()
audio.PanStereo = (slider.Value * 2) - 1 --(from -1 left to +1 right)
end

slider.OnValueChanged(OVC)

hostObject = Space.Host.ExecutingObject;

function spBlendChange ()
if hostObject.Audio.SpatialBlend < 1 then
hostObject.Audio.SpatialBlend = hostObject.Audio.SpatialBlend + 0.2;
else
hostObject.Audio.SpatialBlend = 0;
end
Space.Log(hostObject.Audio.SpatialBlend);
end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(spBlendChange);
-- Spatial Blend is increased by 0.2 every time the object is clicked, until it reaches 1.

-- Then with the next click, it resets back to 0.

--the below script will make the object toggle it's Spatialize feature OnClick
--[Add "audio" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
audio = Space.Host.GetReference("audio").Audio


OnClick = function()
audio.Spatialize =  not audio.Spatialize
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make the object toggle it's Spatialize Post Effects feature OnClick
--[Add "audio" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
audio = Space.Host.GetReference("audio").Audio


OnClick = function()
audio.SpatializePostEffects =  not audio.SpatializePostEffects
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

exa--the below script will make a slider set the Reverb Zone Mix value
--[Add "slider" and "audio" references to the Scripting Runtime component]


slider = Space.Host.GetReference("slider").UISlider
audio = Space.Host.GetReference("audio").Audio


OVC = function()
audio.ReverbZoneMix  = (slider.Value * 1.1) --(from 0.0 to 1.1)
end

slider.OnValueChanged(OVC)

--the below script will make the object toggle it's Bypass Effects feature OnClick
--[Add "audio" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
audio = Space.Host.GetReference("audio").Audio


OnClick = function()
audio.BypassEffects =  not audio.BypassEffects
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make the object toggle it's Bypass Listener Effects feature OnClick
--[Add "audio" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
audio = Space.Host.GetReference("audio").Audio


OnClick = function()
audio.BypassListenerEffects =  not audio.BypassListenerEffects
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make the object toggle it's Bypass Reverb Zones feature OnClick
--[Add "audio" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
audio = Space.Host.GetReference("audio").Audio


OnClick = function()
audio.BypassReverbZones =  not audio.BypassReverbZones
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

hostObject = Space.Host.ExecutingObject;

function increaseSpread ()
if hostObject.Audio.Spread < 360 then
hostObject.Audio.Spread = hostObject.Audio.Spread + 90;
end
Space.Log(hostObject.Audio.Spread);
end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(increaseSpread);
-- Every time an object is clicked, the spread increases by 90 degrees - compare the sound at different angles of spread!

hostObject = Space.Host.ExecutingObject;

function changePriority ()
if hostObject.Audio.Priority == 0 then
hostObject.Audio.Priority = 255;
else
hostObject.Audio.Priority = 0;
end
Space.Log(hostObject.Audio.Priority);
end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(changePriority);
-- Now the Audio Source alternates between the highest and the lowest priorities.
-- This can be useful, for example, in a scene with an ambient sound set at Priority 128, where we have a speaker, which plays a certain looped audio nonstop.
-- When we want to hear the audio, we change it to the highest priority, so it blocks the ambient sound.
-- When we don't, we change it to the lowest, and the ambient sound dominates the scene again.

hostObject = Space.Host.ExecutingObject;

function muteOnOff ()
hostObject.Audio.Mute = not hostObject.Audio.Mute;
Space.Log(hostObject.Audio.Mute);
end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(muteOnOff);
-- Now clicking the object works like the Mute button.

--the below script will make a slider set the Minimum Distance
--[Add "slider" and "audio" references to the Scripting Runtime component]


slider = Space.Host.GetReference("slider").UISlider
audio = Space.Host.GetReference("audio").Audio


OVC = function()
audio.MinDistance  = (slider.Value * 20) + 10 --(from 10 to 30)
end

slider.OnValueChanged(OVC)

--the below script will make a slider set the Maximum Distance
--[Add "slider" and "audio" references to the Scripting Runtime component]


slider = Space.Host.GetReference("slider").UISlider
audio = Space.Host.GetReference("audio").Audio


OVC = function()
audio.MaxDistance  = (slider.Value * 40) + 60 --(from 60 to 100)
end

slider.OnValueChanged(OVC)

-- In this example, there are 3 audio clips in Scripting Runtime Resources
hostObject = Space.Host.ExecutingObject;
local nextTrack = 0;

function changeTrack ()
hostObject.Audio.AudioClip = Space.Resources[nextTrack];
hostObject.Audio.Play();
Space.Log(Space.Resources[nextTrack].Name);
if nextTrack == 2 then -- replace 2 with n-1, where n is the amount of audio clips you have added to Resources
nextTrack = 0;
else
nextTrack = nextTrack + 1;
end
end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(changeTrack);
-- Now, every time the object is clicked, the next audio clip is played.
-- What's more, the list is looped (the index resets back to 0 when it gets to the end of the list)!

agentobject = Space.Scene.Find("Cube")
agent = agentobject.NavMeshAgent
if agent == nil then
    agent = Space.Scene.Find("Cube").AddNavMeshAgent()
end
counts = 0
--stop first, then resume.
function StopAndResume()
    counts = counts +1
    if counts > 10 then
      agent.Stop()
    end
    if counts > 50 then
      agent.Resume()
    end
end
agentobject.SubscribeToEvents()
agentobject.OnUpdate(StopAndResume)
agent.Destination = Space.Scene.Find("TargetTransform").WorldPosition
--set destination.

--clicking this object will Enable/Disable it's Nav Mesh Agent component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.NavMeshAgent

OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

local thisObject=Space.Host.ExecutingObject
local thisObjectResource=thisObject.Resources.GetResource("Test")
if thisObjectResource == nil then
    Space.Log("That resource was not found.")
else
    Space.Log("That resource exists and can be used.")
end

STrailRenderer

Index

Functions Index

Function Name

Properties Index

Property Name

Functions

Clear

void Clear ()

Function Description

Parameter

Type

Description

GetPosition

GetPosition (int index)

Get the position of a vertex in the trail.

Parameter

Type

Description

Properties

Enabled

bool Enabled get set

Whether this TrailRenderer component is Enabled.

ReceiveShadows

bool ReceiveShadows get set

Does this object receive shadows?

IsVisible

bool IsVisible get

Is this renderer visible in any camera?

CastShadows

bool CastShadows get set

Does the trail cast a shadow when a shadow-casting Light shines on it?

MotionVectors

bool MotionVectors get set

Set whether to use motion vectors to track this Renderer’s per-pixel, screen-space motion from one frame to the next. You can use this information to apply post-processing effects such as motion blur.

UseLightProbes

bool UseLightProbes get set

Enable Light Probes on the trail.

Time

float Time get set

How long does the trail take to fade out. (seconds)

StartWidth

float StartWidth get set

The width of the trail at the spawning point. A width of 1 corresponds to 1 unit in the game world.

EndWidth

float EndWidth get set

The width of the trail at the end of the trail. A width of 1 corresponds to 1 unit in the game world.

WidthMultiplier

float WidthMultiplier get set

Set an overall multiplier that is applied to the TrailRenderer.widthCurve to get the final width of the trail.

StartColor

StartColor get set

Set the color at the start of the trail.

EndColor

EndColor get set

Set the color at the end of the trail.

Autodestruct

bool Autodestruct get set

Does the GameObject of this Trail Renderer auto destruct?

NumCornerVertices

int NumCornerVertices get set

Set this to a value greater than 0, to get rounded corners between each segment of the trail.

NumCapVertices

int NumCapVertices get set

Set this to a value greater than 0, to get rounded corners on each end of the trail.

MinVertexDistance

float MinVertexDistance get set

Set the minimum distance the trail can travel before a new vertex is added to it. Smaller values with give smoother trails, consisting of more vertices, but costing more performance.

TextureMode

int TextureMode get set

Choose whether the U coordinate of the trail texture is tiled or stretched. 0 Stretch, 1 Tile, 2 Distribute Per Segment, 3 Repeat Per Segment

Alignment

int Alignment get set

Property Description

PositionCount

int PositionCount get

Get the number of line segments in the trail.

GameObject

SGameObject GameObject get

Property Description

spawningparticles = Space.Scene.Find("Particles")
--get particle object and get the particle system component on it.
particles=spawningparticles.ParticleSystem
--set random seed.
particles.UseAutoRandomSeed = false
particles.RandomSeed = 123456

--Clicking the object Enables/Disables the Trail Renderer component on this object  
--[Add "trailrenderer" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OnClick = function()
trailrenderer.Enabled =  not trailrenderer.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--Make a UIToggle disable/enable the Receive Shadows feature of a Trail Renderer
--[Add "toggle" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer

toggle.IsOn = trailrenderer.ReceiveShadows  --make toggle start at correct state

OVC = function()
  if toggle.IsOn then
    trailrenderer.ReceiveShadows  = true
  else
    trailrenderer.ReceiveShadows  = false
  end
end

toggle.OnValueChanged(OVC)

--Make a UIToggle disable/enable the Cast Shadows feature of a Trail Renderer
--[Add "toggle" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer

toggle.IsOn = trailrenderer.CastShadows  --make toggle start at correct state

OVC = function()
  if toggle.IsOn then
    trailrenderer.CastShadows  = true
  else
    trailrenderer.CastShadows  = false
  end
end

toggle.OnValueChanged(OVC)

--Make a UIToggle disable/enable the Motion Vectors feature of a Trail Renderer
--[Add "toggle" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer

toggle.IsOn = trailrenderer.MotionVectors  --make toggle start at correct state

OVC = function()
  if toggle.IsOn then
    trailrenderer.MotionVectors  = true
  else
    trailrenderer.MotionVectors  = false
  end
end

toggle.OnValueChanged(OVC)

--Make a UIToggle disable/enable the Light Probes feature of a Trail Renderer
--[Add "toggle" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer

toggle.IsOn = trailrenderer.UseLightProbes  --make toggle start at correct state

OVC = function()
  if toggle.IsOn then
    trailrenderer.UseLightProbes  = true
  else
    trailrenderer.UseLightProbes  = false
  end
end

toggle.OnValueChanged(OVC)

--Make a slider change the Trail Renderer's Time
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.Time = slider.Value * 10 --0 to 10
end

slider.OnValueChanged(OVC)

--Make a slider change the Trail Renderer's Start Width
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.StartWidth = slider.Value * 10 --0 to 10
end

slider.OnValueChanged(OVC)

--Make a slider change the Trail Renderer's End Width
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.EndWidth = slider.Value * 10 --0 to 10
end

slider.OnValueChanged(OVC)

--Make a slider change the Trail Renderer's Width Multiplier
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.WidthMultiplier = slider.Value * 10 --0 to 10
end

slider.OnValueChanged(OVC)

--makes UIButton open a color picker to change TrailRenderer's Start Color
--[Add "button" and "trailrenderer" references to the Scripting Runtime component]

button = Space.Host.GetReference("button").UIButton 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer
originalColor = trailrenderer.StartColor

OnChange = function(SColor) 
 trailrenderer.StartColor = SColor
end

OnSelect = function(SColor)
 trailrenderer.StartColor = SColor
end

OnCancel = function()
  trailrenderer.StartColor = originalColor 
end

OnClick = function()
Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)
end


button.OnClick(OnClick)

--makes UIButton open a color picker to change TrailRenderer's End Color
--[Add "button" and "trailrenderer" references to the Scripting Runtime component]

button = Space.Host.GetReference("button").UIButton 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer
originalColor = trailrenderer.EndColor

OnChange = function(SColor) 
 trailrenderer.EndColor = SColor
end

OnSelect = function(SColor)
 trailrenderer.EndColor = SColor
end

OnCancel = function()
  trailrenderer.EndColor = originalColor 
end

OnClick = function()
Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)
end


button.OnClick(OnClick)

--Make a UIToggle disable/enable the Autodestruct feature of a Trail Renderer
--[Add "toggle" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer

toggle.IsOn = trailrenderer.Autodestruct  --make toggle start at correct state

OVC = function()
  if toggle.IsOn then
    trailrenderer.Autodestruct  = true
  else
    trailrenderer.Autodestruct  = false
  end
end

toggle.OnValueChanged(OVC)

--Make a slider change the Trail Renderer's Number of Corner Vertices
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.NumCornerVertices = slider.Value * 90 --0 to 90
end

slider.OnValueChanged(OVC)

--Make a slider change the Trail Renderer's Number of End Cap Vertices
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.NumCapVertices = slider.Value * 90 --0 to 90
end

slider.OnValueChanged(OVC)

--Make a slider change the Trail Renderer's Number of Mininum Vertex Distance
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.MinVertexDistance = slider.Value * 10 --0 to 10
end

slider.OnValueChanged(OVC)

--Clicking the object toggles between TrailRenderer's 4 different Texture Modes
--[Add "trailrenderer" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OnClick = function()
  if trailrenderer.TextureMode == 3 then
    trailrenderer.TextureMode = 0
  else
    trailrenderer.TextureMode = trailrenderer.TextureMode + 1
  end
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--Clicking the object toggles between TrailRenderer's View or Transform Z alignment
--[Add "trailrenderer" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OnClick = function()
  if trailrenderer.Alignment == 0 then
    trailrenderer.Alignment = 1
  else
    trailrenderer.Alignment = 0
  end
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

SLineRenderer

Index

Functions Index

Function Name

Properties Index

Property Name

Functions

SetPosition

void SetPosition (int index, position)

Set the position of a vertex in the line.

Parameter

Type

Description

GetPosition

GetPosition (int index)

Get the position of a vertex in the line

Parameter

Type

Description

SetPositions

void SetPositions ([] positions)

Set the positions of all vertices in the line.

Parameter

Type

Description

GetPositions

[] GetPositions ()

Get the positions of all vertices in the line.

SetWidth

void SetWidth (float start, float end)

Set width at start and end

Parameter

Type

Description

SetColors

void SetColors ( start, end)

Set color at start and end (Line shader necessary)

Parameter

Type

Description

Properties

Enabled

bool Enabled get set

Makes the renderer visible if enabled.

ReceiveShadows

bool ReceiveShadows get set

Enable this option to make the line display any shadows that are cast upon it.

IsVisible

bool IsVisible get

To check if this renderer is visible.

CastShadows

bool CastShadows get set

Specify if and how the line casts shadows when a suitable Light shine on it.

MotionVectors

bool MotionVectors get set

Specifies whether this renderer has a per-object motion vector pass. If set to true, this object will have a per-object motion vector pass rendered

UseLightProbes

bool UseLightProbes get set

The light probe interpolation type.

StartWidth

float StartWidth get set

Set the width at the start of the line.

EndWidth

float EndWidth get set

Set the width at the end of the line.

WidthMultiplier

float WidthMultiplier get set

Set an overall multiplier that is applied to the LineRenderer.widthCurve to get the final width of the line.

StartColor

StartColor get set

Set the color at the start of the line.

EndColor

EndColor get set

Set the color at the end of the line.

PositionCount

int PositionCount get set

Set/get the number of vertices.

UseWorldSpace

bool UseWorldSpace get set

If enabled, the points are considered as world space coordinates. If disabled, they are local to the transform of the GameObject to which this component is attached.

Loop

bool Loop get set

Enable this to connect the first and last positions of the line, and form a closed loop.

NumCornerVertices

int NumCornerVertices get set

Set this to a value greater than 0, to get rounded corners between each segment of the line.

NumCapVertices

int NumCapVertices get set

Set this to a value greater than 0, to get rounded corners on each end of the line.

TextureMode

int TextureMode get set

Control how the Texture is applied to the line. (0-3)

Alignment

int Alignment get set

Set the direction that the line faces. (0 or 1)

GameObject

GameObject get

Property Description

local obj = Space.Host.ExecutingObject;

obj.Rigidbody.AddExplosionForce (300, obj.WorldPosition, 10, 20)
-- The explosion will occur at the location of the ExecutingObject.
-- Place other rigidbodies around it to observe the effect!

local obj = Space.Host.ExecutingObject;
local applyForceHere = Vector.New(obj.WorldPosition.x-0.5,obj.WorldPosition.y-0.5,obj.WorldPosition.z-0.5)
-- This vector is equivalent to one of the lower corners of a 1x1x1 cube.

obj.Rigidbody.AddForceAtPosition (Vector.New(0,40,0), applyForceHere);
-- The object is experiencing an effect similar to being tipped upwards at the aforementioned corner.

local obj = Space.Host.ExecutingObject;

Space.Log(obj.Rigidbody.ClosestPointOnBounds (Vector.Zero));
-- prints [x,y,z] to the console, where x,y,z are coordinates of the rigidbody's point that is the closest to the global origin

local obj = Space.Host.ExecutingObject;
local moveHere = Vector.New(obj.WorldPosition.x+10,obj.WorldPosition.y,obj.WorldPosition.z);

obj.Rigidbody.MovePosition (moveHere);
-- The object has been moved by 10 units in the positive X direction

local obj = Space.Host.ExecutingObject;
local setRotationTo = Quaternion.Euler(60,0,0)

obj.Rigidbody.MoveRotation (setRotationTo);
-- The object's rotation has been set to 60 degrees in the positive X direction and 0 in Y and Z

local obj = Space.Host.ExecutingObject;

obj.Rigidbody.CenterOfMass = Vector.New(1,1,1);
Space.Log(obj.Rigidbody.CenterOfMass);
-- prints "[1,1,1]" to the console

obj.Rigidbody.ResetCenterOfMass();
Space.Log(obj.Rigidbody.CenterOfMass);
-- prints "[0,0,0]" to the console

solid = Space.Scene.Find("Solid")
--get rigidbody of inertia frame.
rigid = solid.Rigidbody
if rigid == nil then
    rigid = solid.AddRigidbody()
end
rigid.ResetIntertiaTensor()
--to reset inertia tensor if intertia tensor is set

solid = Space.Scene.Find("Solid")
--get rigidbody of inertia frame.
rigid = solid.Rigidbody
if rigid == nil then
    rigid = solid.AddRigidbody()
end
hits = rigid.SweepTestAll(solid.Forward , 20)
--sweep forward 20 meters, and return all hits.
if hits~=nil and #hits-1 > 0 then
    for i = 1,#hits-1 do
        Space.Log(hits[i].Object.Name)
    end
end
--output all hit gameobject.

local obj = Space.Host.ExecutingObject;

-- Set a new angular velocity vector
obj.Rigidbody.AngularVelocity = Vector.New(0,Space.Math.Pi,0);
-- Now the object is rotating about the Y axis at a speed of 180 degrees per second
-- (or 30 revolutions per minute)

-- Get the current angular velocity vector
Space.Log(obj.Rigidbody.AngularVelocity);
-- prints "[0, 3.141593, 0]" to the console

local obj = Space.Host.ExecutingObject;

-- Set UseGravity to False (it is set to True by default)
obj.Rigidbody.UseGravity = false;
-- Now gravity does not affect the rigidbody.

-- Get the UseGravity value (find out if UseGravity is in action)
Space.Log(obj.Rigidbody.UseGravity);
-- prints "False" to the console

local obj = Space.Host.ExecutingObject;

-- Set a new velocity vector
obj.Rigidbody.Velocity = Vector.New(0, 0, 1);
-- Now the object is moving in the positive Z direction at a speed of 1 unit per second

-- Get the current velocity vector
Space.Log(obj.Rigidbody.Velocity);
-- prints "[0, 0, 1]" to the console

local obj = Space.Host.ExecutingObject;

-- Get the current center of mass
Space.Log(obj.Rigidbody.WorldCenterOfMass);
-- prints "[x, y, z]" to the console, where x,y,z are global coordinates of the center of mass. If CenterOfMass == [0,0,0], then x,y,z are equal to the global coordinates of the object.

local obj = Space.Host.ExecutingObject;

obj.Rigidbody.Sleep();
Space.Log(obj.Rigidbody.Sleeping);
-- prints "True" to the console

obj.Rigidbody.WakeUp();
Space.Log(obj.Rigidbody.Sleeping);
-- prints "False" to the console

local obj = Space.Host.ExecutingObject;

Space.Log(obj.Rigidbody.Mass);
-- prints "1" to the console
obj.LocalScale = Vector.New(2,2,2);
obj.Rigidbody.Density = 0.5;
Space.Log(obj.Rigidbody.Mass);
-- prints "4" to the console - the density is 2 times lower, and the object is 8 times bigger, therefore it's 4 times heavier.

solid = Space.Scene.Find("Solid")
--get rigidbody of inertia frame.
rigid = solid.Rigidbody
if rigid == nil then
    rigid = solid.AddRigidbody()
end
rigid.InertiaTensor = Vector.New(10,100,1)
rigid.AddTorque(Vector.New(100,100,100))
--set inertia tensor to 10,100,1, and add torque 100 to all axis,and rotate velocity x:y:z would be 10:1:100.

solid = Space.Scene.Find("Solid")
--get rigidbody of inertia frame.
rigid = solid.Rigidbody
if rigid == nil then
    rigid = solid.AddRigidbody()
end
rigid.InertiaTensor = Vector.New(10,100,1)
rigid.InertiaTensorRotation = Quaternion.Euler(0,90,0)
rigid.AddTorque(Vector.New(100,100,100))
--set inertia tensor manually and rotate this inertia tensor by 90 degrees in y axis.

--this object will continuously render a line between two different game objects

refObject1 = Space.Host.GetReference("object1") --Add in References section of Scripting Runtime Component
refObject2 = Space.Host.GetReference("object2") --Add in References section of Scripting Runtime Component

thisObject = Space.Host.ExecutingObject

function OnUpdateFunction()
  thisObject.LineRenderer.PositionCount = 2 --this is necessary 

  thisObject.LineRenderer.SetPosition(1,refObject1.WorldPosition)
  thisObject.LineRenderer.SetPosition(2,refObject2.WorldPosition)

end

thisObject.OnUpdate(OnUpdateFunction)

--this object will continuously render a line between two different game objects

refObject1 = Space.Host.GetReference("object1") --Add in References section of Scripting Runtime Component
refObject2 = Space.Host.GetReference("object2") --Add in References section of Scripting Runtime Component

thisObject = Space.Host.ExecutingObject

function OnUpdateFunction()
  thisObject.LineRenderer.PositionCount = 2 --this is necessary
  thisObject.LineRenderer.SetPositions({refObject1.WorldPosition,refObject2.WorldPosition})

end

thisObject.OnUpdate(OnUpdateFunction)

--the below script will make a slider set both the Line Renderer's Start Width and End Width
thisGameObject = Space.Host.ExecutingObject

refSlider = Space.Host.GetReference("Slider") --Add Reference to Scripting Runtime Component
refLineRenderer = Space.Host.GetReference("LineRenderer") --Add Reference to Scripting Runtime Component



OVC = function()
  local width = (refSlider.UISlider.Value * 5)  -- from 0 to 5
  refLineRenderer.LineRenderer.SetWidth(width,width)
end

refSlider.UISlider.OnValueChanged(OVC)

--clicking the object will open a color picker that changes both Line Renderer's Start Color and End Color

thisGameObject = Space.Host.ExecutingObject
originalStartColor = thisGameObject.LineRenderer.StartColor
originalEndColor = thisGameObject.LineRenderer.EndColor

OnChange = function(SColor) 
  thisGameObject.LineRenderer.SetColors(SColor,SColor) 
end

OnSelect = function(SColor)
    thisGameObject.LineRenderer.SetColors(SColor,SColor) 
end

OnCancel = function()
   thisGameObject.LineRenderer.SetColors(originalStartColor,originalEndColor) 
end

OnClick = function()
  Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalStartColor)
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object toggles it's LineRenderer component On/Off

thisObject = Space.Host.ExecutingObject

function OnClickFunction()
  thisObject.LineRenderer.Enabled =  not thisObject.LineRenderer.Enabled
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object toggles it's Recieve Shadows options

thisObject = Space.Host.ExecutingObject

function OnClickFunction()
  thisObject.LineRenderer.ReceiveShadows =  not thisObject.LineRenderer.ReceiveShadows
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object toggles it's Line Renderer's Motion Vectors (Per Object Motion or Force no motion)
thisObject = Space.Host.ExecutingObject

function OnClickFunction()
  thisObject.LineRenderer.MotionVectors =  not thisObject.LineRenderer.MotionVectors
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object toggles it's Light Probe between Off and Blend Mode

thisObject = Space.Host.ExecutingObject

function OnClickFunction()
  thisObject.LineRenderer.UseLightProbes =  not thisObject.LineRenderer.UseLightProbes
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--the below script will make a slider change the Line Renderers start width


thisGameObject = Space.Host.ExecutingObject

refSlider = Space.Host.GetReference("Slider") --Add Reference to Scripting Runtime Component
refLineRenderer = Space.Host.GetReference("LineRenderer") --Add Reference to Scripting Runtime Component

refSlider.UISlider.Value = refLineRenderer.LineRenderer.StartWidth / 2 --initial position of slider

OVC = function()
  refLineRenderer.LineRenderer.StartWidth = (refSlider.UISlider.Value * 2)  -- from 0 to 2
end

refSlider.UISlider.OnValueChanged(OVC)

--the below script will make a slider change the Line Renderer's End Width
thisGameObject = Space.Host.ExecutingObject

refSlider = Space.Host.GetReference("Slider") --Add Reference to Scripting Runtime Component
refLineRenderer = Space.Host.GetReference("LineRenderer") --Add Reference to Scripting Runtime Component

refSlider.UISlider.Value = refLineRenderer.LineRenderer.EndWidth / 2 --initial position of slider

OVC = function()
  refLineRenderer.LineRenderer.EndWidth = (refSlider.UISlider.Value * 2)  -- from 0 to 2
end

refSlider.UISlider.OnValueChanged(OVC)

--the below script will make a slider change the Line Renderer's Width Multiplier
thisGameObject = Space.Host.ExecutingObject

refSlider = Space.Host.GetReference("Slider") --Add Reference to Scripting Runtime Component
refLineRenderer = Space.Host.GetReference("LineRenderer") --Add Reference to Scripting Runtime Component

refSlider.UISlider.Value = refLineRenderer.LineRenderer.WidthMultiplier / 5 --initial position of slider

OVC = function()
  refLineRenderer.LineRenderer.WidthMultiplier = (refSlider.UISlider.Value * 5)  -- from 0 to 5
end

refSlider.UISlider.OnValueChanged(OVC)

--clicking the object will open a color picker that changes the Line Renderer's Start Color

thisGameObject = Space.Host.ExecutingObject
originalColor = thisGameObject.LineRenderer.StartColor

OnChange = function(SColor) 
  thisGameObject.LineRenderer.StartColor = SColor
end

OnSelect = function(SColor)
  thisGameObject.LineRenderer.StartColor = SColor
end

OnCancel = function()
  thisGameObject.LineRenderer.StartColor = originalColor
end

OnClick = function()
  Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking the object will open a color picker that changes the Line Renderer's End Color

thisGameObject = Space.Host.ExecutingObject
originalColor = thisGameObject.LineRenderer.EndColor

OnChange = function(SColor) 
  thisGameObject.LineRenderer.EndColor = SColor
end

OnSelect = function(SColor)
  thisGameObject.LineRenderer.EndColor = SColor
end

OnCancel = function()
  thisGameObject.LineRenderer.EndColor = originalColor
end

OnClick = function()
  Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--the below script will make a slider change the Line Renderer's Position Count
thisGameObject = Space.Host.ExecutingObject

refSlider = Space.Host.GetReference("Slider") --Add Reference to Scripting Runtime Component
refLineRenderer = Space.Host.GetReference("LineRenderer") --Add Reference to Scripting Runtime Component

refSlider.UISlider.Value = refLineRenderer.LineRenderer.PositionCount  / 20 --initial position of slider

OVC = function()
  refLineRenderer.LineRenderer.PositionCount  = refSlider.UISlider.Value * 20  -- from 0 to 20
end

refSlider.UISlider.OnValueChanged(OVC)

--clicking this object toggles it's Use World Space option

thisObject = Space.Host.ExecutingObject

function OnClickFunction()
  thisObject.LineRenderer.UseWorldSpace = not   thisObject.LineRenderer.UseWorldSpace

end


thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object toggles it's Loop option

thisObject = Space.Host.ExecutingObject

function OnClickFunction()
  thisObject.LineRenderer.Loop = not   thisObject.LineRenderer.Loop

end


thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--the below script will make a slider change the Line Renderer's Corner Vertices
thisGameObject = Space.Host.ExecutingObject

refSlider = Space.Host.GetReference("Slider") --Add Reference to Scripting Runtime Component
refLineRenderer = Space.Host.GetReference("LineRenderer") --Add Reference to Scripting Runtime Component

refSlider.UISlider.Value = refLineRenderer.LineRenderer.NumCornerVertices  / 10 --initial position of slider

OVC = function()
  refLineRenderer.LineRenderer.NumCornerVertices  = refSlider.UISlider.Value * 10  -- from 0 to 10
end

refSlider.UISlider.OnValueChanged(OVC)

--the below script will make a slider change the Line Renderer's End Cap Vertices
thisGameObject = Space.Host.ExecutingObject

refSlider = Space.Host.GetReference("Slider") --Add Reference to Scripting Runtime Component
refLineRenderer = Space.Host.GetReference("LineRenderer") --Add Reference to Scripting Runtime Component

refSlider.UISlider.Value = refLineRenderer.LineRenderer.NumCapVertices  / 20 --initial position of slider

OVC = function()
  refLineRenderer.LineRenderer.NumCapVertices  = refSlider.UISlider.Value * 20  -- from 0 to 10
end

refSlider.UISlider.OnValueChanged(OVC)

--clicking this object toggles between it's 4 Texture Modes

thisObject = Space.Host.ExecutingObject

function OnClickFunction()
  if thisObject.LineRenderer.TextureMode == 3 then
    thisObject.LineRenderer.TextureMode = 0
  else 
    thisObject.LineRenderer.TextureMode = thisObject.LineRenderer.TextureMode + 1
  end
end


thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

--clicking this object toggles it's Alignment option between View (0) and Transform Z (1)

thisObject = Space.Host.ExecutingObject

function OnClickFunction()
  if thisObject.LineRenderer.Alignment == 0 then
    thisObject.LineRenderer.Alignment = 1
  else thisObject.LineRenderer.Alignment = 0
  end

end


thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

SAnimator

Index

Functions Index

Function Name

Properties Index

Property Name

Functions

Rebind

void Rebind ()

Rebind all the animated properties and mesh data with the Animator.

Stop

void Stop ()

Stop the Animator.

SetTime

void SetTime (double time)

Function Description

Parameter

Type

Description

GetTime

double GetTime ()

Function Description

GetNormalizedTime

double GetNormalizedTime (int layer=0)

Normalized time of the State. The integer part is the number of time a state has been looped. The fractional part is the % (0-1) of progress in the current loop.

Parameter

Type

Description

GetLength

double GetLength (int layer=0)

Current duration of the state.

Parameter

Type

Description

GetLoop

bool GetLoop (int layer=0)

Is the state looping.

Parameter

Type

Description

GetFloat

float GetFloat (string name) float GetFloat (int id)

Returns the value of the given float parameter. name: The name of the parameter. id: The id of the parameter.

Parameter

Type

Description

GetBool

bool GetBool (string name) bool GetBool (int id)

Returns the value of the given boolean parameter. name: The name of the parameter. id: The id of the parameter.

Parameter

Type

Description

GetInteger

int GetInteger (string name) int GetInteger (int id)

Returns the value of the given integer parameter. name: The name of the parameter. id: The id of the parameter.

Parameter

Type

Description

ResetTrigger

void ResetTrigger (string name) void ResetTrigger (int id)

Resets the trigger parameter to false.

Parameter

Type

Description

IsParameterControlledByCurve

bool IsParameterControlledByCurve (string name)

bool IsParameterControlledByCurve (int id)

Returns true if a parameter is controlled by an additional curve on an animation.

Parameter

Type

Description

GetLayerName

string GetLayerName (int layerIndex)

Gets name of the layer.

Parameter

Type

Description

GetLayerIndex

int GetLayerIndex (string layerName)

Gets the index of the layer with specified name.

Parameter

Type

Description

GetLayerWeight

float GetLayerWeight (int layerIndex)

Gets the layer's current weight.

Parameter

Type

Description

SetLayerWeight

void SetLayerWeight (int layerIndex, float weight)

Sets the weight of the layer at the given index.

Parameter

Type

Description

IsInTransition

bool IsInTransition (int layerIndex)

Is the specified layer in a transition.

Parameter

Type

Description

CrossFadeInFixedTime

void CrossFadeInFixedTime (string stateName, float transitionDuration)

void CrossFadeInFixedTime (string stateName, float transitionDuration, int layer)

void CrossFadeInFixedTime (string stateName, float transitionDuration, int layer, float fixedTime)

Creates a dynamic transition between the current state and the destination state. The duration and offset in the target state are in fixed time. stateName: The name of the destination state. transitionDuration: The duration of the transition. Value is in seconds. layer: Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. fixedTime: Start time of the current destination state. Value is in seconds. If no explicit fixedTime is specified or fixedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time and no transition will happen.

Parameter

Type

Description

CrossFade

void CrossFade (string stateName, float transitionDuration)

void CrossFade (string stateName, float transitionDuration, int layer)

void CrossFade (string stateName, float transitionDuration, int layer, float normalizedTime)

Creates a dynamic transition between the current state and the destination state. stateName: The name of the destination state. transitionDuration: The duration of the transition. Value is in source state normalized time. layer: Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. normalizedTime: Start time of the current destination state. Value is in source state normalized time, should be between 0 and 1. If no explicit normalizedTime is specified or normalizedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time and no transition will happen.

Parameter

Type

Description

PlayInFixedTime

void PlayInFixedTime (string stateName, int layer) void PlayInFixedTime (string stateName) void PlayInFixedTime (string stateName, int layer, float fixedTime)

Plays a state. The offset in the target state is in fixed time. stateName: The name of the state to play. Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played.

Parameter

Type

Description

Play

void Play (string stateName)

void Play (string stateName, int layer)

void Play (string stateName, int layer, float normalizedTime)

Plays a state.

Parameter

Type

Description

StartPlayback

void StartPlayback ()

Sets the animator in playback mode.

StopPlayback

void StopPlayback ()

Stops the animator playback mode. When playback stops, the avatar resumes getting control from game logic.

StartRecording

void StartRecording ()

Sets the animator in recording mode. The recording will continue until the user calls StopRecording. Maximum 10,000 frames. Note it is not possible to start playback until a call to StopRecording is made

StopRecording

void StopRecording ()

Stops animator record mode.

Update

void Update (float deltaTime)

Function Description

Parameter

Type

Description

SetTrigger

void SetTrigger (string trigger)

void SetTrigger (int id)

Sets a trigger parameter to active. A trigger parameter is a bool parameter that gets reset to false when it has been used in a transition. For state machines with multiple layers, the trigger will only get reset once all layers have been evaluated, so that the layers can synchronize their transitions on the same parameter.

Parameter

Type

Description

SetFloat

void SetFloat (string name, float value)

void SetFloat (string name, float value, float dampTime, float deltaTime)

void SetFloat (int id, float value)

void SetFloat (int id, float value, float dampTime, float deltaTime)

Send float values to the Animator to affect transitions. dampTime: The damper total time. deltaTime: The delta time to give to the damper.

Parameter

Type

Description

SetBool

void SetBool (int id, bool value) void SetBool (string name, bool value)

Sets the value of a boolean parameter.

Parameter

Type

Description

SetInteger

void SetInteger (string name, int value) void SetInteger (int id, int value)

Sets the value of the given integer parameter.

Parameter

Type

Description

StringToHash

int StringToHash (string name)

Generates an parameter id from a string. Ids are used for optimized setters and getters on parameters.

Parameter

Type

Description

GetCurrentAnimatorStateInfo

GetCurrentAnimatorStateInfo (int Layerindex)

Returns an SAnimatorStateInfo with the information on the current state..

Parameter

Type

Description

Properties

Controller

Controller get set

The Animator Controller resource of this Animator

Avatar

Avatar get set

Gets/Sets the current Avatar.

ApplyRootMotion

bool ApplyRootMotion get set

Should root motion be applied?

Root motion is the effect where an object's entire mesh moves away from its starting point but that motion is created by the animation itself rather than by changing the Transform position.

PlaybackTime

float PlaybackTime get set

Property Description

Enabled

bool Enabled get set

Whether the Animator component is enabled or not

Parameters

string[] Parameters get

The AnimatorControllerParameter list used by the animator.

GameObject

GameObject get

Returns a reference to the GameObject of this component.

getParam = Space.Host.ExecutingObject.Animator.GetFloat("paramName")

-- or 

 paramID = Space.Host.ExecutingObject.Animator.StringToHash("paramName")
getParam = Space.Host.ExecutingObject.Animator.GetFloat(paramID)

--clicking the object will toggle it's Animator's "flySpeed" float parameter between 0.0 and 5.0
thisObject = Space.Host.ExecutingObject

OnClick = function()
if thisObject.Animator.GetFloat("flySpeed") == 0.0 then
  thisObject.Animator.SetFloat("flySpeed", 5.0) 
else 
  thisObject.Animator.SetFloat("flySpeed", 0.0) 
end

end
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

--clicking the object will toggle it's Animator's "flySpeed" float parameter between 0.0 and 5.0
--this script uses parameter ID instead of string (StringToHash function gets the ID)

thisObject = Space.Host.ExecutingObject
paramID = thisObject.Animator.StringToHash("flySpeed")

OnClick = function()
if thisObject.Animator.GetFloat(paramID) == 0.0 then
  thisObject.Animator.SetFloat(paramID, 5.0) 
else 
  thisObject.Animator.SetFloat(paramID, 0.0) 
end

end
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

isFlying = Space.Host.ExecutingObject.Animator.GetBool("IsFlying")

--or

ID = Space.Host.ExecutingObject.Animator.StringToHash("isFlying")
isFlying = Space.Host.ExecutingObject.Animator.GetBool(ID)

--clicking the object will toggle it's "isFlying" bool parameter between true and false
thisObject = Space.Host.ExecutingObject

OnClick = function()
if thisObject.Animator.GetBool("isFlying") == true then
  thisObject.Animator.SetBool("isFlying", false) 
else 
  thisObject.Animator.SetBool("isFlying", true) 
end

end
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

--clicking the object will toggle it's "isFlying" bool parameter between true and false
--this script uses parameter ID instead of string (StringToHash function gets the ID)
thisObject = Space.Host.ExecutingObject

OnClick = function()
  parameterID = thisObject.Animator.StringToHash("isFlying")
  
if thisObject.Animator.GetBool(parameterID) == true then
  thisObject.Animator.SetBool(parameterID, false) 
else 
  thisObject.Animator.SetBool(parameterID, true) 
end

end
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

getParam = Space.Host.ExecutingObject.Animator.GetInteger("paramName")
--or
 paramID = Space.Host.ExecutingObject.Animator.StringToHash("paramName")
getParam = Space.Host.ExecutingObject.Animator.GetInteger(paramID)

--clicking the object will toggle it's Animator's "jumpHeight" int parameter between 0 and 5

thisObject = Space.Host.ExecutingObject

OnClick = function()
if thisObject.Animator.GetInteger("jumpHeight") == 0 then
  thisObject.Animator.SetInteger("jumpHeight", 1) 
else 
  thisObject.Animator.SetInteger("jumpHeight", 0) 
end

end
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

--clicking the object will toggle it's Animator's "jumpHeight" int parameter between 0 and 5
--this script uses parameter ID instead of string (StringToHash function gets the ID)

thisObject = Space.Host.ExecutingObject
paramID = thisObject.Animator.StringToHash("jumpHeight")

OnClick = function()
if thisObject.Animator.GetInteger(paramID ) == 0 then
  thisObject.Animator.SetInteger(paramID , 1) 
else 
  thisObject.Animator.SetInteger(paramID , 0) 
end

end
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

Space.Host.ExecutingObject.Animator.ResetTrigger("parameterName")
--or
paramID = Space.Host.ExecutingObject.Animator.StringToHash("parameterName")
Space.Host.ExecutingObject.Animator.ResetTrigger(paramID)

-- when object is clicked, "clickedTrigger" trigger parameter will be set and initial trigger cleared
thisObject = Space.Host.ExecutingObject


OnClick = function()
thisObject.Animator.ResetTrigger("initialTrigger")
thisObject.Animator.SetTrigger("clickedTrigger")
end
  

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

-- when object is clicked, "clickedTrigger" trigger parameter will be set and initial trigger cleared
thisObject = Space.Host.ExecutingObject

initialID = thisObject.Animator.StringToHash("initialTrigger")
clickedID = thisObject.Animator.StringToHash("clickedTrigger")

OnClick = function()
thisObject.Animator.ResetTrigger(initialID)
thisObject.Animator.SetTrigger(clickedID)
end
  

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

--clicking the object will toggle the Layer Weight of your second layer (index 1) between 0.0 and 1.0

thisObject = Space.Host.ExecutingObject

OnClick = function()
if thisObject.Animator.GetLayerWeight(1) == 0 then
  thisObject.Animator.SetLayerWeight(1, 1.0)
else 
  thisObject.Animator.SetLayerWeight(1, 0.0)
end

end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

Space.Host.ExecutingObject.Animator.CrossFadeInFixedTime("State Name", 15.0)
Space.Host.ExecutingObject.Animator.CrossFadeInFixedTime("State Name", 15.0, 0)
Space.Host.ExecutingObject.Animator.CrossFadeInFixedTime("State Name", 15.0, 0 , 0.0)

--clicking the object will make it's animator crossfade from current state to the middle of "Second State" (on the second layer) in 3 seconds
thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.Animator.CrossFadeInFixedTime("Second State", 3.0, 1, 0.5)
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

Space.Host.ExecutingObject.Animator.CrossFade("State Name", 3.0)
Space.Host.ExecutingObject.Animator.CrossFade("State Name", 3.0, 0)
Space.Host.ExecutingObject.Animator.CrossFade("State Name", 3.0, 0 , 0.0)

--clicking the object will make it's animator crossfade from current state to the middle of "Second State" (on the second layer)
--Crossfade duration will be triple the length of Source state
thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.Animator.CrossFade("Second State", 3.0, 1, 0.5)
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

Space.Host.ExecutingObject.Animator.PlayInFixedTime("State Name")
Space.Host.ExecutingObject.Animator.PlayInFixedTime("State Name", 0)
Space.Host.ExecutingObject.Animator.PlayInFixedTime("State Name", 0, 0.0)

--clicking the object will make it's animator play the "Second State", on the second Layer, and starting half a second in
thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.Animator.PlayInFixedTime("Second State",1,0.5) --add "Second State" to the second Layer in Animator Controller 
end


thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

 Space.Host.ExecutingObject.Animator.SetFloat("parameterName", 2.2)
--or
Space.Host.ExecutingObject.Animator.SetFloat("parameterName", 2.2,2.0,Space.DeltaTime)
--or
paramID = Space.Host.ExecutingObject.Animator.StringToHash("parameterName")
Space.Host.ExecutingObject.Animator.SetFloat(paramID, 2.2)
--or
paramID = Space.Host.ExecutingObject.Animator.StringToHash("parameterName")
Space.Host.ExecutingObject.Animator.SetFloat(paramID, 2.2,2.0,Space.DeltaTime)

--clicking the object will make it's Animator damp transition it's "danceSpeed" property from 0.0 to 5.0

thisObject = Space.Host.ExecutingObject

OnClick = function()
  Space.Host.StartCoroutine(function()
      while thisObject.Animator.GetFloat("danceSpeed") < 5.0 do
thisObject.Animator.SetFloat("danceSpeed", 5.0, 1.0, Space.DeltaTime) 
coroutine.yield(0)
      end

end)
end
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

Space.Host.ExecutingObject.Animator.SetBool("IsFlying", true)
--or
paramID = Space.Host.ExecutingObject.Animator.StringToHash("parameterName")
Space.Host.ExecutingObject.Animator.SetFloat(paramID, 2.2)

--clicking the object will toggle it's "isFlying" bool parameter between true and false
thisObject = Space.Host.ExecutingObject

OnClick = function()
if thisObject.Animator.GetBool("isFlying") == true then
  thisObject.Animator.SetBool("isFlying", false) 
else 
  thisObject.Animator.SetBool("isFlying", true) 
end

end
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

--clicking the object will toggle it's Animator's "jumpHeight" int parameter between 0 and 5

thisObject = Space.Host.ExecutingObject

OnClick = function()
if thisObject.Animator.GetInteger("jumpHeight") == 0 then
  thisObject.Animator.SetInteger("jumpHeight", 1) 
else 
  thisObject.Animator.SetInteger("jumpHeight", 0) 
end

end
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

--clicking the object will toggle it's "isFlying" bool parameter between true and false
--this script uses parameter ID instead of string (StringToHash function gets the ID)
thisObject = Space.Host.ExecutingObject

OnClick = function()
  parameterID = thisObject.Animator.StringToHash("isFlying")
  
if thisObject.Animator.GetBool(parameterID) == true then
  thisObject.Animator.SetBool(parameterID, false) 
else 
  thisObject.Animator.SetBool(parameterID, true) 
end

end
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

-- when object is clicked, it's Animator's Avatar will be changed to an alternate one
thisObject = Space.Host.ExecutingObject

alternateAvatar = Space.GetResource("altavatar") -- add Avatar to Scripting Runtime resources section

OnClick = function()
thisObject.Animator.Avatar = alternateAvatar
end
  

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

--clicking this object will Enable/Disable it's Root Motion
thisGameObject = Space.Host.ExecutingObject.Animator


OnClick = function()
animator.ApplyRootMotion =  not animator.ApplyRootMotion
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

--clicking this object will Enable/Disable it's Animator component
thisGameObject = Space.Host.ExecutingObject
animator = thisGameObject.Animator


OnClick = function()
animator.Enabled =  not animator.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)