Firstborn/Library/PackageCache/com.unity.addressables@1.19.19/Runtime/ResourceLocators/IResourceLocator.cs

30 lines
1.0 KiB
C#
Raw Normal View History

using System;
using System.Collections.Generic;
using UnityEngine.ResourceManagement.ResourceLocations;
namespace UnityEngine.AddressableAssets.ResourceLocators
{
/// <summary>
/// Interface used by the Addressables system to find the locations of a given key.
/// </summary>
public interface IResourceLocator
{
/// <summary>
/// The id for this locator.
/// </summary>
string LocatorId { get; }
/// <summary>
/// The keys defined by this locator.
/// </summary>
IEnumerable<object> Keys { get; }
/// <summary>
/// Retrieve the locations from a specified key.
/// </summary>
/// <param name="key">The key to use.</param>
/// <param name="type">The resource type.</param>
/// <param name="locations">The resulting set of locations for the key.</param>
/// <returns>True if any locations were found with the specified key.</returns>
bool Locate(object key, Type type, out IList<IResourceLocation> locations);
}
}