wiki.sine.space | sinespace

Difference between revisions of "Scripting/SAudioReactiveBase"

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:
The SAudioReactiveBase is a base class that can be used to access any of the Audio Reactive components base properties. For example: If you have an Audio Reactive Material component the base properties are accessed using SAudioReactiveBase class and the material specific properties will be accessed using the SAudioReactiveMaterial class.
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/saudioreactivebase
 
+
=Properties=
+
 
+
{{ScriptFunction|bool|Enabled|{get; set;}|Whether the Audio Reactive component is enabled or not.|5= <pre>Space.Host.ExecutingObject.</pre>|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|int|BandMin|{get; set;}|The Band Min property of an Audio Reactive component.|5=<pre>Space.Host.ExecutingObject.AudioReactive.BandMin= 1</pre>|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|int|BandMax|{get; set;}|The Band Max property of an Audio Reactive component.|5=<pre>Space.Host.ExecutingObject.AudioReactive.BandMax= 11</pre>|6=<pre>--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)</pre>
+
}}
+
 
+
 
+
{{ScriptFunction|int|BPMWindow|{get; set;}|The BPM Window property of an Audio Reactive component.|5=<pre>Space.Host.ExecutingObject.AudioReactive.BPMWindow= 5</pre>|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|int|LimitIncrease|{get; set;}|The Limit Increase property of an Audio Reactive component.|5=<pre>Space.Host.ExecutingObject.AudioReactive.LimitIncrease= 1</pre>|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|int|LimitDecrease|{get; set;}|The Limit Decrease property of an Audio Reactive component.|5=<pre>Space.Host.ExecutingObject.AudioReactive.LimitDecrease= 3</pre>|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|int|MinValue|{get; set;}|The Min Value property of an Audio Reactive component.|5=<pre>Space.Host.ExecutingObject.AudioReactive.MinValue= 1</pre>|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|int|MaxValue|{get; set;}|The Max Value property of an Audio Reactive component.|5=<pre>Space.Host.ExecutingObject.AudioReactive.MaxValue= 3</pre>|6=<pre>--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)</pre>
+
}}
+
 
+
{{ScriptFunction|int|Mode|{get; set;}|The Mode property of an Audio Reactive component. Band is 0, and BMP is 1.|5=<pre>Space.Host.ExecutingObject.AudioReactive.Mode= 1</pre>|6=<pre>--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)</pre>
+
}}
+
 
+
{{Scripting Navbox}}
+

Latest revision as of 05:07, 19 September 2022

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