Package Manager のスクリプティング API を使用して、プログラムを通して Package Manager を操作できます。例えば、ターゲットマシンのプラットフォームに応じて、特定のパッケージやバージョンをインストールしたい場合があります。
システムの中核となるのは、PackageManager.Client クラスです。これを使うと、パッケージの検索、パッケージのリストの参照、スクリプトによるパッケージのインストールとアンインストールをスクリプト経由で行えます。
もう 1 つの重要なクラスは PackageManager.PackageInfo です。これには、パッケージマニフェストとレジストリから取得したメタデータを含む、パッケージの状態が含まれます。例えば、パッケージで使用可能なバージョンのリストや、パッケージの検索やインストール中に発生する可能性があるエラーリストを取得できます。
この例では、Client クラスを使用してプロジェクトにパッケージをインストールまたは加える方法を示しています。
Client.Add メソッドを呼び出すときに、 パッケージ名、または特定のバージョン付きの名前を指定できます。例えば、 Client.Add("com.unity.textmeshpro@1.3.0")
は、TextMesh Pro パッケージのバージョン 1.3.0 をインストールし、Client.Add("com.unity.textmeshpro")
のみを使用するとパッケージの最新バージョンをインストール (または、最新バージョンに更新) します。
Client.Add メソッドは AddRequest インスタンスを返します。これを利用して、状態やエラーを把握できます。また、新しく加えられたパッケージの PackageInfo 情報を含む Request レスポンスを取得できます。
using System;
using UnityEditor;
using UnityEditor.PackageManager.Requests;
using UnityEditor.PackageManager;
using UnityEngine;
namespace Unity.Editor.Example {
static class AddPackageExample
{
static AddRequest Request;
[MenuItem("Window/Add Package Example")]
static void Add()
{
// パッケージをプロジェクトに加える
Request = Client.Add("com.unity.textmeshpro");
EditorApplication.update += Progress;
}
static void Progress()
{
if (Request.IsCompleted)
{
if (Request.Status == StatusCode.Success)
Debug.Log("Installed: " + Request.Result.packageId);
else if (Request.Status >= StatusCode.Failure)
Debug.Log(Request.Error.message);
EditorApplication.update -= Progress;
}
}
}
}
この例は、Client クラスを使用してプロジェクト内のパッケージを繰り返し使用する方法を示しています。
Client.List メソッドは ListRequest インスタンスを返します。これを利用して、List オペレーションやエラーの状態を把握できます。また、繰り返し使うパッケージの PackageInfo 情報を含む Request レスポンスを取得できます。
using System;
using UnityEditor;
using UnityEditor.PackageManager.Requests;
using UnityEditor.PackageManager;
using UnityEngine;
namespace Unity.Editor.Example {
static class ListPackageExample
{
static ListRequest Request;
[MenuItem("Window/List Package Example")]
static void List()
{
Request = Client.List(); // プロジェクトにインストールしたパッケージを列挙する
EditorApplication.update += Progress;
}
static void Progress()
{
if (Request.IsCompleted)
{
if (Request.Status == StatusCode.Success)
foreach (var package in Request.Result)
Debug.Log("Package name: " + package.name);
else if (Request.Status >= StatusCode.Failure)
Debug.Log(Request.Error.message);
EditorApplication.update -= Progress;
}
}
}
}
この例は、Client クラスを使用して、すでにプロジェクトにインストールされているパッケージの 1 つを埋め込む方法を示しています。メインメソッドである Client.Embed は、パッケージのコピーを作成し、プロジェクトの Packages
フォルダーに格納します。
Client.Embed メソッドはEmbedRequest インスタンスを返します。これを利用して、Embed オペレーションやエラーの状態を把握できます。また、新しく埋め込まれたパッケージの PackageInfo 情報を含む Request レスポンスを取得できます。
以下の例でも Client.List メソッドを使用し、現在プロジェクトにインストールされているパッケージの集合にアクセスし、埋め込みでもビルトインでもない最初のパッケージを選択します。
Client.List メソッドは ListRequest インスタンスを返します。これを利用して、List オペレーションやエラーの状態を把握できます。また、繰り返し使うパッケージの PackageInfo 情報を含む Request レスポンスを取得できます。
using System;
using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEditor.PackageManager.Requests;
using UnityEditor.PackageManager;
using UnityEngine;
namespace Unity.Editor.Example
{
static class EmbedPackageExample
{
static String targetPackage;
static EmbedRequest Request;
static ListRequest LRequest;
[MenuItem("Window/Embed Package Example")]
static void GetPackageName()
{
// まず、インストールされたパッケージの名前を取得します
LRequest = Client.List();
EditorApplication.update += LProgress;
}
static void LProgress()
{
if (LRequest.IsCompleted)
{
if (LRequest.Status == StatusCode.Success)
{
foreach (var package in LRequest.Result)
{
// 現在、プロジェクトにインストールされていて、ビルトインでもなく
// すでに埋め込まれているものでもないパッケージのみを取得します
if (package.isDirectDependency && package.source
!= PackageSource.BuiltIn && package.source
!= PackageSource.Embedded)
{
targetPackage = package.name;
break;
}
}
}
else
Debug.Log(LRequest.Error.message);
EditorApplication.update -= LProgress;
Embed(targetPackage);
}
}
static void Embed(string inTarget)
{
// プロジェクトにパッケージを埋め込みます
Debug.Log("Embed('" + inTarget + "') called");
Request = Client.Embed(inTarget);
EditorApplication.update += Progress;
}
static void Progress()
{
if (Request.IsCompleted)
{
if (Request.Status == StatusCode.Success)
Debug.Log("Embedded: " + Request.Result.packageId);
else if (Request.Status >= StatusCode.Failure)
Debug.Log(Request.Error.message);
EditorApplication.update -= Progress;
}
}
}
}