브라우저 스크립팅과 상호작용

웹용 콘텐츠를 빌드할 때 웹페이지의 다른 요소와 커뮤니케이션해야 할 수 있습니다.또는 Unity가 현재 기본적으로 노출하지 않는 웹 API를 사용하여 기능을 구현하고 싶을 수 있습니다.두 가지 경우 모두 브라우저의 JavaScript 엔진과 직접 상호작용해야 합니다.Unity WebGL은 이렇게 할 수 있는 여러 방법을 제공합니다.

Unity 스트립트에서 JavaScript 함수 호출

브라우저 JavaScript를 프로젝트에 사용하려면 JavaScript 소스를 프로젝트에 추가한 다음 해당 함수를 스크립트 코드에서 직접 호출하는 방법이 권장됩니다. 이렇게 하려면 JavaScript 코드를 통해 .jslib 확장자를 사용하여 파일을 Assets 폴더의 “Plugins” 하위폴더에 저장해야 합니다. 플러그인 파일에는 다음과 같은 구문이 있어야 합니다.

mergeInto(LibraryManager.library, {

  Hello: function () {
    window.alert("Hello, world!");
  },

  HelloString: function (str) {
    window.alert(UTF8ToString(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.GetNativeTexturePtr());
    }
}

• 단순 숫자 타입은 전환하지 않고도 함수 파라미터의 JavaScript에 전달할 수 있습니다.다른 데이터 타입은 JavaScript에 있는 큰 배열일 뿐인 emscripten 힙에서 포인터로서 전달할 수 있습니다.
• 문자열의 UTF8ToString 헬퍼 함수를 사용하여 JavaScript 문자열로 전환할 수 있습니다.
• 문자열 값을 반환하려면 _malloc를 호출하여 일부 메모리를 할당하고 stringToUTF8 헬퍼 함수를 호출하여 JavaScript 문자열을 작성해야 합니다.문자열이 반환 값인 경우 IL2CPP 런타임이 가용 메모리를 늘리는 작업을 자동으로 처리합니다.
• 프리미티브 타입 배열의 경우 emscripten은 다음과 같은 여러 정수 크기, 서명되지 않은 정수 또는 부동 소수점 메모리 표현에 대해 각기 다른 ArrayBufferViews를 힙에 제공합니다.HEAP8, HEAPU8, HEAP16, HEAPU16, HEAP32, HEAPU32, HEAPF32, HEAPF64
• WebGL에서 텍스처에 액세스하기 위해 emscripten은 Unity의 기본 텍스처 ID를 WebGL 텍스처 오브젝트에 매핑하는 GL.textures 배열을 제공합니다.WebGL 함수는 emscripten의 WebGL 컨텍스트인 GLctx에서 호출할 수 있습니다.

JavaScript와 인터랙션하는 방법에 대한 자세한 내용은 emscripten 문서를 참조하십시오.

또한 Unity 설치 폴더에는 PlaybackEngines/WebGLSupport/BuildTools/lib 및 PlaybackEngines/WebGLSupport/BuildTools/Emscripten/src/library*에서 레퍼런스로 사용할 수 있는 여러 개의 플러그인이 있습니다.

코드 가시성

권장하는 접근 방식은 모든 빌드 코드를 자체 범위에서 실행하는 것입니다.이렇게 하면 내장한 페이지 코드와 충돌을 일으키지 않고도 임의 페이지에 콘텐츠를 내장할 수 있으며, 동일한 페이지에 두 개 이상의 빌드를 내장할 수 있습니다.

모든 JavaScript 코드가 .jslib 플러그인 형태로 프로젝트 안에 있는 경우 이 JavaScript 코드는 컴파일된 빌드와 같은 스코프 안에서 실행되고, 코드는 이전 Unity 버전과 동일한 방법으로 작동합니다. 예를 들어 Module, SendMessage, HEAP8, ccall 등과 같은 오브젝트와 함수는 JavaScript 플러그인 코드에서 직접 볼 수 있습니다.

하지만 임베딩 페이지의 전역 범위에서 내부 JavaScript 함수를 호출하려는 경우 WebGL 템플릿 index.html에서 unityInstance 변수를 사용해야 합니다. Unity 엔진 인스턴스화가 성공한 후 이 작업을 수행하십시오. 예를 들면 다음과 같습니다.

  var myGameInstance = null;
    script.onload = () => {
      createUnityInstance(canvas, config, (progress) => {...}).then((unityInstance) => {
        myGameInstance = unityInstance;
        …

그러면 myGameInstance.SendMessage()를 사용하여 메시지를 빌드로 전송하거나 myGameInstance.Module을 사용하여 빌드 모듈 오브젝트에 액세스할 수 있습니다.

JavaScript에서 Unity 스크립트 함수 호출

데이터나 알림을 브라우저의 JavaScript에서 Unity 스크립트로 전송해야 하는 경우가 있습니다.이 작업에는 콘텐츠의 게임 오브젝트에서 메서드를 호출하는 방법을 권장합니다.프로젝트에 내장된 JavaScript 플러그인에서 호출하는 경우 다음 코드를 사용할 수 있습니다.

MyGameInstance.SendMessage(objectName, methodName, value);

여기에서 objectName 은 씬에 있는 오브젝트의 이름이고, methodName 은 해당 오브젝트에 현재 연결된 스크립트에 있는 메서드의 이름이고, value 는 문자열 또는 숫자이거나 비어 있을 수 있습니다. 예:

MyGameInstance.SendMessage('MyGameObject', 'MyFunction');
MyGameInstance.SendMessage('MyGameObject', 'MyFunction', 5);

MyGameInstance.SendMessage('MyGameObject', 'MyFunction', 'MyString');

임베딩 페이지의 전역 스코프에서 호출하려면 아래의 코드 가시성 섹션을 참조하십시오.

Unity 스트립트에서 C 함수 호출

Unity 에디터는 emscripten을 사용하여 C/C++ 코드에서 JavaScript로 소스를 컴파일하기 때문에 C/C++ 코드로 플러그인을 작성하고 C#에서 함수를 호출할 수 있습니다. 따라서 위 예의 jslib 파일 대신 C/C++ 파일이 프로젝트에 포함될 수 있습니다. 이 파일은 자동으로 스크립트로 컴파일되고 위의 JavaScript 예처럼 이 파일에서 함수를 호출할 수 있습니다.

C++(.cpp)로 플러그인을 구현하는 경우 이름 맹글링 문제를 방지하기 위해 함수가 C 링크로 선언되도록 해야 합니다.

# include <stdio.h>

extern "C" void Hello ()
{
    printf("Hello, world!\n");
}

extern "C" int AddNumbers (int x, int y)
{
    return x + y;
}

참고:Unity는 Emscripten 버전 2.0.19 툴체인을 사용하고 있습니다.

---

• 2021.2 이상에서 Pointer__stringify()를 UTF8ToString으로 교체함

• 2020.1에서 unity.Instance가 createUnityInstance로 대체됨

• 코드 예제에서 오류 수정

• 2019.1에서 WebGL 인스턴스의 이름이 gameInstance에서 unityInstance로 변경됨