Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Particles
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- AActor
- AEmitter
- AEmitterCameraLensEffectBase
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Particles/EmitterCameraLensEffectBase.h |
| Include | #include "Particles/EmitterCameraLensEffectBase.h" |
Syntax
class AEmitterCameraLensEffectBase :
public AEmitter,
public ICameraLensEffectInterface
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
uint8: 1 | bAllowMultipleInstances | True if multiple instances of this emitter can exist simultaneously, false otherwise. |
 |
TObjectPtr< class APlayerCameraManager > | BaseCamera | Camera this emitter is attached to, will be notified when emitter is destroyed |
 |
float | BaseFOV | This is the assumed FOV for which the effect was authored. |
 |
uint8: 1 | bResetWhenRetriggered | If bAllowMultipleInstances is true and this effect is retriggered, the particle system will be reset if this is true |
 |
TArray< TSubclassOf< AActor > > | EmittersToTreatAsSame | If an emitter class in this array is currently playing, do not play this effect. |
 |
TObjectPtr< class UParticleSystem > | PS_CameraEffect | Particle System to use |
 |
FTransform | RelativeTransform | Effect-to-camera transform to allow arbitrary placement of the particle system . |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
AEmitterCameraLensEffectBase
(
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 |
  |
void | Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
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 | Tell the emitter what camera it is attached to. | |
   |
bool | ||
   |
bool | ||
   |
bool | ShouldTreatEmitterAsSame
(
TSubclassOf< AActor > OtherEmitter |
Is this emitter functionally equivalent to the class OtherEmitter? |
  |
void | UpdateLocation
(
const FVector& CamLoc, |
Given updated camera information, adjust this effect to display appropriately. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FTransform | GetAttachedEmitterTransform
(
AEmitterCameraLensEffectBase const* Emitter, |
ICameraLensEffectInterface::GetAttachedEmitterTransform is favored now |