diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2024-06-12 18:16:56 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2024-06-12 18:16:56 +0200 |
| commit | 7ec0bc554ffb5dfc4be3b7618752e8fdc01eaed1 (patch) | |
| tree | 5b8b43a4c0264098ebf6abaaaa50b9ca3fd1fafc | |
| parent | 2fb296a5cd83bfa7a234cfcaae78a63da3556fb8 (diff) | |
| parent | 2ab9344b3b9af7f2bfd598a49e59d433b6128f44 (diff) | |
| download | redot-engine-7ec0bc554ffb5dfc4be3b7618752e8fdc01eaed1.tar.gz | |
Merge pull request #92860 from timothyqiu/amplitude
Fix description for `Input.vibrate_handheld()`
| -rw-r--r-- | doc/classes/Input.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 642bb76e75..1e7b63ecce 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -399,8 +399,8 @@ <param index="0" name="duration_ms" type="int" default="500" /> <param index="1" name="amplitude" type="float" default="-1.0" /> <description> - [b]Note:[/b] While [code skip-lint]amplitude[/code] expects a value between 0 and 1, -1 does the default amplitude for the device. Vibrate the handheld device for the specified duration in milliseconds. + [param amplitude] is the strength of the vibration, as a value between [code]0.0[/code] and [code]1.0[/code]. If set to [code]-1.0[/code], the default vibration strength of the device is used. [b]Note:[/b] This method is implemented on Android, iOS, and Web. It has no effect on other platforms. [b]Note:[/b] For Android, [method vibrate_handheld] requires enabling the [code]VIBRATE[/code] permission in the export preset. Otherwise, [method vibrate_handheld] will have no effect. [b]Note:[/b] For iOS, specifying the duration is only supported in iOS 13 and later. |