Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Camera > UCameraShakePattern

Light Theme

Dark Theme

UCameraShakePattern

A shake "pattern" defines how a camera should be effectively shaken.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UCameraShakePattern

UCompositeCameraShakePattern

UMatineeCameraShakePattern

USequenceCameraShakePattern

USimpleCameraShakePattern

	UPerlinNoiseCameraShakePattern
	UWaveOscillatorCameraShakePattern

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Camera/CameraShakeBase.h
Include	#include "Camera/CameraShakeBase.h"

Syntax

class UCameraShakePattern : public UObject

Remarks

A shake "pattern" defines how a camera should be effectively shaken. Examples of shake patterns are sinewave oscillation, perlin noise, or FBX animation.

Constructors

	Name	Description
	UCameraShakePattern ( const FObjectInitializer& ObjectIn... )	Constructor for a shake pattern

Functions

	Name	Description
UCameraShake...	GetShakeInstance()	Gets the shake pattern's parent shake
InstanceType...	GetShakeInstance()	Gets the shake pattern's parent shake
void	GetShakePatternInfo ( FCameraShakeInfo& OutInfo )	Gets information about this shake pattern
bool	IsFinished()	Returns whether this shake pattern is finished
void	ScrubShakePattern ( const FCameraShakeScrubParams& Par..., FCameraShakeUpdateResult& OutResul... )	Scrubs the shake pattern to the given time, and apply the generated offset to the given result
void	StartShakePattern ( const FCameraShakeStartParams& Par... )	Called when the shake pattern starts
void	StopShakePattern ( const FCameraShakeStopParams& Para... )	Called when the shake pattern is manually stopped
void	TeardownShakePattern()	Call when the shake pattern is discard, either after naturally finishing or being stopped manually
void	UpdateShakePattern ( const FCameraShakeUpdateParams& Pa..., FCameraShakeUpdateResult& OutResul... )	Updates the shake pattern, which should add its generated offset to the given result

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss