Add vibration support

Author: JohannesDeml

Assets/Plugins/WebGL/WebBridge/CommonCommands.cs

@@ -393,6 +393,38 @@ public void SetCursor(string cursorName)
 			WebToolPlugins.SetCursor(cursorName);
 		}
 
+		/// <summary>
+		/// Triggers a vibration on devices that support it.
+		/// Browser Usage: <code>unityGame.SendMessage("WebGL", "Vibrate", 200);</code>
+		/// </summary>
+		/// <param name="durationInMs">Duration of the vibration in milliseconds</param>
+		[WebCommand(Description = "Vibrate for a given duration in ms")]
+		public void Vibrate(int durationInMs)
+		{
+			WebToolPlugins.Vibrate(durationInMs);
+		}
+
+		/// <summary>
+		/// Stops any ongoing vibration.
+		/// Browser Usage: <code>unityGame.SendMessage("WebGL", "StopCurrentVibration");</code>
+		/// </summary>
+		[WebCommand(Description = "Stop any ongoing vibration")]
+		public void StopCurrentVibration()
+		{
+			WebToolPlugins.StopCurrentVibration();
+		}
+
+		/// <summary>
+		/// Triggers a vibration SOS pattern (... --- ...) on devices that support it.
+		/// Browser Usage: <code>unityGame.SendMessage("WebGL", "VibrateSosPattern");</code>
+		/// </summary>
+		[WebCommand(Description = "Vibrate SOS pattern (... --- ...)")]
+		[ContextMenu(nameof(VibrateSosPattern))]
+		public void VibrateSosPattern()
+		{
+			WebToolPlugins.Vibrate(new int[] { 100, 30, 100, 30, 100, 30, 200, 30, 200, 30, 200, 30, 100, 30, 100, 30, 100 });
+		}
+
 		/// <summary>
 		/// Captures the current screen and saves it as a PNG file.
 		/// </summary>

Assets/Plugins/WebGL/WebTools/WebToolPlugins.cs

@@ -46,6 +46,10 @@ public static class WebToolPlugins
 		private static extern void _DownloadBlob(string filename, byte[] byteArray, int byteLength, string mimeType);
 		[DllImport("__Internal")]
 		private static extern void _SetCursor(string cursorName);
+		[DllImport("__Internal")]
+		private static extern void _Vibrate(int durationInMs);
+		[DllImport("__Internal")]
+		private static extern void _VibratePattern(int[] durationsInMs, int length);
 
 #endif
 
@@ -330,5 +334,47 @@ public static void SetCursor(string cursorName)
 				Debug.Log($"{nameof(WebToolPlugins)}.{nameof(SetCursor)} called with cursor: {cursorName}");
 			#endif
 		}
+
+		/// <summary>
+		/// Triggers a vibration on devices that support it using the Vibration API.
+		/// <see href="https://developer.mozilla.org/en-US/docs/Web/API/Navigator/vibrate"/>
+		/// </summary>
+		/// <param name="durationInMs">Duration of the vibration in milliseconds</param>
+		public static void Vibrate(int durationInMs)
+		{
+			#if UNITY_WEBGL && !UNITY_EDITOR
+				_Vibrate(durationInMs);
+			#elif UNITY_EDITOR && WEBTOOLS_LOG_CALLS
+				Debug.Log($"{nameof(WebToolPlugins)}.{nameof(Vibrate)} called with duration: {durationInMs}ms");
+			#endif
+		}
+
+		/// <summary>
+		/// Triggers a vibration with 0ms on devices that support it using the Vibration API.
+		/// <see href="https://developer.mozilla.org/en-US/docs/Web/API/Navigator/vibrate"/>
+		/// </summary>
+		public static void StopCurrentVibration()
+		{
+			#if UNITY_WEBGL && !UNITY_EDITOR
+				_Vibrate(0);
+			#elif UNITY_EDITOR && WEBTOOLS_LOG_CALLS
+				Debug.Log($"{nameof(WebToolPlugins)}.{nameof(StopCurrentVibration)} called");
+			#endif
+		}
+
+		/// <summary>
+		/// Triggers a vibration pattern on devices that support it using the Vibration API.
+		/// Alternating values represent vibration and pause durations.
+		/// <see href="https://developer.mozilla.org/en-US/docs/Web/API/Navigator/vibrate"/>
+		/// </summary>
+		/// <param name="durationsInMs">Alternating vibration/pause durations in milliseconds</param>
+		public static void Vibrate(int[] durationsInMs)
+		{
+			#if UNITY_WEBGL && !UNITY_EDITOR
+				_VibratePattern(durationsInMs, durationsInMs.Length);
+			#elif UNITY_EDITOR && WEBTOOLS_LOG_CALLS
+				Debug.Log($"{nameof(WebToolPlugins)}.{nameof(Vibrate)} called with pattern: [{string.Join(", ", durationsInMs)}]ms");
+			#endif
+		}
 	}
 }

Assets/Plugins/WebGL/WebTools/WebToolPlugins.jslib

@@ -169,6 +169,18 @@ var WebGlPlugins =
         if (canvasElement) {
             canvasElement.style.cursor = cursorStr;
         }
+    },
+
+    _Vibrate: function(durationInMs) {
+        navigator.vibrate(durationInMs);
+    },
+
+    _VibratePattern: function(durationsInMs, length) {
+        var pattern = [];
+        for (var i = 0; i < length; i++) {
+            pattern.push(HEAP32[(durationsInMs >> 2) + i]);
+        }
+        navigator.vibrate(pattern);
     }
 };