Version: 2018.3 (switch to 2019.1b or 2017.4)
LanguageEnglish
  • C#
Method group is Obsolete

BuildPipeline.BuildStreamedSceneAssetBundle

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Obsolete public static string BuildStreamedSceneAssetBundle(string[] levels, string locationPath, BuildTarget target);
Obsolete public static string BuildStreamedSceneAssetBundle(string[] levels, string locationPath, BuildTarget target, out uint crc);
Obsolete public static string BuildStreamedSceneAssetBundle(string[] levels, string locationPath, BuildTarget target, BuildOptions options);
Obsolete public static string BuildStreamedSceneAssetBundle(string[] levels, string locationPath, BuildTarget target, out uint crc, BuildOptions options);

Parameters

levelsPathnames of levels to include in the asset bundle.
locationPathPathname for the output asset bundle.
targetRuntime platform on which the asset bundle will be used.
crcOutput parameter to receive CRC checksum of generated assetbundle.
optionsBuild options. See BuildOptions for possible values.

Returns

string String with an error message, empty on success.

Description

Builds one or more Scenes and all their dependencies into a compressed asset bundle.

The Scene AssetBundle can be built for any target platform and always creates a single compressed unity3d file.

The Scene can be downloaded and loaded using the UnityWebRequest class. You can use UnityWebRequestAssetBundle.GetAssetBundle to cache the downloaded Scene after it has been downloaded. The optional crc output parameter can be used to get a CRC checksum for the generated AssetBundle, which can be used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle().

using UnityEngine;
using UnityEditor;
using System.Collections;

public class StreamedSceneLoaderExample : MonoBehaviour { // Build a streamed unity3d file. This contain one Scene that can be downloaded // on demand and loaded once its asset bundle has been loaded.

[MenuItem("Build/BuildWlayerStreamed")] public static void MyBuild() { string[] levels = new string[] {"Assets/Level1.unity"}; BuildPipeline.BuildStreamedSceneAssetBundle(levels, "Streamed-Level1.unity3d", BuildTarget.StandaloneWindows); } }

When downloading the built compressed file, you need to call DownloadHandlerAssetBundle.GetContent() in order to make the Scene available to the Application.LoadLevel() and Application.LoadLevelAdditive() functions.

using UnityEngine;
using UnityEngine.Networking;
using System.Collections;

public class StreamedSceneLoaderExample : MonoBehaviour { IEnumerator Start() { // Download compressed Scene. If version 5 of the file named "Streamed-Level1.unity3d" was previously downloaded and cached. // Then Unity will completely skip the download and load the decompressed Scene directly from disk. var download = UnityWebRequestAssetBundle.GetAssetBundle("http://myWebSite.com/Streamed-Level1.unity3d", 5); yield return download.SendWebRequest();

// Handle error if (download.isNetworkError || download.isHttpError) { Debug.LogError(download.error); yield break; }

// In order to make the Scene available from LoadLevel, we have to load the asset bundle. // The AssetBundle class also lets you force unload all assets and file storage once it is no longer needed. var bundle = DownloadHandlerAssetBundle.GetContent(download);

// Load the level we have just downloaded Application.LoadLevel("Level1"); } }

Did you find this page useful? Please give it a rating: