User Tools

Site Tools


tutorial:transfer-api

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
tutorial:transfer-api [2022/02/02 20:33] – [Fluid, Item and Energy Transfer] technici4ntutorial:transfer-api [2022/02/02 20:35] – [The Fluid Transfer API] technici4n
Line 6: Line 6:
 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. 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 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 simple tank]] 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/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.   - [[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.
tutorial/transfer-api.txt · Last modified: 2023/07/19 13:38 by technici4n