wiki.sine.space | sinespace

Difference between revisions of "Scripting/SLight"

From wiki.sine.space
Jump to: navigation, search
(Added code examples for Color, Type)
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/slight")
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Light sources within the Space scene.
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/slight
 
+
=Properties=
+
{{ScriptFunction|bool|Enabled|{ get; set;}|Enable/Disable this light.|5=-- Disable this object's Light Source --<br>Space.Host.ExecutingObject.Light.Enabled = false;}}
+
{{ScriptFunction|float|Range|{ get; set;}|Get/Set the effective range of the light source.|5=-- Change the range of the Light --<br>Space.Host.ExecutingObject.Light.Range = 8.0;}}
+
{{ScriptFunction|float|Intensity|{ get; set;}|Get/Set the intensity of the light source. (Multiplied with the light color)|5=-- Get the intensity of the Light --<br>Space.Log("Intensity: " .. Space.Host.ExecutingObject.Light.Intensity);}}
+
{{ScriptFunction|SVector|Color|{ get; set;}|Get/Set the color of the light.|5=
+
local obj = Space.Host.ExecutingObject;<br><br>
+
Space.Log(obj.Light.Color);<br>
+
''-- prints "[1,1,1]" (white) to the console.''<br>
+
local newColor = Vector.New(0.5,0.5,0); ''-- yellow color''<br>
+
obj.Light.Color = newColor;<br>
+
''-- Now the color of the light is yellow.''}}
+
{{ScriptFunction|SLightType|Type|{ get; set;}|4= Get/Set the type of light this source is. 0 = Directional, 1 = Point, 2 = Spot, 3 = Area.|5=
+
local obj = Space.Host.ExecutingObject;<br><br>
+
Space.Log(obj.Light.Type);<br>
+
''-- prints "1" (default) to the console.''<br>
+
obj.Light.Type = 0;<br>
+
''-- Now the light type has changed to Directional.''}}
+
 
+
 
+
{{Scripting Navbox}}
+

Latest revision as of 06:02, 19 September 2022

This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/slight