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

> Unreal Engine API Reference > Runtime > Engine > Components > ULightComponent > ULightComponent::AffectsPrimitive

Light Theme

Dark Theme

ULightComponent::AffectsPrimitive

Test whether this light affects the given primitive.

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/LightComponent.h
Include	#include "Components/LightComponent.h"
Source	/Engine/Source/Runtime/Engine/Private/Components/LightComponent.cpp

Syntax

bool AffectsPrimitive
(
const UPrimitiveComponent * Primitive
) const

Remarks

Test whether this light affects the given primitive. This checks both the primitive and light settings for light relevance and also calls AffectsBounds.

Returns

True if the light affects the primitive.

Parameters

Parameter	Description
PrimitiveSceneInfo	The primitive to test.

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

Take our survey

Dismiss