1. Epic GamesDeveloper
  3. ULegacyCameraShake

ULegacyCameraShake

Legacy camera shake which can do either oscillation or run camera anims.

API > API/Plugins > API/Plugins/EngineCameras

Legacy camera shake which can do either oscillation or run camera anims.

   
Name ULegacyCameraShake
Type class
Header File /Engine/Plugins/Cameras/EngineCameras/Source/EngineCameras/Public/Shakes/LegacyCameraShake.h
Include Path #include "Shakes/LegacyCameraShake.h"

Syntax

UCLASS (MinimalAPI, Blueprintable, HideCategories=(CameraShakePattern))  
class ULegacyCameraShake : public UCameraShakeBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

ULegacyCameraShake ( const FObjectInitializer& ObjectInitializer
)

   Shakes/LegacyCameraShake.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnimBlendInTime float Linear blend-in time. Shakes/LegacyCameraShake.h
  • EditAnywhere
  • Category=AnimShake
  • Meta=(ClampMin="0.0")
AnimBlendOutTime float Linear blend-out time. Shakes/LegacyCameraShake.h
  • EditAnywhere
  • Category=AnimShake
  • Meta=(ClampMin="0.0")
AnimPlayRate float Scalar defining how fast to play the anim. Shakes/LegacyCameraShake.h
  • EditAnywhere
  • Category=AnimShake
  • Meta=(ClampMin="0.001")
AnimScale float Scalar defining how "intense" to play the anim. Shakes/LegacyCameraShake.h
  • EditAnywhere
  • Category=AnimShake
  • Meta=(ClampMin="0.0")
AnimSequence TObjectPtr< class UCameraAnimationSequence > Source camera animation sequence to play. Can be null. Shakes/LegacyCameraShake.h
  • EditAnywhere
  • Category=AnimShake
bRandomAnimSegment uint32 If true, play a random snippet of the animation of length Duration. Shakes/LegacyCameraShake.h
  • EditAnywhere
  • Category=AnimShake
FOVOscillation FFOscillator FOV oscillation Shakes/LegacyCameraShake.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Oscillation
LocOscillation FVOscillator Positional oscillation Shakes/LegacyCameraShake.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Oscillation
OscillationBlendInTime float Duration of the blend-in, where the oscillation scales from 0 to 1. Shakes/LegacyCameraShake.h
  • EditAnywhere
  • Category=Oscillation
  • Meta=(ClampMin="0.0")
OscillationBlendOutTime float Duration of the blend-out, where the oscillation scales from 1 to 0. Shakes/LegacyCameraShake.h
  • EditAnywhere
  • Category=Oscillation
  • Meta=(ClampMin="0.0")
OscillationDuration float Duration in seconds of current screen shake. Less than 0 means indefinite, 0 means no oscillation. Shakes/LegacyCameraShake.h
  • EditAnywhere
  • Category=Oscillation
OscillatorTimeRemaining float Time remaining for oscillation shakes. Less than 0.f means shake infinitely. Shakes/LegacyCameraShake.h
  • Transient
  • BlueprintReadOnly
  • Category=CameraShake
RandomAnimSegmentDuration float When bRandomAnimSegment is true, this defines how long the anim should play. Shakes/LegacyCameraShake.h
  • EditAnywhere
  • Category=AnimShake
  • Meta=(ClampMin="0.0", editcondition="bRandomAnimSegment")
RotOscillation FROscillator Rotational oscillation Shakes/LegacyCameraShake.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Oscillation

Protected

Name Type Remarks Include Path Unreal Specifiers
bBlendingIn bool   Shakes/LegacyCameraShake.h  
bBlendingOut bool   Shakes/LegacyCameraShake.h  
CurrentBlendInTime float   Shakes/LegacyCameraShake.h  
CurrentBlendOutTime float   Shakes/LegacyCameraShake.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BlueprintUpdateCameraShake ( float DeltaTime,
float Alpha,
const FMinimalViewInfo& POV,
FMinimalViewInfo& ModifiedPOV
)

 Called every tick to let the shake modify the point of view Shakes/LegacyCameraShake.h
  • BlueprintImplementableEvent
  • Category=CameraShake

bool IsLooping()

 Returns true if this camera shake will loop forever Shakes/LegacyCameraShake.h  

bool ReceiveIsFinished()

 Called to allow a shake to decide when it's finished playing. Shakes/LegacyCameraShake.h
  • BlueprintNativeEvent
  • Category=CameraShake

void ReceivePlayShake ( float Scale
)

 Called when the shake starts playing Shakes/LegacyCameraShake.h
  • BlueprintImplementableEvent
  • Category=CameraShake

void ReceiveStopShake ( bool bImmediately
)

 Called when the shake is explicitly stopped. Shakes/LegacyCameraShake.h
  • BlueprintImplementableEvent
  • Category=CameraShake

Static

Name Remarks Include Path Unreal Specifiers

static ULegacyCameraShake * StartLegacyCameraShake ( APlayerCameraManager* PlayerCameraManager,
TSubclassOf< ULegacyCameraShake > ShakeClass,
float Scale,
ECameraShakePlaySpace PlaySpace,
FRotator UserPlaySpaceRot
)

 Backwards compatible method used by core BP redirectors. Shakes/LegacyCameraShake.h
  • BlueprintCallable
  • Category="Camera Shakes"

static ULegacyCameraShake * StartLegacyCameraShakeFromSource ( APlayerCameraManager* PlayerCameraManager,
TSubclassOf< ULegacyCameraShake > ShakeClass,
UCameraShakeSourceComponent* SourceComponent,
float Scale,
ECameraShakePlaySpace PlaySpace,
FRotator UserPlaySpaceRot
)

 Backwards compatible method used by core BP redirectors. Shakes/LegacyCameraShake.h
  • BlueprintCallable
  • Category="Camera Shakes"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page