Merge pull request #194 from jeffreylanters/feature/rewrite-for-react-hooks-support

Updated documentation with Hooks and implemented remove event listener method

Author: jeffreylanters

README.md

@@ -1,6 +1,6 @@
 {
   "name": "react-unity-webgl",
-  "version": "8.3.9",
+  "version": "8.4.0",
   "description": "React Unity WebGL provides an easy solution for embedding Unity WebGL builds in your React application, with two-way communication between your React and Unity application with advanced API's.",
   "keywords": [
     "React",

package-lock.json

@@ -1,11 +1,10 @@
-import "../declarations/unity-instance";
-import "../declarations/global";
 import { createElement, PureComponent } from "react";
 import IUnityProps from "../interfaces/unity-props";
 import UnityContext from "../models/unity-context";
 import UnityLoaderService from "../services/unity-loader-service";
 import IUnityInstanceParameters from "../interfaces/unity-instance-parameters";
 
+// TODO turn into functional component
 export default class Unity extends PureComponent<IUnityProps, {}> {
   /**
    * The UnityContext passed by the props.
@@ -92,7 +91,8 @@ export default class Unity extends PureComponent<IUnityProps, {}> {
       if (this.props.devicePixelRatio !== undefined)
         _unityInstanceParameters.devicePixelRatio = this.props.devicePixelRatio;
       if (this.props.matchWebGLToCanvasSize !== undefined)
-        _unityInstanceParameters.matchWebGLToCanvasSize = this.props.matchWebGLToCanvasSize;
+        _unityInstanceParameters.matchWebGLToCanvasSize =
+          this.props.matchWebGLToCanvasSize;
       const _unityInstance = await createUnityInstance(
         this.htmlCanvasElementReference!,
         _unityInstanceParameters,

package.json

@@ -1,8 +1,8 @@
-import "../declarations/global";
 import IUnityConfig from "../interfaces/unity-config";
 import IUnityEvent from "../interfaces/unity-event";
 import IUnityContextEventMap from "../interfaces/unity-context-event-map";
 
+// TODO remove from dir
 /**
  * The Unity Context.
  */
@@ -78,9 +78,8 @@ export default class UnityContext {
    * system events like when the player is initialized or loader and
    * your custom events from Unity.
    * @public
-   * @param {string} eventName the event name
-   * @param {Function} eventListener the event function
-   * @returns {any} The Function
+   * @param {string} eventName the event's name
+   * @param {Function} eventListener the event's function
    */
   public on<MapKey extends keyof IUnityContextEventMap | (string & {})>(
     eventName: keyof IUnityContextEventMap | (MapKey & {}),
@@ -96,11 +95,38 @@ export default class UnityContext {
         eventListener(...parameters);
   }
 
+  /**
+   * Removes all the Event Listeners with a specific Event Name.
+   * @public
+   * @param {string} eventName the event's name
+   * @example unityContext.removeEventListener("progress");
+   */
+  public removeEventListener(eventName: string): void {
+    // TODO refactor to "off"?
+    for (let _i = 0; _i < this.unityEvents.length; _i++)
+      if (this.unityEvents[_i].eventName === eventName)
+        this.unityEvents.splice(_i, 1);
+    delete window.ReactUnityWebGL[eventName];
+  }
+
+  /**
+   * Removes all the Event Listeners.
+   * @public
+   * @example unityContext.removeAllEventListeners();
+   */
+  public removeAllEventListeners(): void {
+    // TODO refactor to "off"?
+    for (let _i = 0; _i < this.unityEvents.length; _i++)
+      delete window.ReactUnityWebGL[this.unityEvents[_i].eventName];
+    this.unityEvents = [];
+  }
+
   /**
    * Dispatches an event listener that has been registered using the on method.
    * @public
-   * @param {string} eventName the event name
-   * @param {any} eventValue the event value
+   * @param {string} eventName the event's name
+   * @param {any} eventValue the event's value
+   * @example unityContext.dispatchEventListener("gameOver", 180);
    */
   public dispatchEventListener(eventName: string, eventValue?: any): void {
     for (let _unityEvent of this.unityEvents)
@@ -109,7 +135,7 @@ export default class UnityContext {
   }
 
   /**
-   * Enables or disabled the fullscreen mode of the UnityInstance.
+   * Enables or disabled the Fullscreen mode of the Unity Instance.
    * @public
    * @param {boolean} enabled
    */

source/components/unity.ts

@@ -1,3 +1,4 @@
+// TODO turn into hook
 export default class UnityLoaderService {
   /**
    * A reference to all UnityLoader script tags and their respective urls.

source/models/unity-context.ts

@@ -1,13 +1,15 @@
-import IUnityInstanceParameters from "../interfaces/unity-instance-parameters";
+import IUnityInstanceParameters from "../source/interfaces/unity-instance-parameters";
 
 /**
  * Type declaration for global types.
  */
 declare global {
   /**
-   * Type declaration for the ReactUnityWebGL object.
+   * Type declaration for the ReactUnityWebGL Object.
    */
-  var ReactUnityWebGL: { [eventName: string]: Function };
+  var ReactUnityWebGL: {
+    [eventName: string]: Function;
+  };
 
   /**
    * Creates a new UnityInstance.