FCameraShakeState | Unreal Engine 5.2 Documentation

References


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

struct FCameraShakeState

Transitive state of a shake or shake pattern.

	Type	Name	Description
		FCameraShakeState ()	Create a new camera shake state

Type	Name	Description
float	GetCurrentBlendInTime ()	Returns the current time into the blend in (only valid if IsBlendingIn() returns true)
float	GetCurrentBlendOutTime ()	Returns the current time into the blend in (only valid if IsBlendingOut() returns true)
float	GetDuration ()	Helper method to get GetShakeInfo().Duration.Get()
float	GetElapsedTime ()	Returns the elapsed time of the shake's current run
const FCameraShakeInfo &	GetShakeInfo ()	Returns the current shake info
bool	HasDuration ()	Helper method to get GetShakeInfo().Duration.IsFixed()
bool	IsBlendingIn ()	Returns whether the shake is blending in
bool	IsBlendingOut ()	Returns whether the shake is blending out
bool	IsInfinite ()	Helper method to get GetShakeInfo().Duration.IsInifnite()
bool	IsPlaying ()	Returns whether the shake is playing
float	Scrub ( float AbsoluteTime )	Scrub the state to the given absolute time.
void	Start ( const FCameraShakeInfo& InShakeInfo )	Initialize the state with a shake's info and start playing.
void	Start ( const UCameraShakePattern* InShakePattern )	Initialize the state with a shake's info and start playing.
void	Stop ( bool bImmediately )	Marks the shake has having been stopped.
float	Update ( float DeltaTime )	Updates the state with a delta time.