1. Epic GamesDeveloper
  3. ULegacyCameraShake

ULegacyCameraShake

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

API > API/Plugins > API/Plugins/GameplayCameras

Inheritance Hierarchy

References

   
Module GameplayCameras
Header /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/LegacyCameraShake.h
Include #include "LegacyCameraShake.h"

Syntax

UCLASS&40;Blueprintable, HideCategories&61;&40;CameraShakePattern&41;&41;  
class ULegacyCameraShake : public UCameraShakeBase

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta float AnimBlendInTime Linear blend-in time.
Public variable UProperty Category, EditAnywhere, Meta float AnimBlendOutTime Linear blend-out time.
Public variable UProperty Category, EditAnywhere, Meta float AnimPlayRate Scalar defining how fast to play the anim.
Public variable UProperty Category, EditAnywhere, Meta float AnimScale Scalar defining how "intense" to play the anim.
Public variable UProperty Category, EditAnywhere TObjectPtr< class UCameraAnimationSequence > AnimSequence Source camera animation sequence to play. Can be null.
Public variable UProperty Category, EditAnywhere uint32: 1 bRandomAnimSegment If true, play a random snippet of the animation of length Duration.
Public variable UProperty Category, EditAnywhere, Meta FFOscillator FOVOscillation FOV oscillation
Protected variable float FOVSinOffset Current FOV sinusoidal offset.
Protected variable float InitialFOVSinOffset Initial offset (could have been assigned at random).
Protected variable FVector InitialLocSinOffset Initial offset (could have been assigned at random).
Protected variable FVector InitialRotSinOffset Initial offset (could have been assigned at random).
Public variable UProperty Category, EditAnywhere, Meta FVOscillator LocOscillation Positional oscillation
Protected variable FVector LocSinOffset Current location sinusoidal offset.
Public variable UProperty Category, EditAnywhere, Meta float OscillationBlendInTime Duration of the blend-in, where the oscillation scales from 0 to 1.
Public variable UProperty Category, EditAnywhere, Meta float OscillationBlendOutTime Duration of the blend-out, where the oscillation scales from 1 to 0.
Public variable UProperty Category, EditAnywhere float OscillationDuration Duration in seconds of current screen shake. Less than 0 means indefinite, 0 means no oscillation.
Public variable UProperty Category BlueprintReadOnly Transient float OscillatorTimeRemaining Time remaining for oscillation shakes. Less than 0.f means shake infinitely.
Public variable UProperty Category, EditAnywhere, Meta float RandomAnimSegmentDuration When bRandomAnimSegment is true, this defines how long the anim should play.
Public variable UProperty Category, EditAnywhere, Meta FROscillator RotOscillation Rotational oscillation
Protected variable FVector RotSinOffset Current rotational sinusoidal offset.
Protected variable UProperty instanced TObjectPtr< class USequenceCameraShakePattern > SequenceShakePattern Sequence shake pattern for when using a sequence instead of a camera anim

Constructors

  Type Name Description
Public function  

ULegacyCameraShake ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction Category, BlueprintImplementableEvent void

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

 Called every tick to let the shake modify the point of view
Public function Const bool Returns true if this camera shake will loop forever
Public function Const UFunction Category blueprintnativeevent bool Called to allow a shake to decide when it's finished playing.
Public function UFunction Category, BlueprintImplementableEvent void

ReceivePlayShake ( float Scale
)

 Called when the shake starts playing
Public function UFunction Category, BlueprintImplementableEvent void

ReceiveStopShake ( bool bImmediately
)

 Called when the shake is explicitly stopped.
Public function Static UFunction BlueprintCallable, Category ULegacyCameraShake *

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

 Backwards compatible method used by core BP redirectors.
Public function Static UFunction BlueprintCallable, Category ULegacyCameraShake *

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

 Backwards compatible method used by core BP redirectors.

Deprecated Functions

  Type Name Description
Public function void SetCurrentTimeAndApplyShake is deprecated, please use ScrubAndApplyCameraShake

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page