WebGL:与浏览器脚本进行交互
在为网络构建内容时,您可能需要与网页上的其他元素进行通信。或者您可能希望使用Unity默认现在不公开的Web API实现功能。在这两种情况下,您都需要直接与浏览器的JavaScript引擎进行交互。 Unity WebGL提供了不同的方法来执行此操作。
Calling JavaScript functions from Unity scripts 从Unity脚本调用JavaScript函数
在项目中使用浏览器JavaScript的推荐方法是将JavaScript源添加到项目中,然后直接从脚本代码中调用这些函数。为此,请在Assets文件夹中的“Plugins”子文件夹下使用.jslib扩展名(如UnityScript编译器的常规.js文件)将JavaScript代码放置到文件中。插件文件需要这样的语法:
mergeInto(LibraryManager.library, {
Hello: function () {
window.alert("Hello, world!");
},
HelloString: function (str) {
window.alert(Pointer_stringify(str));
},
PrintFloatArray: function (array, size) {
for(var i = 0; i < size; i++)
console.log(HEAPF32[(array >> 2) + i]);
},
AddNumbers: function (x, y) {
return x + y;
},
StringReturnValueFunction: function () {
var returnStr = "bla";
var bufferSize = lengthBytesUTF8(returnStr) + 1;
var buffer = _malloc(bufferSize);
stringToUTF8(returnStr, buffer, bufferSize);
return buffer;
},
BindWebGLTexture: function (texture) {
GLctx.bindTexture(GLctx.TEXTURE_2D, GL.textures[texture]);
},
});
然后你可以从你的C#脚本中调用这些函数,如下所示:
using UnityEngine;
using System.Runtime.InteropServices;
public class NewBehaviourScript : MonoBehaviour {
[DllImport("__Internal")]
private static extern void Hello();
[DllImport("__Internal")]
private static extern void HelloString(string str);
[DllImport("__Internal")]
private static extern void PrintFloatArray(float[] array, int size);
[DllImport("__Internal")]
private static extern int AddNumbers(int x, int y);
[DllImport("__Internal")]
private static extern string StringReturnValueFunction();
[DllImport("__Internal")]
private static extern void BindWebGLTexture(int texture);
void Start() {
Hello();
HelloString("This is a string.");
float[] myArray = new float[10];
PrintFloatArray(myArray, myArray.Length);
int result = AddNumbers(5, 7);
Debug.Log(result);
Debug.Log(StringReturnValueFunction());
var texture = new Texture2D(0, 0, TextureFormat.ARGB32, false);
BindWebGLTexture(texture.GetNativeTextureID());
}
}
简单的数字类型可以通过函数参数传递给JavaScript,而不需要任何转换。其他数据类型将作为emscripten堆中的指针传递(这实际上只是JavaScript中的一个大数组)。对于字符串,您可以使用Pointer_stringify
帮助函数转换为JavaScript字符串。为了返回一个字符串值,你需要调用_malloc
来分配一些内存和stringToUTF8
辅助函数来为它写一个JavaScript字符串。如果字符串是一个返回值,那么il2cpp运行时将负责为您释放内存。对于基本类型的数组,emscripten
将不同大小的整数,无符号整数或浮点内存表示形式的堆栈提供给它的堆堆:HEAP8,HEAPU8,HEAP16,HEAPU16,HEAP32,HEAPU32,HEAPF32,HEAPF64。要访问WebGL中的纹理,emscripten提供了GL.textures
数组,它将Unity中的原生纹理ID映射到WebGL纹理对象。可以在emscripten的WebGL上下文GLctx
上调用WebGL函数。
Legacy ways of calling JavaScript code from Unity 从Unity调用JavaScript代码的传统方式
注意:
从Unity 5.6开始,从Unity调用JavaScript代码的推荐方式是通过.jslib插件。下面描述的方法仅出于兼容性原因而被支持,并且可能在Unity的未来版本中被弃用。
您可以使用Application.ExternalCall()和Application.ExternalEval()函数来调用嵌入网页上的JavaScript代码。请注意,表达式在构建的本地范围内进行评估。如果您想在全局范围内执行JavaScript代码,请参阅下面的代码Code Visibility(可见性)部分。
Calling Unity scripts functions from JavaScript 从JavaScript调用Unity脚本函数
有时您需要从浏览器的JavaScript中向Unity脚本发送一些数据或通知。推荐的方法是在你的内容中调用GameObjects上的方法。如果您正在使用嵌入到项目中的JavaScript插件进行调用,则可以使用以下代码:
SendMessage(objectName, methodName, value);
其中objectName
是场景中对象的名称; methodName
是脚本中当前附加到该对象的方法的名称;值可以是字符串,value
,也可以是空的。例如:
SendMessage('MyGameObject', 'MyFunction');
SendMessage('MyGameObject', 'MyFunction', 5);
SendMessage('MyGameObject', 'MyFunction', 'MyString');
如果您想从嵌入页面的全局范围拨打电话,请参阅下面的代码可见性部分。
Calling C++ functions from Unity scripts 从Unity脚本调用C++函数
由于Unity使用emscripten将C++源代码编译为JavaScript,您还可以使用C或C++代码编写插件,并从C#中调用这些函数。因此,与上例中的jslib文件不同,您可以在项目中使用如下所示的c文件 - 它将自动使用脚本进行编译,并且可以从中调用函数,就像上面的JavaScript示例中一样。
如果您使用C++(.cpp)实现插件,那么您必须确保使用C链接声明函数以避免名称修改问题。
#include <stdio.h>
void Hello ()
{
printf("Hello, world!\n");
}
int AddNumbers (int x, int y)
{
return x + y;
}
Code visibility 代码可见性
从Unity 5.6开始,所有构建代码都在其自己的范围内执行。这种方法可以将游戏嵌入到任意页面中,而不会与嵌入页面代码发生冲突,并且可以在同一页面上嵌入多个构建。
如果您的项目中包含.jslib插件形式的所有JavaScript代码,那么此JavaScript代码将与编译的内部版本在相同的范围内运行,并且您的代码的工作方式应与以前版本的Unity中的方式几乎相同(适用于例如,以下对象和函数应该直接从JavaScript插件代码中可见:Module,SendMessage,HEAP8,ccall等)。
但是,如果打算从嵌入页面的全局范围调用内部JavaScript函数,则应始终假定页面上嵌入了多个构建版本,因此应明确指定要引用的构建版本。例如,如果你的游戏已经被实例化为:
var gameInstance = UnityLoader.instantiate("gameContainer", "Build/build.json", {onProgress: UnityProgress});
然后,您可以使用gameInstance.SendMessage()
向构建发送消息,或访问构建模块对象,如gameInstance.Module
。
Unity WebGL 中文文档 Unity 2018.1.b
1. WebGL
2. webGL Browser Compatibility
3. Building and running a WebGL project
4. WebGL: Deploying compressed builds
5. Debugging and trouble shooting WebGL builds
6. WebGL Graphics
7. WebGL Networking
8. Using Audio In WebGL
9. WebGL performance considerations
10. WebGL: Interacting with browser scripting
11. Using WebGL Templates
12. Cursor locking and full-screen mode in WebGL
13. Input in WebGL