wiki.sine.space | sinespace
Open Nav

Difference between revisions of "Scripting/SRenderSettings"

From wiki.sine.space
Jump to: navigation, search
Line 31: Line 31:
  
 
=Properties=
 
=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)
 +
}}
 +
 +
{{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)
 +
}}
 +
 +
{{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)
 +
}}
 +
 +
{{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)
 +
}}
 +
 +
{{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)
 +
}}
 +
 +
{{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)
 +
}}
 +
 +
{{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)
 +
}}
 +
 +
{{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())
 +
}}
 +
 +
{{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)
 +
}}
 +
 +
{{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())
 +
}}
 +
 +
{{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())
 +
}}
 +
 +
 +
{{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())
 +
}}
 +
 +
{{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())
 +
}}
 +
 +
{{ScriptFunction|SAmbientMode|AmbientMode|{get, set;}|Ambient lighting mode.|5=
 +
''--set value.''<br>
 +
Space.RenderSettings.AmbientMode=0<br>
 +
''--Skybox = 0.''<br>
 +
''--Trilight = 1.''<br>
 +
''--Flat = 3.''<br>
 +
''--Custom = 4.''<br>
 +
Space.Log(Space.RenderSettings.AmbientMode)
 +
}}
 +
 +
 +
{{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)
 +
}}
 +
 +
{{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)
 +
}}
 +
 +
{{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)
 +
}}
 +
 +
{{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)
 +
}}
 +
 +
{{ScriptFunction|bool|Fog|{get, set;}|The color of the fog.|5=
 +
''--set value.''<br>
 +
Space.RenderSettings.Fog=true<br>
 +
''--get value.''<br>
 +
Space.Log(Space.RenderSettings.Fog)
 +
}}
 +
 +
{{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)
 +
}}
 +
 +
{{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)
 +
}}
 +
 +
{{Scripting Navbox}}

Revision as of 08:21, 24 December 2020

The Render Settings include values for a range of visual elements in Scene, such as fog and ambient light.

Members

SetGlobalShaderTexture

void SetGlobalShaderTexture {string name, SResource dir;}

Set a global texture property.

--Create a shader first and define it "half _Mult".
--Use "_Mult" as "_Metallic" and delete "_Metallic".
--set value and put on a gameobject
Space.RenderSettings.SetGlobalShaderTexture("_TestTex",Space.Resources[3])


SetGlobalShaderFloat

void SetGlobalShaderFloat {string name, float dir;}

Set a global float property for all shaders.

--Create a shader first and define "sampler2D _TestTex".
--Use "_TestTex" as "_MainTex" and delete "_MainTex".
--set value and put on a gameobject
Space.RenderSettings.SetGlobalShaderFloat("_Mult",1)


SetGlobalShaderColor

void SetGlobalShaderColor {string name, SColor dir;}

Set a global color property for all shaders.

--create a shader first and define "fixed4 _TestColor"
--use "_TestColor" as "_Color" and delete "_TestColor".
--set value and put on a gameobject
Space.RenderSettings.SetGlobalShaderFloat("_TestColor",Color.Red)


SetGlobalShaderVector

void SetGlobalShaderVector {string name, SVector dir;}

Set a global color property for all shaders.

--Create a shader first and define "vector _TestVector"

--set value and put on a gameobject
Space.RenderSettings.SetGlobalShaderFloat("_TestVector",Vector.One)



Properties

DefaultReflectionResolution

int DefaultReflectionResolution {get, set;}

Cubemap resolution for default reflection.

--set value.

Space.RenderSettings.DefaultReflectionResolution=256
--get value.

Space.Log(Space.RenderSettings.DefaultReflectionResolution)


Skybox

SMaterial Skybox {get, set;}

The global skybox to use.

--set value.

Space.RenderSettings.Skybox=Space.Resources[1].AsMaterial
--get value.

Space.Log(Space.RenderSettings.Skybox.Name)


FlareFadeSpeed

float FlareFadeSpeed {get, set;}

The fade speed of all flares in the Scene.

--set value.

Space.RenderSettings.FlareFadeSpeed=5
--get value.

Space.Log(Space.RenderSettings.FlareFadeSpeed)


FlareStrength

float FlareStrength {get, set;}

The intensity of all flares in the Scene.

--set value.

Space.RenderSettings.FlareStrength=1
--get value.

Space.Log(Space.RenderSettings.FlareStrength)


HaloStrength

float HaloStrength {get, set;}

Size of the light halos.

--set value.

Space.RenderSettings.HaloStrength=1
--get value.

Space.Log(Space.RenderSettings.HaloStrength)


ReflectionBounces

int ReflectionBounces {get, set;}

The number of times a reflection includes other reflections.

--set value.

Space.RenderSettings.ReflectionBounces=5
--get value.

Space.Log(Space.RenderSettings.ReflectionBounces)


ReflectionIntensity

float ReflectionIntensity {get, set;}

How much the skybox / custom cubemap reflection affects the Scene.

--set value.

Space.RenderSettings.ReflectionIntensity=1
--get value.

Space.Log(Space.RenderSettings.ReflectionIntensity)


SubtractiveShadowColor

SColor SubtractiveShadowColor {get, set;}

The color used for the sun shadows in the Subtractive lightmode.

--set value.

Space.RenderSettings.SubtractiveShadowColor=Color.Red
--get value.

Space.Log(Space.RenderSettings.SubtractiveShadowColor.ToString())


AmbientIntensity

float AmbientIntensity {get, set;}

How much the light from the Ambient Source affects the Scene.

--set value.

Space.RenderSettings.AmbientIntensity=1
--get value.

Space.Log(Space.RenderSettings.AmbientIntensity)


AmbientLight

SColor AmbientLight {get, set;}

Flat ambient lighting color.

--set value.

Space.RenderSettings.AmbientLight=Color.Blue
--get value.

Space.Log(Space.RenderSettings.AmbientLight.ToString())


AmbientGroundColor

SColor AmbientGroundColor {get, set;}

Ambient lighting coming from below.

--set value.

Space.RenderSettings.AmbientGroundColor=Color.Green
--get value.

Space.Log(Space.RenderSettings.AmbientGroundColor.ToString())



AmbientEquatorColor

SColor AmbientEquatorColor {get, set;}

Ambient lighting coming from the sides.

--set value.

Space.RenderSettings.AmbientEquatorColor=Color.Green
--get value.

Space.Log(Space.RenderSettings.AmbientEquatorColor.ToString())


AmbientSkyColor

SColor AmbientSkyColor {get, set;}

Ambient lighting coming from above.

--set value.

Space.RenderSettings.AmbientSkyColor=Color.White
--get value.

Space.Log(Space.RenderSettings.AmbientSkyColor.ToString())


AmbientMode

SAmbientMode AmbientMode {get, set;}

Ambient lighting mode.

--set value.

Space.RenderSettings.AmbientMode=0
--Skybox = 0.
--Trilight = 1.
--Flat = 3.
--Custom = 4.

Space.Log(Space.RenderSettings.AmbientMode)



FogEndDistance

float FogEndDistance {get, set;}

The ending distance of linear fog.

--set value.

Space.RenderSettings.FogEndDistance=300
--get value.

Space.Log(Space.RenderSettings.FogEndDistance)


FogStartDistance

float FogStartDistance {get, set;}

The starting distance of linear fog.

--set value.

Space.RenderSettings.FogStartDistance=10
--get value.

Space.Log(Space.RenderSettings.FogStartDistance)


FogDensity

float FogDensity {get, set;}

The density of the exponential fog.

--set value.

Space.RenderSettings.FogDensity=10
--get value.

Space.Log(Space.RenderSettings.FogDensity)


FogMode

SFogMode FogMode {get, set;}

Ambient lighting mode.

--set value.

Space.RenderSettings.FogMode=2
--Linear = 1.
--Exponential = 2.
--ExponentialSquared = 3.

Space.Log(Space.RenderSettings.FogMode)


Fog

bool Fog {get, set;}

The color of the fog.

--set value.

Space.RenderSettings.Fog=true
--get value.

Space.Log(Space.RenderSettings.Fog)


AmbientSkyboxAmount

float AmbientSkyboxAmount {get, set;}

How much the light from the Ambient Source affects the Scene.

--set value.

Space.RenderSettings.AmbientSkyboxAmount=10
--get value.

Space.Log(Space.RenderSettings.AmbientSkyboxAmount)


DefaultReflectionMode

SDefaultReflectionMode DefaultReflectionMode {get, set;}

Ambient lighting mode.

--set value.

Space.RenderSettings.DefaultReflectionMode=1
--Skybox = 0.
--Custom = 1.
--get value.

Space.Log(Space.RenderSettings.DefaultReflectionMode)


v · d · e
Scripting Portal
Common
Key Classes
Helper Classes
Scripting samples and tutorials
Retrieved from "https://wiki.sine.space/index.php?title=Scripting/SRenderSettings&oldid=199441"