Skip to content

Commit

Permalink
Define standard FluidConstants
Browse files Browse the repository at this point in the history
  • Loading branch information
Technici4n committed Jun 18, 2024
1 parent a91eb52 commit 17a008b
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 1 deletion.
57 changes: 57 additions & 0 deletions src/main/java/net/neoforged/neoforge/fluids/FluidConstants.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/*
* Copyright (c) NeoForged and contributors
* SPDX-License-Identifier: LGPL-2.1-only
*/

package net.neoforged.neoforge.fluids;

/**
* Defines fluid amount constants for common resources.
* All amounts are given in millibuckets (mb), the standard fluid unit used by NeoForge.
*/
public final class FluidConstants {
/**
* One bucket is by definition 1000 millibuckets.
*/
public static final int BUCKET = 1000;
/**
* A molten block, if the block can be divided into 4 parts.
*
* @see #GEM_4
*/
public static final int BLOCK_4 = 1000;
/**
* A molten block, if the block can be divided into 9 parts.
*
* @see #GEM_9
* @see #INGOT
* @see #NUGGET
*/
public static final int BLOCK_9 = 810;
/**
* A molten gem, if the gem is equivalent to 1/4th of a block of some resource.
*
* @see #BLOCK_4 for the corresponding block
*/
public static final int GEM_4 = 250;
/**
* A molten gem, if the gem is equivalent to 1/9th of a block of some resource.
*
* @see #BLOCK_9 for the corresponding block
*/
public static final int GEM_9 = 90;
/**
* A molten ingot, i.e. 1/9th of a block of some resource that can be divided into 9 parts.
*
* @see #BLOCK_9 for the corresponding block
*/
public static final int INGOT = 90;
/**
* A molten nugget, i.e. 1/81th of a block of some resource that can be divided into 81 parts.
*
* @see #BLOCK_9 for the corresponding block
*/
public static final int NUGGET = 10;

private FluidConstants() {}
}
5 changes: 4 additions & 1 deletion src/main/java/net/neoforged/neoforge/fluids/FluidType.java
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,11 @@
public class FluidType {
/**
* The number of fluid units that a bucket represents.
*
* @deprecated Use {@link FluidConstants#BUCKET} instead.
*/
public static final int BUCKET_VOLUME = 1000;
@Deprecated(forRemoval = true)
public static final int BUCKET_VOLUME = FluidConstants.BUCKET;

/**
* A lazy value which computes the number of fluid types within the
Expand Down

0 comments on commit 17a008b

Please sign in to comment.