Worst-case scenario: the UEd Goblin wipes the map and burns down your house.

From Unreal Wiki, The Unreal Engine Documentation Site

v • d • e

Object >> Actor >> Camera

Package: 

Engine

Known direct subclass:

AnimatedCamera

This class in other games:

RTNP, U1, U2, U2XMP, UDK, UE2Runtime, UT, UT2003, UT2004

Camera: defines the Point of View of a player in world space. Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

[edit] Properties

[edit] bCamOverridePostProcess

Type: bool

Indicates if CamPostProcessSettings should be used when using this Camera to view through.

[edit] bConstrainAspectRatio

Type: bool

If we should insert black areas when rendering the scene to ensure an aspect ratio of ConstrainedAspectRatio

[edit] bEnableColorScaleInterp

Type: bool

Should interpolate color scale values

[edit] bEnableColorScaling

Type: bool

Turn on scaling of color channels in final image using ColorScale property.

[edit] bEnableFading

Type: bool

If we should apply FadeColor/FadeAmount to the screen.

[edit] BlendParams

Type: ViewTargetTransitionParams

Default value:

[edit] BlendTimeToGo

Type: float

Time left when blending to pending view target

[edit] bLockedFOV

Type: bool

true if FOV is locked to a constant value

[edit] CameraCache

Type: TCameraCache

Default value:

[edit] CameraStyle

Type: name

Camera Mode

[edit] CamPostProcessSettings

Type: PostProcessVolume.PostProcessSettings

Post-process settings to use if bCamOverridePostProcess is TRUE.

Default value:

[edit] ColorScale

Type: Object.Vector

Allows control over scaling individual color channels in the final image.

[edit] ColorScaleInterpDuration

Type: float

Total time for color scale interpolation to complete

[edit] ColorScaleInterpStartTime

Type: float

Time at which interpolation started

[edit] ConstrainedAspectRatio

Type: float

If bConstrainAspectRatio is true, add black regions to ensure aspect ratio is this. Ratio is horizontal/vertical.

[edit] DefaultAspectRatio

Type: float

Default aspect ratio

Default value: 1.333333

[edit] DefaultFOV

Type: float

default FOV

Default value: 90.0

[edit] DesiredColorScale

Type: Object.Vector

Desired color scale which ColorScale will interpolate to

[edit] FadeAmount

Type: float

Amount of fading to apply.

[edit] FadeColor

Type: Object.Color

Color to fade to.

[edit] FreeCamDistance

Type: float

Distance to place free camera from view target

Default value: 256.0

[edit] FreeCamOffset

Type: Object.Vector

Offset to Z free camera position

[edit] LockedFOV

Type: float

value FOV is locked at

[edit] ModifierList

Type: array<CameraModifier>

List of camera modifiers to apply during update of camera position/ rotation

[edit] OriginalColorScale

Type: Object.Vector

Color scale value at start of interpolation

[edit] PCOwner

Type: PlayerController

PlayerController Owning this Camera Actor

[edit] PendingViewTarget

Type: TViewTarget

Pending view target for blending

Default value:

[edit] ViewTarget

Type: TViewTarget

Current ViewTarget

Default value:

[edit] Default values

[edit] Enums

[edit] EViewTargetBlendFunction

VTBlend_Linear 

Camera does a simple linear interpolation.

VTBlend_Cubic 

Camera has a slight ease in and ease out, but amount of ease cannot be tweaked.

VTBlend_EaseIn 

Camera immediately accelerates, but smoothly decelerates into the target. Ease amount controlled by BlendExp.

VTBlend_EaseOut 

Camera smoothly accelerates, but does not decelerate into the target. Ease amount controlled by BlendExp.

VTBlend_EaseInOut 

Camera smoothly accelerates and decelerates. Ease amount controlled by BlendExp.

[edit] Structs

[edit] TCameraCache

Modifiers: native

The actors which the camera shouldn't see. Used to hide actors which the camera penetrates.

float TimeStamp 

Cached Time Stamp

Object.TPOV POV 

cached Point of View

[edit] TViewTarget

Modifiers: native

View Target definition A View Target is responsible for providing the Camera with an ideal Point of View (POV)

Actor Target 

Target Actor used to compute ideal POV

Controller Controller 

Controller of Target (only for non Locally controlled Pawns)

Object.TPOV POV 

Point of View

float AspectRatio 

Aspect ratio

PlayerReplicationInfo PRI 

PlayerReplicationInfo (used to follow same player through pawn transitions, etc., when spectating)

[edit] ViewTargetTransitionParams

Modifiers: native

A set of parameters to describe how to transition between viewtargets.

float BlendTime 

Total duration of blend to pending view target. 0 means no blending.

EViewTargetBlendFunction BlendFunction 

Function to apply to the blend parameter

float BlendExp 

Exponent, used by certain blend functions to control the shape of the curve.

Default values:

[edit] Functions

[edit] Native functions

[edit] CheckViewTarget

Make sure ViewTarget is valid

[edit] SetViewTarget

Set a new ViewTarget with optional BlendTime

[edit] Events

[edit] ApplyCameraModifiers

Apply modifiers on Camera.

Parameters:

• DeltaTime - Time is seconds since last update
• OutPOV - Point of View

[edit] UpdateCamera

Performs camera update. Called once per frame after all actors have been ticked.

[edit] Other instance functions

[edit] AllowPawnRotation

[edit] BlendViewTargets

Blend 2 viewtargets.

Parameters:

• A - Source view target
• Alpha - Alpha, % of blend from A to B.

Paramn: B destination view target

[edit] DisplayDebug

Overrides: Actor.DisplayDebug

list important Camera variables on canvas. HUD will call DisplayDebug() on the current ViewTarget when the ShowDebug exec is used

Parameters:

• HUD - HUD with canvas to draw on
• out_YL - Height of the current font
• out_YPos - Y position on Canvas. out_YPos += out_YL, gives position to draw text for next debug line.

[edit] FillCameraCache

Cache update results

[edit] GetCameraViewPoint

Master function to retrieve Camera's actual view point. do not call this directly, call PlayerController::GetPlayerViewPoint() instead.

Parameters:

• OutCamLoc - Camera Location
• OutCamRot - Camera Rotation

[edit] GetFOVAngle

returns camera's current FOV angle

[edit] InitializeFor

Initialize Camera for associated PlayerController

Parameters:

• PC - PlayerController attached to this Camera.

[edit] ProcessViewRotation

Give each modifier a chance to change view rotation/deltarot

[edit] SetDesiredColorScale

Sets the new desired color scale and enables interpolation.

[edit] SetFOV

Lock FOV to a specific value. A value of 0 to beyond 170 will unlock the FOV setting.

[edit] UpdateViewTarget

Query ViewTarget and outputs Point Of View.

Parameters:

• OutVT - ViewTarget to use.
• DeltaTime - Delta Time since last camera update (in seconds).