feat: Add Mimic PlayerInventory API hook

Author: osipxd

CHANGELOG.md

@@ -3,6 +3,7 @@
 ### Added
 
 - [Documentation](https://endlesscodegroup.github.io/ECInventory/docs/intro)
+- Support of Mimic PlayerInventory API to integrate with other plugins
 
 ### Changed
 

core/src/main/kotlin/ECInventoryPlugin.kt

@@ -24,6 +24,7 @@ import org.bukkit.plugin.java.JavaPlugin
 import ru.endlesscode.inventory.internal.compat.BukkitVersion
 import ru.endlesscode.inventory.internal.di.DI
 import ru.endlesscode.inventory.internal.di.DataModule
+import ru.endlesscode.inventory.internal.hooks.EcInventoryPlayerInventory
 import ru.endlesscode.inventory.internal.hooks.PlaceholderApiPlaceholders
 import ru.endlesscode.inventory.internal.listener.InventoryClicksRouter
 import ru.endlesscode.inventory.internal.listener.PlayerInventoriesLoader
@@ -108,6 +109,7 @@ public class ECInventoryPlugin : JavaPlugin() {
             Please download latest version: https://www.spigotmc.org/resources/mimic.82515/
             """.trimIndent()
         }
+        EcInventoryPlayerInventory.hook(this)
     }
 
     private fun makeSure(action: () -> Boolean): Boolean {

core/src/main/kotlin/internal/data/repository/InventoriesRepository.kt

@@ -42,6 +42,8 @@ internal class InventoriesRepository(
 
     private val cache = InventoriesCache()
 
+    fun getInventories(player: Player): Sequence<CustomInventory> = cache.getInventories(player.uniqueId)
+
     fun getInventory(player: Player, type: String): CustomInventory {
         val inventory = cache.getInventories(player.uniqueId).find { it.type == type }
         return inventory ?: createInventory(player, type)

core/src/main/kotlin/internal/di/DI.kt

@@ -34,7 +34,7 @@ internal object DI {
     val scheduler: TaskScheduler by lazy { PluginTaskScheduler(plugin) }
 
     // Hooks
-    private val mimic: Mimic by lazy { Mimic.getInstance() }
+    val mimic: Mimic by lazy { Mimic.getInstance() }
     val itemsRegistry: BukkitItemsRegistry by lazy { mimic.getItemsRegistry() }
     var placeholders: Placeholders = DisabledPlaceholders()
 

core/src/main/kotlin/internal/hooks/EcInventoryPlayerInventory.kt

@@ -0,0 +1,60 @@
+/*
+ * This file is part of ECInventory
+ * <https://github.com/EndlessCodeGroup/ECInventory>.
+ * Copyright (c) 2022 EndlessCode Group and contributors
+ *
+ * ECInventory is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * ECInventory is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with ECInventory. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package ru.endlesscode.inventory.internal.hooks
+
+import org.bukkit.entity.Player
+import org.bukkit.inventory.ItemStack
+import org.bukkit.plugin.Plugin
+import org.bukkit.plugin.ServicePriority.High
+import ru.endlesscode.inventory.internal.data.repository.InventoriesRepository
+import ru.endlesscode.inventory.internal.di.DI
+import ru.endlesscode.inventory.slot.SlotContentType
+import ru.endlesscode.mimic.ExperimentalMimicApi
+import ru.endlesscode.mimic.MimicApiLevel.VERSION_0_8
+import ru.endlesscode.mimic.inventory.BukkitPlayerInventory
+
+@Suppress("UnstableApiUsage")
+@OptIn(ExperimentalMimicApi::class)
+internal class EcInventoryPlayerInventory(
+    player: Player,
+    private val inventoriesRepository: InventoriesRepository,
+) : BukkitPlayerInventory(player) {
+
+    constructor(player: Player) : this(player, DI.data.inventoriesRepository)
+
+    override val equippedItems: List<ItemStack>
+        get() = collectEquippedItems(collectItems(SlotContentType.EQUIPMENT))
+
+    override val storedItems: List<ItemStack>
+        get() = collectStoredItems(collectItems(SlotContentType.GENERIC))
+
+    private fun collectItems(type: SlotContentType): List<ItemStack> {
+        return inventoriesRepository.getInventories(player)
+            .flatMap { it.getContainerSlots(type) }
+            .map { it.content }
+            .toList()
+    }
+
+    companion object {
+        fun hook(plugin: Plugin) {
+            DI.mimic.registerPlayerInventoryProvider(::EcInventoryPlayerInventory, VERSION_0_8, plugin, priority = High)
+        }
+    }
+}