UCameraModifier_CameraShake

A [UCameraModifier_CameraShake](API\Runtime\Engine\Camera\UCameraModifier_CameraShake) is a camera modifier that can apply a [UCameraShake](API\Runtime\Engine\Camera\UCameraShake) to the owning camera.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Camera/CameraModifier_CameraShake.h

Include

#include "Camera/CameraModifier_CameraShake.h"

Syntax

class UCameraModifier_CameraShake : public UCameraModifier

Remarks

A UCameraModifier_CameraShake is a camera modifier that can apply a UCameraShake to the owning camera.

Variables

Name Description

Public variable

TArray< class U...

 

ActiveShakes

List of active CameraShake instances

Public variable

TMap< TSubclass...

 

ExpiredPooledShakesMap

Protected variable

float

 

SplitScreenShakeScale

Scaling factor applied to all camera shakes in when in splitscreen mode.

Constructors

Name Description

Public function

UCameraModifier_CameraShake

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual

UCameraShake...

 

AddCameraShake

(
    TSubclassOf< class UCameraShake > N...,
    float Scale,
    ECameraAnimPlaySpace::Type PlaySpac...,
    FRotator UserPlaySpaceRot
)

Adds a new active screen shake to be applied.

Public function

UCameraShake...

 

ReclaimShakeFromExpiredPool

(
    TSubclassOf< class UCameraShake > C...
)

Public function Virtual

void

 

RemoveAllCameraShakes

(
    bool bImmediately
)

Stops and removes all camera shakes from the camera.

Public function Virtual

void

 

RemoveAllCameraShakesOfClass

(
    TSubclassOf< class UCameraShake > S...,
    bool bImmediately
)

Stops and removes all camera shakes of the given class from the camera.

Public function Virtual

void

 

RemoveCameraShake

(
    UCameraShake* ShakeInst,
    bool bImmediately
)

Stops and removes the camera shake of the given class from the camera.

Public function

void

 

SaveShakeInExpiredPool

(
    UCameraShake* ShakeInst
)

Overridden from UCameraModifier

Name Description

Public function Virtual

bool

 

ModifyCamera

(
    float DeltaTime,
    FMinimalViewInfo& InOutPOV
)

Directly modifies variables in the owning camera

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