Navigation
API > API/Plugins > API/Plugins/GameplayCameras
An evaluation service for running "camera actions", which allow manipuilating running camera rig instances, such as making them turn towards a given point, freeze them, and so on.
| Name | FCameraActionService |
| Type | class |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Services/CameraActionService.h |
| Include Path | #include "Services/CameraActionService.h" |
Syntax
class FCameraActionService : public UE::Cameras::FCameraEvaluationService
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FCameraEvaluationService → FCameraActionService
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FCameraActionService() |
Services/CameraActionService.h |
Structs
| Name | Remarks |
|---|---|
| FActionInfo | |
| FActionSetInfo |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Super | FCameraEvaluationService | Services/CameraActionService.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PrivateTypeID | UE_API const ::UE::Cameras::TCameraObjectTypeID< FCameraActionService > | Services/CameraActionService.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActionSets | TArray< FActionSetInfo > | Services/CameraActionService.h | ||
| bHasAnyNewActiveCameraRigs | bool | Services/CameraActionService.h | ||
| NextActionSetID | uint32 | Services/CameraActionService.h | ||
| RootNodeEvaluator | FRootCameraNodeEvaluator * | Services/CameraActionService.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetNumScopeActions
(
const FCameraActionInstanceID InInstanceID |
Returns how many actual actions are running for the given instance ID. | Services/CameraActionService.h | |
bool IsActionRunning
(
const FCameraActionInstanceID InInstanceID |
Returns whether a given camera action instance is running. | Services/CameraActionService.h | |
FCameraActionInstanceID StartAction
(
const UCameraAction* CameraAction |
Starts a new camera action. | Services/CameraActionService.h | |
bool StopAction
(
const FCameraActionInstanceID InInstanceID |
Stops a given camera action instance. | Services/CameraActionService.h | |
bool StopAllActionsOfClass
(
TSubclassOf< UCameraAction > InActionClass |
Stops all camera action instances of a given class. | Services/CameraActionService.h |
Public Virtual
Overridden from FCameraEvaluationService
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FCameraObjectTypeID & GetTypeID() |
Services/CameraActionService.h | ||
virtual bool IsKindOf
(
const FCameraObjectTypeID& InTypeID |
Services/CameraActionService.h |
Protected Virtual
Overridden from FCameraEvaluationService
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnBuildDebugBlocks
(
const FCameraDebugBlockBuildParams& Params, |
Called to create debug blocks for this node evaluator. | Services/CameraActionService.h | |
virtual void OnInitialize
(
const FCameraEvaluationServiceInitializeParams& Params |
Initializes the evaluation service. | Services/CameraActionService.h | |
virtual void OnPostCameraDirectorUpdate
(
const FCameraEvaluationServiceUpdateParams& Params, |
Runs after the camera director update. | Services/CameraActionService.h | |
virtual void OnPostUpdate
(
const FCameraEvaluationServiceUpdateParams& Params, |
Runs at the end of the camera system update. | Services/CameraActionService.h | |
virtual void OnTeardown
(
const FCameraEvaluationServiceTeardownParams& Params |
Tears down the evaluation service. | Services/CameraActionService.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const ::UE::Cameras::TCameraObjectTypeID< FCameraActionService > & StaticTypeID() |
Services/CameraActionService.h |