IGameplayCameraSystemHost

An interface for objects that host a camera system evaluator.

API > API/Plugins > API/Plugins/GameplayCameras

An interface for objects that host a camera system evaluator.

   
Name IGameplayCameraSystemHost
Type class
Header File /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/GameFramework/IGameplayCameraSystemHost.h
Include Path #include "GameFramework/IGameplayCameraSystemHost.h"

Syntax

class IGameplayCameraSystemHost

Derived Classes

Typedefs

Name Type Remarks Include Path
FCameraEvaluationContext UE::Cameras::FCameraEvaluationContext   GameFramework/IGameplayCameraSystemHost.h
FCameraSystemEvaluator UE::Cameras::FCameraSystemEvaluator   GameFramework/IGameplayCameraSystemHost.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DebugDrawDelegateHandle FDelegateHandle   GameFramework/IGameplayCameraSystemHost.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TScriptInterface< IGameplayCameraSystemHost > GetAsScriptInterface()

 Returns this object as a script interface. GameFramework/IGameplayCameraSystemHost.h  

TSharedPtr< FCameraSystemEvaluator > GetCameraSystemEvaluator()

 Gets the camera system evaluator. GameFramework/IGameplayCameraSystemHost.h  

bool HasCameraSystem()

 Returns whether a camera system evaluation has been created in this host. GameFramework/IGameplayCameraSystemHost.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual UObject * GetAsObject()

 Should be implemented by the underlying class to return itself as a UObject. GameFramework/IGameplayCameraSystemHost.h  

Protected

Name Remarks Include Path Unreal Specifiers

FCameraRigInstanceID ActivateCameraRig ( const UCameraRigAsset* CameraRig,
TSharedPtr< FCameraEvaluationContext > EvaluationContext,
ECameraRigLayer EvaluationLayer
)

 Activates the given camera rig in the given layer. Should not be used with Main layer. GameFramework/IGameplayCameraSystemHost.h  

void DeactivateCameraRig ( FCameraRigInstanceID InInstanceID,
bool bImmediately
)

 Deactivates a previously activated camera rig. GameFramework/IGameplayCameraSystemHost.h  

void DestroyCameraSystem()

 Destroys the camera system. GameFramework/IGameplayCameraSystemHost.h  

void EnsureCameraSystemInitialized()

 Ensures that the camera system is created. GameFramework/IGameplayCameraSystemHost.h  
Creates a new camera system. Asserts if there is already one. GameFramework/IGameplayCameraSystemHost.h  
Creates a new camera system. Asserts if there is already one. GameFramework/IGameplayCameraSystemHost.h  

bool IsActionRunning ( const FCameraActionInstanceID InInstanceID
) const

 Returns whether a given camera action instance is running. GameFramework/IGameplayCameraSystemHost.h  

bool IsCameraShakePlaying ( FCameraShakeInstanceID InInstanceID
) const

 Checks if a camera shake is running. GameFramework/IGameplayCameraSystemHost.h  

void OnAddReferencedObjects ( FReferenceCollector& Collector
)

 Should be called by the underlying object for garbage collection. GameFramework/IGameplayCameraSystemHost.h  

FCameraActionInstanceID StartAction ( const UCameraAction* CameraAction
)

 Starts a new camera action. GameFramework/IGameplayCameraSystemHost.h  

FCameraRigInstanceID StartCameraModifierRig ( const UCameraRigAsset* CameraRig,
TSharedPtr< FCameraEvaluationContext > EvaluationContext,
ECameraRigLayer EvaluationLayer,
int32 OrderKey
)

 Starts a camera modifier rig on the given layer. GameFramework/IGameplayCameraSystemHost.h  

FCameraShakeInstanceID StartCameraShake ( const UCameraShakeAsset* CameraShake,
float ShakeScale,
ECameraShakePlaySpace PlaySpace,
FRotator UserPlaySpaceRotation
)

 Starts a new camera shake. GameFramework/IGameplayCameraSystemHost.h  

bool StopAction ( const FCameraActionInstanceID InInstanceID
)

 Stops a given camera action instance. GameFramework/IGameplayCameraSystemHost.h  

bool StopAllActionsOfClass ( TSubclassOf< UCameraAction > InActionClass
)

 Stops all camera action instances of a given class. GameFramework/IGameplayCameraSystemHost.h  

void StopCameraModifierRig ( FCameraRigInstanceID InstanceID,
bool bImmediately
)

 Stops a camera modifier rig on previously started on the global or visual layer. GameFramework/IGameplayCameraSystemHost.h  

bool StopCameraShake ( FCameraShakeInstanceID InInstanceID,
bool bImmediately
)

 Stops a running camera shake. GameFramework/IGameplayCameraSystemHost.h  

void UpdateCameraSystem ( float DeltaTime
)

 Updates the camera system, if it exists. GameFramework/IGameplayCameraSystemHost.h  

void UpdateCameraSystemForEditorPreview ( float DeltaTime
)

 Updates the camera system, if it exists, for an editor world preview. GameFramework/IGameplayCameraSystemHost.h  

Static

Name Remarks Include Path Unreal Specifiers

static IGameplayCameraSystemHost * FindActiveHost ( APlayerController* PlayerController
)

 Finds a valid host on the player controller's camera manager, or its view target. GameFramework/IGameplayCameraSystemHost.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page