UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
CameraShakeBase.h File Reference
#include "CoreMinimal.h"
#include "Misc/EnumClassFlags.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "UObject/ScriptMacros.h"
#include "Camera/CameraTypes.h"
#include "Engine/Scene.h"
#include "CameraShakeBase.generated.h"

Go to the source code of this file.

Classes

struct  FCameraShakePatternStartParams
 
struct  FCameraShakePatternUpdateParams
 
struct  FCameraShakePatternScrubParams
 
struct  FCameraShakePatternUpdateResult
 
struct  FCameraShakePatternStopParams
 
struct  FCameraShakeDuration
 
struct  FCameraShakeInfo
 
struct  FCameraShakeApplyResultParams
 
struct  FCameraShakeState
 
struct  FCameraShakeBaseStartParams
 
class  UCameraShakeBase
 
class  UCameraShakePattern
 

Macros

#define UE_LEGACY_CAMERA_SHAKE_PATTERN_TYPES   0
 

Enumerations

enum class  ECameraShakePatternUpdateResultFlags : uint8 { ApplyAsAbsolute = 1 << 0 , SkipAutoScale = 1 << 1 , SkipAutoPlaySpace = 1 << 2 , Default = 0 }
 
enum class  ECameraShakeDurationType : uint8 { Fixed , Infinite , Custom }
 

Functions

 ENUM_CLASS_FLAGS (ECameraShakePatternUpdateResultFlags)
 

Macro Definition Documentation

◆ UE_LEGACY_CAMERA_SHAKE_PATTERN_TYPES

#define UE_LEGACY_CAMERA_SHAKE_PATTERN_TYPES   0

Enumeration Type Documentation

◆ ECameraShakeDurationType

Camera shake duration type.

Enumerator
Fixed 

Camera shake has a fixed duration

Infinite 

Camera shake is playing indefinitely, until explicitly stopped

Custom 

Camera shake has custom/dynamic duration

◆ ECameraShakePatternUpdateResultFlags

Flags that camera shake patterns can return to change base-class behaviour.

Enumerator
ApplyAsAbsolute 

Apply the result location, rotation, and field of view as absolute values, instead of additive values.

SkipAutoScale 

Do not apply scaling (dynamic scale, blending weight, shake scale), meaning that this will be done in the sub-class. Implied when ApplyAsAbsolute is set.

SkipAutoPlaySpace 

Do not re-orient the result based on the play-space. Implied when ApplyAsAbsolute is set.

Default 

Default flags: the sub-class is returning local, additive offsets, and lets the base class take care of the rest.

Function Documentation

◆ ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS ( ECameraShakePatternUpdateResultFlags  )