mirror of
https://github.com/MinecraftForge/MinecraftForge.git
synced 2026-11-19 03:49:14 +00:00
[1.17.x Omnibus] Fix typos and javadocs across code base (#8144)
This commit is contained in:
1 parent
df8954869a
commit
b4feee8046
163 files changed
+708
-454
No files matched your search
@@ -23,6 +23,7 @@ import javax.annotation.Nonnull;
|
||||
import javax.annotation.Nullable;
|
||||
|
||||
import com.google.common.base.Preconditions;
|
||||
import net.minecraft.world.item.BucketItem;
|
||||
import net.minecraft.world.level.block.Block;
|
||||
import net.minecraft.world.level.block.BucketPickup;
|
||||
import net.minecraft.world.level.block.LiquidBlockContainer;
|
||||
@@ -130,7 +131,7 @@ public class FluidUtil
|
||||
*
|
||||
* @param container The container to be filled. Will not be modified.
|
||||
* Separate handling must be done to reduce the stack size, stow containers, etc, on success.
|
||||
* See {@link #tryFillContainerAndStow(ItemStack, IFluidHandler, IItemHandler, int, PlayerEntity, boolean)}.
|
||||
* See {@link #tryFillContainerAndStow(ItemStack, IFluidHandler, IItemHandler, int, Player, boolean)}.
|
||||
* @param fluidSource The fluid handler to be drained.
|
||||
* @param maxAmount The largest amount of fluid that should be transferred.
|
||||
* @param player The player to make the filling noise. Pass null for no noise.
|
||||
@@ -173,7 +174,7 @@ public class FluidUtil
|
||||
*
|
||||
* @param container The filled container. Will not be modified.
|
||||
* Separate handling must be done to reduce the stack size, stow containers, etc, on success.
|
||||
* See {@link #tryEmptyContainerAndStow(ItemStack, IFluidHandler, IItemHandler, int, PlayerEntity, boolean)}.
|
||||
* See {@link #tryEmptyContainerAndStow(ItemStack, IFluidHandler, IItemHandler, int, Player, boolean)}.
|
||||
* @param fluidDestination The fluid handler to be filled by the container.
|
||||
* @param maxAmount The largest amount of fluid that should be transferred.
|
||||
* @param player Player for making the bucket drained sound. Pass null for no noise.
|
||||
@@ -514,11 +515,11 @@ public class FluidUtil
|
||||
}
|
||||
|
||||
/**
|
||||
* ItemStack version of {@link #tryPlaceFluid(PlayerEntity, World, Hand, BlockPos, IFluidHandler, FluidStack)}.
|
||||
* ItemStack version of {@link #tryPlaceFluid(Player, Level, InteractionHand, BlockPos, IFluidHandler, FluidStack)}.
|
||||
* Use the returned {@link FluidActionResult} to update the container ItemStack.
|
||||
*
|
||||
* @param player Player who places the fluid. May be null for blocks like dispensers.
|
||||
* @param world World to place the fluid in
|
||||
* @param world Level to place the fluid in
|
||||
* @param hand
|
||||
* @param pos The position in the world to place the fluid block
|
||||
* @param container The fluid container holding the fluidStack to place
|
||||
@@ -542,10 +543,10 @@ public class FluidUtil
|
||||
* Honors the amount of fluid contained by the used container.
|
||||
* Checks if water-like fluids should vaporize like in the nether.
|
||||
*
|
||||
* Modeled after {@link net.minecraft.item.BucketItem#tryPlaceContainedLiquid(PlayerEntity, World, BlockPos, BlockRayTraceResult)}
|
||||
* Modeled after {@link BucketItem#emptyContents(Player, Level, BlockPos, BlockHitResult)}
|
||||
*
|
||||
* @param player Player who places the fluid. May be null for blocks like dispensers.
|
||||
* @param world World to place the fluid in
|
||||
* @param world Level to place the fluid in
|
||||
* @param hand
|
||||
* @param pos The position in the world to place the fluid block
|
||||
* @param fluidSource The fluid source holding the fluidStack to place
|
||||
@@ -618,8 +619,8 @@ public class FluidUtil
|
||||
/**
|
||||
* Internal method for getting a fluid block handler for placing a fluid.
|
||||
*
|
||||
* Modders: Instead of this method, use {@link #tryPlaceFluid(PlayerEntity, World, Hand, BlockPos, ItemStack, FluidStack)}
|
||||
* or {@link #tryPlaceFluid(PlayerEntity, World, Hand, BlockPos, IFluidHandler, FluidStack)}
|
||||
* Modders: Instead of this method, use {@link #tryPlaceFluid(Player, Level, InteractionHand, BlockPos, ItemStack, FluidStack)}
|
||||
* or {@link #tryPlaceFluid(Player, Level, InteractionHand, BlockPos, IFluidHandler, FluidStack)}
|
||||
*/
|
||||
private static IFluidHandler getFluidBlockHandler(Fluid fluid, Level world, BlockPos pos)
|
||||
{
|
||||
@@ -629,9 +630,9 @@ public class FluidUtil
|
||||
|
||||
/**
|
||||
* Destroys a block when a fluid is placed in the same position.
|
||||
* Modeled after {@link net.minecraft.item.BucketItem#tryPlaceContainedLiquid(PlayerEntity, World, BlockPos, BlockRayTraceResult)}
|
||||
* Modeled after {@link BucketItem#emptyContents(Player, Level, BlockPos, BlockHitResult)}
|
||||
*
|
||||
* This is a helper method for implementing {@link IFluidBlock#place(World, BlockPos, FluidStack, IFluidHandler.FluidAction)}.
|
||||
* This is a helper method for implementing {@link IFluidBlock#place(Level, BlockPos, FluidStack, IFluidHandler.FluidAction)}.
|
||||
*
|
||||
* @param world the world that the fluid will be placed in
|
||||
* @param pos the location that the fluid will be placed
|
||||
|
||||
Reference in new issue
Block a user