EK at 10:32, 5 August 2023

2023-08-05T10:32:54Z

EK: Created page with "Create a haptic left/right effect for devices which support haptic effects. {| class="ts" |- | style="width:15%" | Related functions | Global Command: createHapticEffectCon..."

2023-08-05T10:10:43Z

Created page with "Create a haptic left/right effect for devices which support haptic effects. {| class="ts" |- | style="width:15%" | Related functions | Global Command: createHapticEffectCon..."

New page

Create a haptic left/right effect for devices which support haptic effects.

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

== Syntax ==
<syntaxhighlight lang="lua">
createHapticEffectLeftRight(effectType, length, large_magnitude, small_magnitude)
</syntaxhighlight>

== Parameters ==
{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| effectType
| string
| Type of the effect. Supported values:
* leftright
|-
| length
| int
| Duration of the effect in milliseconds
|-
| large_magnitude
| int
| Control of the large controller motor
|-
| small_magnitude
| int
| Control of the small controller motor
|}

== Return values ==
{| class="ts"
|-
! style="width:15%" | Type
! Description
|-
| integer
| The unique id of the effect or -1 if the effect is not supported by the controller.
|}

== Examples ==

'''Example 1:''' Create a constant haptic effect and start it.
<syntaxhighlight lang="lua">
local effectID = createHapticEffectLeftRight('leftright', 5000, 0x3000, 0xFFFF)
startHapticEffect(effectID)
</syntaxhighlight>
{{toc}}

@@ Line 53: / Line 53: @@
 == Examples ==
-'''Example 1:''' Create a constant haptic effect and start it.
+'''Example 1:''' Create a haptic left/right effect and start it.
 <syntaxhighlight lang="lua">
 local effectID = createHapticEffectLeftRight('leftright', 5000, 0x3000, 0xFFFF)

Global Command: createHapticEffectLeftRight - Revision history

EK at 10:32, 5 August 2023

EK: Created page with "Create a haptic left/right effect for devices which support haptic effects. {| class="ts" |- | style="width:15%" | Related functions | Global Command: createHapticEffectCon..."