Navigation
API > API/Plugins > API/Plugins/GameplayCameras
A camera system service that handles running camera shakes in the visual layer.
| Name | FCameraShakeService |
| Type | class |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Services/CameraShakeService.h |
| Include Path | #include "Services/CameraShakeService.h" |
Syntax
class FCameraShakeService : public UE::Cameras::FCameraEvaluationService
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FCameraEvaluationService → FCameraShakeService
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Super | FCameraEvaluationService | Services/CameraShakeService.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PrivateTypeID | const ::UE::Cameras::TCameraObjectTypeID< FCameraShakeService > | Services/CameraShakeService.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Evaluator | FCameraSystemEvaluator * | The system running this service. | Services/CameraShakeService.h | |
| ShakeContainerRig | TObjectPtr< UCameraRigAsset > | The camera rig used to create the shake container. | Services/CameraShakeService.h | |
| ShakeContext | TSharedPtr< FCameraEvaluationContext > | The evaluation context used for running the shakes. | Services/CameraShakeService.h | |
| ShakeEvaluator | FCameraShakeServiceCameraNodeEvaluator * | The shake container evaluator. | Services/CameraShakeService.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsCameraShakePlaying
(
FCameraShakeInstanceID InInstanceID |
Checks if a camera shake is running. | Services/CameraShakeService.h | |
void RequestCameraShakeThisFrame
(
const FStartCameraShakeParams& Params |
Requests that a given camera shake runs. | Services/CameraShakeService.h | |
FCameraShakeInstanceID StartCameraShake
(
const FStartCameraShakeParams& Params |
Starts a new camera shake. | Services/CameraShakeService.h | |
bool StopCameraShake
(
FCameraShakeInstanceID InInstanceID, |
Stops a running camera shake. | Services/CameraShakeService.h |
Overridden from FCameraEvaluationService
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FCameraObjectTypeID & GetTypeID() |
Services/CameraShakeService.h | ||
virtual bool IsKindOf
(
const FCameraObjectTypeID& InTypeID |
Services/CameraShakeService.h |
Protected
Overridden from FCameraEvaluationService
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnInitialize
(
const FCameraEvaluationServiceInitializeParams& Params |
Initializes the evaluation service. | Services/CameraShakeService.h | |
virtual void OnTeardown
(
const FCameraEvaluationServiceTeardownParams& Params |
Tears down the evaluation service. | Services/CameraShakeService.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const ::UE::Cameras::TCameraObjectTypeID< FCameraShakeService > & StaticTypeID() |
Services/CameraShakeService.h |