Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UCameraShakeSourceComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UCameraShakeSourceComponent

References

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

Syntax

class UCameraShakeSourceComponent : public USceneComponent

Variables

	Name	Description
ECameraShakeAtt...	Attenuation	The attenuation profile for how camera shakes' intensity falls off with distance
bool	bAutoPlay
TSubclassOf< UC...	CameraShake
UTexture2D *...	EditorSpriteTexture	Sprite to display in the editor.
float	EditorSpriteTextureScale	Sprite scaling for display in the editor.
float	InnerAttenuationRadius	Under this distance from the source, the camera shakes are at full intensity
float	OuterAttenuationRadius	Outside of this distance from the source, the camera shakes don't apply at all

Constructors

	Name	Description
	UCameraShakeSourceComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
float	GetAttenuationFactor ( const FVector& Location )	Computes an attenuation factor from this source
void	Play()
void	PlayCameraShake ( TSubclassOf< UCameraShake > InCamer... )	Starts a new camera shake originating from this source, and apply it on all player controllers
void	StopAllCameraShakes ( bool bImmediately )	Stops all currently active camera shakes that are originating from this source from all player controllers

Overridden from UActorComponent

	Name	Description
void	BeginPlay()	Begins Play for the component.
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Ends gameplay for this component.
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
	void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss