Add a WebGL bridge gameobject that makes it easy to access unity functionality through the browser console

Author: JohannesDeml

Assets/Plugins/WebGL/WebGlBridge.cs

@@ -0,0 +1,96 @@
+// --------------------------------------------------------------------------------------------------------------------
+// <copyright file="WebGlBridge.cs">
+//   Copyright (c) 2021 Johannes Deml. All rights reserved.
+// </copyright>
+// <author>
+//   Johannes Deml
+//   public@deml.io
+// </author>
+// --------------------------------------------------------------------------------------------------------------------
+
+using System;
+using UnityEngine;
+
+namespace Supyrb
+{
+	/// <summary>
+	/// Bridge to Unity to access unity logic through the browser console
+	/// </summary>
+	public class WebGlBridge : MonoBehaviour
+	{
+		[RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
+		private static void OnBeforeSceneLoadRuntimeMethod()
+		{
+			var bridgeInstance = new GameObject("WebGL");
+			DontDestroyOnLoad(bridgeInstance);
+			bridgeInstance.AddComponent<WebGlBridge>();
+		}
+
+		private void Start()
+		{
+			Debug.Log("Unity WebGL Bridge ready -> Run 'unityGame.SendMessage(\"WebGL\", \"Help\")' in the browser console to see usage");
+		}
+
+		public void Help()
+		{
+			Debug.Log("Available unity interfaces:\n" +
+			          "- LogMemory() -> logs current memory\n" +
+			          "- SetApplicationRunInBackground(int runInBackground) -> Application.runInBackground\n" +
+			          "- SetApplicationTargetFrameRate(int targetFrameRate) -> Application.targetFrameRate\n" +
+			          "- SetTimeFixedDeltaTime(float fixedDeltaTime) -> Time.fixedDeltaTime\n" +
+			          "- SetTimeTimeScale(float timeScale) -> Time.timeScale\n" +
+			          "\nRun a command through 'unityGame.SendMessage(\"WebGL\", \"COMMAND_NAME\",PARAMETER)'");
+		}
+		
+		/// <summary>
+		/// Logs the current memory usage
+		/// Browser Usage: <code>unityGame.SendMessage("WebGL","LogMemory");</code>
+		/// </summary>
+		public void LogMemory()
+		{
+			WebGlPlugins.LogMemory();
+		}
+		
+		/// <summary>
+		/// Sets if the application should run while not focused.
+		/// It is in background while another tab is focused or the console is focused
+		/// Browser Usage: <code>unityGame.SendMessage("WebGL", "SetApplicationRunInBackground", 1);</code>
+		/// </summary>
+		/// <param name="runInBackground">1 if it should run in background</param>
+		public void SetApplicationRunInBackground(int runInBackground)
+		{
+			Application.runInBackground = runInBackground == 1;
+		}
+		
+		/// <summary>
+		/// Sets the rendering frame rate, see <see cref="Application.targetFrameRate"/>
+		/// Browser Usage: <code>unityGame.SendMessage("WebGL", "SetApplicationTargetFrameRate", 15);</code>
+		/// </summary>
+		/// <param name="targetFrameRate">frame rate to render in</param>
+		public void SetApplicationTargetFrameRate(int targetFrameRate)
+		{
+			Application.targetFrameRate = targetFrameRate;
+		}
+		
+		/// <summary>
+		/// Sets the interval for fixed time updates, see <see cref="Time.fixedDeltaTime"/>
+		/// Browser Usage: <code>unityGame.SendMessage("WebGL", "SetTimeFixedDeltaTime", 0.02);</code>
+		/// </summary>
+		/// <param name="fixedDeltaTime"></param>
+		public void SetTimeFixedDeltaTime(float fixedDeltaTime)
+		{
+			Time.fixedDeltaTime = fixedDeltaTime;
+		}
+		
+		/// <summary>
+		/// Sets the global timeScale, see <see cref="Time.timeScale"/>
+		/// Somehow the timescale also affects the physics refresh rate on WebGL
+		/// Browser Usage: <code>unityGame.SendMessage("WebGL", "SetTimeTimeScale", 0.2);</code>
+		/// </summary>
+		/// <param name="timeScale">new timescale value</param>
+		public void SetTimeTimeScale(float timeScale)
+		{
+			Time.timeScale = timeScale;
+		}
+	}
+}

Assets/Plugins/WebGL/WebGlBridge.cs.meta

@@ -89,12 +89,14 @@
     var loadingBar = document.querySelector("#unity-loading-bar");
     var progressBar = document.querySelector("#unity-progress-bar");
 
+    var unityGame; // This can be used to access the application with .SendMessage() commands
     var script = document.createElement("script");
     script.src = loaderUrl;
     script.onload = function() {
       createUnityInstance(canvas, config, function(progress) {
         progressBar.style.width = 100 * progress + "%";
       }).then(function(unityInstance) {
+        unityGame = unityInstance;
         loadingBar.style.display = "none";
       }).catch(function(message) {
         alert(message);