From 2ab9344b3b9af7f2bfd598a49e59d433b6128f44 Mon Sep 17 00:00:00 2001 From: Haoyu Qiu Date: Fri, 7 Jun 2024 15:57:00 +0800 Subject: [PATCH] Fix description for `Input.vibrate_handheld()` --- doc/classes/Input.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 642bb76e75b..1e7b63eccea 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -399,8 +399,8 @@ - [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.