Global Command: startHapticRumble

From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 11:36, 5 August 2023 by EK (talk | contribs) (Created page with "Start a haptic rumble effect for devices which support haptic effects. {| class="ts" |- | style="width:15%" | Related functions | Global Command: createHapticEffectConditio...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Start a haptic rumble effect for devices which support haptic effects.

Related functions createHapticEffectCondition | createHapticEffectConstant | createHapticEffectLeftRight | createHapticEffectPeriodic | createHapticEffectRamp | startHapticEffect | stopHapticEffect | stopHapticRumble


Syntax

startHapticRumble(strength, length)


Parameters

Parameter Type Description
strength int Strength of the rumble to play (0 to 100)
length int Length of the rumble to play in milliseconds, -1 for infinite


Return values

Type Description
boolean Status


Examples

Example 1: Start a 5 second haptic rumble effect.

local rumble = startHapticRumble(50, 5000)