Create AssetReferenceSprite from Sprite in code?

Unity Engine
1

This may be slightly unusual, but I’m modding a Unity game where some of the objects need an AssetReferenceSprite. Unfortunately I’m not a Unity programmer and I’m approaching this purely from C#. What I would like to do is load a .png/.jpg etc as a Sprite (can do already) and then create an AssetReferenceSprite from that, so:

var sprite = CreateSprite(...);  // done

… then what :slight_smile: ?

I feel that I should be able to do something like

Addressables.LoadAssetAsync<Sprite>(new MySpriteResource()).ExecuteUntilDone();

MySpriteResource : IResourceLocation { ... }

Is it possible?

2

Further investigation makes me think I can derive from ResourceProviderBase and ResourceLocationBase but I haven’t worked out how add my resource provider to the ResourceManager or how to get the presumably single instance of ResourceManager.

3

If anyone’s interested this is possible. Here’s most of the applicable code.

   internal static class ResourceLocatorContext
    {
        public static void Load()
        {
            // Add our resource provider - no public API?
            Addressables.ResourceManager
                .GetField<IList<IResourceProvider>>("m_ResourceProviders")
                .TryAdd(SpriteResourceProvider.Instance);

            // Add our resource locator - there is a public API.
            Addressables.AddResourceLocator(SpriteResourceLocator.Instance);
        }
    }

    // ResourceProvider provides the resource given the resource location
    internal class SpriteResourceProvider : ResourceProviderBase
    {
        public static SpriteResourceProvider Instance { get; } = new SpriteResourceProvider();

        public override void Provide(ProvideHandle provideHandle)
        {
            var location = (SpriteResourceLocation)provideHandle.Location;

            Main.Log($"SpriteResourceProvider.Provide: InternalId='{location.InternalId}', ProviderId='{location.ProviderId}', PrimaryKey='{location.PrimaryKey}', SpriteName='{location.Sprite.name}'.");

            provideHandle.Complete(location.Sprite, true, null);
        }

        public override bool CanProvide(Type t, IResourceLocation location)
        {
            var canProvide = base.CanProvide(t, location);

            Main.Log($"SpriteResourceProvider.CanProvide: TypeName='{t.Name}', InternalId='{location.InternalId}', CanProvide={canProvide}");

            return canProvide;
        }

        public override Type GetDefaultType(IResourceLocation location)
        {
            return typeof(Sprite);
        }

        protected SpriteResourceProvider() { }
    }

    // ResourceLocator returns location of resource
    internal class SpriteResourceLocator : IResourceLocator
    {
        private static readonly Dictionary<string, SpriteResourceLocation> locationsCache = new();
        private static readonly List<IResourceLocation> emptyList = new();

        public static SpriteResourceLocator Instance { get; } = new SpriteResourceLocator();
       
        // These two properties don't seem to be used
        public string LocatorId => GetType().FullName;
        public IEnumerable<object> Keys => locationsCache.Keys;

        public bool Locate(object key, Type type, out IList<IResourceLocation> locations)
        {
            var id = key.ToString();
            var sprite = CustomIcons.GetSpriteByGuid(id);

            if (sprite != null)
            {
                Main.Log($"SpriteResourceLocator.Locate: key={key}, type={type}, sprite={sprite.name}");

                if (!locationsCache.TryGetValue(id, out var location))
                {
                    location = new SpriteResourceLocation(sprite, sprite.name, id);
                    locationsCache.Add(id, location);
                }

                locations = new List<IResourceLocation> { location };
                return true;
            }
            else
            {
                locations = emptyList;
                return false;
            }
        }

        protected SpriteResourceLocator() { }
    }

    // ResourceLocation of sprite used by ResourceProvider.  We're using it to directly hold the sprite.
    internal class SpriteResourceLocation : ResourceLocationBase
    {
        private Sprite sprite;

        public Sprite Sprite
        {
            get
            {
                Main.Log($"SpriteResourceLocation.GetSprite: {sprite.name}");

                return sprite;
            }
            private set
            {
                sprite = value;
            }
        }

        public SpriteResourceLocation(Sprite sprite, string name, string id)
            : base(name, id, typeof(SpriteResourceProvider).FullName, typeof(Sprite))
        {
            Sprite = sprite;
        }
    }