EK at 10:13, 5 August 2023

2023-08-05T10:13:29Z

← Older revision		Revision as of 11:13, 5 August 2023
Line 23:		Line 23:
	\| effectType		\| effectType
	\| string		\| string
	\|		\| Type of the effect
	\|-		\|-
	\| length		\| length
	\| int		\| int
	\|		\| Duration of the effect in milliseconds
	\|-		\|-
	\| delay		\| delay
Line 78:		Line 78:
	\|-		\|-
	\| integer		\| integer
	\| The id of the created effect.		\| The unique id of the created effect.
	\|}		\|}

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

2023-05-19T14:13:17Z

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

New page

Create a constant haptic effect for devices which support haptic effects.

{| class="ts"
|-
| style="width:15%" | Related functions
| [[Global Command: createHapticEffectCondition|createHapticEffectCondition]] | [[Global Command: createHapticEffectLeftRight|createHapticEffectLeftRight]] | [[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">
createHapticEffectConstant(effectType, length, delay, level, 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
|
|-
| length
| int
|
|-
| delay
| int
|
|-
| level
| 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 id of the created effect.
|}

== Examples ==

'''Example 1:''' Create a constant haptic effect and start it.
<syntaxhighlight lang="lua">
local effectID = createHapticEffectConstant('constant', 1000, -1, 0x6000, 1000, -1, 1000, -1, 'polar', 20000)
startHapticEffect(effectID)
</syntaxhighlight>
{{toc}}

Global Command: createHapticEffectConstant - Revision history

EK at 10:13, 5 August 2023

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