UGameplayStatics::PlayWorldCameraShake

Plays an in-world camera shake that affects all nearby local players, with distance-based attenuation.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Kismet/GameplayStatics.h

Include

#include "Kismet/GameplayStatics.h"

Source

/Engine/Source/Runtime/Engine/Private/GameplayStatics.cpp

Syntax

static void PlayWorldCameraShake
(
    const UObject * WorldContextObject,
    TSubclassOf < class UCameraShakeBase > Shake,
    FVector Epicenter,
    float InnerRadius,
    float OuterRadius,
    float Falloff,
    bool bOrientShakeTowardsEpicenter
)

Remarks

Plays an in-world camera shake that affects all nearby local players, with distance-based attenuation. Does not replicate.

Parameters

Parameter

Description

WorldContextObject

Object that we can obtain a world context from

Shake

Camera shake asset to use

Epicenter

location to place the effect in world space

InnerRadius

Cameras inside this radius are ignored

OuterRadius

Cameras outside of InnerRadius and inside this are effected

Falloff

Affects falloff of effect as it nears OuterRadius

bOrientShakeTowardsEpicenter

Changes the rotation of shake to point towards epicenter instead of forward

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