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::Stop

Light Theme

Dark Theme

FCameraShakeState::Stop

Marks the shake has having been stopped.

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

bool Stop
(
bool bImmediately
)

Remarks

Marks the shake has having been stopped.

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

If the state is managed, this puts the current elapsed time at the end of the shake's duration (if we need to stop immediately), or at the start of the shake's blend-out, if any (if we don't stop immediately).

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

Take our survey

Dismiss