Class Addressables

Entry point for Addressable API, this provides a simpler interface than using ResourceManager directly as it assumes string address type.

Inheritance

object

Addressables

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.AddressableAssets

Assembly: Unity.Addressables.dll

Syntax

public static class Addressables

Fields

Name	Description
BuildReportPath	The path to the Addressables Build Reports subfolder
LibraryPath	The path to the Addressables Library subfolder
kAddressablesRuntimeBuildLogPath	The name of the PlayerPrefs value used to set the path to check for build logs that need to be shown in the runtime.
kAddressablesRuntimeDataPath	The name of the PlayerPrefs value used to set the path to load the addressables runtime data file.

Properties

Name	Description
BuildPath	The build path used by the Addressables system for its initialization data.
InstanceProvider	The Instance Provider used by the Addressables System.
InternalIdTransformFunc	Functor to transform internal ids before being used by the providers.
PlayerBuildDataPath	The path that addressables player data gets copied to during a player build.
ResourceLocators	Gets the collection of configured IResourceLocator objects. Resource Locators are used to find IResourceLocation objects from user-defined typed keys.
ResourceManager	Stores the ResourceManager associated with this Addressables instance.
RuntimePath	The path used by the Addressables system to load initialization data.
StreamingAssetsSubFolder	The subfolder used by the Addressables system for its built data.
Version	Returns the Addressables package version in Unity 2019.3 or newer
WebRequestOverride	Delegate that can be used to override the web request options before being sent.

Methods

Name	Description
AddResourceLocator(IResourceLocator, string, IResourceLocation)	Adds a ResourceLocator to the Addressables runtime.
CheckForCatalogUpdates(bool)	Checks all updatable content catalogs for a new version.
CleanBundleCache(IEnumerable<string>)	Removes any AssetBundles that are no longer referenced in the bundle cache. This can occur when a new, updated catalog excludes entries present in an older catalog.
ClearDependencyCacheAsync(IList<IResourceLocation>)	Clear the cached AssetBundles for a list of Addressable locations. Operation may be performed async if Addressables is initializing or updating.
ClearDependencyCacheAsync(IList<IResourceLocation>, bool)	Clear the cached AssetBundles for a list of Addressable locations. Operation may be performed async if Addressables is initializing or updating.
ClearDependencyCacheAsync(IEnumerable)	Clear the cached AssetBundles for a list of Addressable keys. Operation may be performed async if Addressables is initializing or updating.
ClearDependencyCacheAsync(IEnumerable, bool)	Clear the cached AssetBundles for a list of Addressable keys. Operation may be performed async if Addressables is initializing or updating.
ClearDependencyCacheAsync(object)	Clear the cached AssetBundles for a given key. Operation may be performed async if Addressables is initializing or updating.
ClearDependencyCacheAsync(object, bool)	Clear the cached AssetBundles for a given key. Operation may be performed async if Addressables is initializing or updating.
ClearDependencyCacheAsync(string)	Clear the cached AssetBundles for a list of Addressable keys. Operation may be performed async if Addressables is initializing or updating.
ClearDependencyCacheAsync(string, bool)	Clear the cached AssetBundles for a list of Addressable keys. Operation may be performed async if Addressables is initializing or updating.
ClearResourceLocators()	Clears all ResourceLocators from the Addressables runtime. This can be used to remove the default locators in order to add custom ones.
CreateCatalogLocationWithHashDependencies<T>(string)	Given a location path that points to a remote content catalog, create a location with the assumed dependencies that point to remote, and local, hash files respectively. The first dependency, remote, assumes that the .hash file is located beside the provided location of the .json catalog file. The second dependency, local, points to a location inside the Addressables local cache data folder. The Addressables local cache data folder is meant for content catalogs and is not the same cache location for AssetBundles.
CreateCatalogLocationWithHashDependencies<T>(string, string)	Given a location path that points to a remote content catalog and its corresponding remote hash file, create a location with the dependencies that point to remote, and local, hash files respectively. The first dependency, remote, uses the provided remote hash location. The second dependency, local, points to a location inside the Addressables local cache data folder. The Addressables local cache data folder is meant for content catalogs and is not the same cache location for AssetBundles.
CreateCatalogLocationWithHashDependencies<T>(IResourceLocation)	Given a location path that points to a remote content catalog, create a location with the assumed dependencies that point to remote, and local, hash files respectively. The first dependency, remote, assumes that the .hash file is located beside the provided location of the .json catalog file. The second dependency, local, points to a location inside the Addressables local cache data folder. The Addressables local cache data folder is meant for content catalogs and is not the same cache location for AssetBundles.
DownloadDependenciesAsync(IList<IResourceLocation>, bool)	Downloads dependencies of assets at the specified locations.
DownloadDependenciesAsync(IEnumerable, MergeMode, bool)	Downloads dependencies of assets identified by a list of keys.
DownloadDependenciesAsync(object, bool)	Downloads dependencies of assets identified with the specified label or address.
GetDownloadSizeAsync(IEnumerable)	Determines the required download size, dependencies included, for the specified keys. Cached assets require no download and thus their download size will be 0. The Result of the operation is the download size in bytes.
GetDownloadSizeAsync(object)	Determines the required download size, dependencies included, for the specified key. Cached assets require no download and thus their download size will be 0. The Result of the operation is the download size in bytes.
GetDownloadSizeAsync(string)	Determines the required download size, dependencies included, for the specified key. Cached assets require no download and thus their download size will be 0. The Result of the operation is the download size in bytes.
GetLocatorInfo(string)	Given the Id of an IResourceLocator, get the relevant content catalog data associated with it.
GetLocatorInfo(IResourceLocator)	Given an IResourceLocator, get the relevant content catalog data associated with it.
InitializeAsync()	Initialize the Addressables system, if needed.
InitializeAsync(bool)	Initialize the Addressables system, if needed.
InstantiateAsync(object, InstantiationParameters, bool)	Instantiate a single object.
InstantiateAsync(object, Transform, bool, bool)	Instantiate a single object.
InstantiateAsync(object, Vector3, Quaternion, Transform, bool)	Instantiate a single object.
InstantiateAsync(IResourceLocation, InstantiationParameters, bool)	Instantiate a single object.
InstantiateAsync(IResourceLocation, Transform, bool, bool)	Instantiate a single object.
InstantiateAsync(IResourceLocation, Vector3, Quaternion, Transform, bool)	Instantiate a single object.
LoadAssetAsync<TObject>(object)	Loads a single Addressable asset identified by an IResourceLocation.
LoadAssetAsync<TObject>(IResourceLocation)	Loads a single Addressable asset identified by an IResourceLocation.
LoadAssetsAsync<TObject>(IList<IResourceLocation>, Action<TObject>)	Loads multiple assets, based on the list of locations provided.
LoadAssetsAsync<TObject>(IList<IResourceLocation>, Action<TObject>, bool)	Loads multiple assets, based on the list of locations provided.
LoadAssetsAsync<TObject>(IEnumerable, Action<TObject>, MergeMode)	Loads multiple assets identified by a list of keys.
LoadAssetsAsync<TObject>(IEnumerable, Action<TObject>, MergeMode, bool)	Loads multiple assets, identified by a set of keys.
LoadAssetsAsync<TObject>(object, Action<TObject>)	Loads multiple assets identified by a single key.
LoadAssetsAsync<TObject>(object, Action<TObject>, bool)	Loads multiple assets identified by a single key.
LoadAssetsAsync<TObject>(string, Action<TObject>)	Loads multiple assets identified by a key.
LoadAssetsAsync<TObject>(string, bool, Action<TObject>)	Loads multiple assets, identified by a key.
LoadContentCatalogAsync(string, bool, string)	Additively load catalogs from runtime data.
LoadContentCatalogAsync(string, string)	Additively load catalogs from runtime data.
LoadResourceLocationsAsync(IEnumerable, MergeMode, Type)	Loads the resource locations specified by a set of keys.
LoadResourceLocationsAsync(object, Type)	Loads the resource locations specified by a key.
LoadSceneAsync(object, LoadSceneMode, bool, int, SceneReleaseMode)	Loads an Addressable Scene asset.
LoadSceneAsync(object, LoadSceneMode, SceneReleaseMode, bool, int)	Loads an Addressable Scene asset.
LoadSceneAsync(object, LoadSceneParameters, bool, int)	Loads an Addressable Scene asset.
LoadSceneAsync(object, LoadSceneParameters, SceneReleaseMode, bool, int)	Loads an Addressable Scene asset.
LoadSceneAsync(IResourceLocation, LoadSceneMode, bool, int)	Loads an Addressable Scene asset.
LoadSceneAsync(IResourceLocation, LoadSceneMode, SceneReleaseMode, bool, int)	Loads an Addressable Scene asset.
LoadSceneAsync(IResourceLocation, LoadSceneParameters, bool, int)	Loads an Addressable Scene asset.
LoadSceneAsync(IResourceLocation, LoadSceneParameters, SceneReleaseMode, bool, int)	Loads an Addressable Scene asset.
Log(string)	Log can be used to write a Debug level log message.
LogError(string)	Write an error level log message.
LogErrorFormat(string, params object[])	Write an error level formatted log message.
LogException(Exception)	Write an exception as a debug log message.
LogException(AsyncOperationHandle, Exception)	Write an exception as a log message.
LogFormat(string, params object[])	LogFormat can be used to write a formatted log message.
LogWarning(string)	LogWarning can be used to write a log message.
LogWarningFormat(string, params object[])	LogFormat can be used to write a formatted log message.
Release(AsyncOperationHandle)	Release the operation and its associated resources.
ReleaseInstance(GameObject)	Releases and destroys an object that was created via Addressables.InstantiateAsync.
ReleaseInstance(AsyncOperationHandle)	Releases and destroys an object that was created via Addressables.InstantiateAsync.
ReleaseInstance(AsyncOperationHandle<GameObject>)	Releases and destroys an object that was created via Addressables.InstantiateAsync.
Release<TObject>(AsyncOperationHandle<TObject>)	Release the operation and its associated resources.
Release<TObject>(TObject)	Release asset.
RemoveResourceLocator(IResourceLocator)	Removes a ResourceLocator from the Addressables runtime. This is uncommon but can be used to remove a specific locator that is only needed for a short time.
ResolveInternalId(string)	Used to resolve a string using addressables config values
UnloadSceneAsync(AsyncOperationHandle, bool)	Release scene
UnloadSceneAsync(AsyncOperationHandle, UnloadSceneOptions, bool)	Release scene
UnloadSceneAsync(AsyncOperationHandle<SceneInstance>, bool)	Release scene
UnloadSceneAsync(SceneInstance, bool)	Release scene
UnloadSceneAsync(SceneInstance, UnloadSceneOptions, bool)	Release scene
UpdateCatalogs(bool, IEnumerable<string>, bool)	Update the specified catalogs.
UpdateCatalogs(IEnumerable<string>, bool)	Update the specified catalogs.