User Tools

Site Tools


Sidebar

Setup

Basics

Advanced

Items

Blocks and Block Entities

Fluids

Entities

World Generation

Recipe Types

Miscellaneous

Events

Mixins

Dynamic Data Generation

Tutorials for Minecraft 1.15

Tutorials for Minecraft 1.14

Contribute to Fabric

Extremely Strange People

tutorial:transfer-api

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 or energy transfer. For any question, please go to the #transfer-api-debating channel on the official Fabric Discord server.

All Transfer API classes are marked as @ApiStatus.Experimental. This is temporary, and it means that there may be occasional breaking changes if a design flaw is encountered in the API, but we will try not to break the API to avoid disrupting the large amount of mods that are using it already. In practice, this means that you can mostly ignore this warning, and disable it in your IDE if it's too annoying.

The Fluid Transfer API

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).

  1. Creating a simple tank walks you through how you can create a simple tank block entity, and what FluidVariant is.
  2. Understanding Storage<FluidVariant> teaches what Storage<FluidVariant> is and how to use it.
  3. 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

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).

  1. 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

The TechReborn Energy API

  1. [Not yet written] How to use and implement the TR energy API.
tutorial/transfer-api.txt · Last modified: 2022/05/16 23:50 by technici4n