ドキュメント

Unity Engine

Unity Engine

マネージプラグイン

マネージプラグインの使用に関する詳細。
読み終わるまでの所要時間 14 分最終更新 5日前

マネージプラグインは、Unity の外部で作成およびコンパイルし、Visual Studio などのツールでダイナミックリンクライブラリ (DLL) にする .NET アセンブリです。
これは、Unity が Unity プロジェクトの Assets フォルダーにソースファイルとして保存する標準の C# スクリプトとは異なるプロセスです。Unityは、標準のC#スクリプトが変更されるたびにコンパイルしますが、DLLは事前コンパイルされ、変更されません。標準のスクリプトと同じ方法で、コンパイルされた .dll ファイルをプロジェクトに追加し、そこに含まれるクラスを GameObjects にアタッチ、設定、添付できます。
C# のマネージコードの詳細については、Microsoft のドキュメント「What is マネージコード?」を参照してください。
マネージプラグインには .NET コードのみが含まれているため、.NET ライブラリがサポートしない機能にアクセスすることはできません。ただし、マネージコードは、Unity がスクリプトのコンパイルに使用する標準の .NET ツールにアクセスできます。
Unity で DLL を使用する場合、スクリプトを使用する場合よりも多くの手順を実行する必要があります。ただし、代わりに .dll ファイルを作成して Unity プロジェクトに追加すると便利な場合があります。例えば、
  • Unity がサポートしないコンパイラをコードで使用する。
  • サードパーティの .NET コードを .dll ファイルに追加する。
  • ソースなしで Unity にコードを提供する。
このページでは、マネージプラグインの作成に使用できる一般的なメソッドと、Visual Studio を使用してマネージプラグインを作成し、デバッグセッションを設定する方法について説明します。

マネージプラグインの作成

マネージプラグインを作成するには、DLL を作成する必要があります。これを行うには、次のような適切なコンパイラーが必要です。
.NET コードを生成するすべてのコンパイラーが Unity と互換性のあるわけではないため、コンパイラーで重要な作業を行う前に、使用可能なコードでコンパイラーをテストする必要があります。Unityが現在サポートしている.NETプロファイルについては、.NETプロファイル サポートを参照してください。
DLL の作成に使用するメソッドは、DLL に Unity API コードが含まれているかどうかによって異なります。
  • DLL に Unity API コードが含まれている場合は、コンパイル前に Unity 独自の DLL をコンパイラーで使用可能にする必要があります。
    1. Unity DLL を検索するには、以下を行います。
      • Windows では、
        C:\Program Files\Unity\Hub\Editor\<version-number>\Editor\Data\Managed
        に移動します。
      • macOS の場合:
        1. コンピュータで
          Unity.app
          ファイルを探します。macOS での Unity DLL へのパスは次のとおりです。
          /Applications/Unity/Hub/Editor/<version-number>/Unity.app/Contents/Managed
        2. Unity.app
          を右クリックします。
        3. Show Package Contents (パッケージ内容の表示) を選択します。
    2. Managed
      フォルダーには、すべてのエディターコードとエンジンコードの
      UnityEditor.dll
      と
      UnityEngine.dll
      ファサードアセンブリがそれぞれ格納されます。リファレンスを使用して、スクリプトで Editor または Engine API を使用できるようにします。個々のモジュールアセンブリはサポートされていないため、直接リファレンスを試みないでください。名前空間によっては、Unity プロジェクトからのコンパイル済みライブラリ (例えば、
      UnityEngine.UI
      ) へのリファレンスも必要です。プロジェクトフォルダーのディレクトリ
      ~\Library\ScriptAssemblies
  • DLL に Unity API コードが含まれていない場合、または Unity DLL をすでに使用可能にしている場合は、コンパイラーのドキュメントに従って .dll ファイルをコンパイルします。DLL のコンパイルに使用する正確なオプションは、使用するコンパイラーによって異なります。たとえば、Roslyn コンパイラー
    csc
    のコマンドラインの外観は、macOS では以下のようになります。
csc /r:/Applications/Unity/Hub/Editor/<version-number>/Unity.app/Contents/Managed/UnityEngine.dll /target:library /out:MyManagedAssembly.dll /recurse:*.cs
この例では、
  • /r
    オプションを使用して、ビルドに含めるライブラリ (この場合は
    UnityEngine
    ライブラリ) へのパスを指定します。
  • /target
    オプションを使用して、必要なビルドのタイプを指定します。
    library
    は DLL ビルドを示します。
  • /out
    を使用してライブラリの名前を指定します。ここでは
    MyManagedAssembly.dll
    です。
  • 含めるソースファイルの名前を追加します。
    /recurse
    メソッドを使用して、現在の作業ディレクトリと任意のサブフォルダに
    .cs
    で終わるすべてのファイルを追加します。結果の .dll ファイルは、ソースファイルと同じフォルダーに表示されます。

マネージプラグインの使用

DLL をコンパイルしたら、他のアセットと同様に .dll ファイルを Unity プロジェクトにドラッグできます。その後、以下を実行できます。
  • マネージプラグインを展開し、ライブラリ内の別のクラスを表示します。
  • MonoBehaviour から派生したクラスをゲームオブジェクトにドラッグします。
  • 他のスクリプトから直接 MonoBehaviour 以外のクラスを使用します。

An expanded DLL with the classes visible

Visual Studio での DLL の作成

このセクションでは、以下について説明します。
  • 簡単な DLL サンプルをビルドして Visual Studio と統合する方法
  • Unity で DLL のデバッグセッションを準備する方法。

プロジェクトの設定

  1. Visual Studio を開き、新しいプロジェクトを作成します。
  2. 「ファイル」>「新規」>「プロジェクト」>「Visual C#」>「.Net Standard」>「クラスライブラリ (.NET Standard)」を選択します。
  3. 以下の情報を新しいライブラリに追加します。
    • Name (名前): 名前空間(この例では、
      DLLTest
      を名前として使用します)。
    • 場所: プロジェクトの親フォルダー。
    • ソリューション名:プロジェクトのフォルダー。
  4. スクリプトで Unity DLL を使用できるようにします。Visual Studio で、ソリューションエクスプローラーの References (参照) のコンテキストメニューを開き、**Add Reference (**リファレンスの追加)> Browse (参照)> Select File (ファイルの選択) を選択します。
  5. UnityEngine フォルダーにある必要な .dll ファイルを選択します。

DLL のコーディング

  1. この例では、ソリューションブラウザーでデフォルトクラスの名前を
    MyUtilities
    に変更します。
  2. コードを以下のように置き換えます。
using System; using UnityEngine;名前空間 DLLTest { public class MyUtilities { public int c; public void AddValues(int a, int b) { c = a + b; } public static int GenerateRandom(int min, int max) { System.Random rand = new System.Random(); return rand.Next(min, max); } }}
  1. プロジェクトをビルドして、デバッグシンボルとともに DLL ファイルを生成します。

Unity での DLL のデバッグ

Unity で DLL のデバッグセッションを設定するには、以下を行います。
  1. Unity で新しいプロジェクトを作成し、ビルドした .dll ファイル (例えば
    <project folder>/bin/Debug/DLLTest.dll
    ) を Assets フォルダーにコピーします。
  2. Assets フォルダーに Test という Cスクリプトを作成します。
  3. そのコンテンツを、DLL で作成したクラスの新しいインスタンスを作成し、その機能を使用してコンソール ウィンドウに出力を表示するスクリプトに置き換えます。例えば、上のセクションから DLL のテストスクリプトを作成するには、以下のコードをコピーします。
using UnityEngine;using System.Collections;using DLLTest;public class Test :MonoBehaviour { void Start () { MyUtilities utils = new MyUtilities(); utils.AddValues(2, 3); print("2 + 3 = " + utils.c); } void Update () { print(MyUtilities.GenerateRandom(0, 100)); }}
  1. このスクリプトをシーンのゲームオブジェクトにアタッチ、設定、添付し、再生をクリックします。
Unity は DLL からのコード出力をコンソールウィンドウに表示します。

安全でない C# コードのコンパイル

Unsafe C# コードは、メモリに直接アクセスできるコードです。デフォルトでは有効になっていません。これは、コンパイラーがセキュリティリスクが生じないことを検証できないためです。
安全でないコードを使用して、以下を行うことができます。
  • ポインターを使用してメモリにアクセスします。
  • Raw メモリを割り当てます。
  • ポインターを使用してメソッドをコールます。
安全でない C# コードのコンパイルのサポートを有効にするには、編集>
プロジェクト設定

?

> プレイヤー> その他の設定に移動し、Unsafe コード許可を有効にします。
詳細については、安全でないコードのMicrosoftドキュメントを参照してください。

追加リソース