wiki.sine.space | sinespace

Difference between revisions of "Scripting/SAudioReactiveLight"

From wiki.sine.space
Jump to: navigation, search
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/saudioreactivebase")
Line 1: Line 1:
=Properties=
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/saudioreactivebase
 
+
{{ScriptFunction|bool|Enabled|{get; set;}|Returns true if the Audio Reactive Light Enabled.|5=
+
local Object = Space.Scene.Find("Audio Source")<br>
+
Space.Log(Object.AudioReactiveLight.Enabled)<br>
+
''-- print true.''|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|SLight|Target|{get; set;}|Returns true if the light target Enabled.|5=
+
local Object = Space.Scene.Find("Audio Source")<br>
+
Space.Log(Object.AudioReactiveLight.Target.Enabled) | 6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|bool|Range|{get; set;}|Returns true if Range Enabled.|5=
+
local Object = Space.Scene.Find("Audio Source")<br>
+
Space.Log(Object.AudioReactiveLight.Range)|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|float|MinRange|{get; set;}|Returns MinRange value of the Audio Reactive Light.|5=
+
local Object = Space.Scene.Find("Audio Source")<br>
+
Space.Log(Object.AudioReactiveLight.MinRange)|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|float|MaxRange|{get; set;}|Returns MaxRange value of the Audio Reactive Light.|5=
+
local Object = Space.Scene.Find("Audio Source")<br>
+
Space.Log(Object.AudioReactiveLight.MaxRange)|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|bool|AnimateColor|{get; set;}|Returns true if AnimateColor Enabled.|5=
+
local Object = Space.Scene.Find("Audio Source")<br>
+
Space.Log(Object.AudioReactiveLight.AnimateColor)|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|SColor|MinColor|{get; set;}|Returns MinColor value of the Audio Reactive Light.|5=
+
local Object = Space.Scene.Find("Audio Source")<br>
+
Space.Log(Object.AudioReactiveLight.MinColor)|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|SColor|MaxColor|{get; set;}|Returns MaxColor value of the Audio Reactive Light.|5=
+
local Object = Space.Scene.Find("Audio Source")<br>
+
Space.Log(Object.AudioReactiveLight.MaxColor)|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|bool|Intensity|{get; set;}|Returns true if Intensity Enabled.|5=
+
local Object = Space.Scene.Find("Audio Source")<br>
+
Space.Log(Object.AudioReactiveLight.Intensity)|6=<pre>--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)</pre>
+
}}
+
 
+
 
+
{{ScriptFunction|float|MinIntensity|{get; set;}|Returns MinIntensity value of the Audio Reactive Light.|5=
+
local Object = Space.Scene.Find("Audio Source")<br>
+
Space.Log(Object.AudioReactiveLight.MinIntensity)|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|float|MaxIntensity|{get; set;}|Returns MaxIntensity value of the Audio Reactive Light.|5=
+
local Object = Space.Scene.Find("Audio Source")<br>
+
Space.Log(Object.AudioReactiveLight.MaxIntensity)|6=<pre>--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)</pre>
+
}}
+
 
+
 
+
 
+
{{Scripting Navbox}}
+

Revision as of 05:08, 19 September 2022

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