IHomeDesignerAPI.cs

using System.Collections.Generic;

namespace HappyHomeDesigner;

public interface IHomeDesignerAPI
{
	/// <summary>Whether or not a catalogue is open on the current screen</summary>
	public bool IsCatalogOpen { get; }

	/// <summary>Try to open the menu</summary>
	/// <param name="catalogues">The list of catalogue shops to display in the menu. Leave this empty to show all of them.</param>
	/// <returns>If the catalogue was sucessfully opened</returns>
	public bool TryOpenCatalogue(params IEnumerable<string> catalogues);

	/// <summary>Register a mod which attaches catalogue shops to furniture items</summary>
	public void AddCatalogueProvider(ICatalogueProvider provider);

	/// <summary>Call this when a provider's catalogue list changes</summary>
	public void InvalidateProviderCache();

	public interface ICatalogueProvider
	{
		/// <summary>Returns a sequence of pairs, where the key is the qualified item ID and the value is the shop id associated with the catalogue item.</summary>
		IEnumerable<KeyValuePair<string, string>> GetCatalogues();
	}
}