clean up completely.(Although I think Intellij IDEA did a lot of useless thing)

This commit is contained in:
xsun 2017-04-12 22:10:13 +08:00
parent 115c33b713
commit 53d3eafdbf
896 changed files with 4942 additions and 7273 deletions

View File

@ -24,14 +24,14 @@
package appeng.api;
import java.lang.reflect.Field;
import appeng.api.exceptions.CoreInaccessibleException;
import java.lang.reflect.Field;
/**
* Entry point for api.
*
* <p>
* Available IMCs:
*/
public enum AEApi

View File

@ -24,11 +24,7 @@
package appeng.api;
import appeng.api.definitions.Blocks;
import appeng.api.definitions.IDefinitions;
import appeng.api.definitions.Items;
import appeng.api.definitions.Materials;
import appeng.api.definitions.Parts;
import appeng.api.definitions.*;
import appeng.api.exceptions.FailedConnection;
import appeng.api.features.IRegistryContainer;
import appeng.api.networking.IGridBlock;
@ -58,7 +54,6 @@ public interface IAppEngApi
/**
* @return an accessible list of all of AE's Items
*
* @deprecated use {@link appeng.api.definitions.IDefinitions#items()}
*/
@Deprecated
@ -66,7 +61,6 @@ public interface IAppEngApi
/**
* @return an accessible list of all of AE's materials; materials are items
*
* @deprecated use {@link appeng.api.definitions.IDefinitions#materials()}
*/
@Deprecated
@ -74,7 +68,6 @@ public interface IAppEngApi
/**
* @return an accessible list of all of AE's blocks
*
* @deprecated use {@link appeng.api.definitions.IDefinitions#blocks()}
*/
@Deprecated
@ -82,7 +75,6 @@ public interface IAppEngApi
/**
* @return an accessible list of all of AE's parts, parts are items
*
* @deprecated use {@link appeng.api.definitions.IDefinitions#parts()}
*/
@Deprecated
@ -97,7 +89,6 @@ public interface IAppEngApi
* create a grid node for your {@link appeng.api.networking.IGridHost}
*
* @param block grid block
*
* @return grid node of block
*/
IGridNode createGridNode( IGridBlock block );
@ -107,7 +98,6 @@ public interface IAppEngApi
*
* @param a to be connected gridnode
* @param b to be connected gridnode
*
* @throws appeng.api.exceptions.FailedConnection
*/
IGridConnection createGridConnection( IGridNode a, IGridNode b ) throws FailedConnection;

View File

@ -26,5 +26,5 @@ package appeng.api.config;
public enum ItemSubstitution
{
ENABLED, DISABLED;
ENABLED, DISABLED
}

View File

@ -48,14 +48,13 @@ public enum PowerUnits
/**
* do power conversion using AE's conversion rates.
*
* <p>
* Example: PowerUnits.EU.convertTo( PowerUnits.AE, 32 );
*
* <p>
* will normally returns 64, as it will convert the EU, to AE with AE's power settings.
*
* @param target target power unit
* @param value value
*
* @return value converted to target units, from this units.
*/
public double convertTo( final PowerUnits target, final double value )

View File

@ -24,8 +24,8 @@
package appeng.api.config;
import java.util.EnumSet;
import javax.annotation.Nonnull;
import java.util.EnumSet;
public enum Settings

View File

@ -24,15 +24,13 @@
package appeng.api.config;
import java.util.HashMap;
import java.util.Map;
import net.minecraft.item.ItemStack;
import com.google.common.base.Optional;
import appeng.api.definitions.IItemDefinition;
import appeng.api.util.AEItemDefinition;
import com.google.common.base.Optional;
import net.minecraft.item.ItemStack;
import java.util.HashMap;
import java.util.Map;
public enum Upgrades
@ -106,7 +104,6 @@ public enum Upgrades
*
* @param item machine in which this upgrade can be installed
* @param maxSupported amount how many upgrades can be installed
*
* @deprecated use {@link Upgrades#registerItem(IItemDefinition, int)}
*/
@Deprecated

View File

@ -1,12 +1,11 @@
package appeng.api.definitions;
import com.google.common.base.Optional;
import net.minecraft.block.Block;
import net.minecraft.item.ItemBlock;
import net.minecraft.world.IBlockAccess;
import com.google.common.base.Optional;
public interface IBlockDefinition extends IItemDefinition
{
@ -27,7 +26,6 @@ public interface IBlockDefinition extends IItemDefinition
* @param x x pos of block
* @param y y pos of block
* @param z z pos of block
*
* @return if the block is placed in the world at the specific location.
*/
boolean isSameAs( IBlockAccess world, int x, int y, int z );

View File

@ -18,7 +18,6 @@ public interface IComparableDefinition
* Compare {@link ItemStack} with this
*
* @param comparableStack compared item
*
* @return true if the item stack is a matching item.
*/
boolean isSameAs( ItemStack comparableStack );
@ -30,9 +29,7 @@ public interface IComparableDefinition
* @param x x pos of block
* @param y y pos of block
* @param z z pos of block
*
* @return if the block is placed in the world at the specific location.
*
* @deprecated moved to {@link IBlockDefinition}. Is removed in the next major release rv3
*/
@Deprecated

View File

@ -25,7 +25,6 @@ package appeng.api.definitions;
import com.google.common.base.Optional;
import net.minecraft.item.Item;
import net.minecraft.item.ItemStack;

View File

@ -1,9 +1,8 @@
package appeng.api.definitions;
import net.minecraft.tileentity.TileEntity;
import com.google.common.base.Optional;
import net.minecraft.tileentity.TileEntity;
public interface ITileDefinition extends IBlockDefinition

View File

@ -24,14 +24,13 @@
package appeng.api.events;
import cpw.mods.fml.common.eventhandler.Event;
import appeng.api.features.ILocatable;
import cpw.mods.fml.common.eventhandler.Event;
/**
* Input Event:
*
* <p>
* Used to Notify the Location Registry of objects, and their availability.
*/
public class LocatableEventAnnounce extends Event

View File

@ -29,7 +29,7 @@ import appeng.api.networking.IGridNode;
/**
* Exception occurred because of an already existing connection between the two {@link IGridNode}s
*
* <p>
* Intended to signal an internal exception and not intended to be thrown by
* any 3rd party module.
*

View File

@ -29,10 +29,10 @@ import appeng.api.networking.IGridNode;
/**
* Exception indicating a failed connection between two {@link IGridNode}s.
*
* <p>
* Intended to signal an internal exception and not intended to be thrown by
* any 3rd party module.
*
* <p>
* See any subclass for a more specific reason.
*
* @author AlgorithmX2

View File

@ -26,7 +26,7 @@ package appeng.api.exceptions;
/**
* Exception due to trying to connect one or more null values.
*
* <p>
* Intended to signal an internal exception and not intended to be thrown by
* any 3rd party module.
*

View File

@ -26,7 +26,7 @@ package appeng.api.exceptions;
/**
* Exception due to trying to connect different security realms.
*
* <p>
* Intended to signal an internal exception and not intended to be thrown by
* any 3rd party module.
*

View File

@ -24,10 +24,10 @@
package appeng.api.features;
import java.util.List;
import net.minecraft.item.ItemStack;
import java.util.List;
/**
* Lets you manipulate Grinder Recipes, by adding or editing existing ones.
@ -79,7 +79,6 @@ public interface IGrinderRegistry
* Searches for a recipe for a given input, and returns it.
*
* @param input input
*
* @return identified recipe or null
*/
IGrinderEntry getRecipeForInput( ItemStack input );

View File

@ -1,20 +1,19 @@
package appeng.api.features;
import java.util.List;
import javax.annotation.Nonnull;
import com.google.common.base.Optional;
import net.minecraft.item.ItemStack;
import com.google.common.base.Optional;
import javax.annotation.Nonnull;
import java.util.List;
/**
* Registration Records for {@link IInscriberRegistry}
*
* <p>
* You have to pay attention though, that recipes are not mirrored,
* where the top and bottom slots are switching places.
*
* <p>
* This is applied on runtime.
*
* @author thatsIch

View File

@ -1,11 +1,11 @@
package appeng.api.features;
import java.util.Collection;
import javax.annotation.Nonnull;
import net.minecraft.item.ItemStack;
import javax.annotation.Nonnull;
import java.util.Collection;
/**
* Builder for an inscriber recipe
@ -21,7 +21,6 @@ public interface IInscriberRecipeBuilder
* Needs to be invoked.
*
* @param inputs new inputs for the recipe
*
* @return currently used builder
*/
@Nonnull
@ -32,7 +31,6 @@ public interface IInscriberRecipeBuilder
* Needs to be invoked.
*
* @param output new output for the recipe
*
* @return currently used builder
*/
@Nonnull
@ -43,7 +41,6 @@ public interface IInscriberRecipeBuilder
* Either this or bot needs to be invoked.
*
* @param topOptional new top for the recipe
*
* @return currently used builder
*/
@Nonnull
@ -54,7 +51,6 @@ public interface IInscriberRecipeBuilder
* Either this or top needs to be invoked.
*
* @param bottomOptional new bot for the recipe
*
* @return currently used builder
*/
@Nonnull
@ -65,7 +61,6 @@ public interface IInscriberRecipeBuilder
* Needs to be invoked.
*
* @param type new type for the recipe
*
* @return currently used builder
*/
@Nonnull
@ -76,7 +71,6 @@ public interface IInscriberRecipeBuilder
* Needs to be invoked to fetch inscriber recipe.
*
* @return legal inscriber recipe
*
* @throws IllegalStateException when input is not defined
* @throws IllegalStateException when input has no size
* @throws IllegalStateException when output is not defined

View File

@ -1,13 +1,11 @@
package appeng.api.features;
import java.util.Collection;
import java.util.Set;
import net.minecraft.item.ItemStack;
import javax.annotation.Nonnull;
import net.minecraft.item.ItemStack;
import java.util.Collection;
import java.util.Set;
/**
@ -21,13 +19,12 @@ public interface IInscriberRegistry
{
/**
* An immutable copy of currently registered recipes.
*
* <p>
* Use the provided methods to actually modify the inscriber recipes.
*
* @return currentlyRegisteredRecipes
* @see IInscriberRegistry#addRecipe(IInscriberRecipe)
* @see IInscriberRegistry#removeRecipe(IInscriberRecipe)
*
* @return currentlyRegisteredRecipes
*/
@Nonnull
Collection<IInscriberRecipe> getRecipes();
@ -61,7 +58,6 @@ public interface IInscriberRegistry
* Added recipes will be automatically added to the optionals and inputs.
*
* @param recipe new recipe
*
* @throws IllegalArgumentException if null is added
*/
void addRecipe( IInscriberRecipe recipe );

View File

@ -40,7 +40,6 @@ public interface IItemComparisonProvider
* the supplied item.
*
* @param is item
*
* @return IItemComparison, or null
*/
IItemComparison getComparison( ItemStack is );
@ -49,7 +48,6 @@ public interface IItemComparisonProvider
* Simple test for support ( AE generally skips this and calls the above function. )
*
* @param stack item
*
* @return true, if getComparison will return a valid IItemComparison Object
*/
boolean canHandle( ItemStack stack );

View File

@ -34,9 +34,7 @@ public interface ILocatableRegistry
* returns the object.
*
* @param serial serial
*
* @return requestedObject, or null
*
* @deprecated use {@link ILocatableRegistry#getLocatableBy(long)}
*/
@Deprecated
@ -46,7 +44,6 @@ public interface ILocatableRegistry
* Gets the {@link ILocatable} with the registered serial, if available
*
* @param serial serial
*
* @return requestedObject, or null, if the object does not exist anymore
*/
ILocatable getLocatableBy( long serial );

View File

@ -42,7 +42,6 @@ public interface IMatterCannonAmmoRegistry
* get the penetration value for a particular ammo, 0 indicates a non-ammo.
*
* @param is ammo
*
* @return 0 or a valid penetration value.
*/
float getPenetration( ItemStack is );

View File

@ -34,7 +34,6 @@ public interface INetworkEncodable
* Used to get the current key from the item.
*
* @param item item
*
* @return string key of item
*/
String getEncryptionKey( ItemStack item );

View File

@ -24,11 +24,10 @@
package appeng.api.features;
import javax.annotation.Nullable;
import appeng.api.config.TunnelType;
import net.minecraft.item.ItemStack;
import appeng.api.config.TunnelType;
import javax.annotation.Nullable;
/**
@ -50,7 +49,6 @@ public interface IP2PTunnelRegistry
* returns null if no attunement can be found.
*
* @param trigger attunement trigger
*
* @return null if no attunement can be found or attunement
*/
@Nullable

View File

@ -24,12 +24,11 @@
package appeng.api.features;
import javax.annotation.Nullable;
import com.mojang.authlib.GameProfile;
import net.minecraft.entity.player.EntityPlayer;
import javax.annotation.Nullable;
/**
* Maintains a save specific list of userids and username combinations this greatly simplifies storage internally and
@ -40,21 +39,18 @@ public interface IPlayerRegistry
/**
* @param gameProfile user game profile
*
* @return user id of a username.
*/
int getID( GameProfile gameProfile );
/**
* @param player player
*
* @return user id of a player entity.
*/
int getID( EntityPlayer player );
/**
* @param playerID to be found player id
*
* @return PlayerEntity, or null if the player could not be found.
*/
@Nullable

View File

@ -24,12 +24,12 @@
package appeng.api.features;
import javax.annotation.Nullable;
import appeng.api.recipes.ICraftHandler;
import appeng.api.recipes.IRecipeHandler;
import appeng.api.recipes.ISubItemResolver;
import javax.annotation.Nullable;
/**
* @author AlgorithmX2
@ -42,17 +42,17 @@ public interface IRecipeHandlerRegistry
/**
* Add a new Recipe Handler to the parser.
*
* <p>
* MUST BE CALLED IN PRE-INIT
*
* @param name name of crafthandler
* @param name name of crafthandler
* @param handler class of crafthandler
*/
void addNewCraftHandler( String name, Class<? extends ICraftHandler> handler );
/**
* Add a new resolver to the parser.
*
* <p>
* MUST BE CALLED IN PRE-INIT
*
* @param sir sub item resolver
@ -61,7 +61,6 @@ public interface IRecipeHandlerRegistry
/**
* @param name name of crafting handler
*
* @return A recipe handler by name, returns null on failure.
*/
@Nullable
@ -76,8 +75,7 @@ public interface IRecipeHandlerRegistry
* resolve sub items by name.
*
* @param nameSpace namespace of item
* @param itemName full name of item
*
* @param itemName full name of item
* @return ResolverResult or ResolverResultSet or null if could not resolve
*/
@Nullable

View File

@ -37,7 +37,6 @@ public interface ISpecialComparisonRegistry
* return TheHandler or null.
*
* @param stack item
*
* @return a handler it found for a specific item
*/
IItemComparison getSpecialComparison( ItemStack stack );

View File

@ -24,11 +24,10 @@
package appeng.api.features;
import appeng.api.util.IConfigManager;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.item.ItemStack;
import appeng.api.util.IConfigManager;
/**
* A handler for a wireless terminal.
@ -38,7 +37,6 @@ public interface IWirelessTermHandler extends INetworkEncodable
/**
* @param is wireless terminal
*
* @return true, if usePower, hasPower, etc... can be called for the provided item
*/
boolean canHandle( ItemStack is );
@ -49,7 +47,6 @@ public interface IWirelessTermHandler extends INetworkEncodable
* @param amount is in AE units ( 5 per MJ ), if you return false, the item should be dead and return false for
* hasPower
* @param is wireless terminal
*
* @return true if wireless terminal uses power
*/
boolean usePower( EntityPlayer player, double amount, ItemStack is );
@ -58,7 +55,6 @@ public interface IWirelessTermHandler extends INetworkEncodable
* gets the power status of the item.
*
* @param is wireless terminal
*
* @return returns true if there is any power left.
*/
boolean hasPower( EntityPlayer player, double amount, ItemStack is );
@ -67,7 +63,6 @@ public interface IWirelessTermHandler extends INetworkEncodable
* Return the config manager for the wireless terminal.
*
* @param is wireless terminal
*
* @return config manager of wireless terminal
*/
IConfigManager getConfigManager( ItemStack is );

View File

@ -44,14 +44,12 @@ public interface IWirelessTermRegistry
/**
* @param is item which might have a handler
*
* @return true if there is a handler for this item
*/
boolean isWirelessTerminal( ItemStack is );
/**
* @param is item with handler
*
* @return a register handler for the item in question, or null if there
* isn't one
*/

View File

@ -24,12 +24,11 @@
package appeng.api.implementations;
import appeng.api.networking.crafting.ICraftingPatternDetails;
import net.minecraft.item.Item;
import net.minecraft.item.ItemStack;
import net.minecraft.world.World;
import appeng.api.networking.crafting.ICraftingPatternDetails;
/**
* Implemented on {@link Item}
@ -42,7 +41,6 @@ public interface ICraftingPatternItem
*
* @param is pattern
* @param w crafting world
*
* @return details of pattern
*/
ICraftingPatternDetails getPatternForItem( ItemStack is, World w );

View File

@ -24,11 +24,10 @@
package appeng.api.implementations;
import net.minecraft.tileentity.TileEntity;
import appeng.api.config.Upgrades;
import appeng.api.implementations.tiles.ISegmentedInventory;
import appeng.api.util.IConfigurableObject;
import net.minecraft.tileentity.TileEntity;
public interface IUpgradeableHost extends IConfigurableObject, ISegmentedInventory

View File

@ -24,9 +24,8 @@
package appeng.api.implementations.guiobjects;
import net.minecraft.inventory.IInventory;
import appeng.api.networking.IGridHost;
import net.minecraft.inventory.IInventory;
/**

View File

@ -24,10 +24,9 @@
package appeng.api.implementations.items;
import net.minecraft.item.ItemStack;
import appeng.api.config.AccessRestriction;
import appeng.api.networking.energy.IAEPowerStorage;
import net.minecraft.item.ItemStack;
/**
@ -49,7 +48,6 @@ public interface IAEItemPowerStorage
* return it.
*
* @param amt to be extracted power from device
*
* @return what it could extract
*/
double extractAEPower( ItemStack is, double amt );

View File

@ -42,7 +42,6 @@ public interface IAEWrench
* @param x x pos of wrenched block
* @param y y pos of wrenched block
* @param z z pos of wrenched block
*
* @return true if wrench can be used
*/
boolean canWrench( ItemStack wrench, EntityPlayer player, int x, int y, int z );

View File

@ -24,15 +24,13 @@
package appeng.api.implementations.items;
import java.util.EnumSet;
import net.minecraft.item.ItemStack;
import com.mojang.authlib.GameProfile;
import appeng.api.config.SecurityPermissions;
import appeng.api.features.IPlayerRegistry;
import appeng.api.networking.security.ISecurityRegistry;
import com.mojang.authlib.GameProfile;
import net.minecraft.item.ItemStack;
import java.util.EnumSet;
public interface IBiometricCard
@ -50,7 +48,6 @@ public interface IBiometricCard
/**
* @param itemStack card
*
* @return the full list of permissions encoded on the card.
*/
EnumSet<SecurityPermissions> getPermissions( ItemStack itemStack );
@ -59,7 +56,6 @@ public interface IBiometricCard
* Check if a permission is encoded on the card.
*
* @param permission card
*
* @return true if this permission is set on the card.
*/
boolean hasPermission( ItemStack is, SecurityPermissions permission );

View File

@ -24,10 +24,10 @@
package appeng.api.implementations.items;
import java.util.Set;
import net.minecraft.item.ItemStack;
import java.util.Set;
/**
* Lets you specify the name of the group of items this falls under.
@ -39,7 +39,6 @@ public interface IItemGroup
* returning null, is the same as not implementing the interface at all.
*
* @param is item
*
* @return an unlocalized string to use for the items group name.
*/
String getUnlocalizedGroupName( Set<ItemStack> otherItems, ItemStack is );

View File

@ -31,7 +31,7 @@ import net.minecraft.nbt.NBTTagCompound;
/**
* Memory Card API
*
* <p>
* AE's Memory Card Item Class implements this interface.
*/
public interface IMemoryCard
@ -55,14 +55,12 @@ public interface IMemoryCard
* previous call to setMemoryCardContents.
*
* @param is item
*
* @return setting name
*/
String getSettingsName( ItemStack is );
/**
* @param is item
*
* @return the NBT Data previously saved by setMemoryCardContents, or an
* empty NBTCompound
*/

View File

@ -24,13 +24,12 @@
package appeng.api.implementations.items;
import appeng.api.implementations.TransitionResult;
import appeng.api.util.WorldCoord;
import net.minecraft.item.Item;
import net.minecraft.item.ItemStack;
import net.minecraft.world.World;
import appeng.api.implementations.TransitionResult;
import appeng.api.util.WorldCoord;
/**
* Implemented on a {@link Item}
@ -40,21 +39,18 @@ public interface ISpatialStorageCell
/**
* @param is spatial storage cell
*
* @return true if this item is a spatial storage cell
*/
boolean isSpatialStorage( ItemStack is );
/**
* @param is spatial storage cell
*
* @return the maximum size of the spatial storage cell along any given axis
*/
int getMaxStoredDim( ItemStack is );
/**
* @param is spatial storage cell
*
* @return the world for this cell
*/
World getWorld( ItemStack is );
@ -63,7 +59,6 @@ public interface ISpatialStorageCell
* get the currently stored size.
*
* @param is spatial storage cell
*
* @return size of spatial
*/
WorldCoord getStoredSize( ItemStack is );
@ -72,7 +67,6 @@ public interface ISpatialStorageCell
* Minimum coordinates in its world for the storage cell.
*
* @param is spatial storage cell
*
* @return minimum coordinate of dimension
*/
WorldCoord getMin( ItemStack is );
@ -81,7 +75,6 @@ public interface ISpatialStorageCell
* Maximum coordinates in its world for the storage cell.
*
* @param is spatial storage cell
*
* @return maximum coordinate of dimension
*/
WorldCoord getMax( ItemStack is );
@ -94,7 +87,6 @@ public interface ISpatialStorageCell
* @param min min coord
* @param max max coord
* @param doTransition transition
*
* @return result of transition
*/
TransitionResult doSpatialTransition( ItemStack is, World w, WorldCoord min, WorldCoord max, boolean doTransition );

View File

@ -24,20 +24,19 @@
package appeng.api.implementations.items;
import net.minecraft.item.ItemStack;
import appeng.api.storage.ICellWorkbenchItem;
import appeng.api.storage.data.IAEItemStack;
import net.minecraft.item.ItemStack;
/**
* Any item which implements this can be treated as an IMEInventory via
* Util.getCell / Util.isCell It automatically handles the internals and NBT
* data, which is both nice, and bad for you!
*
* <p>
* Good cause it means you don't have to do anything, bad because you have
* little to no control over it.
*
* <p>
* The standard AE implementation only provides 1-63 Types
*/
public interface IStorageCell extends ICellWorkbenchItem
@ -48,7 +47,6 @@ public interface IStorageCell extends ICellWorkbenchItem
* The limit is ({@link Integer#MAX_VALUE} + 1) / 8.
*
* @param cellItem item
*
* @return number of bytes
*/
int getBytes( ItemStack cellItem );
@ -57,9 +55,7 @@ public interface IStorageCell extends ICellWorkbenchItem
* Determines the number of bytes used for any type included on the cell.
*
* @param cellItem item
*
* @return number of bytes
*
* @deprecated use {@link IStorageCell#getBytesPerType(ItemStack)}
*/
@Deprecated
@ -69,7 +65,6 @@ public interface IStorageCell extends ICellWorkbenchItem
* Determines the number of bytes used for any type included on the cell.
*
* @param cellItem item
*
* @return number of bytes
*/
int getBytesPerType( ItemStack cellItem );
@ -79,7 +74,6 @@ public interface IStorageCell extends ICellWorkbenchItem
* the item.
*
* @param cellItem item
*
* @return number of types
*/
int getTotalTypes( ItemStack cellItem );
@ -91,7 +85,6 @@ public interface IStorageCell extends ICellWorkbenchItem
*
* @param cellItem item
* @param requestedAddition requested addition
*
* @return true to preventAdditionOfItem
*/
boolean isBlackListed( ItemStack cellItem, IAEItemStack requestedAddition );
@ -112,7 +105,6 @@ public interface IStorageCell extends ICellWorkbenchItem
* cell.
*
* @param i item
*
* @return if the ItemStack should behavior as a storage cell.
*/
boolean isStorageCell( ItemStack i );

View File

@ -40,7 +40,6 @@ public interface IStorageComponent
* the condenser.
*
* @param is item
*
* @return number of bytes
*/
int getBytes( ItemStack is );
@ -49,7 +48,6 @@ public interface IStorageComponent
* Just true or false for the item stack.
*
* @param is item
*
* @return true if item is a storage component
*/
boolean isStorageComponent( ItemStack is );

View File

@ -24,9 +24,8 @@
package appeng.api.implementations.items;
import net.minecraft.item.ItemStack;
import appeng.api.config.Upgrades;
import net.minecraft.item.ItemStack;
public interface IUpgradeModule
@ -34,7 +33,6 @@ public interface IUpgradeModule
/**
* @param itemstack item with potential upgrades
*
* @return null, or a valid upgrade type.
*/
Upgrades getType( ItemStack itemstack );

View File

@ -24,17 +24,16 @@
package appeng.api.implementations.parts;
import java.util.EnumSet;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraftforge.common.util.ForgeDirection;
import appeng.api.networking.IGridHost;
import appeng.api.parts.BusSupport;
import appeng.api.parts.IPart;
import appeng.api.parts.IPartHost;
import appeng.api.util.AECableType;
import appeng.api.util.AEColor;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraftforge.common.util.ForgeDirection;
import java.util.EnumSet;
/**
@ -63,14 +62,13 @@ public interface IPartCable extends IPart, IGridHost
* Change the color of the cable, this should cost a small amount of dye, or something.
*
* @param newColor new color
*
* @return if the color change was successful.
*/
boolean changeColor( AEColor newColor, EntityPlayer who );
/**
* Change sides on the cables node.
*
* <p>
* Called by AE, do not invoke.
*
* @param sides sides of cable
@ -81,7 +79,6 @@ public interface IPartCable extends IPart, IGridHost
* used to tests if a cable connects to neighbors visually.
*
* @param side neighbor side
*
* @return true if this side is currently connects to an external block.
*/
boolean isConnected( ForgeDirection side );

View File

@ -39,15 +39,14 @@ public interface IChestOrDrive extends ICellContainer, IGridHost, IOrientable
/**
* 0 - cell is missing.
*
* <p>
* 1 - green,
*
* <p>
* 2 - orange,
*
* <p>
* 3 - red
*
* @param slot slot index
*
* @return status of the slot, one of the above indices.
*/
int getCellStatus( int slot );
@ -59,7 +58,6 @@ public interface IChestOrDrive extends ICellContainer, IGridHost, IOrientable
/**
* @param slot slot index
*
* @return is the cell currently blinking to show activity.
*/
boolean isCellBlinking( int slot );

View File

@ -24,11 +24,10 @@
package appeng.api.implementations.tiles;
import appeng.api.util.AEColor;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraftforge.common.util.ForgeDirection;
import appeng.api.util.AEColor;
public interface IColorableTile
{

View File

@ -24,11 +24,10 @@
package appeng.api.implementations.tiles;
import appeng.api.networking.crafting.ICraftingPatternDetails;
import net.minecraft.inventory.InventoryCrafting;
import net.minecraftforge.common.util.ForgeDirection;
import appeng.api.networking.crafting.ICraftingPatternDetails;
public interface ICraftingMachine
{
@ -39,7 +38,6 @@ public interface ICraftingMachine
* @param patternDetails details of pattern
* @param table crafting table
* @param ejectionDirection ejection direction
*
* @return if it was accepted, all or nothing.
*/
boolean pushPattern( ICraftingPatternDetails patternDetails, InventoryCrafting table, ForgeDirection ejectionDirection );

View File

@ -29,12 +29,12 @@ import net.minecraftforge.common.util.ForgeDirection;
/**
* Crank/Crankable API,
*
* <p>
* Tiles that Implement this can receive power, from the crank, and have the
* crank placed on them.
*
* <p>
* Tiles that access other tiles that implement this method can act as Cranks.
*
* <p>
* This interface must be implemented by a tile entity.
*/
public interface ICrankable

View File

@ -35,7 +35,6 @@ public interface ISegmentedInventory
* them a real inventories will result in duplication.
*
* @param name inventory name
*
* @return inventory with inventory name
*/
IInventory getInventoryByName( String name );

View File

@ -24,10 +24,9 @@
package appeng.api.implementations.tiles;
import net.minecraftforge.common.util.ForgeDirection;
import appeng.api.networking.security.BaseActionSource;
import appeng.api.storage.IStorageMonitorable;
import net.minecraftforge.common.util.ForgeDirection;
/**

View File

@ -27,10 +27,10 @@ package appeng.api.integration;
/**
* An interface to get access to the individual settings for AE's Internal Bee
* Comparison handler.
*
* <p>
* Assessable via: ( IBeeComparison )
* IAEItemStack.getTagCompound().getSpecialComparison()
*
* <p>
* If you don't have the forestry API, just delete this file when using the API.
*/
public interface IBeeComparison

View File

@ -37,7 +37,6 @@ public interface IMovableHandler
*
* @param myClass tile entity class
* @param tile tile entity
*
* @return true if it can handle moving
*/
boolean canHandle( Class<? extends TileEntity> myClass, TileEntity tile );
@ -46,9 +45,9 @@ public interface IMovableHandler
* request that the handler move the the tile from its current location to
* the new one. the tile has already been invalidated, and the blocks have
* already been fully moved.
*
* <p>
* Potential Example:
*
* <p>
* <pre>
* {@code
* Chunk c = world.getChunkFromBlockCoords( x, z ); c.setChunkBlockTileEntity( x

View File

@ -30,29 +30,29 @@ import net.minecraft.tileentity.TileEntity;
/**
* Used to determine if a tile is marked as movable, a block will be considered movable, if...
*
* <p>
* 1. The Tile or its super classes have been white listed with whiteListTileEntity.
*
* <p>
* 2. The Tile has been register with the IMC ( which basically calls whiteListTileEntity. )
*
* <p>
* 3. The Tile implements IMovableTile 4. A IMovableHandler is register that returns canHandle = true for the Tile
* Entity Class
*
* <p>
* IMC Example: FMLInterModComms.sendMessage( "appliedenergistics2", "movabletile", "appeng.common.AppEngTile" );
*
* <p>
* The movement process is as follows,
*
* <p>
* 1. IMovableTile.prepareToMove() or TileEntity.invalidate() depending on your opt-in method. 2. The tile will be
* removed from the world. 3. Its world, coordinates will be changed. *** this can be overridden with a IMovableHandler
* *** 4. It will then be re-added to the world, or a new world. 5. TileEntity.validate() 6. IMovableTile.doneMoving (
* if you implemented IMovableTile )
*
* <p>
* Please note, this is a 100% white list only feature, I will never opt in any non-vanilla, non-AE blocks. If you do
* not want to support your tiles being moved, you don't have to do anything.
*
* <p>
* I appreciate anyone that takes the effort to get their tiles to work with this system to create a better use
* experience.
*
* <p>
* If you need a build of deobf build of AE for testing, do not hesitate to ask.
*/
public interface IMovableRegistry
@ -60,7 +60,7 @@ public interface IMovableRegistry
/**
* Black list a block from movement, please only use this to prevent exploits.
*
* <p>
* You can also use the IMC, FMLInterModComms.sendMessage( "appliedenergistics2", "whitelist-spatial",
* "appeng.common.AppEngTile" );
*
@ -70,17 +70,16 @@ public interface IMovableRegistry
/**
* White list your tile entity with the registry.
*
* <p>
* You can also use the IMC, FMLInterModComms.sendMessage( "appliedenergistics2", "blacklist-block-spatial", new
* ItemStack(...) );
*
* <p>
* If you tile is handled with IMovableHandler or IMovableTile you do not need to white list it.
*/
void whiteListTileEntity( Class<? extends TileEntity> c );
/**
* @param te to be moved tile entity
*
* @return true if the tile has accepted your request to move it
*/
boolean askToMove( TileEntity te );
@ -101,11 +100,10 @@ public interface IMovableRegistry
/**
* handlers are used to perform movement, this allows you to override AE's internal version.
*
* <p>
* only valid after askToMove(...) = true
*
* @param te tile entity
*
* @return moving handler of tile entity
*/
IMovableHandler getHandler( TileEntity te );
@ -117,7 +115,6 @@ public interface IMovableRegistry
/**
* @param blk block
*
* @return true if this block is blacklisted
*/
boolean isBlacklisted( Block blk );

View File

@ -30,7 +30,7 @@ import appeng.api.util.IReadOnlyCollection;
/**
* Gives you access to Grid based information.
*
* <p>
* Don't Implement.
*/
public interface IGrid
@ -40,7 +40,6 @@ public interface IGrid
* Get Access to various grid modules
*
* @param iface face
*
* @return the IGridCache you requested.
*/
<C extends IGridCache> C getCache( Class<? extends IGridCache> iface );
@ -49,7 +48,6 @@ public interface IGrid
* Post an event into the network event bus.
*
* @param ev - event to post
*
* @return returns ev back to original poster
*/
MENetworkEvent postEvent( MENetworkEvent ev );
@ -58,7 +56,6 @@ public interface IGrid
* Post an event into the network event bus, but direct it at a single node.
*
* @param ev event to post
*
* @return returns ev back to original poster
*/
MENetworkEvent postEventTo( IGridNode node, MENetworkEvent ev );
@ -75,7 +72,6 @@ public interface IGrid
* Get machines on the network.
*
* @param gridHostClass class of the grid host
*
* @return IMachineSet of all nodes belonging to hosts of specified class.
*/
IMachineSet getMachines( Class<? extends IGridHost> gridHostClass );

View File

@ -24,19 +24,18 @@
package appeng.api.networking;
import java.util.EnumSet;
import net.minecraft.item.ItemStack;
import net.minecraftforge.common.util.ForgeDirection;
import appeng.api.parts.IPart;
import appeng.api.util.AEColor;
import appeng.api.util.DimensionalCoord;
import net.minecraft.item.ItemStack;
import net.minecraftforge.common.util.ForgeDirection;
import java.util.EnumSet;
/**
* An Implementation is required to create your node for IGridHost
*
* <p>
* Implement for use with IGridHost
*/
public interface IGridBlock
@ -44,7 +43,7 @@ public interface IGridBlock
/**
* how much power to drain per tick as part of idle network usage.
*
* <p>
* if the value of this changes, you must post a MENetworkPowerIdleChange
*
* @return ae/t to use.

View File

@ -27,7 +27,7 @@ package appeng.api.networking;
/**
* Allows you to create a network wise service, AE2 uses these for providing
* item, spatial, and tunnel services.
*
* <p>
* Any Class that implements this, should have a public default constructor that
* takes a single argument of type IGrid.
*/
@ -42,7 +42,7 @@ public interface IGridCache
/**
* inform your cache, that a machine was removed from the grid.
*
* <p>
* Important: Do not trust the grids state in this method, interact only
* with the node you are passed, if you need to manage other grid
* information, do it on the next updateTick.
@ -54,7 +54,7 @@ public interface IGridCache
/**
* informs you cache that a machine was added to the grid.
*
* <p>
* Important: Do not trust the grids state in this method, interact only
* with the node you are passed, if you need to manage other grid
* information, do it on the next updateTick.

View File

@ -44,7 +44,6 @@ public interface IGridCacheRegistry
* requests a new INSTANCE of a grid cache for use, used internally
*
* @param grid grid
*
* @return a new HashMap of IGridCaches from the registry, called from IGrid when constructing a new grid.
*/
HashMap<Class<? extends IGridCache>, IGridCache> createCacheInstance( IGrid grid );

View File

@ -29,10 +29,10 @@ import net.minecraftforge.common.util.ForgeDirection;
/**
* Access to AE's internal grid connections.
*
* <p>
* Messing with connection is generally completely unnecessary, you should be able to just use IGridNode.updateState()
* to have AE manage them for you.
*
* <p>
* Don't Implement.
*/
public interface IGridConnection
@ -42,7 +42,6 @@ public interface IGridConnection
* lets you get the opposing node of the connection by passing your own node.
*
* @param gridNode current grid node
*
* @return the IGridNode which represents the opposite side of the connection.
*/
IGridNode getOtherSide( IGridNode gridNode );
@ -51,7 +50,6 @@ public interface IGridConnection
* determine the direction of the connection based on your node.
*
* @param gridNode current grid node
*
* @return the direction of the connection, only valid for in world connections.
*/
ForgeDirection getDirection( IGridNode gridNode );

View File

@ -24,11 +24,10 @@
package appeng.api.networking;
import net.minecraft.tileentity.TileEntity;
import net.minecraftforge.common.util.ForgeDirection;
import appeng.api.parts.IPart;
import appeng.api.util.AECableType;
import net.minecraft.tileentity.TileEntity;
import net.minecraftforge.common.util.ForgeDirection;
/**
@ -45,7 +44,6 @@ public interface IGridHost
*
* @param dir feel free to ignore this, most blocks will use the same node
* for every side.
*
* @return a new IGridNode, create these with
* AEApi.INSTANCE().createGridNode( MyIGridBlock )
*/

View File

@ -24,21 +24,20 @@
package appeng.api.networking;
import java.util.EnumSet;
import appeng.api.IAppEngApi;
import appeng.api.util.IReadOnlyCollection;
import net.minecraft.nbt.NBTTagCompound;
import net.minecraft.world.World;
import net.minecraftforge.common.util.ForgeDirection;
import appeng.api.IAppEngApi;
import appeng.api.util.IReadOnlyCollection;
import java.util.EnumSet;
/**
* Gives you a view into your Nodes connections and information.
*
* <p>
* updateState, getGrid, destroy are required to implement a proper IGridHost.
*
* <p>
* Don't Implement; Acquire from {@link IAppEngApi}.createGridNode
*/
public interface IGridNode
@ -54,10 +53,10 @@ public interface IGridNode
/**
* inform the node that your IGridBlock has changed its internal state, and force the node to update.
*
* <p>
* ALWAYS make sure that your tile entity is in the world, and has its node properly saved to be returned from the
* host before updating state,
*
* <p>
* If your entity is not in the world, or if you IGridHost returns a different node for the same side you will
* likely crash the game.
*/
@ -116,7 +115,7 @@ public interface IGridNode
/**
* this should be called for each node you create, if you have a nodeData compound to load from, you can store all
* your nods on a single compound using name.
*
* <p>
* Important: You must call this before updateState.
*
* @param name nbt name
@ -143,7 +142,6 @@ public interface IGridNode
* see if this node has a certain flag
*
* @param flag flags
*
* @return true if has flag
*/
boolean hasFlag( GridFlags flag );

View File

@ -32,11 +32,10 @@ public interface IGridVisitor
/**
* Called for each node on the network.
*
* <p>
* By returning false your informing the host to stop visiting nodes beyond the current node.
*
* @param n the current node.
*
* @return true to continue visiting nodes beyond this node.
*/
boolean visitNode( IGridNode n );

View File

@ -24,17 +24,15 @@
package appeng.api.networking.crafting;
import java.util.concurrent.Future;
import net.minecraft.world.World;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableSet;
import appeng.api.networking.IGrid;
import appeng.api.networking.IGridCache;
import appeng.api.networking.security.BaseActionSource;
import appeng.api.storage.data.IAEItemStack;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableSet;
import net.minecraft.world.World;
import java.util.concurrent.Future;
public interface ICraftingGrid extends IGridCache
@ -45,7 +43,6 @@ public interface ICraftingGrid extends IGridCache
* @param world crafting world
* @param slot slot index
* @param details pattern details
*
* @return a collection of crafting patterns for the item in question.
*/
ImmutableCollection<ICraftingPatternDetails> getCraftingFor( IAEItemStack whatToCraft, ICraftingPatternDetails details, int slot, World world );
@ -59,7 +56,6 @@ public interface ICraftingGrid extends IGridCache
* @param craftWhat result
* @param callback callback
* -- optional
*
* @return a future which will at an undetermined point in the future get you the {@link ICraftingJob} do not wait
* on this, your be waiting forever.
*/
@ -75,7 +71,6 @@ public interface ICraftingGrid extends IGridCache
* end cpus, automatic processes generally should pick lower end cpus.
* @param src - the action source to use when starting the job, this will be used for extracting items, should
* usually be the same as the one provided to beginCraftingJob.
*
* @return null ( if failed ) or an {@link ICraftingLink} other wise, if you send requestingMachine you need to
* properly keep track of this and handle the nbt saving and loading of the object as well as the
* {@link ICraftingRequester} methods. if you send null, this object should be discarded after verifying the
@ -90,7 +85,6 @@ public interface ICraftingGrid extends IGridCache
/**
* @param what to be requested item
*
* @return true if the item can be requested via a crafting emitter.
*/
boolean canEmitFor( IAEItemStack what );
@ -99,7 +93,6 @@ public interface ICraftingGrid extends IGridCache
* is this item being crafted?
*
* @param aeStackInSlot item being crafted
*
* @return true if it is being crafting
*/
boolean isRequesting( IAEItemStack aeStackInSlot );

View File

@ -39,7 +39,6 @@ public interface ICraftingMedium
*
* @param patternDetails details
* @param table crafting table
*
* @return if the pattern was successfully pushed.
*/
boolean pushPattern( ICraftingPatternDetails patternDetails, InventoryCrafting table );

View File

@ -24,17 +24,16 @@
package appeng.api.networking.crafting;
import appeng.api.implementations.ICraftingPatternItem;
import appeng.api.storage.data.IAEItemStack;
import net.minecraft.inventory.InventoryCrafting;
import net.minecraft.item.ItemStack;
import net.minecraft.world.World;
import appeng.api.implementations.ICraftingPatternItem;
import appeng.api.storage.data.IAEItemStack;
/**
* do not implement provided by {@link ICraftingPatternItem}
*
* <p>
* caching this INSTANCE will increase performance of validation and checks.
*/
public interface ICraftingPatternDetails
@ -49,7 +48,6 @@ public interface ICraftingPatternDetails
* @param slotIndex specific slot index
* @param itemStack item in slot
* @param world crafting world
*
* @return if an item can be used in the specific slot for this pattern.
*/
boolean isValidItemForSlot( int slotIndex, ItemStack itemStack, World world );
@ -89,7 +87,6 @@ public interface ICraftingPatternDetails
*
* @param craftingInv inventory
* @param world crafting world
*
* @return the crafted ( work bench ) item.
*/
ItemStack getOutput( InventoryCrafting craftingInv, World world );

View File

@ -24,11 +24,10 @@
package appeng.api.networking.crafting;
import com.google.common.collect.ImmutableSet;
import appeng.api.config.Actionable;
import appeng.api.networking.security.IActionHost;
import appeng.api.storage.data.IAEItemStack;
import com.google.common.collect.ImmutableSet;
public interface ICraftingRequester extends IActionHost
@ -48,14 +47,13 @@ public interface ICraftingRequester extends IActionHost
*
* @param items item
* @param mode action mode
*
* @return unwanted item
*/
IAEItemStack injectCraftedItems( ICraftingLink link, IAEItemStack items, Actionable mode );
/**
* called when the job changes from in progress, to either complete, or canceled.
*
* <p>
* after this call the crafting link is "dead" and should be discarded.
*/
void jobStateChange( ICraftingLink link );

View File

@ -24,10 +24,10 @@
package appeng.api.networking.crafting;
import java.util.Collection;
import appeng.api.storage.data.IAEStack;
import java.util.Collection;
public interface ICraftingWatcher extends Collection<IAEStack>
{

View File

@ -39,7 +39,6 @@ public interface IAEPowerStorage extends IEnergySource
*
* @param amt to be injected amount
* @param mode action mode
*
* @return amount of power which was unable to be stored
*/
double injectAEPower( double amt, Actionable mode );

View File

@ -55,7 +55,7 @@ public interface IEnergyGrid extends IGridCache, IEnergySource, IEnergyGridProvi
* AE maintains an idle draw of power separate from active power draw, it condenses this into a single operation
* that determines the networks "powered state" if the network is considered off-line, your machines should not
* function.
*
* <p>
* {@link MENetworkPowerStatusChange} events are posted when this value changes if you need to be notified of the
* change, most machines can simply test the value when they operate.
*
@ -65,18 +65,17 @@ public interface IEnergyGrid extends IGridCache, IEnergySource, IEnergyGridProvi
/**
* AE will accept any power, and store it, to maintain sanity please don't send more then 10,000 at a time.
*
* <p>
* IMPORTANT: Network power knows no bounds, for less spamy power flow, networks can store more then their allotted
* storage, however, it should be kept to a minimum, to help with this, this method returns the networks current
* OVERFLOW, this is not energy you can store some where else, its already stored in the network, you can extract it
* if you want, however it it owned by the network, this is different then IAEEnergyStore
*
* <p>
* Another important note, is that if a network that had overflow is deleted, its power is gone, this is one of the
* reasons why keeping overflow to a minimum is important.
*
* @param amt power to inject into the network
* @param mode should the action be simulated or performed?
*
* @return the amount of power that the network has OVER the limit.
*/
double injectPower( double amt, Actionable mode );

View File

@ -24,10 +24,10 @@
package appeng.api.networking.energy;
import java.util.Set;
import appeng.api.config.Actionable;
import java.util.Set;
/**
* internal use only.

View File

@ -36,7 +36,6 @@ public interface IEnergySource
*
* @param amt extracted power
* @param mode should the action be simulated or performed?
*
* @return returns extracted power.
*/
double extractAEPower( double amt, Actionable mode, PowerMultiplier usePowerMultiplier );

View File

@ -30,7 +30,7 @@ import appeng.api.networking.IGridNode;
/**
* Posted by the network when the booting status of the network goes up
* or down, the change is reflected via {@link IGridNode}.isActive()
*
* <p>
* Note: Most machines just need to check {@link IGridNode}.isActive()
*/
public class MENetworkBootingStatusChange extends MENetworkEvent

View File

@ -26,10 +26,10 @@ package appeng.api.networking.events;
/**
* Posted by storage devices to inform AE to refresh its storage structure.
*
* <p>
* This is done in cases such as a storage cell being removed or added to a
* drive.
*
* <p>
* you do not need to send this event when your node is added / removed from the
* grid.
*/

View File

@ -29,7 +29,7 @@ import appeng.api.networking.IGridHost;
/**
* Posted to the {@link IGridHost} when the channels on the node connections are altered.
*
* <p>
* Never posted IGridCaches.
*/
public class MENetworkChannelsChanged extends MENetworkEvent

View File

@ -29,7 +29,7 @@ import appeng.api.networking.IGrid;
/**
* Part of AE's Event Bus.
*
* <p>
* Posted via {@link IGrid}.postEvent or {@link IGrid}.postEventTo
*/
public class MENetworkEvent

View File

@ -24,12 +24,12 @@
package appeng.api.networking.events;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import appeng.api.networking.IGridCache;
import appeng.api.networking.IGridHost;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Usable on any {@link IGridHost}, or {@link IGridCache}

View File

@ -31,7 +31,7 @@ import appeng.api.networking.IGridNode;
* Implementers of a IGridBlock must post this event when your getIdlePowerUsage
* starts returning a new value, if you do not post this event the network will
* not change the idle draw.
*
* <p>
* you do not need to send this event when your node is added / removed from the grid.
*/
public class MENetworkPowerIdleChange extends MENetworkEvent

View File

@ -32,7 +32,7 @@ import appeng.api.networking.energy.IEnergyGrid;
* Posted by the network when the power status of the network goes up or down,
* the change is reflected via the {@link IEnergyGrid}.isNetworkPowered() or via
* {@link IGridNode}.isActive()
*
* <p>
* Note: Most machines just need to check {@link IGridNode}.isActive()
*/
public class MENetworkPowerStatusChange extends MENetworkEvent

View File

@ -30,10 +30,10 @@ import appeng.api.networking.energy.IAEPowerStorage;
/**
* informs the network, that a {@link IAEPowerStorage} block that had either run,
* out of power, or was full, is no longer in that state.
*
* <p>
* failure to post this event when your {@link IAEPowerStorage} changes state will
* result in your block not charging, or not-discharging.
*
* <p>
* you do not need to send this event when your node is added / removed from the grid.
*/
public class MENetworkPowerStorage extends MENetworkEvent

View File

@ -31,9 +31,9 @@ import appeng.api.storage.StorageChannel;
/**
* posted by the network when the networks Storage Changes, you can use the currentItems list to check levels, and
* update status.
*
* <p>
* this is the least useful method of getting info about changes in the network.
*
* <p>
* Do not modify the list or its contents in anyway.
*/
public class MENetworkStorageEvent extends MENetworkEvent

View File

@ -24,10 +24,9 @@
package appeng.api.networking.security;
import net.minecraft.entity.player.EntityPlayer;
import appeng.api.config.SecurityPermissions;
import appeng.api.networking.IGridCache;
import net.minecraft.entity.player.EntityPlayer;
public interface ISecurityGrid extends IGridCache
@ -43,7 +42,6 @@ public interface ISecurityGrid extends IGridCache
*
* @param player to be checked player
* @param perm checked permissions
*
* @return true if the player has permissions.
*/
boolean hasPermission( EntityPlayer player, SecurityPermissions perm );
@ -53,7 +51,6 @@ public interface ISecurityGrid extends IGridCache
*
* @param playerID id of player
* @param perm checked permissions
*
* @return true if the player has permissions.
*/
boolean hasPermission( int playerID, SecurityPermissions perm );

View File

@ -24,11 +24,11 @@
package appeng.api.networking.security;
import appeng.api.config.SecurityPermissions;
import java.util.EnumSet;
import java.util.HashMap;
import appeng.api.config.SecurityPermissions;
/**
* Implemented on Security Terminal to interface with security cache.

View File

@ -24,10 +24,10 @@
package appeng.api.networking.security;
import java.util.EnumSet;
import appeng.api.config.SecurityPermissions;
import java.util.EnumSet;
/**
* Used by vanilla Security Terminal to post biometric data into the security cache.

View File

@ -24,10 +24,10 @@
package appeng.api.networking.storage;
import java.util.Collection;
import appeng.api.storage.data.IAEStack;
import java.util.Collection;
public interface IStackWatcher extends Collection<IAEStack>
{

View File

@ -44,7 +44,7 @@ public interface IStorageGrid extends IGridCache, IStorageMonitorable
* Used to inform the network of alterations to the storage system that fall outside of the standard Network
* operations, Examples, ME Chest inputs from the world, or a Storage Bus detecting modifications made to the chest
* by an outside force.
*
* <p>
* Expects the input to have either a negative or a positive stack size to correspond to the injection, or
* extraction operation.
*
@ -54,7 +54,7 @@ public interface IStorageGrid extends IGridCache, IStorageMonitorable
/**
* Used to add a cell provider to the storage system
*
* <p>
* THIS IT NOT FOR USE {@link IGridHost} THAT PROVIDE {@link ICellContainer} - those are automatically handled by
* the storage system.
*

View File

@ -48,7 +48,7 @@ public interface IGridTickable
* You can return null, if you wish to tick using MC's ticking mechanism, or
* you can return a valid TickingRequest to tell AE a guide for which type
* of responsiveness your device wants.
*
* <p>
* this will be called for your tile any time your tile changes grids, this
* can happen at any time, so if your using the sleep feature you may wish
* to preserve your sleep, in the result of this method. or you can simply
@ -62,15 +62,14 @@ public interface IGridTickable
* AE lets you adjust your tick rate based on the results of your tick, if
* your block as accomplished work you may wish to increase the ticking
* speed, if your block is idle you may wish to slow it down.
*
* <p>
* Its up to you.
*
* <p>
* Note: this is never called if you return null from getTickingRequest.
*
* @param TicksSinceLastCall the number of world ticks that were skipped since your last
* tick, you can use this to adjust speed of processing or adjust
* your tick rate.
*
* @return tick rate adjustment.
*/
TickRateModulation tickingRequest( IGridNode node, int TicksSinceLastCall );

View File

@ -36,7 +36,7 @@ public interface ITickManager extends IGridCache
/**
* immediately sets the node to tick, only valid if your node is marked as "Alertable" in its TickingRequest
*
* <p>
* Sleeping Devices Still Alertable, when your tile is alerted its new status is determined by the result of its
* tick.
*
@ -48,7 +48,6 @@ public interface ITickManager extends IGridCache
* disables ticking for your device.
*
* @param node gridnode
*
* @return if the call was successful.
*/
boolean sleepDevice( IGridNode node );
@ -57,7 +56,6 @@ public interface ITickManager extends IGridCache
* enables ticking for your device, undoes a sleepDevice call.
*
* @param node gridnode
*
* @return if the call was successful.
*/
boolean wakeDevice( IGridNode node );

View File

@ -32,9 +32,9 @@ public class TickingRequest
/**
* the minimum number of ticks that must pass between ticks.
*
* <p>
* Valid Values are : 1+
*
* <p>
* Suggested is 5-20
*/
public final int minTickRate;
@ -42,9 +42,9 @@ public class TickingRequest
/**
* the maximum number of ticks that can pass between ticks, if this value is
* exceeded the tile must tick.
*
* <p>
* Valid Values are 1+
*
* <p>
* Suggested is 20-40
*/
public final int maxTickRate;

View File

@ -21,7 +21,8 @@
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
@API( apiVersion = "@aeversion@", owner = "appliedenergistics2", provides = "appliedenergistics2|API" ) package appeng.api;
@API( apiVersion = "@aeversion@", owner = "appliedenergistics2", provides = "appliedenergistics2|API" )
package appeng.api;
import cpw.mods.fml.common.API;

View File

@ -34,7 +34,6 @@ public interface IAlphaPassItem
* Extend, and return true to enable a second pass for your parts in the bus rendering pipe line.
*
* @param is item
*
* @return true to enable a second pass for your parts in the bus rendering pipe line.
*/
boolean useAlphaPass( ItemStack is );

View File

@ -24,17 +24,16 @@
package appeng.api.parts;
import java.io.IOException;
import io.netty.buffer.ByteBuf;
import net.minecraft.nbt.NBTTagCompound;
import net.minecraftforge.common.util.ForgeDirection;
import java.io.IOException;
/**
* Used Internally.
*
* <p>
* not intended for implementation.
*/
public interface IFacadeContainer
@ -73,9 +72,7 @@ public interface IFacadeContainer
* read from stream
*
* @param data to be read data
*
* @return true if it was readable
*
* @throws IOException
*/
boolean readFromStream( ByteBuf data ) throws IOException;
@ -91,7 +88,6 @@ public interface IFacadeContainer
* write to stream
*
* @param data to be written data
*
* @throws IOException
*/
void writeToStream( ByteBuf data ) throws IOException;

View File

@ -24,6 +24,8 @@
package appeng.api.parts;
import cpw.mods.fml.relauncher.Side;
import cpw.mods.fml.relauncher.SideOnly;
import net.minecraft.client.renderer.RenderBlocks;
import net.minecraft.entity.Entity;
import net.minecraft.item.Item;
@ -31,13 +33,10 @@ import net.minecraft.item.ItemStack;
import net.minecraft.util.AxisAlignedBB;
import net.minecraftforge.common.util.ForgeDirection;
import cpw.mods.fml.relauncher.Side;
import cpw.mods.fml.relauncher.SideOnly;
/**
* Used Internally.
*
* <p>
* not intended for implementation.
*/
public interface IFacadePart

View File

@ -24,12 +24,10 @@
package appeng.api.parts;
import java.io.IOException;
import java.util.List;
import java.util.Random;
import appeng.api.networking.IGridNode;
import cpw.mods.fml.relauncher.Side;
import cpw.mods.fml.relauncher.SideOnly;
import io.netty.buffer.ByteBuf;
import net.minecraft.client.renderer.RenderBlocks;
import net.minecraft.entity.Entity;
import net.minecraft.entity.EntityLivingBase;
@ -42,10 +40,9 @@ import net.minecraft.util.Vec3;
import net.minecraft.world.World;
import net.minecraftforge.common.util.ForgeDirection;
import cpw.mods.fml.relauncher.Side;
import cpw.mods.fml.relauncher.SideOnly;
import appeng.api.networking.IGridNode;
import java.io.IOException;
import java.util.List;
import java.util.Random;
public interface IPart extends IBoxProvider
@ -54,20 +51,19 @@ public interface IPart extends IBoxProvider
/**
* get an ItemStack that represents the bus, should contain the settings for whatever, can also be used in
* conjunction with removePart to take a part off and drop it or something.
*
* <p>
* This is used to drop the bus, and to save the bus, when saving the bus, wrenched is false, and writeToNBT will be
* called to save important details about the part, if the part is wrenched include in your NBT Data any settings
* you might want to keep around, you can restore those settings when constructing your part.
*
* @param type , what kind of ItemStack to return?
*
* @return item of part
*/
ItemStack getItemStack( PartItemStack type );
/**
* render item form for inventory, or entity.
*
* <p>
* GL Available
*
* @param rh helper
@ -78,7 +74,7 @@ public interface IPart extends IBoxProvider
/**
* render world renderer ( preferred )
*
* <p>
* GL is NOT Available
*
* @param x x coord
@ -92,7 +88,7 @@ public interface IPart extends IBoxProvider
/**
* render TESR.
*
* <p>
* GL Available
*
* @param x x coord
@ -152,7 +148,6 @@ public interface IPart extends IBoxProvider
* does this part act like a ladder?
*
* @param entity climbing entity
*
* @return true if entity can climb
*/
boolean isLadder( EntityLivingBase entity );
@ -176,7 +171,6 @@ public interface IPart extends IBoxProvider
* write data to bus packet.
*
* @param data to be written data
*
* @throws IOException
*/
void writeToStream( ByteBuf data ) throws IOException;
@ -185,9 +179,7 @@ public interface IPart extends IBoxProvider
* read data from bus packet.
*
* @param data to be read data
*
* @return true will re-draw the part.
*
* @throws IOException
*/
boolean readFromStream( ByteBuf data ) throws IOException;
@ -195,7 +187,7 @@ public interface IPart extends IBoxProvider
/**
* get the Grid Node for the Bus, be sure your IGridBlock is NOT isWorldAccessible, if it is your going to cause
* crashes.
*
* <p>
* or null if you don't have a grid node.
*
* @return grid node
@ -240,7 +232,6 @@ public interface IPart extends IBoxProvider
*
* @param player right clicking player
* @param pos position of block
*
* @return if your activate method performed something.
*/
boolean onActivate( EntityPlayer player, Vec3 pos );
@ -250,7 +241,6 @@ public interface IPart extends IBoxProvider
*
* @param player shift right clicking player
* @param pos position of block
*
* @return if your activate method performed something, you should use false unless you really need it.
*/
boolean onShiftActivate( EntityPlayer player, Vec3 pos );
@ -293,7 +283,6 @@ public interface IPart extends IBoxProvider
* Used to determine which parts can be placed on what cables.
*
* @param what placed part
*
* @return true if the part can be placed on this support.
*/
boolean canBePlacedOn( BusSupport what );

View File

@ -32,7 +32,7 @@ public interface IPartCollisionHelper
/**
* add a collision box, expects 0.0 - 16.0 block coords.
*
* <p>
* No complaints about the size, I like using pixels :P
*
* @param minX minimal x collision

View File

@ -35,23 +35,23 @@ public interface IPartHelper
/**
* Register a new layer with the part layer system, this allows you to write
* an in between between tile entities and parts.
*
* <p>
* AE By Default includes,
*
* <p>
* 1. ISidedInventory ( and by extension IInventory. )
*
* <p>
* 2. IFluidHandler Forge Fluids
*
* <p>
* 3. IPowerEmitter BC Power output.
*
* <p>
* 4. IPowerReceptor BC Power input.
*
* <p>
* 5. IEnergySink IC2 Power input.
*
* <p>
* 6. IEnergySource IC2 Power output.
*
* <p>
* 7. IPipeConnection BC Pipe Connections
*
* <p>
* As long as a valid layer is registered for a interface you can simply
* implement that interface on a part get implement it.
*
@ -75,7 +75,6 @@ public interface IPartHelper
* @param side side which the part should be on
* @param player player placing part
* @param world part in world
*
* @return true if placing was successful
*/
boolean placeBus( ItemStack is, int x, int y, int z, int side, EntityPlayer player, World world );

View File

@ -24,21 +24,20 @@
package appeng.api.parts;
import java.util.Set;
import appeng.api.util.AEColor;
import appeng.api.util.DimensionalCoord;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.item.ItemStack;
import net.minecraft.tileentity.TileEntity;
import net.minecraft.util.Vec3;
import net.minecraftforge.common.util.ForgeDirection;
import appeng.api.util.AEColor;
import appeng.api.util.DimensionalCoord;
import java.util.Set;
/**
* Implemented on AE's TileEntity or AE's FMP Part.
*
* <p>
* Do Not Implement
*/
public interface IPartHost
@ -55,7 +54,6 @@ public interface IPartHost
*
* @param part to be added part
* @param side part placed onto side
*
* @return returns false if the part cannot be added.
*/
boolean canAddPart( ItemStack part, ForgeDirection side );
@ -66,7 +64,6 @@ public interface IPartHost
* @param is new part
* @param side onto side
* @param owner with owning player
*
* @return null if the item failed to add, the side it was placed on other wise ( may different for cables,
* {@link ForgeDirection}.UNKNOWN )
*/
@ -76,7 +73,6 @@ public interface IPartHost
* Get part by side ( center is {@link ForgeDirection}.UNKNOWN )
*
* @param side side of part
*
* @return the part located on the specified side, or null if there is no part.
*/
IPart getPart( ForgeDirection side );
@ -84,7 +80,7 @@ public interface IPartHost
/**
* removes the part on the side, this doesn't drop it or anything, if you don't do something with it, its just
* "gone" and its never coming back; think about it.
*
* <p>
* if you want to drop the part you must request it prior to removing it.
*
* @param side side of part
@ -129,7 +125,6 @@ public interface IPartHost
* finds the part located at the position ( pos must be relative, not global )
*
* @param pos part position
*
* @return a new SelectedPart, this is never null.
*/
SelectedPart selectPart( Vec3 pos );
@ -148,7 +143,6 @@ public interface IPartHost
* get the redstone state of host on this side, this value is cached internally.
*
* @param side side of part
*
* @return true of the part host is receiving redstone from an external source.
*/
boolean hasRedstone( ForgeDirection side );

View File

@ -24,20 +24,20 @@
package appeng.api.parts;
import javax.annotation.Nullable;
import net.minecraft.item.ItemStack;
import javax.annotation.Nullable;
//@formatter:off
/**
* This is a pretty basic requirement, once you implement the interface, and createPartFromItemStack
*
* <p>
* you must register your bus with the Bus renderer, using AEApi.INSTANCE().partHelper().setItemBusRenderer( this );
*
* <p>
* then simply add these two methods, which tell MC to use the Block Textures, and call AE's Bus Placement Code.
*
* <p>
* <pre>
* <code>
* {@literal @}Override
@ -62,7 +62,6 @@ public interface IPartItem
* create a new part INSTANCE, from the item stack.
*
* @param is item
*
* @return part from item
*/
@Nullable

View File

@ -39,7 +39,7 @@ public interface IPartRenderHelper
/**
* sets the Render Helpers Block Bounds. 0.0 - 16.0 block coords.
*
* <p>
* No complaints about the size, I like using pixels :P
*
* @param minX minimal x bound
@ -53,7 +53,7 @@ public interface IPartRenderHelper
/**
* static renderer
*
* <p>
* render a single face.
*
* @param x x coord of part
@ -68,7 +68,7 @@ public interface IPartRenderHelper
/**
* static renderer
*
* <p>
* render a box with a cut out box in the center.
*
* @param x x pos of part
@ -84,7 +84,7 @@ public interface IPartRenderHelper
/**
* static renderer
*
* <p>
* render a block of specified bounds.
*
* @param x x pos of block
@ -115,7 +115,7 @@ public interface IPartRenderHelper
/**
* inventory, and static renderer.
*
* <p>
* set unique icons for each side of the block.
*
* @param down down face
@ -129,7 +129,7 @@ public interface IPartRenderHelper
/**
* inventory, and static renderer.
*
* <p>
* set all sides to a single IIcon.
*
* @param ico to be set icon
@ -166,7 +166,7 @@ public interface IPartRenderHelper
/**
* Pre-Calculates default lighting for the part, call this before using the render helper to render anything else to
* get simplified, but faster lighting for more then one block.
*
* <p>
* Only worth it if you render more then 1 block.
*/
ISimplifiedBundle useSimplifiedRendering( int x, int y, int z, IBoxProvider p, ISimplifiedBundle sim );

View File

@ -24,11 +24,11 @@
package appeng.api.parts;
import java.util.Set;
import net.minecraft.tileentity.TileEntity;
import net.minecraftforge.common.util.ForgeDirection;
import java.util.Set;
/**
* All Layers must extends this, this get part implementation is provided to interface with the parts, however a real
@ -39,11 +39,10 @@ public abstract class LayerBase extends TileEntity // implements IPartHost
/**
* Grants access for the layer to the parts of the host.
*
* <p>
* This Method looks silly, that is because its not used at runtime, a real implementation will be used instead.
*
* @param side side of part
*
* @return the part for the requested side.
*/
public IPart getPart( final ForgeDirection side )

View File

@ -24,12 +24,12 @@
package appeng.api.recipes;
import java.util.List;
import appeng.api.exceptions.MissingIngredientError;
import appeng.api.exceptions.RecipeError;
import appeng.api.exceptions.RegistrationError;
import java.util.List;
public interface ICraftHandler
{
@ -39,7 +39,6 @@ public interface ICraftHandler
*
* @param input parsed inputs
* @param output parsed outputs
*
* @throws RecipeError
*/
void setup( List<List<IIngredient>> input, List<List<IIngredient>> output ) throws RecipeError;

View File

@ -24,10 +24,9 @@
package appeng.api.recipes;
import net.minecraft.item.ItemStack;
import appeng.api.exceptions.MissingIngredientError;
import appeng.api.exceptions.RegistrationError;
import net.minecraft.item.ItemStack;
public interface IIngredient
@ -38,7 +37,6 @@ public interface IIngredient
* RegistrationError exception will be thrown, ignore these and let the system handle the error.
*
* @return a single ItemStack for the recipe handler.
*
* @throws RegistrationError
* @throws MissingIngredientError
*/
@ -49,7 +47,6 @@ public interface IIngredient
* multiple inputs per slot.
*
* @return an array of ItemStacks for the recipe handler.
*
* @throws RegistrationError
* @throws MissingIngredientError
*/

View File

@ -24,17 +24,15 @@
package appeng.api.recipes;
import java.io.BufferedReader;
import javax.annotation.Nonnull;
import java.io.BufferedReader;
public interface IRecipeLoader
{
/**
* @param filePath the path to the to be loaded file
*
* @return reader handler of the file
*
* @throws Exception if reading goes wrong
*/
BufferedReader getFile( @Nonnull String filePath ) throws Exception;

View File

@ -29,7 +29,6 @@ public interface ISubItemResolver
/**
* @param namespace namespace of sub item
* @param fullName name of sub item
*
* @return either a ResolveResult, or a ResolverResultSet
*/
Object resolveItemByName( String namespace, String fullName );

Some files were not shown because too many files have changed in this diff Show More