diff options
Diffstat (limited to 'src/main/java/gregtech/api/interfaces')
12 files changed, 60 insertions, 56 deletions
diff --git a/src/main/java/gregtech/api/interfaces/IConfigurationCircuitSupport.java b/src/main/java/gregtech/api/interfaces/IConfigurationCircuitSupport.java index 6ec9f68a8b..8dde8163c8 100644 --- a/src/main/java/gregtech/api/interfaces/IConfigurationCircuitSupport.java +++ b/src/main/java/gregtech/api/interfaces/IConfigurationCircuitSupport.java @@ -20,7 +20,7 @@ public interface IConfigurationCircuitSupport { /** * Return a list of possible configuration circuit this machine expects. - * + * <p> * This list is unmodifiable. Its elements are not supposed to be modified in any way! */ default List<ItemStack> getConfigurationCircuits() { diff --git a/src/main/java/gregtech/api/interfaces/IGT_RecipeMap.java b/src/main/java/gregtech/api/interfaces/IGT_RecipeMap.java index bbc2fd4ada..2c5259882a 100644 --- a/src/main/java/gregtech/api/interfaces/IGT_RecipeMap.java +++ b/src/main/java/gregtech/api/interfaces/IGT_RecipeMap.java @@ -18,14 +18,14 @@ public interface IGT_RecipeMap { /** * Add a downstream recipe map that will get to handle the original builder. - * + * <p> * Downstream recipe maps got passed the recipe builder after parent recipe map is done with its business. Notice * at this time the original recipe builder might be modified by the parent recipe map in some form, but it will * remain as valid. - * + * <p> * A downstream will only be invoked if parent recipe map added something. * - * @param downstream + * @param downstream the downstream recipe map to add */ void addDownstream(IGT_RecipeMap downstream); @@ -38,7 +38,7 @@ public interface IGT_RecipeMap { /** * Return a variant of this recipe map that will perform a deep copy on input recipe builder before doing anything * to it. - * + * <p> * The returned recipe map will not have any downstreams, but can accept new downstreams. */ default IGT_RecipeMap deepCopyInput() { diff --git a/src/main/java/gregtech/api/interfaces/IGlobalWirelessEnergy.java b/src/main/java/gregtech/api/interfaces/IGlobalWirelessEnergy.java index 98fe106f24..9640cb38d1 100644 --- a/src/main/java/gregtech/api/interfaces/IGlobalWirelessEnergy.java +++ b/src/main/java/gregtech/api/interfaces/IGlobalWirelessEnergy.java @@ -1,6 +1,8 @@ package gregtech.api.interfaces; -import static gregtech.common.misc.GlobalVariableStorage.*; +import static gregtech.common.misc.GlobalVariableStorage.GlobalEnergy; +import static gregtech.common.misc.GlobalVariableStorage.GlobalEnergyName; +import static gregtech.common.misc.GlobalVariableStorage.GlobalEnergyTeam; import java.math.BigInteger; import java.util.UUID; diff --git a/src/main/java/gregtech/api/interfaces/INetworkUpdatableItem.java b/src/main/java/gregtech/api/interfaces/INetworkUpdatableItem.java index b7e7b0ce33..1dd36d9998 100644 --- a/src/main/java/gregtech/api/interfaces/INetworkUpdatableItem.java +++ b/src/main/java/gregtech/api/interfaces/INetworkUpdatableItem.java @@ -7,14 +7,14 @@ import net.minecraft.nbt.NBTTagCompound; /** * Together with {@link gregtech.api.net.GT_Packet_UpdateItem} you can request server side to update item in hand with a * NBT tag. - * + * <p> * Usual NBT tag size limit applies. */ public interface INetworkUpdatableItem { /** * Receive update from client. Runs on server thread. - * + * * @param stack Stack being updated * @param player player holding the stack * @param tag received data diff --git a/src/main/java/gregtech/api/interfaces/ITextureBuilder.java b/src/main/java/gregtech/api/interfaces/ITextureBuilder.java index 5cfcffaed9..7c9672d521 100644 --- a/src/main/java/gregtech/api/interfaces/ITextureBuilder.java +++ b/src/main/java/gregtech/api/interfaces/ITextureBuilder.java @@ -64,7 +64,7 @@ public interface ITextureBuilder { /** * Set alpha blending - * + * * @param allowAlpha to set * * @return {@link ITextureBuilder} for chaining diff --git a/src/main/java/gregtech/api/interfaces/internal/IGT_RecipeAdder.java b/src/main/java/gregtech/api/interfaces/internal/IGT_RecipeAdder.java index 71b555e2c0..361e391a9b 100644 --- a/src/main/java/gregtech/api/interfaces/internal/IGT_RecipeAdder.java +++ b/src/main/java/gregtech/api/interfaces/internal/IGT_RecipeAdder.java @@ -36,11 +36,11 @@ public interface IGT_RecipeAdder { /** * Adds a Fusion Reactor Recipe * - * @param FluidOutputArray : Array of input fluids. Up to 16. - * @param FluidOutputArray : Array of output fluids. Up to 16. - * @param aFusionDurationInTicks : How many ticks the Fusion lasts (must be > 0). - * @param aFusionEnergyPerTick : The EU consumed per tick to keep the reaction going. - * @param aEnergyNeededForStartingFusion : EU needed to initialize the fusion reaction. (must be >= 0). + * @param FluidInputArray Array of input fluids. Up to 16. + * @param FluidOutputArray Array of output fluids. Up to 16. + * @param aFusionDurationInTicks How many ticks the Fusion lasts (must be > 0). + * @param aFusionEnergyPerTick The EU consumed per tick to keep the reaction going. + * @param aEnergyNeededForStartingFusion EU needed to initialize the fusion reaction. (must be >= 0). * @return true if the recipe got added, otherwise false. */ @@ -91,7 +91,7 @@ public interface IGT_RecipeAdder { * @param aInput1 must be != null * @param aOutput1 must be != null * @param aDuration must be > 0 - * @return + * @return if the recipe was successfully added */ @Deprecated @@ -509,7 +509,7 @@ public interface IGT_RecipeAdder { * @param aOutput1 must be != null * @param aDuration must be > 0 * @param aEUt should be > 0 - * @return + * @return if the recipe was successfully added */ @Deprecated boolean addOreWasherRecipe(ItemStack aInput, ItemStack aOutput1, ItemStack aOutput2, ItemStack aOutput3, @@ -626,7 +626,7 @@ public interface IGT_RecipeAdder { * @param aOutput1 must be != null * @param aDuration must be > 0 * @param aEUt should be > 0 - * @return + * @return if the recipe was successfully added */ @Deprecated boolean addThermalCentrifugeRecipe(ItemStack aInput, ItemStack aOutput1, ItemStack aOutput2, ItemStack aOutput3, @@ -974,12 +974,15 @@ public interface IGT_RecipeAdder { /** * Adds Pyrolyse Recipe * - * @param aInput - * @param intCircuit - * @param aOutput - * @param aFluidOutput - * @param aDuration - * @param aEUt + * @param aInput input item stack + * @param aFluidInput fluid input + * @param intCircuit circuit index + * @param aOutput output item stack + * @param aFluidOutput fluid output + * @param aDuration recipe duration + * @param aEUt recipe EU/t expenditure + * + * @return if the recipe was successfully added */ @Deprecated boolean addPyrolyseRecipe(ItemStack aInput, FluidStack aFluidInput, int intCircuit, ItemStack aOutput, @@ -988,10 +991,10 @@ public interface IGT_RecipeAdder { /** * Adds Oil Cracking Recipe * - * @param aInput - * @param aOutput - * @param aDuration - * @param aEUt + * @param aInput input item stack + * @param aOutput output item stack + * @param aDuration recipe duration + * @param aEUt recipe EU/t expenditure */ @Deprecated boolean addCrackingRecipe(FluidStack aInput, FluidStack aOutput, int aDuration, int aEUt); @@ -1003,8 +1006,8 @@ public interface IGT_RecipeAdder { * @param aInput The fluid to be cracked * @param aInput2 The fluid to catalyze the cracking (typically Hydrogen or Steam) * @param aOutput The cracked fluid - * @param aDuration - * @param aEUt + * @param aDuration recipe duration + * @param aEUt recipe EU/t expenditure */ @Deprecated boolean addCrackingRecipe(int circuitConfig, FluidStack aInput, FluidStack aInput2, FluidStack aOutput, @@ -1029,14 +1032,14 @@ public interface IGT_RecipeAdder { * partly biological, partly metal nanites TIer 2 Nano Forge - Can make mostly metal nanites with some biological * aspects TIer 3 Nano Forge - Can make nanites entierly out of metal * - * @param aInputs = must not be null - * @param aFluidInputs = can be null - * @param aOutputs = must not be null, the nanite or other output - * @param aFluidOutputs = can be null - * @param aChances = can be null - * @param aDuration - * @param aEUt - * @param aSpecialValue = defines the tier of nano forge required. + * @param aInputs must not be null + * @param aFluidInputs can be null + * @param aOutputs must not be null, the nanite or other output + * @param aFluidOutputs can be null + * @param aChances can be null + * @param aDuration recipe duration + * @param aEUt recipe EU/t expenditure + * @param aSpecialValue defines the tier of nano forge required. * */ @Deprecated @@ -1047,12 +1050,12 @@ public interface IGT_RecipeAdder { * Add a Board Manufacturer Recipe. The Board Manufacturer's main use is to make the circuit boards needed to make * circuits. * - * @param aInputs = must not be null - * @param aFluidInputs = must not be null - * @param aOutputs = must not be null - * @param aDuration - * @param aEUt - * @param aSpecialValue = defines the tier of the board manufacturer required. + * @param aInputs must not be null + * @param aFluidInputs must not be null + * @param aOutputs must not be null + * @param aDuration recipe duration + * @param aEUt recipe EU/t expenditure + * @param aSpecialValue defines the tier of the board manufacturer required. */ @Deprecated boolean addPCBFactoryRecipe(ItemStack[] aInputs, FluidStack[] aFluidInputs, ItemStack[] aOutputs, int aDuration, diff --git a/src/main/java/gregtech/api/interfaces/metatileentity/IMetaTileEntity.java b/src/main/java/gregtech/api/interfaces/metatileentity/IMetaTileEntity.java index fed9501067..9a60092121 100644 --- a/src/main/java/gregtech/api/interfaces/metatileentity/IMetaTileEntity.java +++ b/src/main/java/gregtech/api/interfaces/metatileentity/IMetaTileEntity.java @@ -185,7 +185,7 @@ public interface IMetaTileEntity extends ISidedInventory, IFluidTank, IFluidHand void onRemoval(); /** - * @param facing + * @param facing the facing direction to check * @return if aFacing would be a valid Facing for this Device. Used for wrenching. */ boolean isFacingValid(ForgeDirection facing); @@ -267,7 +267,7 @@ public interface IMetaTileEntity extends ISidedInventory, IFluidTank, IFluidHand /** * a Player right-clicks the Machine Sneaky right clicks are not getting passed to this! * - * @return + * @return mostly {@code false}. Probably is left for compatibility. */ boolean onRightclick(IGregTechTileEntity aBaseMetaTileEntity, EntityPlayer aPlayer, ForgeDirection side, float aX, float aY, float aZ); @@ -323,9 +323,9 @@ public interface IMetaTileEntity extends ISidedInventory, IFluidTank, IFluidHand void sendLoopEnd(byte aIndex); /** - * Called when the Machine explodes, override Explosion Code here. + * Called when the Machine explodes. Override the Explosion code here. * - * @param aExplosionPower + * @param aExplosionPower explosion power */ void doExplosion(long aExplosionPower); @@ -457,7 +457,7 @@ public interface IMetaTileEntity extends ISidedInventory, IFluidTank, IFluidHand * The Machine Update, which is called when the Machine needs an Update of its Parts. I suggest to wait 1-5 seconds * before actually checking the Machine Parts. RP-Frames could for example cause Problems when you instacheck the * Machine Parts. - * + * <p> * just do stuff since we are already in meta tile... */ @Override diff --git a/src/main/java/gregtech/api/interfaces/metatileentity/IMetaTileEntityItemPipe.java b/src/main/java/gregtech/api/interfaces/metatileentity/IMetaTileEntityItemPipe.java index 0c2c5ebf28..5daf895c20 100644 --- a/src/main/java/gregtech/api/interfaces/metatileentity/IMetaTileEntityItemPipe.java +++ b/src/main/java/gregtech/api/interfaces/metatileentity/IMetaTileEntityItemPipe.java @@ -49,7 +49,7 @@ public interface IMetaTileEntityItemPipe extends IMetaTileEntityPipe { class Util { /** - * @return a List of connected Item Pipes + * @return connected Item Pipes */ public static Map<IMetaTileEntityItemPipe, Long> scanPipes(IMetaTileEntityItemPipe aMetaTileEntity, Map<IMetaTileEntityItemPipe, Long> aMap, long aStep, boolean aSuckItems, boolean aIgnoreCapacity) { diff --git a/src/main/java/gregtech/api/interfaces/modularui/ControllerWithOptionalFeatures.java b/src/main/java/gregtech/api/interfaces/modularui/ControllerWithOptionalFeatures.java index 04b6b4e6a9..e6e3142196 100644 --- a/src/main/java/gregtech/api/interfaces/modularui/ControllerWithOptionalFeatures.java +++ b/src/main/java/gregtech/api/interfaces/modularui/ControllerWithOptionalFeatures.java @@ -1,6 +1,7 @@ package gregtech.api.interfaces.modularui; -import static gregtech.api.metatileentity.BaseTileEntity.*; +import static gregtech.api.metatileentity.BaseTileEntity.BUTTON_FORBIDDEN_TOOLTIP; +import static gregtech.api.metatileentity.BaseTileEntity.TOOLTIP_DELAY; import java.util.ArrayList; import java.util.Arrays; diff --git a/src/main/java/gregtech/api/interfaces/tileentity/ICoverable.java b/src/main/java/gregtech/api/interfaces/tileentity/ICoverable.java index 112a7035d7..8834678984 100644 --- a/src/main/java/gregtech/api/interfaces/tileentity/ICoverable.java +++ b/src/main/java/gregtech/api/interfaces/tileentity/ICoverable.java @@ -80,7 +80,7 @@ public interface ICoverable extends IRedstoneTileEntity, IHasInventory, IBasicEn /** * Receiving a packet with cover data. * - * @param coverSide + * @param coverSide cover side * @param aPlayer the player who made the change */ default void receiveCoverData(ForgeDirection coverSide, int aCoverID, ISerializableObject aCoverData, diff --git a/src/main/java/gregtech/api/interfaces/tileentity/IGearEnergyTileEntity.java b/src/main/java/gregtech/api/interfaces/tileentity/IGearEnergyTileEntity.java index eefcbcb5ac..7eeee90c8c 100644 --- a/src/main/java/gregtech/api/interfaces/tileentity/IGearEnergyTileEntity.java +++ b/src/main/java/gregtech/api/interfaces/tileentity/IGearEnergyTileEntity.java @@ -14,7 +14,7 @@ public interface IGearEnergyTileEntity { * Inject Energy Call for Rotational Energy. Rotation Energy can't be stored, this is just for things like internal * Dynamos, which convert it into Energy, or into Progress. * - * @param side + * @param side inject to this side * @param aSpeed Positive = Clockwise, Negative = Counterclockwise */ boolean injectRotationalEnergy(ForgeDirection side, long aSpeed, long aEnergy); diff --git a/src/main/java/gregtech/api/interfaces/tileentity/IGregTechTileEntity.java b/src/main/java/gregtech/api/interfaces/tileentity/IGregTechTileEntity.java index 5062f0fce5..cccc594c76 100644 --- a/src/main/java/gregtech/api/interfaces/tileentity/IGregTechTileEntity.java +++ b/src/main/java/gregtech/api/interfaces/tileentity/IGregTechTileEntity.java @@ -62,7 +62,7 @@ public interface IGregTechTileEntity extends ITexturedTileEntity, IGearEnergyTil * one kind of MetaTileEntity so only use this if you are sure its the correct one or you will get a Class cast * Error. * - * @param aMetaTileEntity + * @param aMetaTileEntity a MetaTileEntity */ void setMetaTileEntity(IMetaTileEntity aMetaTileEntity); @@ -177,9 +177,7 @@ public interface IGregTechTileEntity extends ITexturedTileEntity, IGearEnergyTil && getMetaTileEntity().isMachineBlockUpdateRecursive(); } - default void setShutdownStatus(boolean newStatus) { - return; - } + default void setShutdownStatus(boolean newStatus) {} /** * A randomly called display update to be able to add particles or other items for display The event is proxied by |