AEmitterCameraLensEffectBase

Windows
MacOS
Linux

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

Variables

Name Description

Public variable

uint8 : 1

 

bAllowMultipleInstances

True if multiple instances of this emitter can exist simultaneously, false otherwise.

Protected variable

APlayerCameraMa ...

 

BaseCamera

Camera this emitter is attached to, will be notified when emitter is destroyed

Public variable

float

 

BaseFOV

This is the assumed FOV for which the effect was authored.

Public variable

uint8 : 1

 

bResetWhenRetriggered

If bAllowMultipleInstances is true and this effect is retriggered, the particle system will be reset if this is true

Public variable

TArray < TSubcla ...

 

EmittersToTreatAsSame

If an emitter class in this array is currently playing, do not play this effect.

Protected variable

UParticleSystem ...

 

PS_CameraEffect

Particle System to use

Protected variable

FTransform

 

RelativeTransform

Effect-to-camera transform to allow arbitrary placement of the particle system .

Constructors

Name Description

Public function

AEmitterCameraLensEffectBase

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Public function Virtual

void

 

ActivateLensEffect()

This will actually activate the lens Effect.

Public function Virtual

void

 

DeactivateLensEffect()

Deactivtes the particle system.

Public function Static

FTransform

 

GetAttachedEmitterTransform

(
    AEmitterCameraLensEffectBase const ...,
    const FVector & CamLoc,
    const FRotator & CamRot,
    float CamFOVDeg
)

Public function Const

bool

 

IsLooping()

Returns true if either particle system would loop forever when played

Public function Virtual

void

 

NotifyRetriggered()

Called when this emitter is re-triggered, for bAllowMultipleInstances=false emitters.

Public function Virtual

void

 

RegisterCamera

(
    APlayerCameraManager * C
)

Tell the emitter what camera it is attached to.

Public function Virtual

void

 

UpdateLocation

(
    const FVector & CamLoc,
    const FRotator & CamRot,
    float CamFOVDeg
)

Given updated camera information, adjust this effect to display appropriately.

Overridden from AActor

Name Description

Public function Virtual

void

 

EndPlay

(
    const EEndPlayReason::Type EndPlayR...
)

Overridable function called whenever this actor is being removed from a level

Public function Virtual

void

 

PostInitializeComponents()

Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

Name Description

Protected variable

UParticleSystem ...

 

PS_CameraEffectNonExtremeContent_DEPRECATED

The effect to use for non extreme content

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