Difference between revisions of "Global Command: startHapticEffect"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Created page with "Start a previously created haptic effect for devices which support haptic effects. {| class="ts" |- | style="width:15%" | Related functions | Global Command: createHapticEf...")
 
 
Line 4: Line 4:
 
|-
 
|-
 
| style="width:15%" | Related functions
 
| style="width:15%" | Related functions
| [[Global Command: createHapticEffectCondition|createHapticEffectCondition]] | [[Global Command: createHapticEffectConstant|createHapticEffectConstant]] | [[Global Command: createHapticEffectLeftRight|createHapticEffectLeftRight]] | [[Global Command: createHapticEffectPeriodic|createHapticEffectPeriodic]] | [[Global Command: startHapticEffectRamp|startHapticEffectRamp]] | [[Global Command: startHapticRumble|startHapticRumble]] | [[Global Command: stopHapticEffect|stopHapticEffect]] | [[Global Command: stopHapticRumble|stopHapticRumble]]
+
| [[Global Command: createHapticEffectCondition|createHapticEffectCondition]] | [[Global Command: createHapticEffectConstant|createHapticEffectConstant]] | [[Global Command: createHapticEffectLeftRight|createHapticEffectLeftRight]] | [[Global Command: createHapticEffectPeriodic|createHapticEffectPeriodic]] | [[Global Command: createHapticEffectRamp|createHapticEffectRamp]] | [[Global Command: startHapticRumble|startHapticRumble]] | [[Global Command: stopHapticEffect|stopHapticEffect]] | [[Global Command: stopHapticRumble|stopHapticRumble]]
 
|}
 
|}
  

Latest revision as of 11:32, 5 August 2023

Start a previously created haptic effect for devices which support haptic effects.

Related functions createHapticEffectCondition | createHapticEffectConstant | createHapticEffectLeftRight | createHapticEffectPeriodic | createHapticEffectRamp | startHapticRumble | stopHapticEffect | stopHapticRumble


Syntax

startHapticEffect(effectID)


Parameters

Parameter Type Description
effectID int Id of the created effect.


Return values

Type Description
boolean Status


Examples

Example 1: Create a haptic ramp effect and start it.

local effectID = createHapticEffectRamp('ramp', 5000, -1, 0x4000, -0x4000, 1000, -1, 1000, -1, 'cartesian', 1, -1)
startHapticEffect(effectID)