Component:Light: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
info I guess. Idk what shadow things do other than its some deferred lighting garbo
Line 3: Line 3:
|Name=Light
|Name=Light
}}
}}
{{stub}}


== Usage ==
== Usage ==
{{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|  
|ShadowMapResolution|Int|
|ShadowMapResolution|Int| How detailed the resolution for shadows is in pixels. More info in [[#Behavior]].
|ShadowBias|Float|
|ShadowBias|Float|  
|ShadowNormalBias|Float|
|ShadowNormalBias|Float|  
|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.
}}
}}



Revision as of 04:58, 25 March 2024

Component image 
Light component as seen in the Scene Inspector


Usage

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.
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
ShadowMapResolution Int How detailed the resolution for shadows is in pixels. More info in #Behavior.
ShadowBias Float
ShadowNormalBias Float
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.

Behavior

Examples

See Also