Bei der Integration der Asset Delivery können Unity-Spiele mithilfe von Addressables oder AssetBundles auf Asset-Packs zugreifen. Addressables sind die neuere und empfohlene Asset Delivery-Lösung für Spiele, die mit Unity 2019.4 oder höher entwickelt wurden, während AssetBundles Asset-Packs in Unity 2017.4 und 2018.4 unterstützen.
Ansprechbare Einheit
Bei Spielen, die mit Unity 2019.4 oder höher erstellt wurden, sollten Sie Addressables für die Asset Delivery unter Android verwenden. Unity bietet eine Play Asset Delivery (PAD) API für die Verarbeitung von Android-Asset-Packs mit Addressables. Informationen zur Verwendung von Addressables finden Sie hier:
- Addressables for Android-Paket
- PAD-Leitfaden für Unity
- Referenzdokumentation zur PAD API für Unity
AssetBundle-Dateien verwenden
Bei Spielen, die mit Unity 2017.4 und 2018.4 erstellt wurden, können AssetBundle-Dateien für die Asset-Bereitstellung unter Android verwendet werden. Unity-AssetBundle-Dateien enthalten serielle Assets, die von der Unity-Engine geladen werden können, während die Anwendung ausgeführt wird. Diese Dateien sind plattformspezifisch (z. B. für Android erstellt) und können in Kombination mit Asset-Packs verwendet werden. Meistens wird eine AssetBundle-Datei in einem einzelnen Asset-Pack verpackt, wobei das Paket denselben Namen wie das AssetBundle hat. Wenn Sie ein Asset-Pack flexibler erstellen möchten, können Sie es mithilfe der API konfigurieren.
Verwenden Sie zur Laufzeit die Klasse Play Asset Delivery for Unity, um ein in einem Asset-Pack verpacktes AssetBundle abzurufen.
Voraussetzungen
Laden Sie die neueste Version des Play Asset Delivery Unity-Plug-ins aus den Google-Paketen für Unity herunter.
AssetBundles über die UI konfigurieren
Konfigurieren Sie jedes AssetBundle in einem Asset-Pack:
- Wählen Sie Google > Android App Bundle > Asset Delivery Settings aus.
- Um Ordner auszuwählen, die direkt AssetBundle-Dateien enthalten, klicken Sie auf Ordner hinzufügen.
Ändern Sie für jedes Bundle den Übermittlungsmodus in Installationszeit, Fast Follow oder On Demand. Beheben Sie alle Fehler oder Abhängigkeiten und schließen Sie das Fenster.
Wählen Sie Google > Android App Bundle erstellen aus, um das App Bundle zu erstellen.
(Optional) Konfigurieren Sie Ihr App-Bundle so, dass es verschiedene Formate für die Texturkomprimierung unterstützt.
Asset-Packs mit der API konfigurieren
Sie können die Asset-Bereitstellung mithilfe von Editor-Skripts konfigurieren, die als Teil eines automatisierten Build-Systems ausgeführt werden können.
Mit der Klasse AssetPackConfig kannst du definieren, welche Assets in einen Android App Bundle-Build aufgenommen werden sollen, und den Übermittlungsmodus der Assets festlegen. Diese Asset-Packs müssen kein AssetBundle enthalten.
public void ConfigureAssetPacks {
// Creates an AssetPackConfig with a single asset pack, named
// examplePackName, containing all the files in path/to/exampleFolder.
var assetPackConfig = new AssetPackConfig();
assetPackConfig.AddAssetsFolder("examplePackName",
"path/to/exampleFolder",
AssetPackDeliveryMode.OnDemand);
// Configures the build system to use the newly created assetPackConfig when
// calling Google > Build and Run or Google > Build Android App Bundle.
AssetPackConfigSerializer.SaveConfig(assetPackConfig);
// Alternatively, use BundleTool.BuildBundle to build an App Bundle from script.
BuildBundle(new buildPlayerOptions(), assetPackConfig);
}
Du kannst auch die statische Methode BuildBundle in der Klasse Bundletool verwenden, um ein Android App Bundle mit Asset-Packs unter Angabe von BuildPlayerOptions und AssetPackConfig zu generieren.
Eine Anleitung finden Sie im Codelab zur Verwendung von Play Asset Delivery im Unity-Spiele-Codelab.
In die Play Asset Delivery Unity API einbinden
Die Play Asset Delivery Unity API bietet die Möglichkeit, Asset-Packs anzufordern, Downloads zu verwalten und auf Assets zuzugreifen. Fügen Sie Ihrem Projekt zuerst das Unity-Plug-in hinzu.
Welche Funktionen Sie in der API verwenden, hängt davon ab, wie Sie die Asset-Packs erstellt haben.
Wenn Sie Asset-Packs über die Plug-in-UI erstellt haben, wählen Sie Plug-in-konfigurierte Asset-Packs aus.
Wenn Sie Asset-Packs über die API (oder Plug-in-UI) erstellt haben, wählen Sie API-konfigurierte Asset-Packs aus.
Sie implementieren die API entsprechend dem Übermittlungstyp des Asset-Packs, auf das Sie zugreifen möchten. Diese Schritte sind im folgenden Flussdiagramm dargestellt.
Abbildung 1: Flussdiagramm für den Zugriff auf Asset-Packs
AssetBundles abrufen
Importieren Sie die Play Asset Delivery-Bibliothek und rufen Sie die Methode RetrieveAssetBundleAsync() auf, um ein AssetBundle abzurufen.
using Google.Play.AssetDelivery; // Loads the AssetBundle from disk, downloading the asset pack containing it if necessary. PlayAssetBundleRequest bundleRequest = PlayAssetDelivery.RetrieveAssetBundleAsync(asset-bundle-name);
Installationszeitpunkt-Lieferung
Als install-time konfigurierte Asset-Packs sind sofort beim Start der App verfügbar. Mit folgendem Befehl können Sie eine Szene aus dem AssetBundle laden:
AssetBundle assetBundle = bundleRequest.AssetBundle; // You may choose to load scenes from the AssetBundle. For example: string[] scenePaths = assetBundle.GetAllScenePaths(); SceneManager.LoadScene(scenePaths[path-index]);
Schnelle Lieferung und On-Demand-Bereitstellung
Diese Abschnitte gelten für fast-follow- und on-demand-Asset-Packs.
Status prüfen
Jedes Asset-Pack wird in einem separaten Ordner im internen Speicher der App gespeichert.
Mit der Methode isDownloaded() können Sie feststellen, ob ein Asset-Pack bereits heruntergeladen wurde.
Download überwachen
Fragen Sie das Objekt PlayAssetBundleRequest ab, um den Status der Anfrage zu beobachten:
// Download progress of request, between 0.0f and 1.0f. The value will always be
// 1.0 for assets delivered as install-time.
// NOTE: A value of 1.0 will only signify the download is complete. It will still need to be loaded.
float progress = bundleRequest.DownloadProgress;
// Returns true if:
// * it had either completed the download, installing, and loading of the AssetBundle,
// * OR if it has encountered an error.
bool done = bundleRequest.IsDone;
// Returns status of retrieval request.
AssetDeliveryStatus status = bundleRequest.Status;
switch(status) {
case AssetDeliveryStatus.Pending:
// Asset pack download is pending - N/A for install-time assets.
case AssetDeliveryStatus.Retrieving:
// Asset pack is being downloaded and transferred to app storage.
// N/A for install-time assets.
case AssetDeliveryStatus.Available:
// Asset pack is downloaded on disk but NOT loaded into memory.
// For PlayAssetPackRequest(), this indicates that the request is complete.
case AssetDeliveryStatus.Loading:
// Asset pack is being loaded.
case AssetDeliveryStatus.Loaded:
// Asset pack has finished loading, assets can now be loaded.
// For PlayAssetBundleRequest(), this indicates that the request is complete.
case AssetDeliveryStatus.Failed:
// Asset pack retrieval has failed.
case AssetDeliveryStatus.WaitingForWifi:
// Asset pack retrieval paused until either the device connects via Wi-Fi,
// or the user accepts the PlayAssetDelivery.ShowConfirmationDialog dialog.
case AssetDeliveryStatus.RequiresUserConfirmation:
// Asset pack retrieval paused until the user accepts the
// PlayAssetDelivery.ShowConfirmationDialog dialog.
default:
break;
}
Große Downloads
Asset-Packs, die größer als 200 MB sind, können automatisch heruntergeladen werden, allerdings nur über WLAN. Wenn der Nutzer nicht mit einem WLAN verbunden ist, wird der Status PlayAssetBundleRequest auf AssetDeliveryStatus.WaitingForWifi gesetzt und der Download angehalten. In diesem Fall musst du entweder warten, bis das Gerät mit dem WLAN verbunden ist, den Download fortsetzen oder den Nutzer um seine Zustimmung bitten, das Paket über eine Mobilfunkverbindung herunterzuladen.
Erforderliche Nutzerbestätigung
Wenn ein Paket den Status AssetDeliveryStatus.RequiresUserConfirmation hat, wird der Download erst fortgesetzt, wenn der Nutzer das mit PlayAssetDelivery.ShowConfirmationDialog() angezeigte Dialogfeld akzeptiert hat. Dieser Status kann auftreten, wenn die App von Play nicht erkannt wird. Wenn Sie PlayAssetDelivery.ShowConfirmationDialog() aufrufen, wird in diesem Fall die Anwendung aktualisiert. Fordern Sie die Assets nach der Aktualisierung noch einmal an.
if(request.Status == AssetDeliveryStatus.RequiresUserConfirmation
|| request.Status == AssetDeliveryStatus.WaitingForWifi) {
var userConfirmationOperation = PlayAssetDelivery.ShowConfirmationDialog();
yield return userConfirmationOperation;
switch(userConfirmationOperation.GetResult()) {
case ConfirmationDialogResult.Unknown:
// userConfirmationOperation finished with an error. Something went
// wrong when displaying the prompt to the user, and they weren't
// able to interact with the dialog.
case ConfirmationDialogResult.Accepted:
// User accepted the confirmation dialog--an update will start.
case ConfirmationDialogResult.Declined:
// User canceled or declined the dialog. It can be shown again.
default:
break;
}
}
Anfrage abbrechen (nur On-Demand)
Wenn Sie die Anfrage abbrechen müssen, bevor die AssetBundles in den Arbeitsspeicher geladen werden, rufen Sie die Methode AttemptCancel() für das Objekt PlayAssetBundleRequest auf:
// Will only attempt if the status is Pending, Retrieving, or Available - otherwise
// it will be a no-op.
bundleRequest.AttemptCancel();
// Check to see if the request was successful by checking if the error code is Canceled.
if(bundleRequest.Error == AssetDeliveryErrorCode.Canceled) {
// Request was successfully canceled.
}
Asset-Packs asynchron anfordern
In den meisten Fällen sollten Sie Coroutinen verwenden, um Asset-Packs asynchron anzufordern und den Fortschritt zu beobachten:
private IEnumerator LoadAssetBundleCoroutine(string assetBundleName) {
PlayAssetBundleRequest bundleRequest =
PlayAssetDelivery.RetrieveAssetBundleAsync(assetBundleName);
while (!bundleRequest.IsDone) {
if(bundleRequest.Status == AssetDeliveryStatus.WaitingForWifi) {
var userConfirmationOperation = PlayAssetDelivery.ShowCellularDataConfirmation();
// Wait for confirmation dialog action.
yield return userConfirmationOperation;
if((userConfirmationOperation.Error != AssetDeliveryErrorCode.NoError) ||
(userConfirmationOperation.GetResult() != ConfirmationDialogResult.Accepted)) {
// The user did not accept the confirmation. Handle as needed.
}
// Wait for Wi-Fi connection OR confirmation dialog acceptance before moving on.
yield return new WaitUntil(() => bundleRequest.Status != AssetDeliveryStatus.WaitingForWifi);
}
// Use bundleRequest.DownloadProgress to track download progress.
// Use bundleRequest.Status to track the status of request.
yield return null;
}
if (bundleRequest.Error != AssetDeliveryErrorCode.NoError) {
// There was an error retrieving the bundle. For error codes NetworkError
// and InsufficientStorage, you may prompt the user to check their
// connection settings or check their storage space, respectively, then
// try again.
yield return null;
}
// Request was successful. Retrieve AssetBundle from request.AssetBundle.
AssetBundle assetBundle = bundleRequest.AssetBundle;
Weitere Informationen zum Beheben von Fehlern finden Sie in der Liste der AssetDeliveryErrorCodes.
Andere Play Core API-Methoden
Nachfolgend finden Sie einige zusätzliche API-Methoden, die Sie in Ihrer App verwenden können.
Downloadgröße prüfen
Überprüfen Sie die Größe eines AssetBundles, indem Sie einen asynchronen Aufruf an Google Play ausführen und eine Callback-Methode für den Abschluss des Vorgangs festlegen:
public IEnumerator GetDownloadSize() {
PlayAsyncOperation<long> getSizeOperation =
PlayAssetDelivery.GetDownloadSize(assetPackName);
yield return getSizeOperation;
if(operation.Error != AssetDeliveryErrorCode.NoError) {
// Error while retrieving download size.
} else {
// Download size is given in bytes.
long downloadSize = operation.GetResult();
}
}
Asset-Bundles entfernen
Sie können Fast-Follow- und On-Demand-AssetBundles entfernen, die derzeit nicht in den Arbeitsspeicher geladen sind. Führen Sie den folgenden asynchronen Aufruf aus und legen Sie eine Callback-Methode für den Abschluss fest:
PlayAsyncOperation<string> removeOperation = PlayAssetDelivery.RemoveAssetPack(assetBundleName);
removeOperation.Completed += (operation) =>
{
if(operation.Error != AssetDeliveryErrorCode.NoError) {
// Error while attempting to remove AssetBundles.
} else {
// Files were deleted OR files did not exist to begin with.
}
};
Nächste Schritte
Teste die Asset-Bereitstellung lokal und über Google Play.