1. Epic GamesDeveloper
  3. UGameplayCameraSystemComponent

UGameplayCameraSystemComponent

A component that hosts a camera system.

API > API/Plugins > API/Plugins/GameplayCameras > API/Plugins/GameplayCameras/GameFramework

Inheritance Hierarchy

  • USceneComponent
  • UGameplayCameraSystemComponent

References

   
Module GameplayCameras
Header /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/GameFramework/GameplayCameraSystemComponent.h
Include #include "GameFramework/GameplayCameraSystemComponent.h"

Syntax

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

Remarks

A component that hosts a camera system.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TEnumAsByte< EAutoReceiveInput::Type > AutoActivateForPlayer If AutoActivate is set, auto-activates the camera system for the given player.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bSetPlayerControllerRotation If enabled, sets the evaluated camera orientation as the player controller rotation every frame.

Constructors

  Type Name Description
Public function  

UGameplayCameraSystemComponent ( const FObjectInitializer& ObjectInit
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

ActivateCameraSystemForPlayerController ( APlayerController* PlayerController
)

 Sets this component's actor as the view target for the given player.
Public function UFunction BlueprintCallable, Category void Sets this component's actor as the view target for the given player.
Public function Virtual void  
Public function UFunction BlueprintCallable, Category void

DeactivateCameraSystem ( AActor* NextViewTarget
)

 Removes this component's actor from being the view target.
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

  
Public function TSharedPtr< FCameraSystemEvaluator >

GetCameraSystemEvaluator ( bool bEnsureIfNull
)

 Gets the camera system evaluator.
Public function void

GetCameraView ( float DeltaTime,
FMinimalViewInfo& DesiredView
)

 Updates the camera system and returns the computed view.
Public function Const UFunction BlueprintCallable, Category bool

IsCameraSystemActiveForPlayController ( APlayerController* PlayerController
)

 Returns whether this component's actor is set as the view target for the given player.
Public function void Internal API.
Public function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

  
Public function void  
Public function Virtual void  

Typedefs

Name Description
FCameraSystemEvaluator  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page