Class LightComponent

Light Component

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
LightComponentBase
LightComponent
DirectionalLightComponent
LocalLightComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class LightComponent : LightComponentBase

Properties

| Improve this Doc View Source

bAffectDynamicIndirectLighting

Declaration
public bool bAffectDynamicIndirectLighting { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bCastShadowsFromCinematicObjectsOnly

Declaration
public bool bCastShadowsFromCinematicObjectsOnly { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bEnableLightShaftBloom

Declaration
public bool bEnableLightShaftBloom { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bForceCachedShadowsForMovablePrimitives

Declaration
public bool bForceCachedShadowsForMovablePrimitives { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

BloomScale

Scales the additive color.

Declaration
public float BloomScale { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

BloomThreshold

Scene color must be larger than this to create bloom in the light shafts.

Declaration
public float BloomThreshold { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

BloomTint

Multiplies against scene color to create the bloom color.

Declaration
public Color BloomTint { get; }
Property Value
Type Description
Color
| Improve this Doc View Source

bUseIESBrightness

Declaration
public bool bUseIESBrightness { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bUseRayTracedDistanceFieldShadows

Declaration
public bool bUseRayTracedDistanceFieldShadows { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bUseTemperature

Declaration
public bool bUseTemperature { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CastTranslucentShadows

Declaration
public bool CastTranslucentShadows { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ContactShadowLength

Length of screen space ray trace for sharp contact shadows. Zero is disabled.

Declaration
public float ContactShadowLength { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

ContactShadowLengthInWS

Declaration
public bool ContactShadowLengthInWS { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static LightComponent DefaultObject { get; }
Property Value
Type Description
LightComponent
| Improve this Doc View Source

DisabledBrightness

Brightness factor applied to the light when the light function is specified but disabled, for example in scene captures that use SceneCapView_LitNoShadows.

Declaration
public float DisabledBrightness { get; }
Property Value
Type Description
System.Single
Remarks

This should be set to the average brightness of the light function material's emissive input, which should be between 0 and 1.

| Improve this Doc View Source

IESBrightnessScale

Global scale for IES brightness contribution. Only available when "Use IES Brightness" is selected, and a valid IES profile texture is set

Declaration
public float IESBrightnessScale { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

IESTexture

IES texture (light profiles from real world measured data)

Declaration
public TextureLightProfile IESTexture { get; }
Property Value
Type Description
TextureLightProfile
| Improve this Doc View Source

LightFunctionFadeDistance

Distance at which the light function should be completely faded to DisabledBrightness.

Declaration
public float LightFunctionFadeDistance { get; }
Property Value
Type Description
System.Single
Remarks

This is useful for hiding aliasing from light functions applied in the distance.

| Improve this Doc View Source

LightFunctionMaterial

The light function material to be applied to this light.

Declaration
public MaterialInterface LightFunctionMaterial { get; }
Property Value
Type Description
MaterialInterface
Remarks

Note that only non-lightmapped lights (UseDirectLightMap=False) can have a light function.

| Improve this Doc View Source

LightFunctionScale

Scales the light function projection. X and Y scale in the directions perpendicular to the light's direction, Z scales along the light direction.

Declaration
public Vector LightFunctionScale { get; }
Property Value
Type Description
Vector
| Improve this Doc View Source

LightingChannels

Channels that this light should affect.

Declaration
public LightingChannels LightingChannels { get; }
Property Value
Type Description
LightingChannels
Remarks

These channels only apply to opaque materials, direct lighting, and dynamic lighting and shadowing.

| Improve this Doc View Source

MaxDistanceFadeRange

Max Distance Fade Range

Declaration
public float MaxDistanceFadeRange { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MaxDrawDistance

Max Draw Distance

Declaration
public float MaxDrawDistance { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

RayStartOffsetDepthScale

Controls how large of an offset ray traced shadows have from the receiving surface as the camera gets further away.

Declaration
public float RayStartOffsetDepthScale { get; }
Property Value
Type Description
System.Single
Remarks

This can be useful to hide self-shadowing artifacts from low resolution distance fields on huge static meshes.

| Improve this Doc View Source

ShadowBias

Controls how accurate self shadowing of whole scene shadows from this light are.

Declaration
public float ShadowBias { get; }
Property Value
Type Description
System.Single
Remarks

At 0, shadows will start at the their caster surface, but there will be many self shadowing artifacts. larger values, shadows will start further from their caster, and there won't be self shadowing artifacts but object might appear to fly. around 0.5 seems to be a good tradeoff. This also affects the soft transition of shadows

| Improve this Doc View Source

ShadowResolutionScale

Scales the resolution of shadowmaps used to shadow this light.

Declaration
public float ShadowResolutionScale { get; }
Property Value
Type Description
System.Single
Remarks

By default shadowmap resolution is chosen based on screen size of the caster. Note: shadowmap resolution is still clamped by 'r.Shadow.MaxResolution'

| Improve this Doc View Source

ShadowSharpen

Amount to sharpen shadow filtering

Declaration
public float ShadowSharpen { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

SpecularScale

Multiplier on specular highlights.

Declaration
public float SpecularScale { get; }
Property Value
Type Description
System.Single
Remarks

Use only with great care! Any value besides 1 is not physical! Can be used to artistically remove highlights mimicking polarizing filters or photo touch up.

| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

Temperature

Color temperature in Kelvin of the blackbody illuminant.

Declaration
public float Temperature { get; }
Property Value
Type Description
System.Single
Remarks

White (D65) is 6500K.

Methods

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static LightComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
LightComponent
| Improve this Doc View Source

SetAffectDynamicIndirectLighting(Boolean)

Set Affect Dynamic Indirect Lighting

Declaration
public void SetAffectDynamicIndirectLighting(bool bNewValue)
Parameters
Type Name Description
System.Boolean bNewValue
| Improve this Doc View Source

SetAffectTranslucentLighting(Boolean)

Set Affect Translucent Lighting

Declaration
public void SetAffectTranslucentLighting(bool bNewValue)
Parameters
Type Name Description
System.Boolean bNewValue
| Improve this Doc View Source

SetBloomScale(Single)

Set Bloom Scale

Declaration
public void SetBloomScale(float NewValue)
Parameters
Type Name Description
System.Single NewValue
| Improve this Doc View Source

SetBloomThreshold(Single)

Set Bloom Threshold

Declaration
public void SetBloomThreshold(float NewValue)
Parameters
Type Name Description
System.Single NewValue
| Improve this Doc View Source

SetBloomTint(Color)

Set Bloom Tint

Declaration
public void SetBloomTint(Color NewValue)
Parameters
Type Name Description
Color NewValue
| Improve this Doc View Source

SetEnableLightShaftBloom(Boolean)

Set Enable Light Shaft Bloom

Declaration
public void SetEnableLightShaftBloom(bool bNewValue)
Parameters
Type Name Description
System.Boolean bNewValue
| Improve this Doc View Source

SetForceCachedShadowsForMovablePrimitives(Boolean)

Set Force Cached Shadows for Movable Primitives

Declaration
public void SetForceCachedShadowsForMovablePrimitives(bool bNewValue)
Parameters
Type Name Description
System.Boolean bNewValue
| Improve this Doc View Source

SetIESTexture(TextureLightProfile)

Set IESTexture

Declaration
public void SetIESTexture(TextureLightProfile NewValue)
Parameters
Type Name Description
TextureLightProfile NewValue
| Improve this Doc View Source

SetIndirectLightingIntensity(Single)

Set Indirect Lighting Intensity

Declaration
public void SetIndirectLightingIntensity(float NewIntensity)
Parameters
Type Name Description
System.Single NewIntensity
| Improve this Doc View Source

SetIntensity(Single)

Set intensity of the light

Declaration
public void SetIntensity(float NewIntensity)
Parameters
Type Name Description
System.Single NewIntensity
| Improve this Doc View Source

SetLightColor(LinearColor, Boolean)

Set color of the light

Declaration
public void SetLightColor(LinearColor NewLightColor, bool bSRGB)
Parameters
Type Name Description
LinearColor NewLightColor
System.Boolean bSRGB
| Improve this Doc View Source

SetLightFunctionDisabledBrightness(Single)

Set Light Function Disabled Brightness

Declaration
public void SetLightFunctionDisabledBrightness(float NewValue)
Parameters
Type Name Description
System.Single NewValue
| Improve this Doc View Source

SetLightFunctionFadeDistance(Single)

Set Light Function Fade Distance

Declaration
public void SetLightFunctionFadeDistance(float NewLightFunctionFadeDistance)
Parameters
Type Name Description
System.Single NewLightFunctionFadeDistance
| Improve this Doc View Source

SetLightFunctionMaterial(MaterialInterface)

Set Light Function Material

Declaration
public void SetLightFunctionMaterial(MaterialInterface NewLightFunctionMaterial)
Parameters
Type Name Description
MaterialInterface NewLightFunctionMaterial
| Improve this Doc View Source

SetLightFunctionScale(Vector)

Set Light Function Scale

Declaration
public void SetLightFunctionScale(Vector NewLightFunctionScale)
Parameters
Type Name Description
Vector NewLightFunctionScale
| Improve this Doc View Source

SetShadowBias(Single)

Set Shadow Bias

Declaration
public void SetShadowBias(float NewValue)
Parameters
Type Name Description
System.Single NewValue
| Improve this Doc View Source

SetTemperature(Single)

Set Temperature

Declaration
public void SetTemperature(float NewTemperature)
Parameters
Type Name Description
System.Single NewTemperature
| Improve this Doc View Source

SetTransmission(Boolean)

Set Transmission

Declaration
public void SetTransmission(bool bNewValue)
Parameters
Type Name Description
System.Boolean bNewValue
| Improve this Doc View Source

SetVolumetricScatteringIntensity(Single)

Set Volumetric Scattering Intensity

Declaration
public void SetVolumetricScatteringIntensity(float NewIntensity)
Parameters
Type Name Description
System.Single NewIntensity

Operators

| Improve this Doc View Source

Implicit(IntPtr to LightComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator LightComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
LightComponent