1. Epic GamesDeveloper
  3. UGameplayCameraSystemComponent

UGameplayCameraSystemComponent

A component that hosts a camera system.

API > API/Plugins > API/Plugins/GameplayCameras

A component that hosts a camera system.

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

Syntax

UCLASS (BlueprintType, MinimalAPI, ClassGroup=Camera, HideCategories=(Mobility, Rendering, LOD))  
class UGameplayCameraSystemComponent :  
    public USceneComponent ,  
    public IGameplayCameraSystemHost

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UGameplayCameraSystemComponent ( const FObjectInitializer& ObjectInit
)

   GameFramework/GameplayCameraSystemComponent.h  

Typedefs

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

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AutoActivateForPlayer TEnumAsByte< EAutoReceiveInput::Type > If AutoActivate is set, auto-activates the camera system for the given player. GameFramework/GameplayCameraSystemComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Activation
  • Meta=(EditCondition="bAutoActivate")
bSetPlayerControllerRotation bool If enabled, sets the evaluated camera orientation as the player controller rotation every frame. GameFramework/GameplayCameraSystemComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Camera

Protected

Name Type Remarks Include Path Unreal Specifiers
EditorSpriteTextureScale float Sprite scaling for the editor. GameFramework/GameplayCameraSystemComponent.h
  • Transient
WeakPlayerController TWeakObjectPtr< APlayerController >   GameFramework/GameplayCameraSystemComponent.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ActivateCameraSystemForPlayerController ( APlayerController* PlayerController
)

 Sets this component's actor as the view target for the given player. GameFramework/GameplayCameraSystemComponent.h
  • BlueprintCallable
  • Category=Camera

void ActivateCameraSystemForPlayerIndex ( int32 PlayerIndex
)

 Sets this component's actor as the view target for the given player. GameFramework/GameplayCameraSystemComponent.h
  • BlueprintCallable
  • Category=Camera

void DeactivateCameraSystem ( AActor* NextViewTarget
)

 Removes this component's actor from being the view target. GameFramework/GameplayCameraSystemComponent.h
  • BlueprintCallable
  • Category=Camera

void GetCameraView ( float DeltaTime,
FMinimalViewInfo& DesiredView
)

 Updates the camera system and returns the computed view. GameFramework/GameplayCameraSystemComponent.h  

bool IsCameraSystemActiveForPlayController ( APlayerController* PlayerController
) const

 Returns whether this component's actor is set as the view target for the given player. GameFramework/GameplayCameraSystemComponent.h
  • BlueprintCallable
  • Category=Camera

FCameraRigInstanceID StartGlobalCameraModifierRig ( const UCameraRigAsset* CameraRig,
int32 OrderKey
)

   GameFramework/GameplayCameraSystemComponent.h
  • BlueprintCallable
  • Category=Camera

FCameraRigInstanceID StartVisualCameraModifierRig ( const UCameraRigAsset* CameraRig,
int32 OrderKey
)

   GameFramework/GameplayCameraSystemComponent.h
  • BlueprintCallable
  • Category=Camera

void StopCameraModifierRig ( FCameraRigInstanceID InstanceID,
bool bImmediately
)

   GameFramework/GameplayCameraSystemComponent.h
  • BlueprintCallable
  • Category=Camera

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   GameFramework/GameplayCameraSystemComponent.h  

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

   GameFramework/GameplayCameraSystemComponent.h  

virtual void OnRegister()

   GameFramework/GameplayCameraSystemComponent.h  

Overridden from IGameplayCameraSystemHost

Name Remarks Include Path Unreal Specifiers

virtual UObject * GetAsObject()

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page