AssetKey

Description

Identifies a single asset to load through an asset provider. The key pairs a provider specific address with an expected asset type, and optionally the name of a sub-asset at that address.

The AssetKey.Address is opaque to the cache and is interpreted by the active provider: ReferencedAssetProvider treats it as the key into its address-to-reference map, ResourceFolderProvider treats it as a Resources path, and a provider installed from a package (for example an Addressables-backed one) can interpret it as its own address. AssetKey.Type is part of the identity because one address can hold objects of several types, so two keys with the same address but a different type are distinct.

Additional resources: IAssetProvider, AssetProvider, ReferencedAssetProvider, ResourceFolderProvider

<para>Create a key for a texture and inspect its parts.</para>

using Unity.Localization.Providers;
using UnityEngine;

namespace Unity.Localization.Samples
{
    public class AssetKeyOverviewExample
    {
        public void Run()
        {
            var key = new AssetKey("UI/Flags/Fr", typeof(Texture2D));

            Debug.Log(key.Address);     // UI/Flags/Fr
            Debug.Log(key.Type.Name);   // Texture2D
            Debug.Log(key.IsValid);     // True
        }
    }
}

Properties

Constructors

Public Methods

Operators