You can use functions from your JavaScript plug-insA set of code created outside of Unity that creates functionality in Unity. There are two kinds of plug-ins you can use in Unity: Managed plug-ins (managed .NET assemblies created with tools like Visual Studio) and Native plug-ins (platform-specific native code libraries). More info
See in Glossary in your Unity C# code. It can be useful to use JavaScript code in Unity because you might need to communicate with other elements on your web page or Web APIs.
To learn about the file types and how to set up a JavaScript plug-in for interaction with Unity scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary, refer to Set up your JavaScript plug-in. To learn how to interact with C/C++/C# plug-ins instead, refer to Call C/C++/C# functions from Unity C# scripts.
Topic | Description |
---|---|
Pass different variables from JavaScript to Unity | Tips on how to pass different variables between Unity and JavaScript. |
Execute build code in its own scope | Tips on how to improve visibility of code between Unity and JavaScript. |
Example Unity C# code that calls JavaScript functions | This example code shows how to call JavaScript functions in Unity. |
Use Unity plug-ins as a reference | Shows a list of plug-ins included with Unity you can use as a reference. |
To integrate JavaScript with Unity, you need efficient communication between the two. Use the following tips on how to pass various types of data from JavaScript to Unity.
You can pass simple numeric types to JavaScript in function parameters without converting them.
For example, this function in JavaScript:
js
AddNumbers: function (x, y) {
return x + y;
},
accepts the integer values from C# without conversions:
int result = AddNumbers(5, 7);
You can pass other data types as a pointer in the Emscripten heap. The Emscripten heap is just a large array in JavaScript memory.
To convert a string to a JavaScript string, use the UTF8ToString
helper function.
var stringMessage = UTF8ToString("Hello World");
To return a string value, call _malloc
to allocate some memory and the stringToUTF8
helper function to write a JavaScript string to the memory. If the string is a return value, then the IL2CPPA Unity-developed scripting back-end which you can use as an alternative to Mono when building projects for some platforms. More info
See in Glossary runtime automatically frees up the memory for you.
var returnStr = "Hello World";
var bufferSize = lengthBytesUTF8(returnStr) + 1;
var buffer = _malloc(bufferSize);
stringToUTF8(returnStr, buffer, bufferSize);
For arrays of primitive types, Emscripten provides different ArrayBufferViews
into its heap for different sizes of integer, unsigned integer or floating point representations of memory: HEAP8
, HEAPU8
, HEAP16
, HEAPU16
, HEAP32
, HEAPU32
, HEAPF32
, HEAPF64
.
The following function loops through the HEAPF32
array and outputs the values at each index.
PrintFloatArray: function (array, size) {
for(var i = 0; i < size; i++)
console.log(HEAPF32[(array >> 2) + i]);
},
To access a texture in WebGLA JavaScript API that renders 2D and 3D graphics in a web browser. The Unity Web build option allows Unity to publish content as JavaScript programs which use HTML5 technologies and the WebGL rendering API to run Unity content in a web browser. More info
See in Glossary, Emscripten provides the GL.textures
array which maps native texture IDs from Unity to WebGL texture objects. You can call WebGL functions on Emscripten’s WebGL context, GLctx
.
For example, the following function binds a WebGL texture from the GL texture array to a 2D texture.
BindWebGLTexture: function (texture) {
GLctx.bindTexture(GLctx.TEXTURE_2D, GL.textures[texture]);
},
It is recommended that you execute all build code in its own scope. If you have your code in its own scope, you can embed your content on a page without causing conflicts with the embedding page code, and you can embed more than one build on the same page.
If you have all your JavaScript code in the form of .jslib
plug-ins inside your project, then this JavaScript code will run inside the same scope as the compiled build and your code should work the same way as in previous versions of Unity. Some of the objects and functions directly visible from the JavaScript plug-in code include:
* Module
* SendMessage
* HEAP8
* ccall
If you want to call the internal JavaScript functions from the global scope of the embedded page, in your Web template index.html
, you must use the unityInstance
variable.
Use unityInstance
after the Unity engine instantiation succeeds, for example:
var MyGameInstance = null;
script.onload = () => {
createUnityInstance(canvas, config, (progress) => { /*...*/ }).then((unityInstance) => {
MyGameInstance = unityInstance;
Then, you can use MyGameInstance.SendMessage()
to send a message to the build, or use MyGameInstance.Module
to access the build module object.
The following JavaScript code creates a function named Hello
. For this example, use this code in your JavaScript plug-in so you can call it in your Unity C# scripts.
mergeInto(LibraryManager.library, {
Hello: function () {
window.alert("Hello, world!");
},
});
Then, use this C# code in your Unity project to call the Hello
function from your JavaScript code:
using UnityEngine;
using System.Runtime.InteropServices;
public class NewBehaviourScript : MonoBehaviour {
[DllImport("__Internal")]
private static extern void Hello();
void Start() {
Hello();
}
}
For a larger code example with varied function types, refer to Code examples: Call JavaScript and C/C++/C# functions in Unity.
There are several plug-ins in the Unity installation folder that you can use as reference:
PlaybackEngines/WebGLSupport/BuildTools/lib
PlaybackEngines/WebGLSupport/BuildTools/Emscripten/src/library*
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.