Component:ProceduralSky: Difference between revisions

From Resonite Wiki
Automated: update Fields
if this doesn't fit mobile, then too bad html won't obey my commands. (added info)
 
Line 3: Line 3:
|Name=Procedural Sky
|Name=Procedural Sky
}}
}}
{{stub}}
The '''ProceduralSky''' texture is used to dynamically create a skybox using a sun rotation and intensity including sun color.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|SunQuality|'''[[#SunType|ProceduralSky.SunType]]'''|TypeAdv0=true|
|SunQuality|'''[[#SunType|ProceduralSky.SunType]]'''|TypeAdv0=true| The quality preset of the sun in the sky.
|SunSize|Float|
|SunSize|Float| size of the sun in the sky
|Sun|'''[[Component:Light|Light]]'''|TypeAdv2=true|
|Sun|'''[[Component:Light|Light]]'''|TypeAdv2=true| The light to use for rotation, intensity, and color of the sun on this material.
|AtmosphereThickness|Float|
|AtmosphereThickness|Float| How much the atmosphere will light up the scene. If this is low, the <code>SkyTint</code> color coming up from the lower region of the world won't make it up to the top of the world as well, and will gradient into black. good for thin atmosphere planets, or 0 for no atmosphere.
|SkyTint|ColorX|
|SkyTint|ColorX| The tint of the atmosphere of the world.
|GroundColor|ColorX|
|GroundColor|ColorX| The tint of the sky below the horizon line.
|Exposure|Float|
|Exposure|Float| How much to light up or darken the sky color overall.
}}
 
== SunType ==
{{Table EnumValues
|None|0| There should be no sun texture in the sky.
|Simple|1| There should be a simple disk for the sun texture in the sky.
|HighQuality|2| There should be a disk with a feathered/gradient edge for the sun texture in the sky.
}}
}}


== Behavior ==
== Usage ==


== Examples ==
== Examples ==


[[File:ProceduralSky_Example_1.png|thumb|600px|Example of a procedural sky using a sun size of 0.2, an atmospheric thickness of 0.2, a sun quality of high, and a sun color of cyan close to the horizon.]]
== See Also ==
== See Also ==


Line 25: Line 33:
[[Category:Components{{#translation:}}|Procedural Sky]]
[[Category:Components{{#translation:}}|Procedural Sky]]
[[Category:Components With Nested Enums{{#translation:}}|Procedural Sky]]
[[Category:Components With Nested Enums{{#translation:}}|Procedural Sky]]
[[Category:ComponentStubs]]

Latest revision as of 22:40, 5 July 2025

Component image 
File:ProceduralSkyComponent.png
Procedural Sky component as seen in the Scene Inspector

The ProceduralSky texture is used to dynamically create a skybox using a sun rotation and intensity including sun color.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
SunQuality ProceduralSky.SunType The quality preset of the sun in the sky.
SunSize Float size of the sun in the sky
Sun Light The light to use for rotation, intensity, and color of the sun on this material.
AtmosphereThickness Float How much the atmosphere will light up the scene. If this is low, the SkyTint color coming up from the lower region of the world won't make it up to the top of the world as well, and will gradient into black. good for thin atmosphere planets, or 0 for no atmosphere.
SkyTint ColorX The tint of the atmosphere of the world.
GroundColor ColorX The tint of the sky below the horizon line.
Exposure Float How much to light up or darken the sky color overall.

SunType

Values
Name Value Description
None 0 There should be no sun texture in the sky.
Simple 1 There should be a simple disk for the sun texture in the sky.
HighQuality 2 There should be a disk with a feathered/gradient edge for the sun texture in the sky.

Usage

Examples

Example of a procedural sky using a sun size of 0.2, an atmospheric thickness of 0.2, a sun quality of high, and a sun color of cyan close to the horizon.

See Also