Background for Fallout 4
Member of the ObjectReference script
boolfunctionrampRumble(floatpower=0.5, floatduration=0.25, floatfalloff=1600.0)

Description

Wiki Description

Intended as a quick way to cause some controller and camera rumble. Automatically tapers intensity of the effect based on players distance from the point of origin/calling reference.


Caveats


Parameters

floatpower=0.5

CK Wiki Description

How powerful this rumble is at the point of origin

floatduration=0.25

CK Wiki Description

how long should the effect last?

floatfalloff=1600.0

CK Wiki Description

Radius of the effect. Most intense at calling reference, tapers to nothing at falloff distance


Examples

; cause some intense camera/controller rumble originating from the marker, with a small radius
; send debug traces to let me know if any rumble was caused
if (!RumbleMarker.RampRumble(1.0, 0.25, 512))
     debug.trace("RampRumble() didn't cause any shake.  Player too far away?")
else
     debug.trace("player's world was rocked")
endif
; simple controller/camera shake
RumbleMarker.RampRumble()

Auto-Generated Example

float myFloat__power
float myFloat__duration
float myFloat__falloff

bool returnedValue = myObjectReference__toCallFunctionOn.rampRumble(myFloat__power, myFloat__duration, myFloat__falloff)

Related Pages


Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.