Sinespace Client  2023.2.17543
Client-side scripting for Sinespace
SineSpace.Scripting.RenderSettings.SRenderSettings Class Reference

Public Member Functions

 SRenderSettings (SScript sScript)
 
void SetGlobalShaderTexture (string name, SResource dir)
 Set a global texture property for all shaders. More...
 
void SetGlobalShaderFloat (string name, float dir)
 Set a global float property for all shaders. More...
 
void SetGlobalShaderColor (string name, SColor dir)
 Set a global color property for all shaders. More...
 
void SetGlobalShaderVector (string name, SVector dir)
 Set a global vector property for all shaders. More...
 
void SetGlobalShaderVector (string name, SVector dir, float direction)
 

Properties

int DefaultReflectionResolution [get, set]
 Cubemap resolution for default reflection More...
 
SMaterial Skybox [get, set]
 The global skybox to use. More...
 
float FlareFadeSpeed [get, set]
 The fade speed of all flares in the Scene More...
 
float FlareStrength [get, set]
 The intensity of all flares in the Scene More...
 
float HaloStrength [get, set]
 Size of the light halos More...
 
int ReflectionBounces [get, set]
 The number of times a reflection includes other reflections More...
 
float ReflectionIntensity [get, set]
 How much the skybox / custom cubemap reflection affects the Scene. More...
 
SColor SubtractiveShadowColor [get, set]
 The color used for the sun shadows in the Subtractive light mode. More...
 
float AmbientIntensity [get, set]
 How much the light from the Ambient Source affects the Scene. More...
 
SColor AmbientLight [get, set]
 Flat ambient lighting color. More...
 
SColor AmbientGroundColor [get, set]
 Ambient lighting coming from below. More...
 
SColor AmbientEquatorColor [get, set]
 Ambient lighting coming from the sides. More...
 
SColor AmbientSkyColor [get, set]
 Ambient lighting coming from above. More...
 
SAmbientMode AmbientMode [get, set]
 Ambient lighting mode More...
 
float FogEndDistance [get, set]
 The ending distance of linear fog. More...
 
float FogStartDistance [get, set]
 The starting distance of linear fog. More...
 
float FogDensity [get, set]
 The density of the exponential fog. More...
 
SColor FogColor [get, set]
 The color of the fog. More...
 
SFogMode FogMode [get, set]
 Ambient lighting mode More...
 
bool Fog [get, set]
 The color of the fog. More...
 
float AmbientSkyboxAmount [get, set]
 
SDefaultReflectionMode DefaultReflectionMode [get, set]
 Ambient lighting mode More...
 

Constructor & Destructor Documentation

◆ SRenderSettings()

SineSpace.Scripting.RenderSettings.SRenderSettings.SRenderSettings ( SScript  sScript)

Member Function Documentation

◆ SetGlobalShaderColor()

void SineSpace.Scripting.RenderSettings.SRenderSettings.SetGlobalShaderColor ( string  name,
SColor  dir 
)

Set a global color property for all shaders.

Parameters
nameThe name of the property.
dirThe color you want to set.
–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)

◆ SetGlobalShaderFloat()

void SineSpace.Scripting.RenderSettings.SRenderSettings.SetGlobalShaderFloat ( string  name,
float  dir 
)

Set a global float property for all shaders.

Parameters
nameThe name of the property.
dirThe float you want to set.
–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.SetGlobalShaderFloat("_Mult",1)

◆ SetGlobalShaderTexture()

void SineSpace.Scripting.RenderSettings.SRenderSettings.SetGlobalShaderTexture ( string  name,
SResource  dir 
)

Set a global texture property for all shaders.

Parameters
nameThe name of the property.
dirThe texture you want to set.
–create a shader first and define "sampler2D _TestTex"
–use "_TestTex" as "_MainTex" and delete "_MainTex"
–set value and put on a gameobject
Space.RenderSettings.SetGlobalShaderTexture("_TestTex",Space.Resources[3])

◆ SetGlobalShaderVector() [1/2]

void SineSpace.Scripting.RenderSettings.SRenderSettings.SetGlobalShaderVector ( string  name,
SVector  dir 
)

Set a global vector property for all shaders.

Parameters
nameThe name of the property.
dirThe vector you want to set.
–Create a shader first and define "vector _TestVector"
–set value and put on a gameobject
Space.RenderSettings.SetGlobalShaderFloat("_TestVector",Vector.One)

◆ SetGlobalShaderVector() [2/2]

void SineSpace.Scripting.RenderSettings.SRenderSettings.SetGlobalShaderVector ( string  name,
SVector  dir,
float  direction 
)

Property Documentation

◆ AmbientEquatorColor

SColor SineSpace.Scripting.RenderSettings.SRenderSettings.AmbientEquatorColor
getset

Ambient lighting coming from the sides.

–set value
Space.RenderSettings.AmbientEquatorColor=Color.Green
–get value
Space.Log(Space.RenderSettings.AmbientEquatorColor.ToString())

◆ AmbientGroundColor

SColor SineSpace.Scripting.RenderSettings.SRenderSettings.AmbientGroundColor
getset

Ambient lighting coming from below.

–set value
Space.RenderSettings.AmbientGroundColor=Color.Green
–get value
Space.Log(Space.RenderSettings.AmbientGroundColor.ToString())

◆ AmbientIntensity

float SineSpace.Scripting.RenderSettings.SRenderSettings.AmbientIntensity
getset

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 SineSpace.Scripting.RenderSettings.SRenderSettings.AmbientLight
getset

Flat ambient lighting color.

–set value
Space.RenderSettings.AmbientLight=Color.Blue
–get value
Space.Log(Space.RenderSettings.AmbientLight.ToString())

◆ AmbientMode

SAmbientMode SineSpace.Scripting.RenderSettings.SRenderSettings.AmbientMode
getset

Ambient lighting mode

–set value
Space.RenderSettings.AmbientMode=0
–Skybox = 0,
–Trilight = 1,
–Flat = 3,
–Custom = 4
–get value
Space.Log(Space.RenderSettings.AmbientMode)

◆ AmbientSkyboxAmount

float SineSpace.Scripting.RenderSettings.SRenderSettings.AmbientSkyboxAmount
getset

◆ AmbientSkyColor

SColor SineSpace.Scripting.RenderSettings.SRenderSettings.AmbientSkyColor
getset

Ambient lighting coming from above.

–set value
Space.RenderSettings.AmbientSkyColor=Color.White
–get value
Space.Log(Space.RenderSettings.AmbientSkyColor.ToString())

◆ DefaultReflectionMode

SDefaultReflectionMode SineSpace.Scripting.RenderSettings.SRenderSettings.DefaultReflectionMode
getset

Ambient lighting mode

–set value
Space.RenderSettings.DefaultReflectionMode=1
–Skybox = 0,
–Custom = 1
–get value
Space.Log(Space.RenderSettings.DefaultReflectionMode)

◆ DefaultReflectionResolution

int SineSpace.Scripting.RenderSettings.SRenderSettings.DefaultReflectionResolution
getset

Cubemap resolution for default reflection

–set value
Space.RenderSettings.DefaultReflectionResolution=256
–get value
Space.Log(Space.RenderSettings.DefaultReflectionResolution)

◆ FlareFadeSpeed

float SineSpace.Scripting.RenderSettings.SRenderSettings.FlareFadeSpeed
getset

The fade speed of all flares in the Scene

–set value
Space.RenderSettings.FlareFadeSpeed=5
–get value
Space.Log(Space.RenderSettings.FlareFadeSpeed)

◆ FlareStrength

float SineSpace.Scripting.RenderSettings.SRenderSettings.FlareStrength
getset

The intensity of all flares in the Scene

–set value
Space.RenderSettings.FlareStrength=1
–get value
Space.Log(Space.RenderSettings.FlareStrength)

◆ Fog

bool SineSpace.Scripting.RenderSettings.SRenderSettings.Fog
getset

The color of the fog.

–set value
Space.RenderSettings.Fog=true
–get value
Space.Log(Space.RenderSettings.Fog)

◆ FogColor

SColor SineSpace.Scripting.RenderSettings.SRenderSettings.FogColor
getset

The color of the fog.

–set value
Space.RenderSettings.FogColor=Color.Black
–get value
Space.Log(Space.RenderSettings.FogColor.ToString())

◆ FogDensity

float SineSpace.Scripting.RenderSettings.SRenderSettings.FogDensity
getset

The density of the exponential fog.

–set value
Space.RenderSettings.FogDensity=10
–get value
Space.Log(Space.RenderSettings.FogDensity)

◆ FogEndDistance

float SineSpace.Scripting.RenderSettings.SRenderSettings.FogEndDistance
getset

The ending distance of linear fog.

–set value
Space.RenderSettings.FogEndDistance=300
–get value
Space.Log(Space.RenderSettings.FogEndDistance)

◆ FogMode

SFogMode SineSpace.Scripting.RenderSettings.SRenderSettings.FogMode
getset

Ambient lighting mode

–set value
Space.RenderSettings.FogMode=2
–Linear = 1,
–Exponential = 2,
–get value
Space.Log(Space.RenderSettings.FogMode)

◆ FogStartDistance

float SineSpace.Scripting.RenderSettings.SRenderSettings.FogStartDistance
getset

The starting distance of linear fog.

–set value
Space.RenderSettings.FogStartDistance=10
–get value
Space.Log(Space.RenderSettings.FogStartDistance)

◆ HaloStrength

float SineSpace.Scripting.RenderSettings.SRenderSettings.HaloStrength
getset

Size of the light halos

–set value
Space.RenderSettings.HaloStrength=1
–get value
Space.Log(Space.RenderSettings.HaloStrength)

◆ ReflectionBounces

int SineSpace.Scripting.RenderSettings.SRenderSettings.ReflectionBounces
getset

The number of times a reflection includes other reflections

–set value
Space.RenderSettings.ReflectionBounces=5
–get value
Space.Log(Space.RenderSettings.ReflectionBounces)

◆ ReflectionIntensity

float SineSpace.Scripting.RenderSettings.SRenderSettings.ReflectionIntensity
getset

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

–set value
Space.RenderSettings.ReflectionIntensity=1
–get value
Space.Log(Space.RenderSettings.ReflectionIntensity)

◆ Skybox

SMaterial SineSpace.Scripting.RenderSettings.SRenderSettings.Skybox
getset

The global skybox to use.

–set value
Space.RenderSettings.Skybox=Space.Resources[1].AsMaterial
–get value
Space.Log(Space.RenderSettings.Skybox.Name)
–Print the name of the material you just set.

◆ SubtractiveShadowColor

SColor SineSpace.Scripting.RenderSettings.SRenderSettings.SubtractiveShadowColor
getset

The color used for the sun shadows in the Subtractive light mode.

–set value
Space.RenderSettings.SubtractiveShadowColor=Color.Red
–get value
Space.Log(Space.RenderSettings.SubtractiveShadowColor.ToString())
SineSpace.Scripting.Types.SAmbientMode.Skybox
@ Skybox
SineSpace.Scripting.RenderSettings.SRenderSettings.Skybox
SMaterial Skybox
The global skybox to use.
Definition: SRenderSettings.cs:59
SineSpace.Scripting.Types.SFogMode.Linear
@ Linear