Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

ULocalLightComponent

A light component which emits light from a single point equally in all directions.

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

ULightComponentBase

ULightComponent

ULocalLightComponent

UPointLightComponent

USpotLightComponent

URectLightComponent

References

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

Syntax

class ULocalLightComponent : public ULightComponent

Remarks

A light component which emits light from a single point equally in all directions.

Variables

	Name	Description
float	AttenuationRadius	Bounds the light's visible influence.
ELightUnits	IntensityUnits	Units used for the intensity.
float	InverseExposureBlend	Blend Factor used to blend between Intensity and Intensity/Exposure.
FLightmassPoint...	LightmassSettings	The Lightmass settings for this object.

Constructors

	Name	Description
	ULocalLightComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
float	GetUnitsConversionFactor ( ELightUnits SrcUnits, ELightUnits TargetUnits, float CosHalfConeAngle )
void	SetAttenuationRadius ( float NewRadius )
void	SetIntensityUnits ( ELightUnits NewIntensityUnits )	Set the units used for the intensity of the light

Overridden from ULightComponent

	Name	Description
bool	AffectsBounds ( const FBoxSphereBounds& InBounds )	Test whether the light affects the given bounding volume.
FBox	GetBoundingBox()	Return the world-space bounding box of the light's influence.
FSphere	GetBoundingSphere()
FLightmassLi...	GetLightmassSettings()
FVector4	GetLightPosition()	Return the homogenous position of the light.

Overridden from UActorComponent

		Name	Description
	void	SendRenderTransform_Concurrent()	Called to send a transform update for this component to the rendering thread

Overridden from UObject

	Name	Description
bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called after property has changed via e.g. property window or set command.
void	PostInterpChange ( FProperty* PropertyThatChanged )	This is called when property is modified by InterpPropertyTracks
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

		Name	Description
	float	Radius_DEPRECATED

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel