1. Epic GamesDeveloper
  3. ULightComponentBase

ULightComponentBase

Unreal Engine C++ API Reference > Runtime > Engine > Components

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/LightComponentBase.h
Include #include "Components/LightComponentBase.h"

Syntax

UCLASS (Abstract, HideCategories=(Trigger, Activation, "Components|Activation", Physics),  
       ShowCategories=(Mobility), MinimalAPI)  
class ULightComponentBase : public USceneComponent

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint32: 1 bAffectGlobalIllumination Whether the light affects global illumination, when ray-traced global illumination is enabled.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint32: 1 bAffectReflection Whether the light affects objects in reflections, when ray-traced reflection is enabled.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint32: 1 bAffectsWorld Whether the light can affect the world, or whether it is disabled.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint32: 1 bAffectTranslucentLighting Whether the light affects translucency or not.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint32: 1 bCastDeepShadow Whether the light should cast high quality hair-strands self-shadowing.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint32: 1 bCastVolumetricShadow Whether the light shadows volumetric fog. Disabling this can save GPU time.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint32: 1 bTransmission Whether light from this light transmits through surfaces with subsurface scattering profiles.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint32: 1 CastDynamicShadows Whether the light should cast shadows from dynamic objects.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly TEnumAsByte< ECastRayTracedShadow::Type > CastRaytracedShadow  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly uint32: 1 CastShadows Whether the light should cast any shadows.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint32: 1 CastStaticShadows Whether the light should cast shadows from static objects.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly float DeepShadowLayerDistribution Change the deep shadow layers distribution 0:linear distribution (uniform layer distribution), 1:exponential (more details on near small details).
Public variable UProperty Transient TObjectPtr< UTexture2D > DynamicEditorTexture Sprite for dynamic light in the editor.
Public variable UProperty Transient float DynamicEditorTextureScale Sprite scaling for dynamic light in the editor.
Public variable UProperty Category, Interp, Meta BlueprintReadOnly float IndirectLightingIntensity Scales the indirect lighting contribution from this light.
Public variable UProperty Category, Interp, Meta BlueprintReadOnly float Intensity Total energy that the light emits.
Public variable UProperty Category, Interp, Meta BlueprintReadOnly FColor LightColor Filter color of the light. Note that this can change the light's effective intensity.
Public variable UProperty FGuid LightGuid GUID used to associate a light component with precomputed shadowing information across levels.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly int SamplesPerPixel Samples per pixel for ray tracing
Public variable UProperty Transient TObjectPtr< UTexture2D > StaticEditorTexture Sprite for static light in the editor.
Public variable UProperty Transient float StaticEditorTextureScale Sprite scaling for static light in the editor.
Public variable UProperty Category, Interp, Meta BlueprintReadOnly float VolumetricScatteringIntensity Intensity of the volumetric scattering from this light. This scales Intensity and LightColor.

Constructors

  Type Name Description
Public function  

ULightComponentBase ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UTexture2D *  
Public function Const float  
Public function Const UFunction BlueprintCallable, Category FLinearColor Gets the light color as a linear color
Public function Const bool Return True if a light's parameters as well as its position is static during gameplay, and can thus use static lighting.
Public function Const bool Whether the light has static direct shadowing.
Public function Const bool Returns true if the light's Mobility is set to Movable
Public function UFunction BlueprintCallable, Category void

SetAffectGlobalIllumination ( bool bNewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetAffectReflection ( bool bNewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetCastDeepShadow ( bool bNewValue
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetCastRaytracedShadow ( bool bNewValue
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetCastShadows ( bool bNewValue
)

 Sets whether this light casts shadows
Public function UFunction BlueprintCallable, Category void

SetCastVolumetricShadow ( bool bNewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetSamplesPerPixel ( int NewValue
)

  
Public function Virtual void Update/reset light GUIDs.
Public function Virtual void Update the texture used on the editor sprite
Public function void Validate light GUIDs and resets as appropriate.Validates light GUIDs and resets as appropriate.

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds Get the extent used when placing this component in the editor, used for 'pulling back' hit.
Public function Virtual Const bool We return a small bounds to allow us to non-interpenetrates when placing lights in the level.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void UActorComponent Interface
Public function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void Called after duplication & serialization and before PostLoad.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void UObject interface
Public function Virtual void UObject Interface
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable UProperty uint32: 1 bCastRaytracedShadow_DEPRECATED Whether the light shadows are computed with shadow-mapping or ray-tracing (when available).
Public variable UProperty float Brightness_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page