godotengine / godotengine/godot-docs

Innacurate description of haptic feedback

Open
#7,237 0 comments 0 reactions 0 assignees View on GitHub
area:manual enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version: 4.0.2**

**Issue description: The documentation states, `Vibration (also called haptic feedback) can be used to enhance the feel of a game`, which is misleading.**

Indeed, you obtain `haptic feedback` from `vibration` only with the correct configuration. However, there are not the same, and _Godot_ doesn't yet provide `constants` or `methods` to transform `vibrations` in `haptic feedbacks`.

The documentation should provide a _good enough_ set of variables.

`Vibration` should alert the user, whereas `Haptic feedback` respond to user inputs (they provide *feedback*). The difference is subtle, but we can all *feel* it (thanks to the thousands of apps using them). Unfortunately, the method [`Input.vibrate_handheld`](https://docs.godotengine.org/en/stable/classes/class_input.html#class-input-method-vibrate-handheld) won't give you the `haptic feedback` you want.

For example, `duration_ms = 4` is a good enough variable to simulate [`UIImpactFeedbackStyleLight`](https://developer.apple.com/documentation/uikit/uiimpactfeedbackstyle/uiimpactfeedbackstylelight?language=objc).

I don't know the exact parameters used internally by Apple and Android to send `light`, `medium`, and `strong` haptic feedback. A table of correspondence for each platform will help developers to give a more _native_ feeling to their app.

*Note: `duration_ms = 4` doesn't give a perfect `light haptic feedback` as you can still feel the device vibrating.*

**URL to the documentation page (if already existing): https://docs.godotengine.org/en/stable/tutorials/inputs/controllers_gamepads_joysticks.html#vibration**

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Vibration section of controllers_gamepads_joysticks.html and the Input.vibrate_handheld documentation linked in the issue. Verify the distinction between vibration and haptic feedback, then determine whether platform-specific correspondence can be documented accurately; done means the page explains the distinction without misleading developers.

Written by the indexing model from the issue text.

Assessment

Tech stack
godot
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.