它通过集成 QuickJS 将 JavaScript 运行时功能引入 Unity3D。
It brings Javascript runtime capability to Unity3D by integrating QuickJS.
Typescript is the scripting language used in unity-jsb, the definition files (d.ts) of exported C# types could be generated with one-click simplicity.
v8 is experimentally supported as an alternative backend (only on Windows x64 for now) Debugger is supported when using v8 backend.
QuickJS is a small and embeddable Javascript engine. It supports the ES2020 specification including modules, asynchronous generators, proxies and BigInt.
MonoBehaviour (also available on Prefab)EditorWindowCustomEditor (Inspector)ScriptableObjectAssetPostProcessorRoslyn source generator (for Unity2021.3+ only)UIElement supportSupports .NET4.0/dotnetcore3.1/Unity2020.3+ (Windows/macOS/iOS/Android) x86/x64/arm64 Only tested on macOS with Unity2020.3(INTEL)
…import { EditorWindow } from "UnityEditor";
import { GUILayout, GUIContent } from "UnityEngine";
// with @ScriptEditorWindow decorator, the type will be listed in script launchpad window (Menu: JS Bridge -> Script Editor Window Launcher)
@ScriptEditorWindow()
export class MyEditorWindow extends EditorWindow {
Awake() {
console.log("MyEditorWindow.Awake");
}
OnEnable() {
this.titleContent = new GUIContent("Blablabla");
}
OnGUI() {
if (GUILayout.Button("I am Javascript")) {
console.log("Thanks");
}
}
}Script hot-load is supported, you can run the game, edit scripts without stopping playing to see the change affects immediately. The class instance including member variables in scripts (MonoBehaviour/EditorWindow) will be retained, only the type of class itself will be replaced on the fly to the new version.
Supports editor scripting:
Here is an example of EditorWindow totally implemented in typescript. Only imgui is supported for now.
NOTE: In current version, a C# task returning nothing should use
System.Threading.Tasks.Taskas return type explicitly instead ofvoid, thenjsb.Yieldcan understand that it's a async task.
…Vector3 * Vector3 or Vector3 * float is all right, but be caution that there is no value type in Javascript, Vector3 is by-ref in Javascript.
NOTE: Operator overloading is only supported by quickjs.
{
let vec1 = new Vector3(1, 2, 3);
let vec2 = new Vector3(9, 8, 7);
// @ts-ignore
let vec3 = vec1 + vec2;
let vec4 = vec1 + vec2;
console.log(vec3);
console.log(vec3 / 3);
console.log(vec3 == vec4);
}
{
let vec1 = new Vector2(1, 2);
let vec2 = new Vector2(9, 8);
let vec3 = vec1 + vec2;
console.log(vec3);
}// Supports commonjs modules (require)
require("./test");
// commonjs modules cache access
Object.keys(require.cache).forEach(key => console.log(key));let ws = new WebSocket("ws://127.0.0.1:8080/websocket", "default");
console.log("websocket connecting:", ws.url);
ws.onopen = function () {
console.log("[ws.onopen]", ws.readyState);
let count = 0;
setInterval(function () {
ws.send("websocket message test" + count++);
}, 1000);
};
ws.onclose = function () {
console.log("[ws.onclose]", ws.readyState);
};
ws.onerror = function (err) {
console.log("[ws.onerror]", err);
};
ws.onmessage = function (msg) {
console.log("[ws.recv]", msg);
};let xhr = new XMLHttpRequest();
xhr.open("GET", "http://127.0.0.1:8080/windows/checksum.txt");
xhr.timeout = 1000;
xhr.onreadystatechange = function () {
console.log("readyState:", xhr.readyState);
if (xhr.readyState !== 4) {
return;
}
console.log("status:", xhr.status);
if (xhr.status == 200) {
console.log("responseText:", xhr.responseText);
}
}
xhr.send();This feature is UNFINISHED, all C# types are not exported into Worker runtime at present.
/// master.js
let worker = new Worker("worker");
worker.onmessage = function (data) {
console.log("master receive message from worker", data);
}
// setTimeout(function () { worker.terminate(); }, 5000);
/// worker.js
setInterval(function () {
postMessage("message form worker");
}, 3000)
onmessage = function (data) {
console.log("worker get message from master:", data);
}
You can replace a tagged C# member method by a script function at runtime. This feature is UNFINISHED.
…You could add jsb as a UPM package with this URL: https://github.com/ialex32x/unity-jsb.git#upm.
! Samples are not included in UPM package.
You could clone this repository as a complete sample project.
git clone https://github.com/ialex32x/unity-jsb --depth=1npm install
tsc
# or compile and watch
# tsc --watch Open project with Unity3D, run menu command JS Bridge/Generate Type Definition
NOTE: The split size of the generated d.ts file is configurable in
PrefsEditor(or directly editjs-bridge.json).
Open Assets/Examples/Scenes/SampleScene.unity and select specific example you want to check.
If you use node_modules in your scripts, you need to package them via webpack/gulp when the game actually runs on target platform.
Open this project directory in VSCode, select dotnetcore example in Run And Debug panel, then just run it.
export interface TestData {
name: string,
tick: number;
}
@ScriptType()
export class MyWidgetTest extends JSXWidgetBridge {
private _data: TestData;
private _timer: any;
get data() { return this._data; }
Awake() {
this._data = ViewModel.create({ name: "Unity", tick: 0 });
this._widget =
this._timer = setInterval(() => {
this._data.tick++;
}, 1000);
this._data.tick++;
}
OnDestroy() {
super.OnDestroy();
clearInterval(this._timer);
}
}Multi-threading is not supported in a single runtime. You need to use worker.
Remote debugging is now available with Chrome DevTools.
NOTE: It's still in experimental stage.
暂无开放 Issues,或尚未同步最近议题。