Navigation
API > API/Plugins > API/Plugins/Niagara
Inheritance Hierarchy
- 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"),
MinimalAPI)
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
| Type | 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< TSubclassOf< AActor > > | EmittersToTreatAsSame | If an effect class in this array is currently playing, do not play this effect. |
  |
TObjectPtr< APlayerCameraManager > | OwningCameraManager |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
ANiagaraLensEffectBase
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | ||
  |
void | AdjustBaseFOV
(
float NewFOV |
|
  |
void | ||
  |
void | EndPlay
(
const EEndPlayReason::Type EndPlayReason |
|
   |
float | GetBaseFOV () |
|
   |
const FTransform & | ||
   |
bool | IsLooping () |
|
  |
void | ||
  |
void | ||
  |
void | RegisterCamera
(
APlayerCameraManager* CameraManager |
|
   |
bool | ||
   |
bool | ||
   |
bool | ShouldTreatEmitterAsSame
(
TSubclassOf< AActor > OtherEmitter |