FCameraShakeState

Transitive state of a shake or shake pattern.

Windows
MacOS
Linux

References

Module

Engine

Header

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

Include

#include "Camera/CameraShakeBase.h"

Syntax

struct FCameraShakeState

Remarks

Transitive state of a shake or shake pattern.

Constructors

Name Description

Public function

FCameraShakeState()

Functions

Name Description

Public function Const

float

 

GetDuration()

Helper method to get GetShakeInfo().Duration.Get()

Public function Const

float

 

GetElapsedTime()

Returns the elapsed time of the shake's current run

Public function Const

const FCamer...

 

GetShakeInfo()

Returns the current shake info

Public function Const

bool

 

HasDuration()

Helper method to get GetShakeInfo().Duration.IsFixed()

Public function

void

 

Initialize

(
    const FCameraShakeInfo& InShakeInf...
)

Initialize the state with a shake's info.

Public function Const

bool

 

IsActive()

Returns whether the shake is active

Public function

float

 

Scrub

(
    float AbsoluteTime
)

Scrub the state to the given absolute time.

Public function

bool

 

Stop

(
    bool bImmediately
)

Marks the shake has having been stopped.

Public function

float

 

Update

(
    float DeltaTime
)

Updates the state with a delta time.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss