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.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback