Navigation
API > API/Plugins > API/Plugins/Niagara
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&40;Abstract, Blueprintable,
HideCategories&61;&40;NiagaraActorActivation, "Components&124;Activation", Input, Collision, "Game&124;Damage"&41;,
MinimalAPI&41;
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 |
Overridden from AActor
| Type | Name | Description | |
|---|---|---|---|
  |
void | EndPlay
(
const EEndPlayReason::Type EndPlayReason |
Overridable function called whenever this actor is being removed from a level |
Overridden from ICameraLensEffectInterface
| Type | Name | Description | |
|---|---|---|---|
  |
void | This will actually activate the lens Effect. | |
  |
void | AdjustBaseFOV
(
float NewFOV |
|
  |
void | Deactivtes the particle system. | |
   |
float | GetBaseFOV () |
|
   |
const FTransform & | ||
   |
bool | IsLooping () |
Returns true if any associated particle system is set to looping |
  |
void | Called when this emitter is re-triggered, for bAllowMultipleInstances=false emitters. | |
  |
void | If this type needs to handle being pooled, override this function | |
  |
void | RegisterCamera
(
APlayerCameraManager* CameraManager |
Called when being added to the player camera manager. |
   |
bool | ||
   |
bool | ||
   |
bool | ShouldTreatEmitterAsSame
(
TSubclassOf< AActor > OtherEmitter |
Is this emitter functionally equivalent to the class OtherEmitter? |