Chests are Chests

Ever wondered why, when a chest is open, items don't fall in?
... Okay, I'll admit, me neither, not until I had this idea. But when you think of it... It just makes sense, right?

So now, you can proudly say that Chests are chests! And enjoy making items fall into your storage instead of lamely putting them in by hand!

But as items can fall into an open box... Shouldn't they be able to fall down from one as well, provided it was open on the right side? Thus, you can make it so barrels, when open and facing down, drop all of their content to the ground!

Going back to the chest, if you can open the lid to make items fall in, shouldn't the lid throw items away upon being opened? That's right! With this mod, you can make it so opening a chest throws all the items standing on it upon opening! (Limited to items only for the sake of one's life preservation)

Last but not least, since opening a container has always only been a manual task so far, in order to allow you to automate these new options, opening a container can now be done by activating an empty dispenser pointing at said container!

Now the game will feel more natural, even just a little bit, won't you agree?

Features

• Inserting items in open containers
  • default: enabled
  • gamerule: chests.insertOpen
• Making item fall from open-from-below containers
  • default: disabled
  • gamerule: chests.barrelFall
  • Special item fall (e.g. snowballs falling as actual thrown snowballs)
    • default: enabled
    • gamerule: chests.barrelFall.throwableSpecial
    • item tag: #chests_are_chests:special_fall
• Making chest lids throw items
  • default: disabled
  • gamerule: chests.lidFling
  • entity type tag: #chests_are_chests:flingable
  • Horizontal flinging velocity
    • default: 0.25
    • gamerule: chests.lidFling.horizontalPower
  • Vertical flinging velocity
    • default: 0.6
    • gamerule: chests.lidFling.verticalPower
• Opening containers by powering empty dispensers
  • default: enabled
  • gamerule: chests.dispenserOpen
  • Automated opening duration (in world ticks)
    • default: 10
    • gamerule: chests.dispenserOpen.duration

Dependencies

Mod compatibilities

Internal compatibilities

While compatibilities are planned, direct implementation by the mods themselves would always be preferred. Hence, if a mod of yours is planned, being worked on, or even already implemented, don't hesitate to make your own, and if need be, contact us either for help or to tell us that we have no need to keep our own compatibility.

Implemented

• Anner's Iron Chests
• Mythic Metals Decorations
• Reinforced Chests
• Expanded Storage
• Spectrum

Natural

Known mods that (should) have natural compatibility with this mod, with no extra implementation

• Variant Chests
• Variant Barrels
• Chest Colorizer
• More Chests Variants

Being worked on

• Lootr

Planned

• myLoot
• More Chests
• Compact Storage

Internally refused

• Iron Chests: Restocked Due to mod author names poorly registered, this mod cannot be easily be dealt with. Hence, it has been decided no to attempt implementing builtin compatibility.

Make your own

Container implementation

The mod tweaks the block entities' and item entities' behaviours. In order to implement compatibility with this mod, you need your custom block entity to implement the mc.recraftors.chestsarechests.util.FallInContainer interface.

You may as well make use of other interfaces, such as mc.recraftors.chestsarechests.util.BlockOpenableContainer or mc.recraftors.chestsarechests.util.BooleanHolder, which you can either use as you please, or can exploit if you already extend the vanilla chest or barrel classes.

Don't hesitate to look at the chest and barrel implementations for a reference of how to handle block opening and orientation within the provided methods.

Also don't fear about more methods appearing with updates and your mod not implementing them, causing issues. No methods are planned for deletion, or would include a change of primary version. And all new method will always come with a default implementation, to avoid pointless issues.

Item implementation

The mod enables for some item (registered in the appropriate item tag) to have a custom behaviour upon "falling" from a container. In order to do that, the item itself must implement the mc.recraftors.chestsarechests.util.ContainerItemHelper interface.

This interface comes up with two methods to be implemented. The first one, optional, indicates the item fall directions. This allows to specify on which open side of a container can the item come out. (e.g. upwards-gravitated items may specify an upward fall direction)

By default, this first method will return DOWN.

The second one makes the actual implementation of a special fall behaviour. It should use the first method to know whether to run it or not, and execute what is intended. This method's return value indicates whether the item stack fell (and theoretically is consumed), or not, and therefore shouldn't be bothered with attempting to make it fall in the same direction, to avoid causing more runtime computing stress.

Don't hesitate to look at the arrow or snowball implementations for a reference of how to handle special item fall.

Then again, don't fear about more methods appearing with updates, for all new one will then again include a default implementation, if possible based on already existing methods.

Examples

Up to date with version 0.5

public class MyCustomBlockEntity extends BlockEntity implements FallInContainer {
    private boolean isOpen;
    private final int size;
    private final DefaultedList<ItemStack> content;
    private final Map<Integer, Integer> fallUpdateMap = new HashMap<>();

    @Override
    public boolean chests$tryInsertion(ItemEntity entity) {
        return FallInContainer.chests$inventoryInsertion(this.content, entity, this::setStack);
    }

    @Override
    public boolean chests$isOpen() {
        return isOpen;
    }

    @Override
    public VoxelShape chests$InputAreaShape() {
        return FallInContainer.ABOVE;
    }

    @Override
    public void chests$forceOpen(ServerWorld world, BlockPos at, BlockState from) {
        this.isOpen = true;
        this.onOpen();
    }

    @Override
    public boolean chests$tryForceOpen(BlockState from) {
        ServerWorld serverWorld = (ServerWorld) this.getWorld();
        BlockPos blockPos = this.getPos();
        this.chests$forceOpen(serverWorld, blockPos, from);
        ChestsAreChests.scheduleTick(serverWorld, blockPos, duration);
    }

    @Override
    public boolean chests$forceClose() {
        this.isOpen = false;
        this.onClose();
    }

    @Override
    public Map<Integer, Integer> getFallUpdateMap() {
        return this.fallUpdateMap;
    }

    void onOpen() {
        // ...
        // potential rendering stuff
        ChestsAreChests.ejectAbove(Direction.UP, this);
    }
}

public class MyCustomItem extends Item implements ContainerItemHelper {
    public Direction[] chests$getFallDirection(ItemStack stack) {
        return new Direction[]{Directions.UP};
    }
    
    public boolean defaultOnOpenTick(ItemStack stack, FallInContainer container, Direction direction, World world, Vec3d pos, Vec3d velocity) {
        if (!ChestsAreChests.isInArray(direction, chests$getFallDirection(stack))) return false;
        MyGravitatedEntity entity = new MyGravitatedEntity(world, pos.x, pos.y, pos.z, stack.copy());
        entity.setVelocity(velocity);
        world.spawnEntity(entity);
        return true;
    }
}

Showcase