mirror of
https://github.com/pmmp/PocketMine-MP.git
synced 2025-09-06 01:46:04 +00:00
Separate inventory holder info from container & player inventories (#6533)
This PR breaks the cyclic dependency between `Inventory` and its holder, which unblocks a lot of new developments. ### Related issues & PRs - Fixes #5033 - Removes a blocker for #6147 (which in turn means that async tasks will eventually be able to work with tiles) - Removes a blocker for #2684 ## Changes ### API changes - `Player->getCurrentWindow()` now returns `?InventoryWindow` instead of `?Inventory` - `Player->setCurrentWindow()` now accepts `?InventoryWindow` instead of `?Inventory` - `InventoryWindow` introduced, which is created for each player viewing the inventory, provides decorative information like holder info for `InventoryTransactionEvent`, and is destroyed when the window is closed, eliminating cyclic references - Added: - `player\InventoryWindow` - `player\PlayerInventoryWindow` - wraps all permanent inventories of Player with type info for transactions - `inventory\Hotbar` - replaces all hotbar usages in `PlayerInventory` - `Human->getHotbar()` - `Human->getMainHandItem()`, `Human->setMainHandItem()`, `Human->getOffHandItem()`, `Human->setOffHandItem()` - `block\utils\AnimatedContainerLike` & `block\utils\AnimatedContainerLikeTrait` (for chests, shulkerboxes, etc) - `block\utils\Container` & `block\utils\ContainerTrait` for blocks containing items (chests, etc) - `block\utils\MenuAccessor` implemented by all blocks that can open inventory menus - `block\utils\MenuAccessorTrait` used by blocks with menus but without inventories (anvils, crafting tables etc) - Removed: - `inventory\DelegateInventory` (only used for ender chests) - `inventory\PlayerInventory`, - `inventory\PlayerOffHandInventory`, - `inventory\PlayerCraftingInventory`, - `inventory\PlayerCursorInventory` - these have all been internally replaced by `SimpleInventory` & they will appear as `PlayerInventoryWindow` in transactions (check `getType()` against the `PlayerInventoryWindow::TYPE_*` constants to identify them) - `block\inventory\AnimatedBlockInventoryTrait`, (blocks now handle this logic directly using `AnimatedContainer` and `AnimatedContainerTrait`) - `block\inventory\BlockInventoryTrait`, - `block\inventory\BlockInventory` - Most `BlockInventory` classes have been transitioned to `InventoryWindow` wrappers - Tiles now all use `SimpleInventory` internally (no cyclic references) except for `Chest` (which uses `CombinedInventory`, without holder info) - `InventoryOpenEvent` and `InventoryCloseEvent` now provide `InventoryWindow` instead of `Inventory` (to provide type information) - `InventoryTransaction` and `SlotChangeAction` now provide `InventoryWindow` instead of `Inventory` - Renamed `TransactionBuilderInventory` to `SlotChangeActionBuilder` - `TransactionBuilderInventory->getBuilder()` now accepts `InventoryWindow` instead of `Inventory` - `DoubleChestInventory` superseded by `CombinedInventory` - this new class allows combining any number of inventories behind a single object; mainly used for double chests but plugins could use it to do lots of fun things ### Impacts to plugins Plugins can now do the following: ```php $block = $world->getBlockAt($x, $y, $z); if($block instanceof MenuAccessor){ $block->openToUnchecked($player); } ``` As compared to the old way: ```php $tile = $world->getTileAt($x, $y, $z); if($tile instanceof Container){ $player->setCurrentWindow($tile->getInventory()); } ``` #### Advantages - No tile access needed - Works for menu blocks without inventories as well as container blocks - Less code ### Behavioural changes Inventories no longer keep permanent cyclic references to their holders. ## Backwards compatibility This makes significant BC breaks. However, all changes are able to be adapted to and the same amount of information is present on all APIs and events. ## Follow-up - Implement #6147 - Support inventory inheritance when copying blocks from one position to another
This commit is contained in:
Dylan T.
GitHub
270
tests/phpunit/inventory/CombinedInventoryProxyTest.php
Normal file
270
tests/phpunit/inventory/CombinedInventoryProxyTest.php
Normal file
@ -0,0 +1,270 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
*
|
||||
* ____ _ _ __ __ _ __ __ ____
|
||||
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
|
||||
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
|
||||
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
|
||||
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* @author PocketMine Team
|
||||
* @link http://www.pocketmine.net/
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace pocketmine\inventory;
|
||||
|
||||
use PHPUnit\Framework\Attributes\DataProvider;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use pocketmine\item\Item;
|
||||
use pocketmine\item\ItemTypeIds;
|
||||
use pocketmine\item\VanillaItems;
|
||||
use function array_filter;
|
||||
|
||||
final class CombinedInventoryProxyTest extends TestCase{
|
||||
|
||||
/**
|
||||
* @return Inventory[]
|
||||
* @phpstan-return list<Inventory>
|
||||
*/
|
||||
private function createInventories() : array{
|
||||
$inventory1 = new SimpleInventory(1);
|
||||
$inventory1->setItem(0, VanillaItems::APPLE());
|
||||
$inventory2 = new SimpleInventory(1);
|
||||
$inventory2->setItem(0, VanillaItems::PAPER());
|
||||
$inventory3 = new SimpleInventory(2);
|
||||
$inventory3->setItem(1, VanillaItems::BONE());
|
||||
|
||||
return [$inventory1, $inventory2, $inventory3];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Item[] $items
|
||||
* @phpstan-param array<int, Item> $items
|
||||
*/
|
||||
private function verifyReadItems(array $items) : void{
|
||||
self::assertSame(ItemTypeIds::APPLE, $items[0]->getTypeId());
|
||||
self::assertSame(ItemTypeIds::PAPER, $items[1]->getTypeId());
|
||||
self::assertTrue($items[2]->isNull());
|
||||
self::assertSame(ItemTypeIds::BONE, $items[3]->getTypeId());
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Item[]
|
||||
* @phpstan-return list<Item>
|
||||
*/
|
||||
private static function getAltItems() : array{
|
||||
return [
|
||||
VanillaItems::AMETHYST_SHARD(),
|
||||
VanillaItems::AIR(), //null item
|
||||
VanillaItems::BLAZE_POWDER(),
|
||||
VanillaItems::BRICK()
|
||||
];
|
||||
}
|
||||
|
||||
public function testGetItem() : void{
|
||||
$inventory = new CombinedInventoryProxy($this->createInventories());
|
||||
|
||||
$this->verifyReadItems([
|
||||
$inventory->getItem(0),
|
||||
$inventory->getItem(1),
|
||||
$inventory->getItem(2),
|
||||
$inventory->getItem(3)
|
||||
]);
|
||||
|
||||
$this->expectException(\InvalidArgumentException::class);
|
||||
$inventory->getItem(4);
|
||||
}
|
||||
|
||||
public function testGetContents() : void{
|
||||
$inventory = new CombinedInventoryProxy($this->createInventories());
|
||||
|
||||
$this->verifyReadItems($inventory->getContents(includeEmpty: true));
|
||||
|
||||
$contentsWithoutEmpty = $inventory->getContents(includeEmpty: false);
|
||||
self::assertFalse(isset($contentsWithoutEmpty[2]), "This index should not be set during this test");
|
||||
self::assertCount(3, $contentsWithoutEmpty);
|
||||
$this->verifyReadItems([
|
||||
$contentsWithoutEmpty[0],
|
||||
$contentsWithoutEmpty[1],
|
||||
VanillaItems::AIR(),
|
||||
$contentsWithoutEmpty[3]
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Inventory[] $backing
|
||||
* @param Item[] $altItems
|
||||
*
|
||||
* @phpstan-param array<int, Inventory> $backing
|
||||
* @phpstan-param array<int, Item> $altItems
|
||||
*/
|
||||
private function verifyWriteItems(array $backing, array $altItems) : void{
|
||||
foreach([
|
||||
0 => [$backing[0], 0],
|
||||
1 => [$backing[1], 0],
|
||||
2 => [$backing[2], 0],
|
||||
3 => [$backing[2], 1]
|
||||
] as $combinedSlot => [$backingInventory, $backingSlot]){
|
||||
if(!isset($altItems[$combinedSlot])){
|
||||
self::assertTrue($backingInventory->isSlotEmpty($backingSlot));
|
||||
}else{
|
||||
self::assertSame($altItems[$combinedSlot]->getTypeId(), $backingInventory->getItem($backingSlot)->getTypeId());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public function testSetItem() : void{
|
||||
$backing = $this->createInventories();
|
||||
$inventory = new CombinedInventoryProxy($backing);
|
||||
|
||||
$altItems = self::getAltItems();
|
||||
foreach($altItems as $slot => $item){
|
||||
$inventory->setItem($slot, $item);
|
||||
}
|
||||
$this->verifyWriteItems($backing, $altItems);
|
||||
|
||||
$this->expectException(\InvalidArgumentException::class);
|
||||
$inventory->setItem(4, VanillaItems::BRICK());
|
||||
}
|
||||
|
||||
/**
|
||||
* @phpstan-return \Generator<int, array{array<int, Item>}, void, void>
|
||||
*/
|
||||
public static function setContentsProvider() : \Generator{
|
||||
$altItems = self::getAltItems();
|
||||
|
||||
yield [$altItems];
|
||||
yield [array_filter($altItems, fn(Item $item) => !$item->isNull())];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Item[] $altItems
|
||||
* @phpstan-param array<int, Item> $altItems
|
||||
*/
|
||||
#[DataProvider("setContentsProvider")]
|
||||
public function testSetContents(array $altItems) : void{
|
||||
$backing = $this->createInventories();
|
||||
$inventory = new CombinedInventoryProxy($backing);
|
||||
$inventory->setContents($altItems);
|
||||
|
||||
$this->verifyWriteItems($backing, $altItems);
|
||||
}
|
||||
|
||||
public function testGetSize() : void{
|
||||
self::assertSame(4, (new CombinedInventoryProxy($this->createInventories()))->getSize());
|
||||
}
|
||||
|
||||
public function testGetMatchingItemCount() : void{
|
||||
$inventory = new CombinedInventoryProxy($this->createInventories());
|
||||
//we don't need to test the base functionality, only ensure that the correct delegate is called
|
||||
self::assertSame(1, $inventory->getMatchingItemCount(3, VanillaItems::BONE(), true));
|
||||
self::assertNotSame(1, $inventory->getMatchingItemCount(3, VanillaItems::PAPER(), true));
|
||||
}
|
||||
|
||||
public function testIsSlotEmpty() : void{
|
||||
$inventory = new CombinedInventoryProxy($this->createInventories());
|
||||
|
||||
self::assertTrue($inventory->isSlotEmpty(2));
|
||||
self::assertFalse($inventory->isSlotEmpty(0));
|
||||
self::assertFalse($inventory->isSlotEmpty(1));
|
||||
self::assertFalse($inventory->isSlotEmpty(3));
|
||||
}
|
||||
|
||||
public function testListenersOnProxySlotUpdate() : void{
|
||||
$inventory = new CombinedInventoryProxy($this->createInventories());
|
||||
|
||||
$numChanges = 0;
|
||||
$inventory->getListeners()->add(new CallbackInventoryListener(
|
||||
onSlotChange: function(Inventory $inventory, int $slot, Item $before) use (&$numChanges) : void{
|
||||
$numChanges++;
|
||||
},
|
||||
onContentChange: null
|
||||
));
|
||||
$inventory->setItem(0, VanillaItems::DIAMOND_SWORD());
|
||||
self::assertSame(1, $numChanges, "Inventory listener detected wrong number of changes");
|
||||
}
|
||||
|
||||
public function testListenersOnProxyContentUpdate() : void{
|
||||
$inventory = new CombinedInventoryProxy($this->createInventories());
|
||||
|
||||
$numChanges = 0;
|
||||
$inventory->getListeners()->add(new CallbackInventoryListener(
|
||||
onSlotChange: null,
|
||||
onContentChange: function(Inventory $inventory, array $oldItems) use (&$numChanges) : void{
|
||||
$numChanges++;
|
||||
}
|
||||
));
|
||||
$inventory->setContents(self::getAltItems());
|
||||
self::assertSame(1, $numChanges, "Expected onContentChange to be called exactly 1 time");
|
||||
}
|
||||
|
||||
public function testListenersOnBackingSlotUpdate() : void{
|
||||
$backing = $this->createInventories();
|
||||
$inventory = new CombinedInventoryProxy($backing);
|
||||
|
||||
$slotChangeDetected = null;
|
||||
$numChanges = 0;
|
||||
$inventory->getListeners()->add(new CallbackInventoryListener(
|
||||
onSlotChange: function(Inventory $inventory, int $slot, Item $before) use (&$slotChangeDetected, &$numChanges) : void{
|
||||
$slotChangeDetected = $slot;
|
||||
$numChanges++;
|
||||
},
|
||||
onContentChange: null
|
||||
));
|
||||
$backing[2]->setItem(0, VanillaItems::DIAMOND_SWORD());
|
||||
self::assertNotNull($slotChangeDetected, "Inventory listener didn't hear about backing inventory update");
|
||||
self::assertSame(2, $slotChangeDetected, "Inventory listener detected unexpected slot change");
|
||||
self::assertSame(1, $numChanges, "Inventory listener detected wrong number of changes");
|
||||
}
|
||||
|
||||
/**
|
||||
* When a combined inventory has multiple backing inventories, content updates of the backing inventories must be
|
||||
* turned into slot updates on the proxy, to avoid syncing the entire proxy inventory.
|
||||
*/
|
||||
public function testListenersOnBackingContentUpdate() : void{
|
||||
$backing = $this->createInventories();
|
||||
$inventory = new CombinedInventoryProxy($backing);
|
||||
|
||||
$slotChanges = [];
|
||||
$inventory->getListeners()->add(new CallbackInventoryListener(
|
||||
onSlotChange: function(Inventory $inventory, int $slot, Item $before) use (&$slotChanges) : void{
|
||||
$slotChanges[] = $slot;
|
||||
},
|
||||
onContentChange: null
|
||||
));
|
||||
$backing[2]->setContents([VanillaItems::DIAMOND_SWORD(), VanillaItems::DIAMOND()]);
|
||||
self::assertCount(2, $slotChanges, "Inventory listener detected wrong number of changes");
|
||||
self::assertSame([2, 3], $slotChanges, "Incorrect slots updated");
|
||||
}
|
||||
|
||||
/**
|
||||
* If a combined inventory has only 1 backing inventory, content updates on the backing inventory can be directly
|
||||
* processed as content updates on the proxy inventory without modification. This allows optimizations when only 1
|
||||
* backing inventory is used.
|
||||
* This test verifies that this special case works as expected.
|
||||
*/
|
||||
public function testListenersOnSingleBackingContentUpdate() : void{
|
||||
$backing = new SimpleInventory(2);
|
||||
$inventory = new CombinedInventoryProxy([$backing]);
|
||||
|
||||
$numChanges = 0;
|
||||
$inventory->getListeners()->add(new CallbackInventoryListener(
|
||||
onSlotChange: null,
|
||||
onContentChange: function(Inventory $inventory, array $oldItems) use (&$numChanges) : void{
|
||||
$numChanges++;
|
||||
}
|
||||
));
|
||||
$inventory->setContents([VanillaItems::DIAMOND_SWORD(), VanillaItems::DIAMOND()]);
|
||||
self::assertSame(1, $numChanges, "Expected onContentChange to be called exactly 1 time");
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user