Scripting/SLight

From sine.space Wiki
Jump to: navigation, search

Light sources within the Space scene.

Properties

Enabled

bool Enabled { get; set;}

Enable/Disable this light.

-- Disable this object's Light Source --
Space.Host.ExecutingObject.Light.Enabled = false;

Range

float Range { get; set;}

Get/Set the effective range of the light source.

-- Change the range of the Light --
Space.Host.ExecutingObject.Light.Range = 8.0;

Intensity

float Intensity { get; set;}

Get/Set the intensity of the light source. (Multiplied with the light color)

-- Get the intensity of the Light --
Space.Log("Intensity: " .. Space.Host.ExecutingObject.Light.Intensity);

Color

SVector Color { get; set;}

Get/Set the color of the light.

local obj = Space.Host.ExecutingObject;

Space.Log(obj.Light.Color);
-- prints "[1,1,1]" (white) to the console.
local newColor = Vector.New(0.5,0.5,0); -- yellow color
obj.Light.Color = newColor;

-- Now the color of the light is yellow.

Type

SLightType Type { get; set;}

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

local obj = Space.Host.ExecutingObject;

Space.Log(obj.Light.Type);
-- prints "1" (default) to the console.
obj.Light.Type = 0;

-- Now the light type has changed to Directional.