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

2023-08-05T10:18:49Z

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

New page

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

== Syntax ==
<syntaxhighlight lang="lua">
createHapticEffectPeriodic(effectType, length, delay, peroid, magnitude, offset, phase, 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
|
|-
| level
| int
|
|-
| period
| int
|
|-
| magnitude
| int
|
|-
| offset
| int
|
|-
| phase
| 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 ==

{{toc}}

Global Command: createHapticEffectPeriodic - Revision history

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