Cogito, ergo sum

UE3:CameraModifier_CameraShake (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> CameraModifier >> CameraModifier_CameraShake
Package: 
Engine

Camera modifier that provides support for code-based oscillating camera shakes.

Properties

Property group 'CameraModifier_CameraShake'

SplitScreenShakeScale

Type: float

Modifiers: protected, const

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

Default value: 0.5

Internal variables

ActiveShakes

Type: array<CameraShakeInstance>

Active CameraShakes array

Structs

CameraShakeInstance

Modifiers: native

CameraShake SourceShake 
source shake
float OscillatorTimeRemaining 
<0.f means play infinitely.
bool bBlendingIn 
blend vars
float CurrentBlendInTime 
bool bBlendingOut 
float CurrentBlendOutTime 
Object.Vector LocSinOffset 
Current offsets.
Object.Vector RotSinOffset 
float FOVSinOffset 
float Scale 
CameraAnimInst AnimInst 
Camera.ECameraAnimPlaySpace PlaySpace 
What space to play the shake in before applying to the camera. Affects Anim and Oscillation both.
Object.Matrix UserPlaySpaceMatrix 
Matrix defining the playspace, used when PlaySpace == CAPS_UserDefined

Functions

Static functions

InitializeOffset

static protected function float InitializeOffset (const out CameraShake.FOscillator Param)


Native functions

ModifyCamera

native function bool ModifyCamera (Camera Camera, float DeltaTime, out Object.TPOV OutPOV)

Overrides: CameraModifier.ModifyCamera

See: CameraModifer::ModifyCamera

UpdateCameraShake

native function UpdateCameraShake (float DeltaTime, out CameraShakeInstance Shake, out Object.TPOV OutPOV)

Update a CameraShake

Other instance functions

AddCameraShake

function AddCameraShake (CameraShake NewShake, float Scale, optional Camera.ECameraAnimPlaySpace PlaySpace, optional Object.Rotator UserPlaySpaceRot)

Add a new screen shake to the list

InitializeShake

function protected CameraShakeInstance InitializeShake (CameraShake NewShake, float Scale, Camera.ECameraAnimPlaySpace PlaySpace, optional Object.Rotator UserPlaySpaceRot)

Initialize camera shake structure

ReinitShake

function protected ReinitShake (int ActiveShakeIdx, float Scale)


RemoveAllCameraShakes

function RemoveAllCameraShakes ()


RemoveCameraShake

function RemoveCameraShake (CameraShake Shake)