Differences

This shows you the differences between two versions of the page.

--- tutorial:transfer-api [2022/02/02 20:30] – [The Fluid Transfer API] technici4n
+++ tutorial:transfer-api [2025/03/30 22:05] (current) – [Fluid, Item and Energy Transfer] technici4n
@@ Line 1: / Line 1: @@
 ====== Fluid, Item and Energy Transfer ======
-This series of tutorials is meant to explain how the Fabric Transfer API works, and how you can use it for your own mods.
-**Please make sure that you read all of these tutorials in order, even if you are only interested by item transfer.**
+==== Transactions ====
-For any question, please go to the ''#transfer-api-debating'' channel on the official Fabric Discord server.
+The Fabric Transfer API relies heavily on the concept of transactions.
+  - [[tutorial:transfer-api/transactions|The Transaction system]]. Before looking at the details of how transfer works, we take a detour to discuss transactions.
 ==== The Fluid Transfer API ====
-  - [[tutorial:transfer-api/simpletank|Creating a simple tank]] walks you through how you can create a simple tank, and what ''FluidVariant'' is.
+The Fabric Fluid Transfer API is how fluid-containing blocks such as machines, pipes, and tanks communicate with each other. It's what allows all mods to be compatible with each other as far as fluid transfer is concerned. (If you are coming from Forge, it serves a purpose similar to ''IFluidHandler'').
+  - [[tutorial:transfer-api/simpletank|Creating a tank block entity]] walks you through how you can create a simple tank block entity, and what ''FluidVariant'' is.
   - [[tutorial:transfer-api/storage|Understanding Storage<FluidVariant>]] teaches what ''Storage<FluidVariant>'' is and how to use it.
   - [[tutorial:transfer-api/fluid_implementation|How to implement Storage<FluidVariant>]] provides an overview of the storage implementations provided by Fabric that you can use in your mods, with plenty of example code.
 ==== The Item Transfer API ====
-  - [Not yet written] This tutorial will explain how the item API is almost the same as the fluid API, and how wrappers around Inventory/PlayerInventory can be retrieved.
+The Fabric Item Transfer API is used by item-containing blocks such as chests, machines, or storage drawers to communicate with other. (If you are coming from Forge, it serves a purpose similar to ''IItemHandler'').
-  - [Not yet written] Same as the fluid tutorial, but will also explain ''SingleStackStorage'' and how to use ''Inventory''/''SidedInventory''/''InventoryProvider''.
+  - [[tutorial:transfer-api/item_storage|Item transfer with Storage<ItemVariant>]] explains how the item API is almost the same as the fluid API, how wrappers around Inventory/PlayerInventory can be retrieved, and how item storages can be implemented in practice.
+//Note: the existing item transfer API in Minecraft should be avoided in fabric mods due to its severe limitations. If you don't know what this means, you can ignore this warning.//
 ==== Fluid-containing items ====
-  - [Not yet written] How to use and implement the fluid-containing item API.
+  - [Not finished] [[tutorial:transfer-api/fluid-containing-items|How to use and implement the fluid-containing item API]].
 ==== The TechReborn Energy API ====
-  - [Not yet written] How to use and implement the TR energy API.
+  - [Not yet written] 1. [[tutorial:energy-blockentity|how to create an energy storage block entity]]