Class LightComponentBase

Light Component Base

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
LightComponentBase
LightComponent
SkyLightComponent
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 LightComponentBase : SceneComponent

Properties

| Improve this Doc View Source

bAffectsWorld

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

bAffectTranslucentLighting

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

bCastVolumetricShadow

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

bTransmission

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

CastDynamicShadows

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

CastShadows

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

CastStaticShadows

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

DefaultObject

Get UE4 Default Object for this Class

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

DynamicEditorTexture

Sprite for dynamic light in the editor.

Declaration
public Texture2D DynamicEditorTexture { get; set; }
Property Value
Type Description
Texture2D
| Improve this Doc View Source

DynamicEditorTextureScale

Sprite scaling for dynamic light in the editor.

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

IndirectLightingIntensity

Scales the indirect lighting contribution from this light.

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

A value of 0 disables any GI from this light. Default is 1.

| Improve this Doc View Source

Intensity

Total energy that the light emits.

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

LightColor

Filter color of the light.

Declaration
public Color LightColor { get; }
Property Value
Type Description
Color
Remarks

Note that this can change the light's effective intensity.

| Improve this Doc View Source

LightGuid

GUID used to associate a light component with precomputed shadowing information across levels.

Declaration
public FGuid LightGuid { get; set; }
Property Value
Type Description
FGuid
Remarks

The GUID changes whenever the light position changes.

| 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

StaticEditorTexture

Sprite for static light in the editor.

Declaration
public Texture2D StaticEditorTexture { get; set; }
Property Value
Type Description
Texture2D
| Improve this Doc View Source

StaticEditorTextureScale

Sprite scaling for static light in the editor.

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

VolumetricScatteringIntensity

Intensity of the volumetric scattering from this light. This scales Intensity and LightColor.

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

Methods

| Improve this Doc View Source

GetLightColor()

Gets the light color as a linear color

Declaration
public LinearColor GetLightColor()
Returns
Type Description
LinearColor
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

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

SetCastShadows(Boolean)

Sets whether this light casts shadows

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

SetCastVolumetricShadow(Boolean)

Set Cast Volumetric Shadow

Declaration
public void SetCastVolumetricShadow(bool bNewValue)
Parameters
Type Name Description
System.Boolean bNewValue

Operators

| Improve this Doc View Source

Implicit(IntPtr to LightComponentBase)

Convert from IntPtr to UObject

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