Global Command: createHapticEffectCondition - Revision history

EK at 10:12, 5 August 2023

2023-08-05T10:12:03Z

← Older revision		Revision as of 11:12, 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 66:		Line 66:
	\|-		\|-
	\| integer		\| integer
	\| The id of the created effect.		\| The unique id of the created effect.
	\|}		\|}

EK at 14:10, 19 May 2023

2023-05-19T14:10:17Z

← Older revision		Revision as of 15:10, 19 May 2023
Line 1:		Line 1:
	Create a ~~constant~~ haptic effect for devices ~~supporting~~ haptic effects.		Create a haptic effect for devices which support haptic effects.

	{\| class="ts"		{\| class="ts"
Line 10:		Line 10:
	== Syntax ==		== Syntax ==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~createHapticEffectConstant~~(effectType, length, delay, ~~level~~, ~~attack_length~~, ~~attack_level~~, ~~fade_length~~, ~~fade_level~~, ~~effectDirection [, dir0, dir1, dir2]~~)		createHapticEffectCondition(effectType, length, delay, right_sat, left_sat, right_coeff, left_coeff, deadband, center)
	</syntaxhighlight>		</syntaxhighlight>

Line 33:		Line 33:
	\|		\|
	\|-		\|-
	\| ~~level~~		\| right_sat
	\| int		\| int
	\|		\|
	\|-		\|-
	\| ~~attack_length~~		\| left_sat
	\| int		\| int
	\|		\|
	\|-		\|-
	\| ~~attack_level~~		\| right_coeff
	\| int		\| int
	\|		\|
	\|-		\|-
	\| ~~fade_length~~		\| left_coeff
	\| int		\| int
	\|		\|
	\|-		\|-
	\| ~~fade_level~~		\| deadband
	\| int		\| int
	\|		\|
	\|-		\|-
	\| ~~effectDirection~~		\| center
	~~\| string~~
	\|
	\|-
	~~\| dir0~~
	~~\| int~~
	\|
	\|-
	~~\| dir1~~
	~~\| int~~
	\|
	\|-
	~~\| dir2~~
	\| int		\| int
	\|		\|
Line 84:		Line 72:
	== Examples ==		== Examples ==

	'''Example 1:''' Create a ~~constant~~ haptic effect ~~and start it~~.		'''Example 1:''' Create and start a haptic effect.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local effectID = ~~createHapticEffectConstant~~('~~constant~~', ~~1000~~, -1, ~~0x6000~~, ~~1000~~, -1, ~~1000~~, -1, ~~'polar', 20000~~)		local effectID = createHapticEffectCondition('spring', 5000, -1, 0xFFFF, 0xFFFF, 0x2000, 0x2000, -1, 0x1000)
	startHapticEffect(effectID)		startHapticEffect(effectID)


	</syntaxhighlight>		</syntaxhighlight>
	{{toc}}		{{toc}}

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

2023-05-19T14:05:32Z

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

New page

Create a constant haptic effect for devices supporting haptic effects.

{| class="ts"
|-
| style="width:15%" | Related functions
| [[Global Command: createHapticEffectConstant|createHapticEffectConstant]] | [[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}}