UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FCameraShakeDuration Struct Reference

#include <CameraShakeBase.h>

Public Member Functions

 FCameraShakeDuration ()
 
 FCameraShakeDuration (float InDuration, ECameraShakeDurationType InType=ECameraShakeDurationType::Fixed)
 
ECameraShakeDurationType GetDurationType () const
 
bool IsFixed () const
 
bool IsInfinite () const
 
bool IsCustom () const
 
bool IsCustomWithHint () const
 
float Get () const
 

Static Public Member Functions

static FCameraShakeDuration Infinite ()
 
static FCameraShakeDuration Custom ()
 
static FCameraShakeDuration Custom (float DurationHint)
 

Detailed Description

Camera shake duration.

Constructor & Destructor Documentation

◆ FCameraShakeDuration() [1/2]

FCameraShakeDuration::FCameraShakeDuration ( )
inline

Creates a new shake duration

◆ FCameraShakeDuration() [2/2]

FCameraShakeDuration::FCameraShakeDuration ( float  InDuration,
ECameraShakeDurationType  InType = ECameraShakeDurationType::Fixed 
)
inline

Creates a new shake duration

Member Function Documentation

◆ Custom() [1/2]

static FCameraShakeDuration FCameraShakeDuration::Custom ( )
inlinestatic

Returns a custom shake duration

◆ Custom() [2/2]

static FCameraShakeDuration FCameraShakeDuration::Custom ( float  DurationHint)
inlinestatic

Returns a custom shake duration with a hint for how long the shake might be

◆ Get()

float FCameraShakeDuration::Get ( ) const
inline

When the duration is fixed, return the duration time

◆ GetDurationType()

ECameraShakeDurationType FCameraShakeDuration::GetDurationType ( ) const
inline

Returns the duration type

◆ Infinite()

static FCameraShakeDuration FCameraShakeDuration::Infinite ( )
inlinestatic

Returns an infinite shake duration

◆ IsCustom()

bool FCameraShakeDuration::IsCustom ( ) const
inline

Returns whether this duration is custom

◆ IsCustomWithHint()

bool FCameraShakeDuration::IsCustomWithHint ( ) const
inline

Returns whether this duration is custom, but with a valid effective duration hint

◆ IsFixed()

bool FCameraShakeDuration::IsFixed ( ) const
inline

Returns whether this duration is a fixed time

◆ IsInfinite()

bool FCameraShakeDuration::IsInfinite ( ) const
inline

Returns whether this duration is infinite


The documentation for this struct was generated from the following file: