wiki.sine.space | sinespace

Difference between revisions of "Scripting/SRenderSettings"

From wiki.sine.space
Jump to: navigation, search
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/scene/srendersettings")
 
Line 1: Line 1:
The Render Settings include values for a range of visual elements in Scene, such as fog and ambient light.
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/scene/srendersettings
 
+
=Members=
+
 
+
{{ScriptFunction|void|SetGlobalShaderTexture|{string name, SResource dir;}|Set a global texture property.|
+
''--Create a shader first and define it "half _Mult".''<br>
+
''--Use "_Mult" as "_Metallic" and delete "_Metallic".''<br>
+
''--set value and put on a gameobject''<br>
+
Space.RenderSettings.SetGlobalShaderTexture("_TestTex",Space.Resources[3])
+
}}
+
 
+
{{ScriptFunction|void|SetGlobalShaderFloat|{string name, float dir;}|Set a global float property for all shaders.|
+
''--Create a shader first and define "sampler2D _TestTex".''<br>
+
''--Use "_TestTex" as "_MainTex" and delete "_MainTex".''<br>
+
''--set value and put on a gameobject''<br>
+
Space.RenderSettings.SetGlobalShaderFloat("_Mult",1)
+
}}
+
 
+
{{ScriptFunction|void|SetGlobalShaderColor|{string name, SColor dir;}|Set a global color property for all shaders.|
+
''--create a shader first and define "fixed4 _TestColor"''<br>
+
''--use "_TestColor" as "_Color" and delete "_TestColor".''<br>
+
''--set value and put on a gameobject''<br>
+
Space.RenderSettings.SetGlobalShaderFloat("_TestColor",Color.Red)
+
}}
+
 
+
{{ScriptFunction|void|SetGlobalShaderVector|{string name, SVector dir;}|Set a global color property for all shaders.|''--Create a shader first and define "vector _TestVector"''<br>
+
''--set value and put on a gameobject''<br>
+
Space.RenderSettings.SetGlobalShaderFloat("_TestVector",Vector.One)
+
}}
+
 
+
 
+
=Properties=
+
 
+
{{ScriptFunction|int|DefaultReflectionResolution|{get, set;}|Cubemap resolution for default reflection.|5=
+
''--set value.''<br>
+
Space.RenderSettings.DefaultReflectionResolution=256<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.DefaultReflectionResolution)|6=<pre>--the below script will make a slider change the Render Setting's Cube Map Resolution
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
slider = Space.Host.GetReference("slider").UISlider --add reference to Scripting Runtime
+
 
+
OVC = function()
+
Space.RenderSettings.DefaultReflectionResolution = slider.Value * 4096 -- from 0 to 40906
+
end
+
 
+
slider.OnValueChanged(OVC)</pre>
+
}}
+
 
+
{{ScriptFunction|SMaterial|Skybox|{get, set;}|The global skybox to use.|5=
+
''--set value.''<br>
+
Space.RenderSettings.Skybox=Space.Resources[1].AsMaterial<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.Skybox.Name)|6=<pre>--clicking this object will toggle between two Skyboxes
+
--[Add 2 materials to the first two Resource slots in Scripting Runtime component]
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
OnClick = function()
+
  if Space.RenderSettings.Skybox==Space.Resources[1].AsMaterial then
+
    Space.RenderSettings.Skybox=Space.Resources[2].AsMaterial
+
  else
+
    Space.RenderSettings.Skybox=Space.Resources[1].AsMaterial
+
  end
+
end
+
 
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>
+
}}
+
 
+
{{ScriptFunction|float|FlareFadeSpeed|{get, set;}|The fade speed of all flares in the Scene.|5=
+
''--set value.''<br>
+
Space.RenderSettings.FlareFadeSpeed=5<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.FlareFadeSpeed)|6=<pre>--the below script will make a slider change the Render Setting's Flare Fade Speed
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
slider = Space.Host.GetReference("slider").UISlider --add reference to Scripting Runtime
+
 
+
OVC = function()
+
Space.RenderSettings.FlareFadeSpeed = slider.Value * 5 -- from 0 to 5
+
end
+
 
+
slider.OnValueChanged(OVC)</pre>
+
}}
+
 
+
{{ScriptFunction|float|FlareStrength|{get, set;}|The intensity of all flares in the Scene.|5=
+
''--set value.''<br>
+
Space.RenderSettings.FlareStrength=1<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.FlareStrength)|6=<pre>--the below script will make a slider change the Render Setting's Flare Strength
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
slider = Space.Host.GetReference("slider").UISlider --add reference to Scripting Runtime
+
 
+
OVC = function()
+
Space.RenderSettings.FlareStrength = slider.Value * 5 -- from 0 to 5
+
end
+
 
+
slider.OnValueChanged(OVC)</pre>
+
}}
+
 
+
{{ScriptFunction|float|HaloStrength|{get, set;}|Size of the light halos.|5=
+
''--set value.''<br>
+
Space.RenderSettings.HaloStrength=1<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.HaloStrength)|6=<pre>--the below script will make a slider change the Render Setting's Halo Strength
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
slider = Space.Host.GetReference("slider").UISlider --add reference to Scripting Runtime
+
 
+
OVC = function()
+
Space.RenderSettings.HaloStrength = slider.Value * 5 -- from 0 to 5
+
end
+
 
+
slider.OnValueChanged(OVC)</pre>
+
}}
+
 
+
{{ScriptFunction|int|ReflectionBounces|{get, set;}|The number of times a reflection includes other reflections.|5=
+
''--set value.''<br>
+
Space.RenderSettings.ReflectionBounces=5<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.ReflectionBounces)|6=<pre>--the below script will make a slider change the Render Setting's Reflection Bounces
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
slider = Space.Host.GetReference("slider").UISlider --add reference to Scripting Runtime
+
 
+
OVC = function()
+
Space.RenderSettings.ReflectionBounces = slider.Value * 5 -- from 0 to 5
+
end
+
 
+
slider.OnValueChanged(OVC)</pre>
+
}}
+
 
+
{{ScriptFunction|float|ReflectionIntensity|{get, set;}|How much the skybox / custom cubemap reflection affects the Scene.|5=
+
''--set value.''<br>
+
Space.RenderSettings.ReflectionIntensity=1<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.ReflectionIntensity)|6=<pre>--the below script will make a slider change the Render Setting's Reflection Intensity
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
slider = Space.Host.GetReference("slider").UISlider --add reference to Scripting Runtime
+
 
+
OVC = function()
+
Space.RenderSettings.ReflectionIntensity = slider.Value * 5 -- from 0 to 5
+
end
+
 
+
slider.OnValueChanged(OVC)</pre>
+
}}
+
 
+
{{ScriptFunction|SColor|SubtractiveShadowColor|{get, set;}|The color used for the sun shadows in the Subtractive lightmode.|5=
+
''--set value.''<br>
+
Space.RenderSettings.SubtractiveShadowColor=Color.Red<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.SubtractiveShadowColor.ToString())|6=<pre>--clicking the object will open a color picker that changes the Subtractive Shadow Color
+
thisGameObject = Space.Host.ExecutingObject
+
originalColor = Space.RenderSettings.SubtractiveShadowColor
+
 
+
OnChange = function(SColor)
+
Space.RenderSettings.SubtractiveShadowColor = SColor
+
end
+
 
+
OnSelect = function(SColor)
+
Space.RenderSettings.SubtractiveShadowColor = SColor
+
end
+
 
+
OnCancel = function()
+
Space.RenderSettings.SubtractiveShadowColor = originalColor
+
end
+
 
+
OnClick = function()
+
Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)
+
end
+
 
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>
+
}}
+
 
+
{{ScriptFunction|float|AmbientIntensity|{get, set;}|How much the light from the Ambient Source affects the Scene.|5=
+
''--set value.''<br>
+
Space.RenderSettings.AmbientIntensity=1<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.AmbientIntensity)|6=<pre>--the below script will make a slider change the Render Setting's Ambient Intensity
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
slider = Space.Host.GetReference("slider").UISlider --add reference to Scripting Runtime
+
 
+
OVC = function()
+
Space.RenderSettings.AmbientIntensity = slider.Value * 5 -- from 0 to 5
+
end
+
 
+
slider.OnValueChanged(OVC)</pre>
+
}}
+
 
+
{{ScriptFunction|SColor|AmbientLight|{get, set;}|Flat ambient lighting color.|5=
+
''--set value.''<br>
+
Space.RenderSettings.AmbientLight=Color.Blue<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.AmbientLight.ToString())|6=<pre>--clicking the object will open a color picker that changes the Ambient Light Color
+
thisGameObject = Space.Host.ExecutingObject
+
originalColor = Space.RenderSettings.AmbientLight
+
 
+
OnChange = function(SColor)
+
Space.RenderSettings.AmbientLight = SColor
+
end
+
 
+
OnSelect = function(SColor)
+
Space.RenderSettings.AmbientLight = SColor
+
end
+
 
+
OnCancel = function()
+
Space.RenderSettings.AmbientLight = originalColor
+
end
+
 
+
OnClick = function()
+
Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)
+
end
+
 
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>
+
}}
+
 
+
{{ScriptFunction|SColor|AmbientGroundColor|{get, set;}|Ambient lighting coming from below.|5=
+
''--set value.''<br>
+
Space.RenderSettings.AmbientGroundColor=Color.Green<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.AmbientGroundColor.ToString())|6=<pre>--clicking the object will open a color picker that changes the Ambient Ground Color
+
thisGameObject = Space.Host.ExecutingObject
+
originalColor = Space.RenderSettings.AmbientGroundColor
+
 
+
OnChange = function(SColor)
+
Space.RenderSettings.AmbientGroundColor = SColor
+
end
+
 
+
OnSelect = function(SColor)
+
Space.RenderSettings.AmbientGroundColor = SColor
+
end
+
 
+
OnCancel = function()
+
Space.RenderSettings.AmbientGroundColor = originalColor
+
end
+
 
+
OnClick = function()
+
Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)
+
end
+
 
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>
+
}}
+
 
+
 
+
{{ScriptFunction|SColor|AmbientEquatorColor|{get, set;}|Ambient lighting coming from the sides.|5=
+
''--set value.''<br>
+
Space.RenderSettings.AmbientEquatorColor=Color.Green<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.AmbientEquatorColor.ToString())|6=<pre>--clicking the object will open a color picker that changes the Ambient Equator Color
+
thisGameObject = Space.Host.ExecutingObject
+
originalColor = Space.RenderSettings.AmbientEquatorColor
+
 
+
OnChange = function(SColor)
+
Space.RenderSettings.AmbientEquatorColor = SColor
+
end
+
 
+
OnSelect = function(SColor)
+
Space.RenderSettings.AmbientEquatorColor = SColor
+
end
+
 
+
OnCancel = function()
+
Space.RenderSettings.AmbientEquatorColor= originalColor
+
end
+
 
+
OnClick = function()
+
Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)
+
end
+
 
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>
+
}}
+
 
+
{{ScriptFunction|SColor|AmbientSkyColor|{get, set;}|Ambient lighting coming from above.|5=
+
''--set value.''<br>
+
Space.RenderSettings.AmbientSkyColor=Color.White<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.AmbientSkyColor.ToString())|6=<pre>--clicking the object will open a color picker that changes the Ambient Sky Color
+
thisGameObject = Space.Host.ExecutingObject
+
originalColor = Space.RenderSettings.AmbientSkyColor
+
 
+
OnChange = function(SColor)
+
Space.RenderSettings.AmbientSkyColor = SColor
+
end
+
 
+
OnSelect = function(SColor)
+
Space.RenderSettings.AmbientSkyColor = SColor
+
end
+
 
+
OnCancel = function()
+
Space.RenderSettings.AmbientSkyColor = originalColor
+
end
+
 
+
OnClick = function()
+
Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)
+
end
+
 
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>
+
}}
+
 
+
{{ScriptFunction|SAmbientMode|AmbientMode|{get, set;}|Ambient lighting mode.|5=
+
''--set value.''<br>
+
Space.RenderSettings.AmbientMode=1<br>
+
''--Skybox = 1.''<br>
+
''--Trilight = 2.''<br>
+
''--Flat = 3.''<br>
+
''--Custom = 4.''<br>
+
Space.Log(Space.RenderSettings.AmbientMode)|6=<pre>--clicking this object will toggle between 4 Ambient Modes
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
OnClick = function()
+
  if Space.RenderSettings.AmbientMode==4 then
+
    Space.RenderSettings.AmbientMode=1
+
  else
+
    Space.RenderSettings.AmbientMode = Space.RenderSettings.AmbientMode + 1
+
  end
+
end
+
 
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>
+
}}
+
 
+
 
+
{{ScriptFunction|float|FogEndDistance|{get, set;}|The ending distance of linear fog.|5=
+
''--set value.''<br>
+
Space.RenderSettings.FogEndDistance=300<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.FogEndDistance)|6=<pre>--the below script will make a slider change the Render Setting's Fog End Distance
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
slider = Space.Host.GetReference("slider").UISlider --add reference to Scripting Runtime
+
 
+
OVC = function()
+
Space.RenderSettings.FogEndDistance = (slider.Value * 170) + 30-- from 30 to 200
+
end
+
 
+
slider.OnValueChanged(OVC)</pre>
+
}}
+
 
+
{{ScriptFunction|float|FogStartDistance|{get, set;}|The starting distance of linear fog.|5=
+
''--set value.''<br>
+
Space.RenderSettings.FogStartDistance=10<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.FogStartDistance)|6=<pre>--the below script will make a slider change the Render Setting's Fog Start Distance
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
slider = Space.Host.GetReference("slider").UISlider --add reference to Scripting Runtime
+
 
+
OVC = function()
+
Space.RenderSettings.FogStartDistance = (slider.Value * 10) -- from 0 to 10
+
end
+
 
+
slider.OnValueChanged(OVC)</pre>
+
}}
+
 
+
{{ScriptFunction|float|FogDensity|{get, set;}|The density of the exponential fog.|5=
+
''--set value.''<br>
+
Space.RenderSettings.FogDensity=10<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.FogDensity)|6=<pre>--the below script will make a slider change the Render Setting's Fog Density
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
slider = Space.Host.GetReference("slider").UISlider --add reference to Scripting Runtime
+
 
+
OVC = function()
+
Space.RenderSettings.FogDensity = (slider.Value * 10) -- from 0 to 10
+
end
+
 
+
slider.OnValueChanged(OVC)</pre>
+
}}
+
 
+
{{ScriptFunction|SFogMode|FogMode|{get, set;}|Ambient lighting mode.|5=
+
''--set value.''<br>
+
Space.RenderSettings.FogMode=2<br>
+
''--Linear = 1.''<br>
+
''--Exponential = 2.''<br>
+
''--ExponentialSquared = 3.''<br>
+
Space.Log(Space.RenderSettings.FogMode)|6=<pre>--clicking this object will toggle between 3 Fog Modes
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
OnClick = function()
+
  if Space.RenderSettings.FogMode==3 then
+
    Space.RenderSettings.FogMode=1
+
  else
+
    Space.RenderSettings.FogMode = Space.RenderSettings.FogMode + 1
+
  end
+
end
+
 
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>
+
}}
+
 
+
{{ScriptFunction|bool|Fog|{get, set;}|Whether Fog is enabled or not|5=
+
Space.RenderSettings.Fog=true|6=<pre>--clicking this object will toggle enable/disable Fog
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
OnClick = function()
+
Space.RenderSettings.Fog = not Space.RenderSettings.Fog
+
end
+
 
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>
+
}}
+
 
+
{{ScriptFunction|SColor|FogColor|{get, set;}|The color of the fog.|5=
+
Space.RenderSettings.FogColor = Color.Red|6=<pre>--clicking the object will open a color picker that changes the Fog color
+
thisGameObject = Space.Host.ExecutingObject
+
originalColor = Space.RenderSettings.FogColor
+
 
+
OnChange = function(SColor)
+
Space.RenderSettings.FogColor = SColor
+
end
+
 
+
OnSelect = function(SColor)
+
Space.RenderSettings.FogColor = SColor
+
end
+
 
+
OnCancel = function()
+
Space.RenderSettings.FogColor = originalColor
+
end
+
 
+
OnClick = function()
+
Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)
+
end
+
 
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>
+
}}
+
 
+
{{ScriptFunction|float|AmbientSkyboxAmount|{get, set;}|How much the light from the Ambient Source affects the Scene.|5=
+
''--set value.''<br>
+
Space.RenderSettings.AmbientSkyboxAmount=10<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.AmbientSkyboxAmount) |6=<pre>--the below script will make a slider change the Render Setting's Ambient Skybox Amount
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
slider = Space.Host.GetReference("slider").UISlider --add reference to Scripting Runtime
+
 
+
OVC = function()
+
Space.RenderSettings.AmbientSkyboxAmount = (slider.Value * 10) -- from 0 to 10
+
end
+
 
+
slider.OnValueChanged(OVC)</pre>
+
}}
+
 
+
{{ScriptFunction|SDefaultReflectionMode|DefaultReflectionMode|{get, set;}|Ambient lighting mode.|5=
+
''--set value.''<br>
+
Space.RenderSettings.DefaultReflectionMode=1<br>
+
''--Skybox = 0.''<br>
+
''--Custom = 1.''<br>
+
''--get value.''<br>
+
Space.Log(Space.RenderSettings.DefaultReflectionMode)|6=<pre>--clicking this object will toggle between two Default Reflection Modes
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
OnClick = function()
+
  if Space.RenderSettings.DefaultReflectionMode==1 then
+
    Space.RenderSettings.DefaultReflectionMode=0
+
  else
+
    Space.RenderSettings.DefaultReflectionMode=1
+
  end
+
end
+
 
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>
+
}}
+
 
+
{{Scripting Navbox}}
+

Latest revision as of 07:11, 19 September 2022

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