SLight

Index

Properties Index

Property Name
bool Enabled get set
float Range get set
float SpotAngle get set
float Intensity get set
SVector Color get set
SLightType Type get set
SGameObject GameObject get

Properties

Enabled

bool Enabled get set

Enable/Disable this light.

Lua

Space.Host.ExecutingObject.Light.Enabled = false

Lua

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


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

Range

float Range get set

Get/Set the effective range of the light source.

Lua

Space.Host.ExecutingObject.Light.Range = 8.0

Lua

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

SpotAngle

float SpotAngle get set

The angle of the light's spotlight cone in degrees.

Lua

Space.Host.ExecutingObject.Light.SpotAngle = 50

Lua

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

Intensity

float Intensity get set

Property Description

Lua

LightIntensity = Space.Host.ExecutingObject.Light.Intensity

Lua

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

Color

SVector Color get set

Get/Set the color of the light.

Lua

Space.Host.ExecutingObject.Light.Color = Color.Red

Lua

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

Type

int Type get set

Get/Set the type of light this source is. 0 = Directional, 1 = Point, 2 = Spot, 3 = Area.

Lua

Space.Host.ExecutingObject.Light.Type = 0

Lua

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

GameObject

SGameObject GameObject get

Property Description

Lua

theGameObject = Space.Host.ExecutingObject.Light.GameObject