Create better inventory caching system about smlhelper HOT 2 CLOSED

Currently, the HasRoomCacheCollection of ItemsContainerPatcher only caches a small set of values that indicate if an item of size X_Y will fit in the container.

This likely will expand into a new class that stores this data as well as any other ItemContainer data that is useful to cache and have mods consult through a new public class in SMLHelper.

from smlhelper.

Current suggested interface features:

int MaxPossibleSingleSlots(ItemsContainer container);

int FreeSingleSlotsCount(ItemsContainer container);

bool HasRoomForItemSize(IItemsContainer container, int sizeX, int sizeY);

bool HasRoomForItemSize(IItemsContainer container, Vector2int sizeVector, out bool cached);

bool ContainerEmpty(IItemsContainer container);

bool ContainerFull(IItemsContainer container);

string MainHoverText(IItemsContainer container);

string ExtraHoverText(IItemsContainer container);

If we keep a dictionary that links containers to free slots we can extrapolate:

• Is the container full (free slots 0 or alternatively used slots == sizeX*sizeY)?
• Can an item of size (X,Y) fit inside the container?
• Expose information to mods for tooltips, etc.

Alternatively we can keep two or more caches:

• bool cache for HasRoom
• int cache for free slots
• Anything else that comes up

I do not yet know for sure if we need to change anything about the Harmony patch. It depends on how the helper method ends up looking.

from smlhelper.