LightComponent

Outputs a light source. Recommended for use with TransformComponent.

# Properties

[{"index":"Color Color (Sync)","0":"The color of the light source."}]

[{"index":"float FalloffDistance (Sync)","0":"Determines how much the light will stretch from FreeformPoints if the light source is a Freeform-type. The larger the value, the larger the size."}]

[{"index":"float FalloffIntensity (Sync)","0":"Controls the softness of the curves when the light source starts to disappear. The larger the value, the more blurred and softer the edge looks. The smaller the value, the sharper and clearer the edge looks."}]

[{"index":"SyncList FreeformPoints (Sync)","0":"Points that define the shape of a Freeform-type light source. The number of points can't exceed 2,000."}]

[{"index":"boolean IgnoreMapLayerCheck (Sync)","0":"Does not perform automatic substitution when the Map Layer's name is specified in SortingLayer."}]

[{"index":"float InnerRadius (Sync)","0":"The radius of the internal light source area that has the max brightness if the light source is a Spot-type. It can't be larger than the OuterRadius value."}]

[{"index":"float Intensity (Sync)","0":"The intensity of the light source."}]

[{"index":"int32 LightOrder (Sync)","0":"Determines the rendering order of a light source light texture. The light source with lower values will be rendered first, and then, the larger value light source will be rendered on top."}]

[{"index":"float OuterRadius (Sync)","0":"The outer range that determines the radius Spot-type light source. The light will begin to get weaker from the end of the InnerRadius, and the light strength will be 0% when it reaches the radius."}]

[{"index":"LightOverlapOperation OverlapOperation (Sync)","0":"How to calculate a light source."}]

[{"index":"float PlayRate (Sync)","0":"The play speed of an animation clip resource that is used for a Sprite-type light source. The larger the value, the faster the play speed."}]

[{"index":"float SpotInnerAngle (Sync)","0":"The inner angle of a Spot-type light source. The wider the angle, the larger the interval. All of the pixels have 100% of the light intensity applied to them. It can't be larger than the SpotOuterAngle value."}]

[{"index":"float SpotOuterAngle (Sync)","0":"The outer angle of a Spot-type light source. The larger the value, the wider the angle. The light will begin to get weaker from the end of the SpotInnerAngle, and the light strength will be 0% when it reaches the SpotOuterAngle."}]

[{"index":"string SpriteRUID (Sync)","0":"The RUID of the sprite that will be drawn by a Sprite-type light source."}]

[{"index":"boolean TargetAllSortingLayers (Sync)","0":"Sets whether or not this light source will affect all SortingLayers."}]

[{"index":"SyncList TargetSortingLayers (Sync)","0":"Selects the SortingLayer that will be affected by this light source."}]

[{"index":"LightType Type (Sync)","0":"The type of light source. There are 4 types: Spot, Freeform, Global, and Sprite."}]

##### inherited from Component:

[{"index":"boolean Enable (Sync)","0":"Checks whether Component is activated or not."}]

[{"index":"boolean EnableInHierarchy (ReadOnly) (HideFromInspector)","0":"Displays whether this Component is Enable in the hierarchy. If Entity Enable is false regardless of Component Enable, returns false."}]

[{"index":"Entity Entity (ReadOnly)","0":"The Entity that owns this component."}]

# Methods

##### inherited from Component:

[{"index":"boolean IsClient()","0":"Returns whether the current execution environment is a client or not."}]

[{"index":"boolean IsServer()","0":"Returns whether the current execution environment is a server or not."}]