Automated: create new component page |
add some more info |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 3: | Line 3: | ||
|Name=Light | |Name=Light | ||
}} | }} | ||
== 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| How far away shadows will render for this point light. | ||
|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: | |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. | ||
}} | }} | ||
Line 24: | Line 23: | ||
== Examples == | == Examples == | ||
[[File:LightCookieExample.png|thumb|Example showing a Cookie set on a Light with a StaticTexture2D]] | |||
== See Also == | == See Also == |
Latest revision as of 16:48, 20 October 2024
Component image
Usage
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 | How far away shadows will render for this point light. |
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. |