React Unity WebGL ·

When building content for the web, you might need to communicate with other elements on React Application. Or you might want to implement functionality using Web APIs which Unity does not currently expose by default. In both cases, you need to directly interface with the browser’s JavaScript engine. React Unity WebGL provides an easy library for Unity 5.6 / 2017 or newer with different methods to do this.

See example GIF

Installation
Usage
- Optional attributes
Calling Unity scripts functions from JavaScript in React
Calling JavaScript functions within React from Unity scripts
Notes
Contributing

Installation

Install using npm. Make sure you download the release matching with your Unity version. I try to update this plugin in case of need as fast as possible. Check the releases on GitHub for the corresponding version or view on NPM.

$ npm install react-unity-webgl

Usage

To get started import the default Unity class from react-unity-webgl and include it in your render while giving the public path to your src and loader files. Best practices for adding the src and loader files on a public path.

import React from 'react'
import Unity from 'react-unity-webgl'

export class App extends React.Component {
    render () {
        return <Unity 
            src='Public/Build/myGame.json' 
            loader='Public/Build/UnityLoader.js' />
    }
}

Optional attributes

Width and height

The default width and height is 100%

<Unity ... width='500px' height='350px' />
<Unity ... width='50%' height='50%' />

Tracking progression

The loading progression of the Unity player will be a value between 0 and 1

<Unity ... onProgress={ this.onProgress } />
onProgress (progression) {
    console.log (`Loading ${(progression * 100)} % ...`)
    if (progression === 1) 
        console.log (`Loading done!`)
}

Modules

Overrides the module object

this.myCustomModule = { ... }
<Unity ... module={ this.myCustomModule } />

Calling Unity scripts functions from JavaScript in React

Sometimes you need to send some data or notification to the Unity script from the browser’s JavaScript. The recommended way of doing it is to call methods on GameObjects in your content. To get started import the class UnityEvent from react-unity-webgl.

UnityEvent (objectName: String, methodName: String);

Where objectName is the name of an object in your scene; methodName is the name of a method in the script, currently attached to that object. When you've created a new UnityEvent, you can call the 'emit' function to fire it into Unity. You can pass an optional parameter value.

import React from 'react'
import { UnityEvent } from 'react-unity-webgl'

export class App extends React.Component {
    constructor () {
        this.spawnEnemies = new UnityEvent ('SpawnBehaviour', 'SpawnEnemies')
    }
    onClickSpawnEnemies (count) {
        if (this.spawnEnemies.canEmit () === true)
            this.spawnEnemies.emit (count)
    }
    render () {
        return <div onClick={ this.onClickSpawnEnemies.bind (this, 5) }>
            Click to Spawn 5 Enemies</div>
    }
}

While in Unity the following script is attached the a game object named 'SpawnBehaviour'.

using UnityEngine;

public class SpawnController: MonoBehaviour {
    public void SpawnEnemies (int count) {
        Debug.Log (string.Format ("Spawning {0} enemies", count));
    }
}

Calling JavaScript functions within React from Unity scripts

We also allow you to call JavaScript functions within React from the Unity Content. To get started import the function RegisterExternalListener from react-unity-webgl.

RegisterExternalListener (methodName: String, callback: Function): void;

Where methodName is the name of a method in your JSLib, this method will be binded to the current browser ReactUnityWebGL object so you can refer to it in your JSLib; callback will be a function, which takes one parameter with the value passed by your content. Note that it is recommended to register the callbacks before loading the Unity content. For example:

import React from 'react'
import { RegisterExternalListener } from 'react-unity-webgl'

export class App extends React.Component {
    constructor () {
        RegisterExternalListener ('OpenMenu', this.openMenu.bind (this))
    }
    openMenu (menuId) {
        console.log (`opening menu with id ${menuId$}`)
    }
}

In order to use the function, you have to create a JSLib file to bind the communication. The listener registered in React is now available in the ReactUnityWebGL object in any JSLib file. You can now create a JSLib file and get started. Assets/Plugins/WebGL/MyPlugin.jslib.

mergeInto (LibraryManager.library, {
    OpenMenu: function (menuId) {
        ReactUnityWebGL.OpenMenu (menuId);
    }
});

The OpenMenu function within the JSLib is now available within Unity when you import the __Internal DLL. You can can now make the call. For example:

using UnityEngine;

public class MenuController: MonoBehaviour {
    [DllImport("__Internal")]
    private static extern void OpenMenu (string menuId);
    public void OpenReactMenuById (string menuId) {
        OpenMenu (menuId);
    }

    /* Or use the LEGACY way, this does not require a
        JSLib file and can make a call directly to the
        registered listener by React. But keep in mind
        this functionality is DEPRICATED by Unity. */
    public void LegacyOpenReactMenuById (string menuId) {
        Application.ExternalCall ("OpenMenu", menuId);
    }
}

Notes

Best practices for adding the src and loader files on a public path

Make sure your Unity build is in your public folder, this is due to the component and Unity itself will load files in Runtime and not Compile/Bundle time. The public folder means that the folder should be accesible via a public web adress. The path within your src and loader should be relative to the html file your app is running in.

5.x to 6.x Upgrade note

When upgrading from 5.x to 6.x, make sure you add the loader prop to the Unity component and remove the script tag from your HTML page refering to the UnityLoader.js file. See Usage for further details.

JavaScript to UnityScript types

Simple numeric types can be passed to JavaScript in function parameters without requiring any conversion. Other data types will be passed as a pointer in the emscripten heap (which is really just a big array in JavaScript). For strings, you can use the Pointer_stringify helper function to convert to a JavaScript string. To return a string value you need to call malloc to allocate some memory and the writeStringToMemory helper function to write a JavaScript string to it. If the string is a return value, then the il2cpp runtime will take care of freeing the memory for you. For arrays of primitive types, emscripten provides different ArrayBufferViews into it’s heap for different sizes of integer, unsigned integer or floating point representations of memory: HEAP8, HEAPU8, HEAP16, HEAPU16, HEAP32, HEAPU32, HEAPF32, HEAPF64. To access a texture in WebGL, emscripten provides the GL.textures array which maps native texture IDs from Unity to WebGL texture objects. WebGL functions can be called on emscripten’s WebGL context, GLctx.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Before commiting, please compile your code using npm run compile and open a pull request. Thank you very much!

avatarchik / react-unity-webgl Goto Github PK