Navigation
API > API/Runtime > API/Runtime/Engine
Transitive state of a shake or shake pattern.
| Name | FCameraShakeState |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Classes/Camera/CameraShakeBase.h |
| Include Path | #include "Camera/CameraShakeBase.h" |
Syntax
struct FCameraShakeState
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCameraShakeState() |
Create a new camera shake state | Camera/CameraShakeBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasBlendIn | bool | Cached values for blending information. | Camera/CameraShakeBase.h | |
| bHasBlendOut | bool | Camera/CameraShakeBase.h | ||
| bIsBlendingIn | bool | Camera/CameraShakeBase.h | ||
| bIsBlendingOut | bool | Camera/CameraShakeBase.h | ||
| bIsPlaying | bool | Camera/CameraShakeBase.h | ||
| CurrentBlendInTime | float | Camera/CameraShakeBase.h | ||
| CurrentBlendOutTime | float | Camera/CameraShakeBase.h | ||
| ElapsedTime | float | Running state. | Camera/CameraShakeBase.h | |
| ShakeInfo | FCameraShakeInfo | Information about the shake/shake pattern we're managing. | Camera/CameraShakeBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetCurrentBlendInTime() |
Returns the current time into the blend in (only valid if IsBlendingIn() returns true) | Camera/CameraShakeBase.h | |
float GetCurrentBlendOutTime() |
Returns the current time into the blend in (only valid if IsBlendingOut() returns true) | Camera/CameraShakeBase.h | |
float GetDuration() |
Helper method to get GetShakeInfo().Duration.Get() | Camera/CameraShakeBase.h | |
float GetElapsedTime() |
Returns the elapsed time of the shake's current run | Camera/CameraShakeBase.h | |
const FCameraShakeInfo & GetShakeInfo() |
Returns the current shake info | Camera/CameraShakeBase.h | |
bool HasDuration() |
Helper method to get GetShakeInfo().Duration.IsFixed() | Camera/CameraShakeBase.h | |
bool IsBlendingIn() |
Returns whether the shake is blending in | Camera/CameraShakeBase.h | |
bool IsBlendingOut() |
Returns whether the shake is blending out | Camera/CameraShakeBase.h | |
bool IsInfinite() |
Helper method to get GetShakeInfo().Duration.IsInifnite() | Camera/CameraShakeBase.h | |
bool IsPlaying() |
Returns whether the shake is playing | Camera/CameraShakeBase.h | |
float Scrub
(
float AbsoluteTime |
Scrub the state to the given absolute time. | Camera/CameraShakeBase.h | |
void Start
(
const FCameraShakeInfo& InShakeInfo |
Initialize the state with a shake's info and start playing. | Camera/CameraShakeBase.h | |
void Start
(
const UCameraShakePattern* InShakePattern |
Initialize the state with a shake's info and start playing. | Camera/CameraShakeBase.h | |
void Start
(
const FCameraShakeInfo& InShakeInfo, |
Initialize the state with a shake's info and start playing. | Camera/CameraShakeBase.h | |
void Start
(
const UCameraShakePattern* InShakePattern, |
Initialize the state with a shake's info and start playing. | Camera/CameraShakeBase.h | |
void Stop
(
bool bImmediately |
Marks the shake has having been stopped. | Camera/CameraShakeBase.h | |
float Update
(
float DeltaTime |
Updates the state with a delta time. | Camera/CameraShakeBase.h |