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[edit]

Property group 'AnimShake'[edit]

Anim[edit]

Type: CameraAnim

Parameters for defining CameraAnim-driven camera shakes

AnimBlendInTime[edit]

Type: float

Linear blend-in time.

Default value: 0.2

AnimBlendOutTime[edit]

Type: float

Linear blend-out time.

Default value: 0.2

AnimPlayRate[edit]

Type: float

Scalar defining how fast to play the anim.

Default value: 1.0

AnimScale[edit]

Type: float

Scalar defining how "intense" to play the anim.

Default value: 1.0

bRandomAnimSegment[edit]

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[edit]

Type: float

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

Property group 'CameraShake'[edit]

bSingleInstance[edit]

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'[edit]

FOVOscillation[edit]

Type: FOscillator

FOV oscillation

LocOscillation[edit]

Type: VOscillator

Positional oscillation

OscillationBlendInTime[edit]

Type: float


Default value: 0.1

OscillationBlendOutTime[edit]

Type: float


Default value: 0.2

OscillationDuration[edit]

Type: float

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

RotOscillation[edit]

Type: ROscillator

Rotational oscillation

Enums[edit]

EInitialOscillatorOffset[edit]

Shake start offset parameter

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

Structs[edit]

FOscillator[edit]

Modifiers: native

Defines oscillation of a single number.

float Amplitude 
float Frequency 
EInitialOscillatorOffset InitialOffset 

ROscillator[edit]

Modifiers: native

Defines rotator oscillation.

FOscillator Pitch 
FOscillator Yaw 
FOscillator Roll 

VOscillator[edit]

Modifiers: native

Defines vector oscillation.

FOscillator
FOscillator
FOscillator

Instance functions[edit]

GetLocOscillationMagnitude[edit]

simulated function float GetLocOscillationMagnitude ()


GetRotOscillationMagnitude[edit]

simulated function float GetRotOscillationMagnitude ()