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 > FCameraShakeState > FCameraShakeState::Scrub

Light Theme

Dark Theme

FCameraShakeState::Scrub

Scrub the state to the given absolute time.

Windows

MacOS

Linux

References

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

Syntax

float Scrub
(
float AbsoluteTime
)

Remarks

Scrub the state to the given absolute time.

If the state isn't managed (i.e. it doesn't have any fixed duration information), this doesn't do anything and returns 1.

If the state is managed, this updates the internal state of this class and auto-computes when the shake has ended, along with a blending weight if there is any blending in/out.

Returns

The evaluated blending weight (if any) for the scrub time

Parameters

Parameter	Description
AbsoluteTime	The time to scrub to

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

Take our survey

Dismiss