1. Epic GamesDeveloper
  3. UCameraShakeSourceComponent

UCameraShakeSourceComponent

Unreal Engine C++ API Reference > Runtime > Engine > Camera

Inheritance Hierarchy

References

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

Syntax

UCLASS (Blueprintable, Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UCameraShakeSourceComponent : public USceneComponent

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite ECameraShakeAttenuation Attenuation The attenuation profile for how camera shakes' intensity falls off with distance
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAutoStart Whether to auto start when created
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TSubclassOf< UCameraShakeBase > CameraShake The camera shake class to use for this camera shake source actor
Public variable UProperty Transient TObjectPtr< UTexture2D > EditorSpriteTexture Sprite to display in the editor.
Public variable UProperty Transient float EditorSpriteTextureScale Sprite scaling for display in the editor.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float InnerAttenuationRadius Under this distance from the source, the camera shakes are at full intensity
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float OuterAttenuationRadius Outside of this distance from the source, the camera shakes don't apply at all

Constructors

  Type Name Description
Public function  

UCameraShakeSourceComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category float

GetAttenuationFactor ( const FVector& Location
)

 Computes an attenuation factor from this source
Public function UFunction BlueprintCallable, Category void

Start ()

  
Public function void Starts a new camera shake originating from this source, and apply it on all player controllers
Public function UFunction BlueprintCallable, Category void

StartCameraShake ( TSubclassOf< UCameraShakeBase > InCameraShake,
float Scale,
ECameraShakePlaySpace PlaySpace,
FRotator UserPlaySpaceRot
)

 Starts a new camera shake originating from this source, and apply it on all player controllers
Public function UFunction BlueprintCallable, Category void

StopAllCameraShakes ( bool bImmediately
)

 Stops all currently active camera shakes that are originating from this source from all player controllers
Public function UFunction BlueprintCallable, Category void

StopAllCameraShakesOfType ( TSubclassOf< UCameraShakeBase > InCameraShake,
bool bImmediately
)

 Stops a camera shake originating from this source

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Begins Play for the component.
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Ends gameplay for this component.
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page