Component:Light: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add remaining info
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|Name=Light
|Name=Light
}}
}}
{{stub}}
The '''Light''' component is used to illumate the render scene beyond skybox illumination. This component can be used for suns, spots, and points, but not area lights.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|LightType|LightType|
|LightType|LightType| The type of light, which can be directional or point to name a couple.
|Intensity|Float|
|Intensity|Float| how intense the light is. This is a multiplier.
|Color|ColorX|
|Color|ColorX| the color of the light this source should project
|ShadowType|ShadowType|
|ShadowType|ShadowType| The type of shadow this light should use
|ShadowStrength|Float|
|ShadowStrength|Float| How dark the shadows are.
|ShadowNearPlane|Float|
|ShadowNearPlane|Float| How far away shadows will render for this point light.
|ShadowMapResolution|Int|
|ShadowMapResolution|Int| How detailed the resolution for shadows is in pixels.
|ShadowBias|Float|
|ShadowBias|Float| added to the distance in the shadow map to ensure that pixels on the borderline definitely pass the comparison as they should.
|ShadowNormalBias|Float|
|ShadowNormalBias|Float| Makes surrounding lit areas encroach upon the center shadow, making the encroached area lit too.
|Range|Float|
|Range|Float| How far for the light to shine in meters, where the range represents the point where the falloff stops.
|SpotAngle|Float|
|SpotAngle|Float| The angle from 0-180 when on spot light mode to project the light at. 0 is no light, 60 is like car headlights, and 180 is extreme and unrealistic.
|Cookie|{{RootFieldType|AssetRef`1|[[Type:ITexture|ITexture]]}}|TypeAdv11=true|
|Cookie|{{RootFieldType|AssetRef`1|[[Type:ITexture2D|ITexture2D]]}}|TypeAdv11=true| The cookie texture is used to limit the light area of a spot light from a circle to a custom shape.
}}
}}


== Behavior ==
== Usage ==
{{stub}}


== Examples ==
== Examples ==
[[File:LightCookieExample.png|thumb|Example showing a Cookie set on a Light with a StaticTexture2D]]


== See Also ==
== See Also ==
* [[Component:Skybox]]


[[Category:Components:Rendering{{#translation:}}|Light]]
[[Category:Components:Rendering{{#translation:}}|Light]]
[[Category:Components{{#translation:}}|Light]]
[[Category:Components{{#translation:}}|Light]]
[[Category:ComponentStubs]]

Latest revision as of 20:02, 22 January 2025

Component image 
Light component as seen in the Scene Inspector

The Light component is used to illumate the render scene beyond skybox illumination. This component can be used for suns, spots, and points, but not area lights.

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.
LightType LightType The type of light, which can be directional or point to name a couple.
Intensity Float how intense the light is. This is a multiplier.
Color ColorX the color of the light this source should project
ShadowType ShadowType The type of shadow this light should use
ShadowStrength Float How dark the shadows are.
ShadowNearPlane Float How far away shadows will render for this point light.
ShadowMapResolution Int How detailed the resolution for shadows is in pixels.
ShadowBias Float added to the distance in the shadow map to ensure that pixels on the borderline definitely pass the comparison as they should.
ShadowNormalBias Float Makes surrounding lit areas encroach upon the center shadow, making the encroached area lit too.
Range Float How far for the light to shine in meters, where the range represents the point where the falloff stops.
SpotAngle Float The angle from 0-180 when on spot light mode to project the light at. 0 is no light, 60 is like car headlights, and 180 is extreme and unrealistic.
Cookie ITexture2D The cookie texture is used to limit the light area of a spot light from a circle to a custom shape.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Examples

Example showing a Cookie set on a Light with a StaticTexture2D

See Also