1. Epic GamesDeveloper
  3. UCameraModifier_CameraShake

UCameraModifier_CameraShake

A [UCameraModifier_CameraShake](API\Runtime\Engine\Camera\UCameraModifier_CameraShake) is a camera modifier that can apply a [UCameraShakeBase](API\Runtime\Engine\Camera\UCameraShakeBase) to the owning camera.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Camera

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Camera/CameraModifier_CameraShake.h
Include #include "Camera/CameraModifier_CameraShake.h"

Syntax

class UCameraModifier_CameraShake : public UCameraModifier

Remarks

A UCameraModifier_CameraShake is a camera modifier that can apply a UCameraShakeBase to the owning camera.

Variables

  Type Name Description
Protected variable TArray< FActiveCameraShakeInfo > ActiveShakes List of active CameraShake instances
Protected variable bool bRecordDebugData Whether we are currently recording camera shake debug info
Protected variable TArray< FCameraShakeDebugData > DebugShakes List of debug data for camera shakes
Protected variable TMap< TSubclassOf< UCameraShakeBase >, FPooledCameraShakes > ExpiredPooledShakesMap  
Protected variable float SplitScreenShakeScale Scaling factor applied to all camera shakes in when in splitscreen mode.

Constructors

  Type Name Description
Public function  

UCameraModifier_CameraShake ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual UCameraShakeBase * Adds a new active screen shake to be applied.
Protected function void  
Protected function void

DisplayDebugGraphs ( UCanvas* Canvas,
const FDebugDisplayInfo& DebugDisplay
)

  
Public function Virtual Const void Returns a list of currently active camera shakes.
Protected function UCameraShakeBase *  
Public function Virtual void

RemoveAllCameraShakes ( bool bImmediately
)

 Stops and removes all camera shakes from the camera.
Public function Virtual void

RemoveAllCameraShakesFromSource ( const UCameraShakeSourceComponent* SourceComponent,
bool bImmediately
)

 Stops and removes all camera shakes originating from the given source.
Public function Virtual void

RemoveAllCameraShakesOfClass ( TSubclassOf< UCameraShakeBase > ShakeClass,
bool bImmediately
)

 Stops and removes all camera shakes of the given class from the camera.
Public function Virtual void

RemoveAllCameraShakesOfClassFromSource ( TSubclassOf< UCameraShakeBase > ShakeClass,
const UCameraShakeSourceComponent* SourceComponent,
bool bImmediately
)

 Stops and removes all camera shakes of the given class originating from the given source.
Public function Virtual void

RemoveCameraShake ( UCameraShakeBase* ShakeInst,
bool bImmediately
)

 Stops and removes the camera shake of the given class from the camera.
Protected function void  
Protected function void  
Protected function void  

Overridden from UCameraModifier

  Type Name Description
Public function Virtual void

DisplayDebug ( UCanvas* Canvas,
const FDebugDisplayInfo& DebugDisplay,
float& YL,
float& YPos
)

 Allows camera modifiers to output debug text during "showdebug camera"
Public function Virtual bool

ModifyCamera ( float DeltaTime,
FMinimalViewInfo& InOutPOV
)

 Directly modifies variables in the owning camera

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page