Block Inventory article #246

natri0 · 2024-12-30T20:50:03Z

Added an article about implementing Inventory in block entities. Some stuff (e.g. ImplementedInventory) copied over from wiki's "tutorial:inventory".

Tutorial covers using the ImplementedInventory & implementing SidedInventory, as well as some basic user interaction (inserting items on right-click).

netlify · 2024-12-30T20:50:31Z

✅ Deploy Preview for nimble-elf-d9d491 ready!

Name	Link
🔨 Latest commit	`5305509`
🔍 Latest deploy log	https://app.netlify.com/projects/nimble-elf-d9d491/deploys/693cc2f97591b30009b3cfdb
😎 Deploy Preview	https://deploy-preview-246--nimble-elf-d9d491.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

develop/blocks/inventory.md

JR1811

This looks pretty good so far!

I think it would be interesting to also expand this page to explain how storing things like ItemStacks, Fluids, Energy, and so on, could be stored and retrieved. Also on that note, an example on how to use the Fabric Transfer API might be useful for that too. Or this could get its extra page, if necessary.

JR1811 · 2025-01-16T09:21:46Z

develop/blocks/inventory.md

+
+@[code transcludeWith=:::3](@/reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java)
+
+The `DuplicatorBlock` should now have a `getTicker` method that returns a reference to `DuplicatorBlockEntity::tick`.


Do we really need a ticking functionality here?
From what I can see, it's just copying the slot and is returning it asap.

So this could be handled in the block interaction method in the custom block class, right?

Or do something like duplicating the slot every 10 ticks and then storing it in the inventory, until it's being retrieved or the stack has hit its max size.

@JR1811 changed it to only output one item every second.

develop/blocks/inventory.md

Basically the same content as the article on the fabric wiki: https://wiki.fabricmc.net/tutorial:inventory Uses the same `ImplementedInventory` class as that one to implement `Inventory` on the custom block entity Now updated for latest!

Maybe we should get a Checkstyle rule to allow comments after blocks? It's making me do stuff like this: // :::1 if (condition) { // code... } // :::1 ...which is IMO kinda ugly

some wording stuff and also redid the DuplicatorBlockEntity ticker so that it has a reason to exist.

natri0 · 2025-05-14T15:35:17Z

rebased to latest main and applied changes requested by @its-miroma.

Also on that note, an example on how to use the Fabric Transfer API might be useful for that too. Or this could get its extra page, if necessary.

@JR1811 i think a separate page (maybe "under" this one like Block Entities -> Block Entity Renderers) and a note about the existence of Fabric Transfer API would be better? don't want it to get too long/complex with marginally related parts all in the same article.

its-miroma

lint fixes

develop/blocks/inventory.md

reference/latest/src/main/java/com/example/docs/block/entity/ModBlockEntities.java

develop/blocks/inventory.md

public/assets/develop/blocks/inventory_2.mp4

only one missing is .mp4 -> .webm, need to reencode. Co-authored-by: Miroma <136986257+its-miroma@users.noreply.github.com>

Co-authored-by: Miroma <136986257+its-miroma@users.noreply.github.com>

JR1811

Small changes, nothing major 👍🏻

.vitepress/sidebars/develop.ts

JR1811 · 2025-05-22T16:38:25Z

sidebar_translations.json

  "develop.blocks.blockstates": "Block States",
  "develop.blocks.block-entities": "Block Entities",
  "develop.blocks.block-entity-renderer": "Block Entity Renderers",
+  "develop.blocks.inventory": "Block Inventories",


Change the address to reflect the entry being listed in Blocks > Block Entity instead of Blocks

(For more information, see requested changes in develop.ts file).

JR1811 · 2025-05-22T16:39:54Z

reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java

+
+	private final DefaultedList<ItemStack> items = DefaultedList.ofSize(1, ItemStack.EMPTY);
+
+	// :::3


Reference comments are displayed in the code view?

its-miroma · 2025-09-23T17:37:12Z

Hi @natri0, sorry for the long wait, do you think you could address the last few reviews, and check if anything changed in 1.21.10, so we can get this merged? Thank you!

develop/blocks/inventory.md

reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java

Co-authored-by: Tenneb22 <126985099+Tenneb22@users.noreply.github.com>

natri0 requested a review from a team as a code owner December 30, 2024 20:50

IMB11 marked this pull request as draft December 30, 2024 20:52

IMB11 added new-content A new page or set of pages todo:verify This needs to be reviewed labels Dec 30, 2024

This comment was marked as outdated.

Sign in to view

natri0 force-pushed the inventory branch from 4dbf9a9 to 972b248 Compare January 16, 2025 08:58

This comment was marked as outdated.

Sign in to view

natri0 marked this pull request as ready for review January 16, 2025 08:59

its-miroma requested changes Jan 16, 2025

View reviewed changes

develop/blocks/inventory.md Outdated Show resolved Hide resolved

develop/blocks/inventory.md Outdated Show resolved Hide resolved

develop/blocks/inventory.md Outdated Show resolved Hide resolved

JR1811 reviewed Jan 16, 2025

View reviewed changes

its-miroma mentioned this pull request Jan 29, 2025

Developer Guides #6

Open

9 tasks

This comment was marked as outdated.

Sign in to view

its-miroma marked this pull request as draft February 28, 2025 16:42

This comment was marked as outdated.

Sign in to view

natri0 added 4 commits May 14, 2025 17:00

Add 'Block Inventories' article

86f2575

Basically the same content as the article on the fabric wiki: https://wiki.fabricmc.net/tutorial:inventory Uses the same `ImplementedInventory` class as that one to implement `Inventory` on the custom block entity Now updated for latest!

Spotless & Checkstyle

01935df

Maybe we should get a Checkstyle rule to allow comments after blocks? It's making me do stuff like this: // :::1 if (condition) { // code... } // :::1 ...which is IMO kinda ugly

Fix compilation error

18ecf6b

Requested changes

1fb9719

some wording stuff and also redid the DuplicatorBlockEntity ticker so that it has a reason to exist.

natri0 force-pushed the inventory branch from 972b248 to 1fb9719 Compare May 14, 2025 15:27

natri0 marked this pull request as ready for review May 14, 2025 15:35

natri0 requested a review from its-miroma May 14, 2025 15:35

its-miroma requested changes May 14, 2025

View reviewed changes

natri0 and others added 3 commits May 15, 2025 09:21

Apply (some) suggestions

c8b0473

only one missing is .mp4 -> .webm, need to reencode. Co-authored-by: Miroma <136986257+its-miroma@users.noreply.github.com>

Reencode inventory_2.mp4 to webm

cd01f6e

missed a suggestion

595d299

Co-authored-by: Miroma <136986257+its-miroma@users.noreply.github.com>

natri0 requested a review from its-miroma May 20, 2025 06:41

its-miroma requested a review from JR1811 May 20, 2025 12:22

JR1811 suggested changes May 22, 2025

View reviewed changes

its-miroma added the priority:low This is nice to have, but it can wait a little label Sep 23, 2025

its-miroma marked this pull request as draft October 6, 2025 07:33

its-miroma mentioned this pull request Nov 28, 2025

Transclusions Should Drop ::: Comments #415

Open

cassiancc added 2 commits December 8, 2025 23:18

Merge branch 'main' into pr/246

5533e8c

Port to 1.21.10 and Mojang Mappings

d191139

Tenneb22 suggested changes Dec 13, 2025

View reviewed changes

develop/blocks/inventory.md Outdated Show resolved Hide resolved

develop/blocks/inventory.md Outdated Show resolved Hide resolved

reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java Show resolved Hide resolved

cassiancc and others added 2 commits December 12, 2025 20:32

Apply suggestions from code review

8c2e07e

Co-authored-by: Tenneb22 <126985099+Tenneb22@users.noreply.github.com>

Fix data generation

5305509


		@[code transcludeWith=:::3](@/reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java)

		The `DuplicatorBlock` should now have a `getTicker` method that returns a reference to `DuplicatorBlockEntity::tick`.


		private final DefaultedList<ItemStack> items = DefaultedList.ofSize(1, ItemStack.EMPTY);

		// :::3

Block Inventory article #246

Are you sure you want to change the base?

Block Inventory article #246

Uh oh!

Conversation

natri0 commented Dec 30, 2024

Uh oh!

netlify bot commented Dec 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for nimble-elf-d9d491 ready!

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

JR1811 left a comment

Choose a reason for hiding this comment

Uh oh!

JR1811 Jan 16, 2025

Choose a reason for hiding this comment

Uh oh!

natri0 May 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

natri0 commented May 14, 2025

Uh oh!

its-miroma left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JR1811 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JR1811 May 22, 2025

Choose a reason for hiding this comment

Uh oh!

JR1811 May 22, 2025

Choose a reason for hiding this comment

Uh oh!

its-miroma commented Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

netlify bot commented Dec 30, 2024 •

edited

Loading

its-miroma commented Sep 23, 2025 •

edited

Loading