EK: Created page with "Start a haptic rumble effect for devices which support haptic effects. {| class="ts" |- | style="width:15%" | Related functions | Global Command: createHapticEffectConditio..."

2023-08-05T10:36:50Z

Created page with "Start a haptic rumble effect for devices which support haptic effects. {| class="ts" |- | style="width:15%" | Related functions | Global Command: createHapticEffectConditio..."

New page

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

{| class="ts"
|-
| style="width:15%" | Related functions
| [[Global Command: createHapticEffectCondition|createHapticEffectCondition]] | [[Global Command: createHapticEffectConstant|createHapticEffectConstant]] | [[Global Command: createHapticEffectLeftRight|createHapticEffectLeftRight]] | [[Global Command: createHapticEffectPeriodic|createHapticEffectPeriodic]] | [[Global Command: createHapticEffectRamp|createHapticEffectRamp]] | [[Global Command: startHapticEffect|startHapticEffect]] | [[Global Command: stopHapticEffect|stopHapticEffect]] | [[Global Command: stopHapticRumble|stopHapticRumble]]
|}

== Syntax ==
<syntaxhighlight lang="lua">
startHapticRumble(strength, length)
</syntaxhighlight>

== Parameters ==
{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | 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 ==
{| class="ts"
|-
! style="width:15%" | Type
! Description
|-
| boolean
| Status
|}

== Examples ==

'''Example 1:''' Start a 5 second haptic rumble effect.
<syntaxhighlight lang="lua">
local rumble = startHapticRumble(50, 5000)
</syntaxhighlight>
{{toc}}

Global Command: startHapticRumble - Revision history

EK: Created page with "Start a haptic rumble effect for devices which support haptic effects. {| class="ts" |- | style="width:15%" | Related functions | Global Command: createHapticEffectConditio..."