Expand API for Better Mod Support

[KhloeLeclair]

What do these changes do?

There are a couple things here.

First off, this updates for Stardew 1.5.5 as documented in the migration guide for 1.5.5.

Second, this fixes a bug I noticed with the vanilla crafting page and this mod where it was storing the user's held item in Game1.player.CursorSlotItem while CraftingPage has its own private field for that.

Finally, this expands the API. My changes allow other mods to register custom handlers for their mods. The new method signature is as follows:

bool RegisterBasicMenu(
	Type menuType,
	Func<IClickableMenu, InventoryMenu> inventoryGetter,
	Func<IClickableMenu, IReflectedField<Item>> hoveredItemFieldGetter,
	Func<IClickableMenu, IReflectedField<Item>> heldItemFieldGetter,
	Func<IClickableMenu, Point, Tuple<int, Action<bool, int>>> stackChecker
);

By combining these Funcs with custom GameMenuPageHandler and MenuHandlers, it is possible for a mod to:

1. Add SSR support to its own menus' InventoryMenu instances.
2. Add SSR to arbitrary menu elements.

To give an example, I have developed this by testing it with my own mod Better Crafting, which reimplements the crafting menu. I have used the following code:

API.RegisterBasicMenu(
	menuType: typeof(BetterCraftingPage),
	inventoryGetter: page => (page as BetterCraftingPage)?.inventory,
	hoveredItemFieldGetter: page => {
		if (page is not BetterCraftingPage bcp)
			return null;
		return Self.Helper.Reflection.GetField<Item>(bcp, "hoverItem");
	},
	heldItemFieldGetter: page => {
		if (page is not BetterCraftingPage bcp)
			return null;
		return Self.Helper.Reflection.GetField<Item>(bcp, "HeldItem");
	},
	stackChecker: (page, point) => {
		if (page is not BetterCraftingPage bcp)
			return null;

		if (bcp.Editing)
			return null;

		var recipe = bcp.GetRecipeUnderCursor(point.X, point.Y);
		if (recipe == null)
			return null;

		if (!bcp.CanPerformCraft(recipe))
			return null;

		return new Tuple<int, Action<bool, int>>(recipe.QuantityPerCraft, (success, amount) => {
			int times = (int) Math.Ceiling((double) amount / recipe.QuantityPerCraft);

			bcp.PerformCraft(
				recipe,
				times
			);
		});
	}
);

With this amount of code, SSR is able to function normally on Better Crafting's crafting menu. It displays a split menu as expected when interacting with the inventory, as well as when interacting with a crafting recipe.

SSR doesn't need to know about my mod's crafting logic. My mod doesn't need to know about SSR's menu logic.

I feel like this is the best balance we can strike between mods.

Are there changes in behavior for the user?

More, and better mod support?

Related issue number

There is no existing GitHub issue, but a bug was opened on NexusMods.

Checklist

• I think the code is well written
• Documentation reflects the changes