Code format

This commit is contained in:
yueh
2016-01-01 01:48:15 +01:00
parent 68c3ea5ae9
commit ab689f2a48
96 changed files with 419 additions and 388 deletions
@@ -54,7 +54,7 @@ public enum PowerUnits
* 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
* @param value value
*
* @return value converted to target units, from this units.
*/
@@ -1,3 +1,4 @@
package appeng.api.definitions;
@@ -86,23 +86,16 @@ public interface IBlocks
IBlockDefinition quartzPillarStair();
/*
IBlockDefinition skyStoneSlab();
* IBlockDefinition skyStoneSlab();
* IBlockDefinition skyStoneBlockSlab();
* IBlockDefinition skyStoneBrickSlab();
* IBlockDefinition skyStoneSmallBrickSlab();
* IBlockDefinition fluixSlab();
* IBlockDefinition quartzSlab();
* IBlockDefinition chiseledQuartzSlab();
* IBlockDefinition quartzPillarSlab();
*/
IBlockDefinition skyStoneBlockSlab();
IBlockDefinition skyStoneBrickSlab();
IBlockDefinition skyStoneSmallBrickSlab();
IBlockDefinition fluixSlab();
IBlockDefinition quartzSlab();
IBlockDefinition chiseledQuartzSlab();
IBlockDefinition quartzPillarSlab();
*/
/*
* misc
*/
@@ -1,3 +1,4 @@
package appeng.api.definitions;
@@ -32,11 +32,11 @@ import net.minecraft.item.Item;
import net.minecraft.item.ItemStack;
public interface IItemDefinition extends IComparableDefinition
{
/**
* @return the unique name of the definition which will be used to register the underlying structure. Will never be null
* @return the unique name of the definition which will be used to register the underlying structure. Will never be
* null
*/
@Nonnull
String identifier();
@@ -78,15 +78,15 @@ public interface IParts
IItemDefinition p2PTunnelLiquids();
//IItemDefinition p2PTunnelEU();
// IItemDefinition p2PTunnelEU();
//IItemDefinition p2PTunnelRF();
// IItemDefinition p2PTunnelRF();
IItemDefinition p2PTunnelLight();
//IItemDefinition p2PTunnelOpenComputers();
// IItemDefinition p2PTunnelOpenComputers();
// IItemDefinition p2PTunnelPneumaticCraft();
// IItemDefinition p2PTunnelPneumaticCraft();
IItemDefinition cableAnchor();
@@ -1,3 +1,4 @@
package appeng.api.definitions;
@@ -1,3 +1,4 @@
package appeng.api.exceptions;
@@ -1,3 +1,4 @@
package appeng.api.exceptions;
@@ -45,8 +45,8 @@ public interface IGrinderRegistry
/**
* add a new recipe the easy way, in → out, how many turns., duplicates will not be added.
*
* @param in input
* @param out output
* @param in input
* @param out output
* @param turns amount of turns to turn the input into the output
*/
void addRecipe( ItemStack in, ItemStack out, int turns );
@@ -54,24 +54,24 @@ public interface IGrinderRegistry
/**
* add a new recipe with optional outputs, duplicates will not be added.
*
* @param in input
* @param out output
* @param in input
* @param out output
* @param optional optional output
* @param chance chance to get the optional output within 0.0 - 1.0
* @param turns amount of turns to turn the input into the outputs
* @param chance chance to get the optional output within 0.0 - 1.0
* @param turns amount of turns to turn the input into the outputs
*/
void addRecipe( ItemStack in, ItemStack out, ItemStack optional, float chance, int turns );
/**
* add a new recipe with optional outputs, duplicates will not be added.
*
* @param in input
* @param out output
* @param optional optional output
* @param chance chance to get the optional output within 0.0 - 1.0
* @param in input
* @param out output
* @param optional optional output
* @param chance chance to get the optional output within 0.0 - 1.0
* @param optional2 second optional output
* @param chance2 chance to get the second optional output within 0.0 - 1.0
* @param turns amount of turns to turn the input into the outputs
* @param chance2 chance to get the second optional output within 0.0 - 1.0
* @param turns amount of turns to turn the input into the outputs
*/
void addRecipe( ItemStack in, ItemStack out, ItemStack optional, float chance, ItemStack optional2, float chance2, int turns );
@@ -1,3 +1,4 @@
package appeng.api.features;
@@ -1,3 +1,4 @@
package appeng.api.features;
@@ -33,7 +33,7 @@ public interface IMatterCannonAmmoRegistry
/**
* register a new ammo, generally speaking this is based off of atomic weight to make it easier to guess at
*
* @param ammo new ammo
* @param ammo new ammo
* @param weight atomic weight
*/
void registerAmmo( ItemStack ammo, double weight );
@@ -42,9 +42,9 @@ public interface INetworkEncodable
/**
* Encode the wireless frequency via the Controller.
*
* @param item the wireless terminal.
* @param item the wireless terminal.
* @param encKey the wireless encryption key.
* @param name null for now.
* @param name null for now.
*/
void setEncryptionKey( ItemStack item, String encKey, String name );
}
@@ -42,7 +42,7 @@ public interface IP2PTunnelRegistry
* attunements for AE's P2P Tunnels
*
* @param trigger - the item which triggers attunement. Nullable, but then ignored
* @param type - the type of tunnel. Nullable, but then ignored
* @param type - the type of tunnel. Nullable, but then ignored
*/
void addNewAttunement( @Nullable ItemStack trigger, @Nullable TunnelType type );
@@ -47,8 +47,8 @@ public interface IWirelessTermHandler extends INetworkEncodable
* use an amount of power, in AE units
*
* @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
* hasPower
* @param is wireless terminal
*
* @return true if wireless terminal uses power
*/
@@ -1,3 +1,4 @@
package appeng.api.features;
@@ -41,7 +41,7 @@ public interface ICraftingPatternItem
* Access Details about a pattern
*
* @param is pattern
* @param w crafting world
* @param w crafting world
*
* @return details of pattern
*/
@@ -39,7 +39,7 @@ public interface IBiometricCard
{
/**
* Set the {@link GameProfile} to null, to clear it.
* Set the {@link GameProfile} to null, to clear it.
*/
void setProfile( ItemStack itemStack, GameProfile username );
@@ -67,7 +67,7 @@ public interface IBiometricCard
/**
* remove a permission from the item stack.
*
* @param itemStack card
* @param itemStack card
* @param permission to be removed permission
*/
void removePermission( ItemStack itemStack, SecurityPermissions permission );
@@ -75,7 +75,7 @@ public interface IBiometricCard
/**
* add a permission to the item stack.
*
* @param itemStack card
* @param itemStack card
* @param permission to be added permission
*/
void addPermission( ItemStack itemStack, SecurityPermissions permission );
@@ -84,8 +84,8 @@ public interface IBiometricCard
* lets you handle submission of security values on the card for custom behavior.
*
* @param registry security registry
* @param pr player registry
* @param is card
* @param pr player registry
* @param is card
*/
void registerPermissions( ISecurityRegistry registry, IPlayerRegistry pr, ItemStack is );
}
@@ -41,11 +41,11 @@ public interface IMemoryCard
* Configures the data stored on the memory card, the SettingsName, will be
* localized when displayed.
*
* @param is item
* @param is item
* @param SettingsName unlocalized string that represents the tile entity.
* @param data may contain a String called "tooltip" which is is a
* unlocalized string displayed after the settings name, optional
* but can be used to add details to the card for later.
* @param data may contain a String called "tooltip" which is is a
* unlocalized string displayed after the settings name, optional
* but can be used to add details to the card for later.
*/
void setMemoryCardContents( ItemStack is, String SettingsName, NBTTagCompound data );
@@ -72,7 +72,7 @@ public interface IMemoryCard
* notify the user of a outcome related to the memory card.
*
* @param player that used the card.
* @param msg which message to send.
* @param msg which message to send.
*/
void notifyUser( EntityPlayer player, MemoryCardMessages msg );
}
@@ -89,10 +89,10 @@ public interface ISpatialStorageCell
/**
* Perform a spatial swap with the contents of the cell, and the world.
*
* @param is spatial storage cell
* @param w world of spatial
* @param min min coord
* @param max max coord
* @param is spatial storage cell
* @param w world of spatial
* @param min min coord
* @param max max coord
* @param doTransition transition
*
* @return result of transition
@@ -77,7 +77,7 @@ public interface IStorageCell extends ICellWorkbenchItem
* don't care, just return false; As the handler for this type of cell is
* still the default cells, the normal AE black list is also applied.
*
* @param cellItem item
* @param cellItem item
* @param requestedAddition requested addition
*
* @return true to preventAdditionOfItem
@@ -36,8 +36,8 @@ public interface ICraftingMachine
/**
* inserts a crafting plan, and the necessary items into the crafting machine.
*
* @param patternDetails details of pattern
* @param table crafting table
* @param patternDetails details of pattern
* @param table crafting table
* @param ejectionDirection ejection direction
*
* @return if it was accepted, all or nothing.
@@ -37,7 +37,7 @@ public interface IMovableHandler
* that single entity, you cannot opt out of single entities.
*
* @param myClass tile entity class
* @param tile tile entity
* @param tile tile entity
*
* @return true if it can handle moving
*/
@@ -51,16 +51,22 @@ public interface IMovableHandler
* Potential Example:
*
* <pre>
* {@code
* Chunk c = world.getChunkFromBlockCoords( x, z ); c.setChunkBlockTileEntity( x
* & 0xF, y + y, z & 0xF, tile );
*
* if ( c.isChunkLoaded ) { world.addTileEntity( tile ); world.markBlockForUpdate( x,
* y, z ); }
* {
* &#064;code
* Chunk c = world.getChunkFromBlockCoords( x, z );
* c.setChunkBlockTileEntity( x
* &amp; 0xF, y + y, z &amp; 0xF, tile );
*
* if( c.isChunkLoaded )
* {
* world.addTileEntity( tile );
* world.markBlockForUpdate( x,
* y, z );
* }
* }
* </pre>
*
* @param tile to be moved tile
* @param tile to be moved tile
* @param world world of tile
* @param newPosition the new location
*/
@@ -56,7 +56,8 @@ public enum GridFlags
DENSE_CAPACITY,
/**
* This block is part of a multiblock, used in conjunction with REQUIRE_CHANNEL, and {@link IGridMultiblock} see this
* This block is part of a multiblock, used in conjunction with REQUIRE_CHANNEL, and {@link IGridMultiblock} see
* this
* interface for details.
*/
MULTIBLOCK,
@@ -85,7 +85,7 @@ public interface IGridBlock
/**
* Update Blocks network/connection/booting status. grid,
*
* @param grid grid
* @param grid grid
* @param channelsInUse used channels
*/
void setNetworkStatus( IGrid grid, int channelsInUse );
@@ -48,7 +48,7 @@ public interface IGridCache
* information, do it on the next updateTick.
*
* @param gridNode removed from that grid
* @param machine to be removed machine
* @param machine to be removed machine
*/
void removeNode( IGridNode gridNode, IGridHost machine );
@@ -60,7 +60,7 @@ public interface IGridCache
* information, do it on the next updateTick.
*
* @param gridNode added to grid node
* @param machine to be added machine
* @param machine to be added machine
*/
void addNode( IGridNode gridNode, IGridHost machine );
@@ -44,7 +44,7 @@ public interface IGridHost
* Grid when your block is ready.
*
* @param dir feel free to ignore this, most blocks will use the same node
* for every side.
* for every side.
*
* @return a new IGridNode, create these with
* AEApi.INSTANCE().createGridNode( MyIGridBlock )
@@ -119,7 +119,7 @@ public interface IGridNode
*
* Important: You must call this before updateState.
*
* @param name nbt name
* @param name nbt name
* @param nodeData to be loaded data
*/
void loadFromNBT( String name, NBTTagCompound nodeData );
@@ -128,7 +128,7 @@ public interface IGridNode
* this should be called for each node you maintain, you can save all your nodes to the same tag with different
* names, if you fail to complete the load / save procedure, network state may be lost between game load/saves.
*
* @param name nbt name
* @param name nbt name
* @param nodeData to be saved data
*/
void saveToNBT( String name, NBTTagCompound nodeData );
@@ -155,7 +155,8 @@ public interface IGridNode
/**
* tell the node who was responsible for placing it, failure to do this may result in in-compatibility with the
* security system. Called instead of loadFromNBT when initially placed, once set never required again, the value is saved with the Node NBT.
* security system. Called instead of loadFromNBT when initially placed, once set never required again, the value is
* saved with the Node NBT.
*
* @param playerID new player id
*/
@@ -42,9 +42,9 @@ public interface ICraftingGrid extends IGridCache
/**
* @param whatToCraft requested craft
* @param world crafting world
* @param slot slot index
* @param details pattern details
* @param world crafting world
* @param slot slot index
* @param details pattern details
*
* @return a collection of crafting patterns for the item in question.
*/
@@ -53,12 +53,12 @@ public interface ICraftingGrid extends IGridCache
/**
* Begin calculating a crafting job.
*
* @param world crafting world
* @param grid network
* @param world crafting world
* @param grid network
* @param actionSrc source
* @param craftWhat result
* @param callback callback
* -- optional
* @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.
@@ -68,13 +68,14 @@ public interface ICraftingGrid extends IGridCache
/**
* Submit the job to the Crafting system for processing.
*
* @param job - the crafting job from beginCraftingJob
* @param job - the crafting job from beginCraftingJob
* @param requestingMachine - a machine if its being requested via automation, may be null.
* @param target - can be null
* @param prioritizePower - if cpu is null, this determine if the system should prioritize power, or if it should find the lower
* 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.
* @param target - can be null
* @param prioritizePower - if cpu is null, this determine if the system should prioritize power, or if it should
* find the lower
* 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
@@ -38,7 +38,7 @@ public interface ICraftingMedium
* possible the output should be directed.
*
* @param patternDetails details
* @param table crafting table
* @param table crafting table
*
* @return if the pattern was successfully pushed.
*/
@@ -48,7 +48,7 @@ public interface ICraftingPatternDetails
/**
* @param slotIndex specific slot index
* @param itemStack item in slot
* @param world crafting world
* @param world crafting world
*
* @return if an item can be used in the specific slot for this pattern.
*/
@@ -88,7 +88,7 @@ public interface ICraftingPatternDetails
* Allow using this INSTANCE of the pattern details to preform the crafting action with performance enhancements.
*
* @param craftingInv inventory
* @param world crafting world
* @param world crafting world
*
* @return the crafted ( work bench ) item.
*/
@@ -47,7 +47,7 @@ public interface ICraftingRequester extends IActionHost
* be returned.
*
* @param items item
* @param mode action mode
* @param mode action mode
*
* @return unwanted item
*/
@@ -42,7 +42,7 @@ public interface ICraftingWatcherHost
* Called when a crafting status changes.
*
* @param craftingGrid current crafting grid
* @param what change
* @param what change
*/
void onRequestChange( ICraftingGrid craftingGrid, IAEItemStack what );
}
@@ -37,7 +37,7 @@ public interface IAEPowerStorage extends IEnergySource
/**
* Inject amt, power into the device, it will store what it can, and return the amount unable to be stored.
*
* @param amt to be injected amount
* @param amt to be injected amount
* @param mode action mode
*
* @return amount of power which was unable to be stored
@@ -74,7 +74,7 @@ public interface IEnergyGrid extends IGridCache, IEnergySource, IEnergyGridProvi
* 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 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.
@@ -34,7 +34,7 @@ public interface IEnergySource
/**
* Extract power from the network.
*
* @param amt extracted power
* @param amt extracted power
* @param mode should the action be simulated or performed?
*
* @return returns extracted power.
@@ -30,8 +30,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()
* the change is reflected via the {@link IEnergyGrid}.isNetworkPowered() or via {@link IGridNode}.isActive()
*
* Note: Most machines just need to check {@link IGridNode}.isActive()
*/
@@ -36,7 +36,7 @@ public class MENetworkSpatialEvent extends MENetworkEvent
public final double spatialEnergyUsage;
/**
* @param SpatialIO ( INSTANCE of the SpatialIO block )
* @param SpatialIO ( INSTANCE of the SpatialIO block )
* @param EnergyUsage ( the amount of energy that the SpatialIO uses)
*/
public MENetworkSpatialEvent( final IGridHost SpatialIO, final double EnergyUsage )
@@ -42,7 +42,7 @@ public interface ISecurityGrid extends IGridCache
* Check if a player has permissions.
*
* @param player to be checked player
* @param perm checked permissions
* @param perm checked permissions
*
* @return true if the player has permissions.
*/
@@ -52,7 +52,7 @@ public interface ISecurityGrid extends IGridCache
* Check if a player has permissions.
*
* @param playerID id of player
* @param perm checked permissions
* @param perm checked permissions
*
* @return true if the player has permissions.
*/
@@ -38,7 +38,7 @@ public interface ISecurityRegistry
/**
* Submit Permissions into the register.
*
* @param playerID player id
* @param playerID player id
* @param permissions permissions of player
*/
void addPlayer( int playerID, EnumSet<SecurityPermissions> permissions );
@@ -32,7 +32,8 @@ public interface ISpatialCache extends IGridCache
{
/**
* @return true if a region is defined at all, it doesn't have to be valid, but all points must be in the same world.
* @return true if a region is defined at all, it doesn't have to be valid, but all points must be in the same
* world.
*/
boolean hasRegion();
@@ -44,11 +44,11 @@ public interface IStackWatcherHost
/**
* Called when a watched item changes amounts.
*
* @param o changed item list
* @param o changed item list
* @param fullStack old stack
* @param diffStack new stack
* @param src action source
* @param chan storage channel
* @param src action source
* @param chan storage channel
*/
void onStackChange( IItemList o, IAEStack fullStack, IAEStack diffStack, BaseActionSource src, StorageChannel chan );
}
@@ -68,8 +68,8 @@ public interface IGridTickable
* 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.
* tick, you can use this to adjust speed of processing or adjust
* your tick rate.
*
* @return tick rate adjustment.
*/
+3 -1
View File
@@ -21,8 +21,10 @@
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
@API( apiVersion = "rv2", owner = "appliedenergistics2", provides = "appliedenergistics2|API" ) package appeng.api;
@API( apiVersion = "rv2", owner = "appliedenergistics2", provides = "appliedenergistics2|API" )
package appeng.api;
import net.minecraftforge.fml.common.API;
+17 -17
View File
@@ -70,7 +70,7 @@ public interface IPart extends IBoxProvider
*
* GL Available
*
* @param rh helper
* @param rh helper
* @param renderer renderer
*/
@SideOnly( Side.CLIENT )
@@ -81,10 +81,10 @@ public interface IPart extends IBoxProvider
*
* GL is NOT Available
*
* @param x x coord
* @param y y coord
* @param z z coord
* @param rh helper
* @param x x coord
* @param y y coord
* @param z z coord
* @param rh helper
* @param renderer renderer
*/
@SideOnly( Side.CLIENT )
@@ -95,10 +95,10 @@ public interface IPart extends IBoxProvider
*
* GL Available
*
* @param x x coord
* @param y y coord
* @param z z coord
* @param rh helper
* @param x x coord
* @param y y coord
* @param z z coord
* @param rh helper
* @param renderer renderer
*/
@SideOnly( Side.CLIENT )
@@ -109,7 +109,7 @@ public interface IPart extends IBoxProvider
* texture.
*/
@SideOnly( Side.CLIENT )
TextureAtlasSprite getBreakingTexture(ModelGenerator renderer);
TextureAtlasSprite getBreakingTexture( ModelGenerator renderer );
/**
* return true only if your part require dynamic rendering, must be consistent.
@@ -239,7 +239,7 @@ public interface IPart extends IBoxProvider
* Called when you right click the part, very similar to Block.onActivateBlock
*
* @param player right clicking player
* @param pos position of block
* @param pos position of block
*
* @return if your activate method performed something.
*/
@@ -249,7 +249,7 @@ public interface IPart extends IBoxProvider
* Called when you right click the part, very similar to Block.onActivateBlock
*
* @param player shift right clicking player
* @param pos position of block
* @param pos position of block
*
* @return if your activate method performed something, you should use false unless you really need it.
*/
@@ -259,7 +259,7 @@ public interface IPart extends IBoxProvider
* Add drops to the items being dropped into the world, if your item stores its contents when wrenched use the
* wrenched boolean to control what data is saved vs dropped when it is broken.
*
* @param drops item drops if wrenched
* @param drops item drops if wrenched
* @param wrenched control flag for wrenched vs broken
*/
void getDrops( List<ItemStack> drops, boolean wrenched );
@@ -273,8 +273,8 @@ public interface IPart extends IBoxProvider
* same as Block.randomDisplayTick, for but parts.
*
* @param world world of block
* @param pos location of block
* @param r random
* @param pos location of block
* @param r random
*/
void randomDisplayTick( World world, BlockPos pos, Random r );
@@ -282,8 +282,8 @@ public interface IPart extends IBoxProvider
* Called when placed in the world by a player, this happens before addWorld.
*
* @param player placing player
* @param held held item
* @param side placing side
* @param held held item
* @param side placing side
*/
void onPlacement( EntityPlayer player, ItemStack held, AEPartLocation side );
@@ -34,7 +34,8 @@ import net.minecraft.world.World;
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.
* Register a new layer with the part layer system, this allows you to write an in between between tile entities and
* parts.
*
* AE By Default includes,
*
@@ -52,7 +53,8 @@ public interface IPartHelper
*
* 7. IPipeConnection BC Pipe Connections
*
* As long as a valid layer is registered for a interface you can simply implement that interface on a part get implement it.
* As long as a valid layer is registered for a interface you can simply implement that interface on a part get
* implement it.
*
* @return true on success, false on failure, usually a error will be logged as well.
*/
+4 -4
View File
@@ -64,8 +64,8 @@ public interface IPartHost
/**
* try to add a new part to the specified side, returns false if it failed to be added.
*
* @param is new part
* @param side onto side
* @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,
@@ -90,14 +90,14 @@ public interface IPartHost
* @return the part located on the specified side, or null if there is no part.
*/
IPart getPart( EnumFacing side );
/**
* 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.
*
* if you want to drop the part you must request it prior to removing it.
*
* @param side side of part
* @param side side of part
* @param suppressUpdate - used if you need to replace a part's INSTANCE, without really removing it first.
*/
void removePart( AEPartLocation side, boolean suppressUpdate );
+2 -2
View File
@@ -28,8 +28,8 @@ import javax.annotation.Nullable;
import net.minecraft.item.ItemStack;
//@formatter:off
//@formatter:off
/**
* This is a pretty basic requirement, once you implement the interface, and createPartFromItemStack
@@ -46,7 +46,7 @@ import net.minecraft.item.ItemStack;
* {
* return 0;
* }
*
*
* {@literal @}Override
* public boolean onItemUse(ItemStack is, EntityPlayer player, World world, int x, int y, int z, int side, float hitX, float hitY, float hitZ)
* {
@@ -58,9 +58,9 @@ public interface IPartRenderHelper
*
* render a single face.
*
* @param pos POSITION of part
* @param ico icon of part
* @param face direction its facing
* @param pos POSITION of part
* @param ico icon of part
* @param face direction its facing
* @param renderer renderer of part
*/
@SideOnly( Side.CLIENT )
@@ -71,11 +71,11 @@ public interface IPartRenderHelper
*
* render a box with a cut out box in the center.
*
* @param pos pos of part
* @param ico icon of part
* @param face face of part
* @param pos pos of part
* @param ico icon of part
* @param face face of part
* @param edgeThickness thickness of the edge
* @param renderer renderer
* @param renderer renderer
*/
@SideOnly( Side.CLIENT )
void renderFaceCutout( BlockPos pos, IAESprite ico, EnumFacing face, float edgeThickness, ModelGenerator renderer );
@@ -85,9 +85,9 @@ public interface IPartRenderHelper
*
* render a block of specified bounds.
*
* @param x x pos of block
* @param y y pos of block
* @param z z pos of block
* @param x x pos of block
* @param y y pos of block
* @param z z pos of block
* @param renderer renderer
*/
@SideOnly( Side.CLIENT )
@@ -96,9 +96,9 @@ public interface IPartRenderHelper
/**
* render a single face in inventory renderer.
*
* @param TextureAtlasSprite icon of part
* @param TextureAtlasSprite icon of part
* @param direction face of part
* @param renderer renderer
* @param renderer renderer
*/
@SideOnly( Side.CLIENT )
void renderInventoryFace( IAESprite IIcon, EnumFacing direction, ModelGenerator renderer );
@@ -116,12 +116,12 @@ public interface IPartRenderHelper
*
* set unique icons for each side of the block.
*
* @param down down face
* @param up up face
* @param down down face
* @param up up face
* @param north north face
* @param south south face
* @param west west face
* @param east east face
* @param west west face
* @param east east face
*/
void setTexture( IAESprite down, IAESprite up, IAESprite north, IAESprite south, IAESprite west, IAESprite east );
@@ -164,9 +164,9 @@ public interface IPartRenderHelper
/**
* render a block using the current renderer state.
*
* @param x x pos of part
* @param y y pos of part
* @param z z pos of part
* @param x x pos of part
* @param y y pos of part
* @param z z pos of part
* @param renderer renderer of part
*/
void renderBlockCurrentBounds( BlockPos pos, ModelGenerator renderer );
@@ -37,7 +37,7 @@ public interface ICraftHandler
/**
* Called when your recipe handler receives a newly parsed list of inputs/outputs.
*
* @param input parsed inputs
* @param input parsed inputs
* @param output parsed outputs
*
* @throws RecipeError
@@ -34,7 +34,7 @@ public interface IRecipeHandler
* Call when you want to read recipes in from a file based on a loader
*
* @param loader recipe loader
* @param path path of file
* @param path path of file
*/
void parseRecipes( IRecipeLoader loader, String path );
@@ -28,7 +28,7 @@ public interface ISubItemResolver
{
/**
* @param namespace namespace of sub item
* @param fullName name of sub item
* @param fullName name of sub item
*
* @return either a ResolveResult, or a ResolverResultSet
*/
@@ -52,9 +52,9 @@ public interface ICellHandler
/**
* If you cannot handle the provided item, return null
*
* @param is a storage cell item.
* @param host anytime the contents of your storage cell changes it should use this to request a save, please
* note, this value can be null.
* @param is a storage cell item.
* @param host anytime the contents of your storage cell changes it should use this to request a save, please
* note, this value can be null.
* @param channel the storage channel requested.
*
* @return a new IMEHandler for the provided item
@@ -90,12 +90,12 @@ public interface ICellHandler
* is not available via ME Chests simply tell the user they can't use it, or something, other wise you should open
* your gui and display the cell to the user.
*
* @param player player opening chest gui
* @param chest to be opened chest
* @param player player opening chest gui
* @param chest to be opened chest
* @param cellHandler cell handler
* @param inv inventory handler
* @param is item
* @param chan storage channel
* @param inv inventory handler
* @param is item
* @param chan storage channel
*/
void openChestGui( EntityPlayer player, IChestOrDrive chest, ICellHandler cellHandler, IMEInventoryHandler inv, ItemStack is, StorageChannel chan );
@@ -108,7 +108,7 @@ public interface ICellHandler
*
* 3 - red, ( usually means the cell is 100% full )
*
* @param is the cell item. ( use the handler for any details you can )
* @param is the cell item. ( use the handler for any details you can )
* @param handler the handler for the cell is provides for reference, you can cast this to your handler.
*
* @return get the status of the cell based on its contents.
@@ -67,7 +67,7 @@ public interface ICellRegistry
/**
* returns an IMEInventoryHandler for the provided item.
*
* @param is item with inventory handler
* @param is item with inventory handler
* @param host can be null, or the hosting tile / part.
* @param chan the storage channel to request the handler for.
*
@@ -40,7 +40,7 @@ public interface IExternalStorageHandler
* if this can handle the provided inventory, return true. ( Generally skipped by AE, and it just calls getInventory
* )
*
* @param te to be handled tile entity
* @param te to be handled tile entity
* @param mySrc source
*
* @return true, if it can get a handler via getInventory
@@ -53,10 +53,10 @@ public interface IExternalStorageHandler
* please note that if your inventory changes and requires polling, you must use an {@link IMEMonitor} instead of an
* {@link IMEInventory} failure to do so will result in invalid item counts and reporting of the inventory.
*
* @param te to be handled tile entity
* @param d direction
* @param te to be handled tile entity
* @param d direction
* @param channel channel
* @param src source
* @param src source
*
* @return The Handler for the inventory
*/
@@ -47,10 +47,10 @@ public interface IExternalStorageRegistry
void addExternalStorageInterface( IExternalStorageHandler esh );
/**
* @param te tile entity
* @param te tile entity
* @param opposite direction
* @param channel channel
* @param mySrc source
* @param channel channel
* @param mySrc source
*
* @return the handler for a given tile / forge direction
*/
@@ -47,8 +47,8 @@ public interface IMEInventory<StackType extends IAEStack>
* Store new items, or simulate the addition of new items into the ME Inventory.
*
* @param input item to add.
* @param type action type
* @param src action source
* @param type action type
* @param src action source
*
* @return returns the number of items not added.
*/
@@ -58,7 +58,7 @@ public interface IMEInventory<StackType extends IAEStack>
* Extract the specified item from the ME Inventory
*
* @param request item to request ( with stack size. )
* @param mode simulate, or perform action?
* @param mode simulate, or perform action?
*
* @return returns the number of items extracted, null
*/
@@ -102,10 +102,10 @@ public interface IStorageHelper
/**
* use energy from energy, to remove request items from cell, at the request of src.
*
* @param energy to be drained energy source
* @param cell cell of requested items
* @param energy to be drained energy source
* @param cell cell of requested items
* @param request requested items
* @param src action source
* @param src action source
*
* @return items that successfully extracted.
*/
@@ -115,9 +115,9 @@ public interface IStorageHelper
* use energy from energy, to inject input items into cell, at the request of src
*
* @param energy to be added energy source
* @param cell injected cell
* @param input to be injected items
* @param src action source
* @param cell injected cell
* @param input to be injected items
* @param src action source
*
* @return items that failed to insert.
*/
@@ -161,7 +161,9 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
public AccessRestriction getAccess()
{
return this.getHandler().getAccess();
} @Override
}
@Override
public IItemList<StackType> getStorageList()
{
if( this.hasChanged )
@@ -184,7 +186,9 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
public boolean canAccept( final StackType input )
{
return this.getHandler().canAccept( input );
} @Override
}
@Override
public IItemList<StackType> getAvailableItems( final IItemList out )
{
return this.getHandler().getAvailableItems( out );
@@ -208,7 +212,4 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
return this.getHandler().validForPass( i );
}
}
@@ -152,7 +152,7 @@ public interface IAEStack<StackType extends IAEStack>
*
* a IAEItemStack to another AEItemStack or a ItemStack.
*
* @param st stacks
* @param st stacks
* @param mode used fuzzy mode
*
* @return true if two stacks are equal based on AE Fuzzy Comparison.
@@ -1,7 +1,10 @@
package appeng.api.util;
import net.minecraft.util.AxisAlignedBB;
/**
* Mutable stand in for Axis Aligned BB, this was used to prevent GC Thrashing.. Related code could also be re-written.
*/
@@ -18,15 +21,15 @@ public class AEAxisAlignedBB
{
return AxisAlignedBB.fromBounds( this.minX, this.minY, this.minZ, this.maxX, this.maxY, this.maxZ );
}
public AEAxisAlignedBB( final double a, final double b, final double c, final double d, final double e, final double f)
public AEAxisAlignedBB( final double a, final double b, final double c, final double d, final double e, final double f )
{
this.minX =a;
this.minY =b;
this.minZ =c;
this.maxX =d;
this.maxY =e;
this.maxZ =f;
this.minX = a;
this.minY = b;
this.minZ = c;
this.maxX = d;
this.maxY = e;
this.maxZ = f;
}
public static AEAxisAlignedBB fromBounds(
@@ -37,17 +40,17 @@ public class AEAxisAlignedBB
final double e,
final double f )
{
return new AEAxisAlignedBB(a,b,c,d,e,f);
return new AEAxisAlignedBB( a, b, c, d, e, f );
}
public static AEAxisAlignedBB fromBounds(
final AxisAlignedBB bb )
{
return new AEAxisAlignedBB( bb.minX,
bb.minY,
bb.minZ,
bb.maxX,
bb.maxY,
bb.maxZ );
bb.minY,
bb.minZ,
bb.maxX,
bb.maxY,
bb.maxZ );
}
}
+1 -1
View File
@@ -99,7 +99,7 @@ public enum AEColor
* Vanilla Dye Equivilient
*/
public final EnumDyeColor dye;
AEColor( final String unlocalizedName, final EnumDyeColor dye, final int blackHex, final int medHex, final int whiteHex )
{
this.unlocalizedName = unlocalizedName;
@@ -63,7 +63,7 @@ public interface AEColoredItemDefinition
/**
* Compare {@link ItemStack} with this
*
* @param color compared color of item
* @param color compared color of item
* @param comparableItem compared item
*
* @return true if the item stack is a matching item.
@@ -1,100 +1,105 @@
package appeng.api.util;
import net.minecraft.util.EnumFacing;
/**
* Stand in for previous Forge Direction, Several uses of this class are simply legacy where as some uses of this class are intended.
* Stand in for previous Forge Direction, Several uses of this class are simply legacy where as some uses of this class
* are intended.
*/
public enum AEPartLocation
{
/**
* Negative Y
*/
DOWN(0, -1, 0),
/**
* Negative Y
*/
DOWN( 0, -1, 0 ),
/**
* Positive Y
*/
UP(0, 1, 0),
UP( 0, 1, 0 ),
/**
* Negative Z
*/
NORTH(0, 0, -1),
/**
* Negative Z
*/
NORTH( 0, 0, -1 ),
/**
* Positive Z
*/
SOUTH(0, 0, 1),
/**
* Negative X
*/
WEST(-1, 0, 0),
SOUTH( 0, 0, 1 ),
/**
* Posative X
*/
EAST(1, 0, 0),
/**
* Negative X
*/
WEST( -1, 0, 0 ),
/**
* Center or inside of the block.
*/
INTERNAL(0, 0, 0);
/**
* Posative X
*/
EAST( 1, 0, 0 ),
public final int xOffset;
public final int yOffset;
public final int zOffset;
private static final EnumFacing[] facings = { EnumFacing.DOWN, EnumFacing.UP, EnumFacing.NORTH, EnumFacing.SOUTH, EnumFacing.WEST, EnumFacing.EAST, null };
private static final int[] OPPOSITES = {1, 0, 3, 2, 5, 4, 6};
/**
* Center or inside of the block.
*/
INTERNAL( 0, 0, 0 );
public static final AEPartLocation[] SIDE_LOCATIONS = {DOWN, UP, NORTH, SOUTH, WEST, EAST};
private AEPartLocation( final int x, final int y, final int z)
{
this.xOffset = x;
this.yOffset = y;
this.zOffset = z;
}
public final int xOffset;
public final int yOffset;
public final int zOffset;
/**
* @return Part Location
*/
public static AEPartLocation fromOrdinal( final int id)
{
if (id >= 0 && id < SIDE_LOCATIONS.length)
return SIDE_LOCATIONS[id];
return INTERNAL;
}
private static final EnumFacing[] facings = { EnumFacing.DOWN, EnumFacing.UP, EnumFacing.NORTH, EnumFacing.SOUTH, EnumFacing.WEST, EnumFacing.EAST, null };
private static final int[] OPPOSITES = { 1, 0, 3, 2, 5, 4, 6 };
/**
* 100% chance of success.
*
* @param side
* @return proper Part Location for a facing enum.
*/
public static AEPartLocation fromFacing( final EnumFacing side)
{
if ( side == null ) return INTERNAL;
return values()[side.ordinal()];
}
public static final AEPartLocation[] SIDE_LOCATIONS = { DOWN, UP, NORTH, SOUTH, WEST, EAST };
/**
* @return Opposite Part Location, INTERNAL remains INTERNAL.
*/
public AEPartLocation getOpposite()
{
return fromOrdinal(OPPOSITES[this.ordinal()]);
}
private AEPartLocation( final int x, final int y, final int z )
{
this.xOffset = x;
this.yOffset = y;
this.zOffset = z;
}
/**
* @return EnumFacing Equivalence, if Center returns null.
*/
/**
* @return Part Location
*/
public static AEPartLocation fromOrdinal( final int id )
{
if( id >= 0 && id < SIDE_LOCATIONS.length )
return SIDE_LOCATIONS[id];
return INTERNAL;
}
/**
* 100% chance of success.
*
* @param side
* @return proper Part Location for a facing enum.
*/
public static AEPartLocation fromFacing( final EnumFacing side )
{
if( side == null )
return INTERNAL;
return values()[side.ordinal()];
}
/**
* @return Opposite Part Location, INTERNAL remains INTERNAL.
*/
public AEPartLocation getOpposite()
{
return fromOrdinal( OPPOSITES[this.ordinal()] );
}
/**
* @return EnumFacing Equivalence, if Center returns null.
*/
public EnumFacing getFacing()
{
return facings[this.ordinal()];
}
}
@@ -54,7 +54,7 @@ public class DimensionalCoord extends WorldCoord
public DimensionalCoord( final World _w, final int x, final int y, final int z )
{
super( x,y,z );
super( x, y, z );
this.w = _w;
this.dimId = _w.provider.getDimensionId();
}
@@ -49,7 +49,7 @@ public interface IConfigManager
/**
* used to initialize the configuration manager, should be called for all settings.
*
* @param settingName name of setting
* @param settingName name of setting
* @param defaultValue default value of setting
*/
void registerSetting( Settings settingName, Enum<?> defaultValue );
@@ -67,7 +67,7 @@ public interface IConfigManager
* Change setting
*
* @param settingName to be changed setting
* @param newValue new value for setting
* @param newValue new value for setting
*
* @return changed setting
*/
@@ -23,11 +23,10 @@
package appeng.api.util;
import net.minecraft.util.EnumFacing;
/**
* Nearly all of AE's Tile Entities implement IOrientable.
*
@@ -57,7 +56,7 @@ public interface IOrientable
* Update the orientation
*
* @param Forward new forward direction
* @param Up new upwards direction
* @param Up new upwards direction
*/
void setOrientation( EnumFacing Forward, EnumFacing Up );
}
@@ -41,9 +41,9 @@ public interface IOrientableBlock
/**
* @param world world of block
* @param x x pos of block
* @param y y pos of block
* @param z z pos of block
* @param x x pos of block
* @param y y pos of block
* @param z z pos of block
*
* @return a IOrientable if applicable
*/
+1 -1
View File
@@ -179,7 +179,7 @@ public class WorldCoord
{
return new BlockPos( this.x, this.y, this.z );
}
@Override
public String toString()
{