EK at 10:32, 5 August 2023

2023-08-05T10:32:22Z

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

2023-08-05T10:23:29Z

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

New page

Create a haptic ramp 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: startHapticEffect|startHapticEffect]] | [[Global Command: startHapticRumble|startHapticRumble]] | [[Global Command: stopHapticEffect|stopHapticEffect]] | [[Global Command: stopHapticRumble|stopHapticRumble]]
|}

== Syntax ==
<syntaxhighlight lang="lua">
createHapticEffectRamp(effectType, length, delay, start, end, attack_length, attack_level, fade_length, fade_level, effectDirection, dir0, dir1, dir2)
</syntaxhighlight>

== Parameters ==
{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| effectType
| string
| Type of the effect
|-
| length
| int
| Duration of the effect in milliseconds
|-
| delay
| int
|
|-
| start
| int
|
|-
| end
| int
|
|-
| attack_length
| int
|
|-
| attack_level
| int
|
|-
| fade_length
| int
|
|-
| fade_level
| int
|
|-
| effectDirection
| string
|
|-
| dir0
| int
|
|-
| dir1
| int
|
|-
| dir2
| int
|
|}

== Return values ==
{| class="ts"
|-
! style="width:15%" | Type
! Description
|-
| integer
| The unique id of the effect.
|}

== Examples ==

'''Example 1:''' Create a constant haptic effect and start it.
<syntaxhighlight lang="lua">
local effectID = createHapticEffectRamp('ramp', 5000, -1, 0x4000, -0x4000, 1000, -1, 1000, -1, 'cartesian', 1, -1)
startHapticEffect(effectID)
</syntaxhighlight>
{{toc}}

@@ Line 88: / Line 88: @@
 == Examples ==
-'''Example 1:''' Create a constant haptic effect and start it.
+'''Example 1:''' Create a haptic ramp effect and start it.
 <syntaxhighlight lang="lua">
 local effectID = createHapticEffectRamp('ramp', 5000, -1, 0x4000, -0x4000, 1000, -1, 1000, -1, 'cartesian', 1, -1)

Global Command: createHapticEffectRamp - Revision history

EK at 10:32, 5 August 2023

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