class in UnityEngine
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseThe Caching class lets you manage cached AssetBundles, downloaded using UnityWebRequestAssetBundle.GetAssetBundle.
Note: The Cache API is not supported in WebGL because AssetBundles are stored in the browser cache for the WebGL platform.
Additional resources: DownloadHandlerAssetBundle.
using System.Collections; using UnityEngine; using System.IO; using System; using UnityEngine.Networking; using System.Collections.Generic;
public class Example : MonoBehaviour { IEnumerator DownloadAndCacheAssetBundle(string uri, string manifestBundlePath) { //Load the manifest AssetBundle manifestBundle = AssetBundle.LoadFromFile(manifestBundlePath); AssetBundleManifest manifest = manifestBundle.LoadAsset<AssetBundleManifest>("AssetBundleManifest");
//Create new cache string today = DateTime.Today.ToLongDateString(); Directory.CreateDirectory(today); Cache newCache = Caching.AddCache(today);
//Set current cache for writing to the new cache if the cache is valid if (newCache.valid) Caching.currentCacheForWriting = newCache;
//Download the bundle Hash128 hash = manifest.GetAssetBundleHash("bundleName"); UnityWebRequest request = UnityWebRequestAssetBundle.GetAssetBundle(uri, hash, 0); yield return request.SendWebRequest(); AssetBundle bundle = DownloadHandlerAssetBundle.GetContent(request);
//Get all the cached versions List<Hash128> listOfCachedVersions = new List<Hash128>(); Caching.GetCachedVersions(bundle.name, listOfCachedVersions);
if (!AssetBundleContainsAssetIWantToLoad(bundle)) //Or any conditions you want to check on your new asset bundle { //If our criteria wasn't met, we can remove the new cache and revert back to the most recent one Caching.currentCacheForWriting = Caching.GetCacheAt(Caching.cacheCount); Caching.RemoveCache(newCache);
for (int i = listOfCachedVersions.Count - 1; i > 0; i--) { //Load a different bundle from a different cache request = UnityWebRequestAssetBundle.GetAssetBundle(uri, listOfCachedVersions[i], 0); yield return request.SendWebRequest(); bundle = DownloadHandlerAssetBundle.GetContent(request);
//Check and see if the newly loaded bundle from the cache meets your criteria if (AssetBundleContainsAssetIWantToLoad(bundle)) break; } } else { //This is if we only want to keep 5 local caches at any time if (Caching.cacheCount > 5) Caching.RemoveCache(Caching.GetCacheAt(1)); //Removes the oldest user created cache }
manifestBundle.Unload(true); bundle.Unload(true);
}
bool AssetBundleContainsAssetIWantToLoad(AssetBundle bundle) { return (bundle.LoadAsset<GameObject>("MyAsset") != null); //this could be any conditional } }
To store up to five cached versions of the same bundle and use the previous caches if your most recent cache becomes invalid, or the downloaded Asset Bundle has a problem, use the following setup.
using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.Networking; using System.IO;
public class Example2 : MonoBehaviour { public static class CacheWithPriority { public enum ResolutionType { High, Medium, Low, } static readonly Dictionary<ResolutionType, Cache> ResolutionCaches = new Dictionary<ResolutionType, Cache>();
public static void InitResolutionCaches() { string highResPath = "HighRes"; string medResPath = "MedRes"; string lowResPath = Application.streamingAssetsPath;
//Create cache paths Directory.CreateDirectory(highResPath); Directory.CreateDirectory(medResPath);
//Create the caches and add them to a Dictionary ResolutionCaches.Add(ResolutionType.High, Caching.AddCache(highResPath)); ResolutionCaches.Add(ResolutionType.Medium, Caching.AddCache(medResPath)); ResolutionCaches.Add(ResolutionType.Low, Caching.AddCache(lowResPath)); }
public static void PrioritizeCacheForLoading(ResolutionType resolutionToPrioritize) { //Move cache to the start of the queue Caching.MoveCacheBefore(ResolutionCaches[resolutionToPrioritize], Caching.GetCacheAt(0)); }
public static void SetResolutionCacheForWriting(ResolutionType resolutionToWriteTo) { Caching.currentCacheForWriting = ResolutionCaches[resolutionToWriteTo]; } }
AssetBundle currentTextureAssetBundle; IEnumerator RearrangeCacheOrderExample(string manifestBundlePath) { CacheWithPriority.InitResolutionCaches();
//Load the manifest AssetBundle manifestBundle = AssetBundle.LoadFromFile(manifestBundlePath); AssetBundleManifest manifest = manifestBundle.LoadAsset<AssetBundleManifest>("AssetBundleManifest");
//We know we want to start loading from the Low Resolution Cache CacheWithPriority.PrioritizeCacheForLoading(CacheWithPriority.ResolutionType.Low);
//Load the low res bundle from StreamingAssets UnityWebRequest lowRequest = UnityWebRequestAssetBundle.GetAssetBundle("lowResBundlePath", manifest.GetAssetBundleHash("lowResBundle"), 0); yield return lowRequest; currentTextureAssetBundle = DownloadHandlerAssetBundle.GetContent(lowRequest);
//In the background we can start downloading our higher resolution bundles StartCoroutine(StartDownloadHigherResolutionBundles(manifest));
//Do work with low res bundle while the higher resolutions download...
//Unload the AssetBundle manifestBundle.Unload(true); }
IEnumerator StartDownloadHigherResolutionBundles(AssetBundleManifest manifest) { CacheWithPriority.SetResolutionCacheForWriting(CacheWithPriority.ResolutionType.Medium); UnityWebRequest medRequest = UnityWebRequestAssetBundle.GetAssetBundle("medResBundleUrl", manifest.GetAssetBundleHash("medResBundle"), 0); medRequest.SendWebRequest();
while (!medRequest.isDone) yield return null; SwitchTextureBundleTo(CacheWithPriority.ResolutionType.Medium, medRequest);
//Now you'll be using the medium resolution bundle
CacheWithPriority.SetResolutionCacheForWriting(CacheWithPriority.ResolutionType.High); UnityWebRequest highRequest = UnityWebRequestAssetBundle.GetAssetBundle("highResBundleUrl", manifest.GetAssetBundleHash("highResBundle"), 0); highRequest.SendWebRequest();
while (!highRequest.isDone) yield return null; SwitchTextureBundleTo(CacheWithPriority.ResolutionType.High, highRequest);
//Do work with the high resolution bundle now... }
void SwitchTextureBundleTo(CacheWithPriority.ResolutionType typeToSwitchTo, UnityWebRequest request) { //For performance, we tell the Caching system what cache we want it to search first CacheWithPriority.PrioritizeCacheForLoading(typeToSwitchTo); //Unload our current texture bundle currentTextureAssetBundle.Unload(true); //Load the new one from the passed in UnityWebRequest currentTextureAssetBundle = DownloadHandlerAssetBundle.GetContent(request); currentTextureAssetBundle.Unload(true); } }
The ability to have multiple caches allows you to keep several cached version of a particular Asset Bundle. You can use these for things like backups and fallbacks.
This example shows downloading medium resolution and high resolution textures after startup and caching them in their own appropriate caches.
cacheCount | Returns the cache count in the cache list. |
compressionEnabled | Controls compression of cache data. Enabled by default. |
currentCacheForWriting | Gets or sets the current cache in which AssetBundles should be cached. |
defaultCache | Returns the default cache which is added by Unity internally. |
ready | Returns true if Caching system is ready for use. |
AddCache | Add a cache with the given path. |
ClearAllCachedVersions | Removes all the cached versions of the given AssetBundle from the cache. |
ClearCache | Removes all AssetBundle content that has been cached by the current application. |
ClearCachedVersion | Removes the given version of the AssetBundle. |
ClearOtherCachedVersions | Removes all the cached versions of the AssetBundle from the cache, except for the specified version. |
GetAllCachePaths | Returns all paths of the cache in the cache list. |
GetCacheAt | Returns the Cache at the given position in the cache list. |
GetCacheByPath | Returns the Cache that has the given cache path. |
GetCachedVersions | Returns all cached versions of the given AssetBundle. |
IsVersionCached | Checks if an AssetBundle is cached. |
MarkAsUsed | Bumps the timestamp of a cached file to be the current time. |
MoveCacheAfter | Moves the source Cache after the destination Cache in the cache list. |
MoveCacheBefore | Moves the source Cache before the destination Cache in the cache list. |
RemoveCache | Removes the Cache from cache list. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.