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 > Plugins > Niagara > ANiagaraLensEffectBase

Light Theme

Dark Theme

ANiagaraLensEffectBase

Niagara equivalent of [AEmitterCameraLensEffectBase](API\Runtime\Engine\Particles\AEmitterCameraLensEffectBase).

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

ANiagaraActor

ANiagaraLensEffectBase

References

Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraLensEffectBase.h
Include	#include "NiagaraLensEffectBase.h"

Syntax

UCLASS(Abstract, Blueprintable,
       HideCategories=(NiagaraActorActivation, "Components|Activation", Input, Collision, "Game|Damage"))
class ANiagaraLensEffectBase :
    public ANiagaraActor,
    public ICameraLensEffectInterface

Remarks

Niagara equivalent of AEmitterCameraLensEffectBase. This class is supported by APlayerCameraManager (via ICameraLensEffectInterface) as a camera lens effect.

Variables

	Name	Description
uint8: 1	bAllowMultipleInstances	Are multiple instances of the effect allowed? When disabled, a single instance of the effect may be retriggered!
float	BaseAuthoredFOV	FOVs that differ from this may cause adjustments in positioning.
uint8: 1	bResetWhenRetriggered	When an instance of this effect is retriggered (because more than one instance is not allowed) should the particle system be explicitly reset? Activate(bReset = true);
FTransform	DesiredRelativeTransform	Relative offset from the camera (where X is out from the camera) Might be changed slightly when the FOV is different than expected.
TArray< TSubcla...	EmittersToTreatAsSame	If an effect class in this array is currently playing, do not play this effect.
TObjectPtr< APl...	OwningCameraManager

Constructors

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

Overridden from AActor

		Name	Description
	void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Overridable function called whenever this actor is being removed from a level

Overridden from ICameraLensEffectInterface

	Name	Description
void	ActivateLensEffect()	This will actually activate the lens Effect.
void	AdjustBaseFOV ( float NewFOV )
void	DeactivateLensEffect()	Deactivtes the particle system.
float	GetBaseFOV()
const FTrans...	GetRelativeTransform()
bool	IsLooping()	Returns true if any associated particle system is set to looping
void	NotifyRetriggered()	Called when this emitter is re-triggered, for bAllowMultipleInstances=false emitters.
void	NotifyWillBePooled()	If this type needs to handle being pooled, override this function
void	RegisterCamera ( APlayerCameraManager* CameraMa... )	Called when being added to the player camera manager.
bool	ResetWhenTriggered()
bool	ShouldAllowMultipleInstances()
bool	ShouldTreatEmitterAsSame ( TSubclassOf< AActor > OtherEmitter )	Is this emitter functionally equivalent to the class OtherEmitter?