The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE3:GamePlayerCamera (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 05:24, 17 January 2010 by (Talk)

Jump to: navigation, search
UDK Object >> Actor >> Camera >> GamePlayerCamera
Package: 
GameFramework


Properties

Property group 'Camera'

CurrentCamera

Type: GameCameraBase

Modifiers: editinline, transient

Which camera is currently active.

FixedCam

Type: GameCameraBase

Modifiers: editinline, transient

Implements fixed camera, used for viewing through pre-placed camera actors.

FixedCameraClass

Type: class<GameCameraBase>

Modifiers: protected, const

Class to use for third person camera.

Default value: Class'GameFramework.GameFixedCamera'

ThirdPersonCam

Type: GameCameraBase

Modifiers: editinline, transient

Implements typical third person camera.

ThirdPersonCameraClass

Type: class<GameCameraBase>

Modifiers: protected, const

Class to use for third person camera.

Default value: Class'GameFramework.GameThirdPersonCamera'

Property group 'GamePlayerCamera'

SplitScreenShakeScale

Type: float

Modifiers: protected, const

Scalar applied to all screen shakes in splitscreen. Normally used to dampen, since shakes feel more intense in a smaller viewport.

Internal variables

bInterpolateCamChanges

Type: bool

Modifiers: transient


bResetInterp

Type: bool

Modifiers: transient, private

Indicates if we should reset interpolation on whichever active camera processes next.

bUseForcedCamFOV

Type: bool

Modifiers: transient

Should the FOV be overridden?

ForcedCamFOV

Type: float

Modifiers: transient

If bUseForcedCamFOV is true, use this angle

LastTargetBase

Type: Actor

Modifiers: transient, protected


LastTargetBaseTM

Type: Object.Matrix

Modifiers: transient, protected


LastViewTarget

Type: Actor

Modifiers: transient, private


Default values

Property Value
CameraStyle 'Default'
DefaultFOV 70.0

Functions

Native functions

AdjustFOVForViewport

final protected native function float AdjustFOVForViewport (float inHorizFOV, Pawn CameraTargetPawn) const

Given a horizontal FOV that assumes a 16:9 viewport, return an appropriately adjusted FOV for the viewport of the target pawn. Used to correct for splitscreen.

CacheLastTargetBaseInfo

protected native function CacheLastTargetBaseInfo (Actor TargetBase)


Events

PostBeginPlay

event PostBeginPlay ()

Overrides: Camera.PostBeginPlay


Reset

event Reset ()

Overrides: Actor.Reset


Other instance functions

CreateCamera

protected function GameCameraBase CreateCamera (class<GameCameraBaseCameraClass)

Internal. Creates and initializes a new camera of the specified class, returns the object ref.

DisplayDebug

simulated function DisplayDebug (HUD HUD, out float out_YL, out float out_YPos)

Overrides: Camera.DisplayDebug

(Description copied from Camera.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.

FindBestCameraType

protected function GameCameraBase FindBestCameraType (Actor CameraTarget)

Internal. Polls game state to determine best camera to use.

ProcessViewRotation

function ProcessViewRotation (float DeltaTime, out Object.Rotator out_ViewRotation, out Object.Rotator out_DeltaRot)

Overrides: Camera.ProcessViewRotation

Give cameras a chance to influence player view rotation.

ResetInterpolation

simulated function ResetInterpolation ()

Stop interpolation for this frame and just let everything go to where it's supposed to be.

SetColorScale

simulated function SetColorScale (Object.Vector NewColorScale)

Sets the new color scale

ShouldConstrainAspectRatio

function bool ShouldConstrainAspectRatio ()

Available for overriding.

UpdateCameraLensEffects

simulated function UpdateCameraLensEffects (const out Camera.TViewTarget OutVT)

Update any attached camera lens effects (e.g. blood) *

UpdateViewTarget

function UpdateViewTarget (out Camera.TViewTarget OutVT, float DeltaTime)

Overrides: Camera.UpdateViewTarget

Query ViewTarget and outputs Point Of View.

Parameters:

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