API.cs

using System;
using System.Collections.Generic;
using System.Linq;
using static ExtraSlots.Slots;

namespace ExtraSlots;

public static class API
{
    /// <summary>
    /// Player custom-data key containing ExtraSlots deferred inventory escrow.
    /// Format: int envelope version, int entry count, then for each entry
    /// prefab name, preferred slot id, restore-equipped flag, original stack size,
    /// and an opaque Base64 string containing a ZPackage whose first value is a compressed
    /// vanilla Inventory.Save ZPackage with exactly one item. Readers can check the prefab
    /// name before decompressing or parsing the item payload.
    /// </summary>
    public const string DeferredInventoryCustomDataKey = DeferredInventory.CustomDataKey;

    /// <summary>Current deferred inventory envelope version.</summary>
    public const int DeferredInventoryEnvelopeVersion = DeferredInventory.EnvelopeVersion;

    /// <summary>
    /// Returns list of all slots
    /// </summary>
    public static List<Slot> GetExtraSlots() => slots.ToList();

    /// <summary>
    /// Returns list of corresponding slots
    /// </summary>
    public static List<Slot> GetEquipmentSlots() => slots.Where(slot => slot.IsEquipmentSlot).ToList();

    /// <summary>
    /// Returns list of corresponding slots
    /// </summary>
    public static List<Slot> GetQuickSlots() => slots.Where(slot => slot.IsQuickSlot).ToList();

    /// <summary>
    /// Returns list of corresponding slots
    /// </summary>
    public static List<Slot> GetFoodSlots() => slots.Where(slot => slot.IsFoodSlot).ToList();

    /// <summary>
    /// Returns list of corresponding slots
    /// </summary>
    public static List<Slot> GetAmmoSlots() => slots.Where(slot => slot.IsAmmoSlot).ToList();

    /// <summary>
    /// Returns list of corresponding slots
    /// </summary>
    public static List<Slot> GetMiscSlots() => slots.Where(slot => slot.IsMiscSlot).ToList();

    /// <summary>
    /// Returns slot with given ID
    /// </summary>
    /// <param name="slotID"></param>
    public static Slot FindSlot(string slotID) => slots.FirstOrDefault(slot => slot.ID == slotID || slot.ID == CustomSlot.GetSlotID(slotID));

    /// <summary>
    /// Returns list of items located in extra slots
    /// </summary>
    /// <returns>List of not null ItemDrop.ItemData</returns>
    public static List<ItemDrop.ItemData> GetAllExtraSlotsItems() => slots.Select(slot => slot.Item).Where(item => item != null).ToList();

    /// <summary>
    /// Returns list of items located in corresponding slots
    /// </summary>
    /// <returns>List of not null ItemDrop.ItemData</returns>
    public static List<ItemDrop.ItemData> GetEquipmentSlotsItems() => GetEquipmentSlots().Select(slot => slot.Item).Where(item => item != null).ToList();

    /// <summary>
    /// Returns list of items located in corresponding slots
    /// </summary>
    /// <returns>List of not null ItemDrop.ItemData</returns>
    public static List<ItemDrop.ItemData> GetQuickSlotsItems() => GetQuickSlots().Select(slot => slot.Item).Where(item => item != null).ToList();

    /// <summary>
    /// Returns list of items located in corresponding slots
    /// </summary>
    /// <returns>List of not null ItemDrop.ItemData</returns>
    public static List<ItemDrop.ItemData> GetFoodSlotsItems() => GetFoodSlots().Select(slot => slot.Item).Where(item => item != null).ToList();

    /// <summary>
    /// Returns list of items located in corresponding slots
    /// </summary>
    /// <returns>List of not null ItemDrop.ItemData</returns>
    public static List<ItemDrop.ItemData> GetAmmoSlotsItems() => GetAmmoSlots().Select(slot => slot.Item).Where(item => item != null).ToList();

    /// <summary>
    /// Returns list of items located in corresponding slots
    /// </summary>
    /// <returns>List of not null ItemDrop.ItemData</returns>
    public static List<ItemDrop.ItemData> GetMiscSlotsItems() => GetMiscSlots().Select(slot => slot.Item).Where(item => item != null).ToList();

    /// <summary>
    /// Tries to find the existing element displaying a real inventory item on a vanilla or ExtraSlots hotbar.
    /// ExtraSlots element indices are inventory columns, not the panel's visual slot order.
    /// Returns false for unsupported bars, missing elements or items not represented by the bar.
    /// </summary>
    public static bool TryGetHotbarElement(HotkeyBar bar, ItemDrop.ItemData item, out HotkeyBar.ElementData element) =>
        HotBars.QuickBars.TryGetElementForItem(bar, item, out element);

    /// <summary>
    /// Returns amount of extra rows added to player available inventory
    /// </summary>
    public static int GetExtraRows() => ExtraRowsPlayer;

    /// <summary>
    /// Returns full height of inventory
    /// </summary>
    public static int GetInventoryHeightFull() => InventoryHeightFull;

    /// <summary>
    /// Returns full height of inventory
    /// </summary>
    public static int GetInventoryHeightPlayer() => InventoryHeightPlayer;

    /// <summary>
    /// Returns if given position is extra slot
    /// </summary>
    /// <param name="gridPos">Position in inventory grid</param>
    public static bool IsGridPositionASlot(Vector2i gridPos) => Slots.IsGridPositionASlot(gridPos);

    /// <summary>
    /// Returns if given item is in extra slot
    /// </summary>
    /// <param name="item"></param>
    public static bool IsItemInSlot(ItemDrop.ItemData item) => Slots.IsItemInSlot(item);

    /// <summary>
    /// Returns if given item is in equipment slot
    /// </summary>
    /// <param name="item"></param>
    public static bool IsItemInEquipmentSlot(ItemDrop.ItemData item) => Slots.IsItemInEquipmentSlot(item);

    /// <summary>
    /// Returns if any global key or player unique key from comma-separated string is enabled.
    /// Respects if slots progression is enabled
    /// </summary>
    /// <param name="requiredKeys">Comma-separated list of global keys and player unique keys</param>
    public static bool IsAnyGlobalKeyActive(string requiredKeys) => SlotsProgression.IsAnyGlobalKeyActive(requiredKeys);

    /// <summary>
    /// Returns if any global key or player unique key from comma-separated string is enabled.
    /// Respects if slots progression is enabled
    /// </summary>
    /// <param name="itemType"></param>
    public static bool IsItemTypeKnown(ItemDrop.ItemData.ItemType itemType) => SlotsProgression.IsItemTypeKnown(itemType);

    /// <summary>
    /// Returns if any global key or player unique key from comma-separated string is enabled.
    /// Respects if slots progression is enabled
    /// </summary>
    /// <param name="itemNames">Comma-separated list of item names (m_shared.m_name)</param>
    public static bool IsAnyMaterialDiscovered(string itemNames) => SlotsProgression.IsAnyMaterialDiscovered(itemNames);

    /// <summary>
    /// Adds new custom equipment slot at first available position
    /// </summary>
    /// <param name="slotID">To add new slot ID should be unique. If given ID is not unique returns true if slot is already created</param>
    /// <param name="getName">function that return slot name how it should be seen in the UI. Localization is recommended.</param>
    /// <param name="itemIsValid">function to check of item fits the slot</param>
    /// <param name="isActive">function to check if slot should be available in equipment panel. If you need live update - call UpdateSlots.</param>
    /// <returns></returns>
    public static bool AddSlot(string slotID, Func<string> getName, Func<ItemDrop.ItemData, bool> itemIsValid, Func<bool> isActive)
    {
        return CustomSlot.TryAddNewSlotWithIndex(slotID, slotIndex: -1, getName, itemIsValid, isActive);
    }

    /// <summary>
    /// Adds new custom equipment slot with set position
    /// </summary>
    /// <param name="slotID">To add new slot ID should be unique. If given ID is not unique returns true if slot is already created</param>
    /// <param name="slotIndex">-1 to take first available empty slot. Otherwise shift other slots to the right and insert into position after vanilla equipment slots</param>
    /// <param name="getName">function that return slot name how it should be seen in the UI. Localization is recommended.</param>
    /// <param name="itemIsValid">function to check of item fits the slot</param>
    /// <param name="isActive">function to check if slot should be available in equipment panel. If you need live update - call UpdateSlots.</param>
    /// <returns></returns>
    public static bool AddSlotWithIndex(string slotID, int slotIndex, Func<string> getName, Func<ItemDrop.ItemData, bool> itemIsValid, Func<bool> isActive)
    {
        return CustomSlot.TryAddNewSlotWithIndex(slotID, slotIndex, getName, itemIsValid, isActive);
    }

    /// <summary>
    /// Adds new custom equipment slot with set position
    /// </summary>
    /// <param name="slotID">To add new slot ID should be unique. If given ID is not unique returns true if slot is already created</param>
    /// <param name="getName">function that return slot name how it should be seen in the UI. Localization is recommended.</param>
    /// <param name="itemIsValid">function to check of item fits the slot</param>
    /// <param name="isActive">function to check if slot should be available in equipment panel. If you need live update - call UpdateSlots.</param>
    /// <param name="slotIDs">slot IDs to add the slot before</param>
    /// <returns></returns>
    [Obsolete("Use AddSlotAfter instead.")]
    public static bool AddSlotBefore(string slotID, Func<string> getName, Func<ItemDrop.ItemData, bool> itemIsValid, Func<bool> isActive, params string[] slotIDs)
    {
        return AddSlotAfter(slotID, getName, itemIsValid, isActive, slotIDs);
    }

    /// <summary>
    /// Adds new custom equipment slot with set position
    /// </summary>
    /// <param name="slotID">To add new slot ID should be unique. If given ID is not unique returns true if slot is already created</param>
    /// <param name="getName">function that return slot name how it should be seen in the UI. Localization is recommended.</param>
    /// <param name="itemIsValid">function to check of item fits the slot</param>
    /// <param name="isActive">function to check if slot should be available in equipment panel. If you need live update - call UpdateSlots.</param>
    /// <param name="slotIDs">slot IDs after which the slot should be added</param>
    /// <returns></returns>
    public static bool AddSlotAfter(string slotID, Func<string> getName, Func<ItemDrop.ItemData, bool> itemIsValid, Func<bool> isActive, params string[] slotIDs)
    {
        return CustomSlot.TryAddNewSlotAfter(slotIDs, slotID, getName, itemIsValid, isActive);
    }

    /// <summary>
    /// Tries to remove custom slot with given ID
    /// </summary>
    /// <param name="slotID"></param>
    public static bool RemoveSlot(string slotID) => CustomSlot.TryRemoveSlot(slotID);

    /// <summary>
    /// Calls an update to slots layout and equipment panel
    /// Should be called if slot active state was changed to update panel
    /// </summary>
    public static void UpdateSlots()
    {
        UpdateSlotsGridPosition();
        UpdateSlotActivation();
        LightenedSlots.UpdateState();
        HotBars.PreventSimilarHotkeys.FillSimilarHotkey();
    }

    internal static void UpdateSlotActivation()
    {
        DeferredInventory.InvalidateRestorationOpportunity();
        ClearCachedItems();
        EquipmentPanel.UpdatePanel();
        ItemsSlotsValidation.ValidateItems();
        ItemsSlotsValidation.ValidateSlots();
        HotBars.QuickSlotsHotBar.MarkDirty();
        HotBars.AmmoSlotsHotBar.MarkDirty();
        HotBars.FoodSlotsHotBar.MarkDirty();
        Compatibility.EpicLootCompat.InvalidatePlayerEffectCache(Player.m_localPlayer);
    }
}