I'm a doctor, not a mechanic

UE3:DemoCamMod_ScreenShake (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> CameraModifier >> DemoCamMod_ScreenShake
Package: 
UTGame

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties[edit]

Property group 'DemoCamMod_ScreenShake'[edit]

TestShake[edit]

Type: ScreenShakeStruct

Always active ScreenShake for testing purposes

Default value:

Member Value
FOVAmplitude 2.0
FOVFrequency 5.0
LocAmplitude
Member Value
X 0.0
Y 3.0
Z 5.0
LocFrequency
Member Value
X 1.0
Y 10.0
Z 20.0
RotAmplitude
Member Value
X 100.0
Y 100.0
Z 200.0
RotFrequency
Member Value
X 10.0
Y 10.0
Z 25.0
TimeDuration 1.0

Internal variables[edit]

Shakes[edit]

Type: array<ScreenShakeStruct>

Active ScreenShakes array

Enums[edit]

EShakeParam[edit]

Shake start offset parameter

ESP_OffsetRandom 
Start with random offset (default)
ESP_OffsetZero 
Start with zero offset

Structs[edit]

ScreenShakeStruct[edit]

Modifiers: native

float TimeToGo 
Time in seconds to go until current screen shake is finished
float TimeDuration 
Duration in seconds of current screen shake
Object.Vector RotAmplitude 
view rotation amplitude
Object.Vector RotFrequency 
view rotation frequency
Object.Vector RotSinOffset 
view rotation Sine offset
ShakeParams RotParam 
rotation parameters
Object.Vector LocAmplitude 
view offset amplitude
Object.Vector LocFrequency 
view offset frequency
Object.Vector LocSinOffset 
view offset Sine offset
ShakeParams LocParam 
location parameters
float FOVAmplitude 
FOV amplitude
float FOVFrequency 
FOV frequency
float FOVSinOffset 
FOV Sine offset
EShakeParam FOVParam 
FOV parameters

Default values:

Property Value
FOVAmplitude 2.0
FOVFrequency 5.0
LocAmplitude
Member Value
X 0.0
Y 3.0
Z 5.0
LocFrequency
Member Value
X 1.0
Y 10.0
Z 20.0
RotAmplitude
Member Value
X 100.0
Y 100.0
Z 200.0
RotFrequency
Member Value
X 10.0
Y 10.0
Z 25.0
TimeDuration 1.0

ShakeParams[edit]

Modifiers: native

Shake vector params

EShakeParam
EShakeParam
EShakeParam
byte Padding 

Functions[edit]

Static functions[edit]

InitializeOffset[edit]

final static function float InitializeOffset (EShakeParam Param)

Initialize sin wave start offset

Native functions[edit]

UpdateScreenShake[edit]

native function UpdateScreenShake (float DeltaTime, out ScreenShakeStruct Shake, out Object.TPOV OutPOV)

Update a ScreenShake

Other instance functions[edit]

AddScreenShake[edit]

final function AddScreenShake (ScreenShakeStruct NewShake)

Add a new screen shake to the list

ComposeNewShake[edit]

final function ScreenShakeStruct ComposeNewShake (float Duration, Object.Vector newRotAmplitude, Object.Vector newRotFrequency, Object.Vector newLocAmplitude, Object.Vector newLocFrequency, float newFOVAmplitude, float newFOVFrequency)

ComposeNewShake Take Screen Shake parameters and create a new ScreenShakeStruct variable

Parameters:

  • Duration - Duration in seconds of shake
  • newRotAmplitude - view rotation amplitude (pitch,yaw,roll)
  • newRotFrequency - frequency of rotation shake
  • newLocAmplitude - relative view offset amplitude (x,y,z)
  • newLocFrequency - frequency of view offset shake
  • newFOVAmplitude - fov shake amplitude
  • newFOVFrequency - fov shake frequency

DumpShakeInfo[edit]

function DumpShakeInfo (ScreenShakeStruct Shake)


InitializeShake[edit]

final function ScreenShakeStruct InitializeShake (ScreenShakeStruct NewShake)

Initialize screen shake structure

ModifyCamera[edit]

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

Overrides: CameraModifier.ModifyCamera

See: CameraModifer::ModifyCamera

StartNewShake[edit]

function StartNewShake (float Duration, Object.Vector newRotAmplitude, Object.Vector newRotFrequency, Object.Vector newLocAmplitude, Object.Vector newLocFrequency, float newFOVAmplitude, float newFOVFrequency)

StartNewShake

Parameters:

  • Duration - Duration in seconds of shake
  • newRotAmplitude - view rotation amplitude (pitch,yaw,roll)
  • newRotFrequency - frequency of rotation shake
  • newLocAmplitude - relative view offset amplitude (x,y,z)
  • newLocFrequency - frequency of view offset shake
  • newFOVAmplitude - fov shake amplitude
  • newFOVFrequency - fov shake frequency