1. Epic GamesDeveloper
  3. UCameraModifier_CameraShake

UCameraModifier_CameraShake

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

API > API/Runtime > API/Runtime/Engine

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

   
Name UCameraModifier_CameraShake
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Camera/CameraModifier_CameraShake.h
Include Path #include "Camera/CameraModifier_CameraShake.h"

Syntax

UCLASS (Config=Camera, MinimalAPI)  
class UCameraModifier_CameraShake : public UCameraModifier

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCameraModifier_CameraShake ( const FObjectInitializer& ObjectInitializer
)

   Camera/CameraModifier_CameraShake.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual UCameraShakeBase * AddCameraShake ( TSubclassOf< UCameraShakeBase > NewShake,
const FAddCameraShakeParams& Params
)

 Adds a new active screen shake to be applied. Camera/CameraModifier_CameraShake.h  

virtual void GetActiveCameraShakes ( TArray< FActiveCameraShakeInfo >& ActiveCameraShakes
) const

 Returns a list of currently active camera shakes. Camera/CameraModifier_CameraShake.h  

virtual void RemoveAllCameraShakes ( bool bImmediately
)

 Stops and removes all camera shakes from the camera. Camera/CameraModifier_CameraShake.h  

virtual void RemoveAllCameraShakesFromSource ( const UCameraShakeSourceComponent* SourceComponent,
bool bImmediately
)

 Stops and removes all camera shakes originating from the given source. Camera/CameraModifier_CameraShake.h  

virtual void RemoveAllCameraShakesOfClass ( TSubclassOf< UCameraShakeBase > ShakeClass,
bool bImmediately
)

 Stops and removes all camera shakes of the given class from the camera. Camera/CameraModifier_CameraShake.h  

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. Camera/CameraModifier_CameraShake.h  

virtual void RemoveCameraShake ( UCameraShakeBase* ShakeInst,
bool bImmediately
)

 Stops and removes the camera shake of the given class from the camera. Camera/CameraModifier_CameraShake.h  

Overridden from UCameraModifier

Name Remarks Include Path Unreal Specifiers

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

 Allows camera modifiers to output debug text during "showdebug camera" Camera/CameraModifier_CameraShake.h  

virtual bool ModifyCamera ( float DeltaTime,
FMinimalViewInfo& InOutPOV
)

 Directly modifies variables in the owning camera Camera/CameraModifier_CameraShake.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Camera/CameraModifier_CameraShake.h  

Protected

Name Remarks Include Path Unreal Specifiers

UCameraShakeBase * ReclaimShakeFromExpiredPool ( TSubclassOf< UCameraShakeBase > CameraShakeClass
)

   Camera/CameraModifier_CameraShake.h  

void SaveShakeInExpiredPool ( UCameraShakeBase* ShakeInst
)

   Camera/CameraModifier_CameraShake.h  

void SaveShakeInExpiredPoolIfPossible ( const FActiveCameraShakeInfo& ShakeInfo
)

   Camera/CameraModifier_CameraShake.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page