Gah - a solution with more questions. – EntropicLqd

UE3:CameraShake (UDK)

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

Object that encapsulates parameters for defining a camera shake. a code-driven (oscillating) screen shake.

Properties

Property group 'AnimShake'

Anim

Type: CameraAnim

Parameters for defining CameraAnim-driven camera shakes

AnimBlendInTime

Type: float

Linear blend-in time.

Default value: 0.2

AnimBlendOutTime

Type: float

Linear blend-out time.

Default value: 0.2

AnimPlayRate

Type: float

Scalar defining how fast to play the anim.

Default value: 1.0

AnimScale

Type: float

Scalar defining how "intense" to play the anim.

Default value: 1.0

bRandomAnimSegment

Type: bool

If TRUE, play a random snippet of the animation of length Duration. Implies bLoop and bRandomStartTime = TRUE for the CameraAnim. If FALSE, play the full anim once, non-looped.

RandomAnimSegmentDuration

Type: float

When bRandomAnimSegment=true, this defines how long the anim should play.

Property group 'CameraShake'

bSingleInstance

Type: bool

TRUE to only allow a single instance of this shake to play at any given time.

Subsequents attempts to play this shake will simply restart the timer.

Property group 'Oscillation'

FOVOscillation

Type: FOscillator

FOV oscillation

LocOscillation

Type: VOscillator

Positional oscillation

OscillationBlendInTime

Type: float


Default value: 0.1

OscillationBlendOutTime

Type: float


Default value: 0.2

OscillationDuration

Type: float

Duration in seconds of current screen shake. <0 means indefinite, 0 means no oscillation

RotOscillation

Type: ROscillator

Rotational oscillation

Enums

EInitialOscillatorOffset

Shake start offset parameter

EOO_OffsetRandom 
Start with random offset (default)
EOO_OffsetZero 
Start with zero offset

Structs

FOscillator

Modifiers: native

Defines oscillation of a single number.

float Amplitude 
float Frequency 
EInitialOscillatorOffset InitialOffset 

ROscillator

Modifiers: native

Defines rotator oscillation.

FOscillator Pitch 
FOscillator Yaw 
FOscillator Roll 

VOscillator

Modifiers: native

Defines vector oscillation.

FOscillator
FOscillator
FOscillator

Instance functions

GetLocOscillationMagnitude

simulated function float GetLocOscillationMagnitude ()


GetRotOscillationMagnitude

simulated function float GetRotOscillationMagnitude ()