mirror of
https://github.com/MinecraftForge/MinecraftForge.git
synced 2026-11-19 03:49:14 +00:00
* Bump pack.mcmeta formats * 1.19 biome modifiers * Mark ClientPlayerNetworkEvent.LoggedOutEvent's getters as nullable * Add docs and package-info to client extension interfaces package * Move RenderBlockOverlayEvent hooks to ForgeHooksClient * Add package-infos to client events package * Rename SoundLoadEvent to SoundEngineLoadEvent This reduces confusion from consumers which may think the name SoundLoadEvent refers to an individual sound being loaded rather than the sound engine. * Document and change SoundLoadEvent to fire on mod bus Previously, it fired on both the mod bus and the Forge bus, which is confusing for consumers. * Delete SoundSetupEvent Looking at its original implementation shows that there isn't an appropriate place in the new sound code to reinsert the event, and the place of 'sound engine/manager initialization event' is taken already by SoundLoadEvent. * Perform some cleanup on client events - Removed nullable annotations from ClientPlayerNetworkEvent - Renamed #getPartialTicks methods to #getPartialTick, to be consistent with vanilla's naming of the partial tick - Cleanup documentation to remove line breaks, use the spelling 'cancelled' over 'canceled', and improve docs on existing and new methods. * Remove EntityEvent.CanUpdate Closes MinecraftForge/MinecraftForge#6394 * Switch to Jetbrains nullability annotations * New PlayLevelSoundEvent; replaces old PlaySoundAtEntityEvent * Remove ForgeWorldPresetScreens * Remove IForgeRegistryEntry * Remove use of List<Throwable> in FML's CompletableFutures * Add docs to mod loading stages, stages, and phases * Gradle 7.4.2 * Use SLF4J in FMLLoader and other subprojects * Switch dynamic versions in subprojects to pinned ones * Switch ForgeRoot and MDK to FG plugin markers * Configure Forge javadoc task The task now uses a custom stylesheet with MCForge elements, and configured to combine the generation from the four FML subprojects (fmlloader, fmlcore, javafmllanguage, mclanguage) and the Forge project into the javadoc output. * Update docs/md files, for 1.19 update and the move away from IRC to Discord. * Make "Potentially dangerous alternative prefix" a debug warning, not info. Co-authored-by: Curle <[email protected]> Co-authored-by: sciwhiz12 <[email protected]> Signed-off-by: SizableShrimp <[email protected]>
64 lines
2.0 KiB
Java
64 lines
2.0 KiB
Java
/*
|
|
* Copyright (c) Forge Development LLC and contributors
|
|
* SPDX-License-Identifier: LGPL-2.1-only
|
|
*/
|
|
|
|
package net.minecraftforge.fluids;
|
|
|
|
import net.minecraftforge.fluids.capability.IFluidHandler.FluidAction;
|
|
import org.jetbrains.annotations.NotNull;
|
|
|
|
/**
|
|
* This interface represents a Fluid Tank. IT IS NOT REQUIRED but is provided for convenience.
|
|
* You are free to handle Fluids in any way that you wish - this is simply an easy default way.
|
|
* DO NOT ASSUME that these objects are used internally in all cases.
|
|
*/
|
|
public interface IFluidTank {
|
|
|
|
/**
|
|
* @return FluidStack representing the fluid in the tank, null if the tank is empty.
|
|
*/
|
|
@NotNull
|
|
FluidStack getFluid();
|
|
|
|
/**
|
|
* @return Current amount of fluid in the tank.
|
|
*/
|
|
int getFluidAmount();
|
|
|
|
/**
|
|
* @return Capacity of this fluid tank.
|
|
*/
|
|
int getCapacity();
|
|
|
|
/**
|
|
* @param stack Fluidstack holding the Fluid to be queried.
|
|
* @return If the tank can hold the fluid (EVER, not at the time of query).
|
|
*/
|
|
boolean isFluidValid(FluidStack stack);
|
|
|
|
/**
|
|
* @param resource FluidStack attempting to fill the tank.
|
|
* @param action If SIMULATE, the fill will only be simulated.
|
|
* @return Amount of fluid that was accepted (or would be, if simulated) by the tank.
|
|
*/
|
|
int fill(FluidStack resource, FluidAction action);
|
|
|
|
/**
|
|
* @param maxDrain Maximum amount of fluid to be removed from the container.
|
|
* @param action If SIMULATE, the drain will only be simulated.
|
|
* @return Amount of fluid that was removed (or would be, if simulated) from the tank.
|
|
*/
|
|
@NotNull
|
|
FluidStack drain(int maxDrain, FluidAction action);
|
|
|
|
/**
|
|
* @param resource Maximum amount of fluid to be removed from the container.
|
|
* @param action If SIMULATE, the drain will only be simulated.
|
|
* @return FluidStack representing fluid that was removed (or would be, if simulated) from the tank.
|
|
*/
|
|
@NotNull
|
|
FluidStack drain(FluidStack resource, FluidAction action);
|
|
|
|
}
|