From d10fd21692bad49e75a7d665005df940c91942f8 Mon Sep 17 00:00:00 2001 From: Lance5057 Date: Sat, 6 Aug 2016 21:47:17 -0500 Subject: Launch update Only a week behind... --- src/api/java/mcp/mobius/waila/api/IWailaBlock.java | 15 +++-- .../mcp/mobius/waila/api/IWailaBlockDecorator.java | 7 ++- .../mcp/mobius/waila/api/IWailaConfigHandler.java | 17 +++--- .../mcp/mobius/waila/api/IWailaDataAccessor.java | 41 ++++++++----- .../mcp/mobius/waila/api/IWailaDataProvider.java | 15 +++-- .../mcp/mobius/waila/api/IWailaEntityAccessor.java | 24 +++++--- .../mcp/mobius/waila/api/IWailaEntityProvider.java | 9 ++- .../mcp/mobius/waila/api/IWailaFMPAccessor.java | 31 ++++++---- .../mcp/mobius/waila/api/IWailaFMPDecorator.java | 5 +- .../mcp/mobius/waila/api/IWailaFMPProvider.java | 5 +- .../java/mcp/mobius/waila/api/IWailaRegistrar.java | 53 ++++++++++------ .../mobius/waila/api/IWailaSummaryProvider.java | 7 ++- .../java/mcp/mobius/waila/api/SpecialChars.java | 71 +++++++++++----------- .../java/mcp/mobius/waila/api/package-info.java | 6 +- 14 files changed, 184 insertions(+), 122 deletions(-) (limited to 'src/api/java/mcp/mobius') diff --git a/src/api/java/mcp/mobius/waila/api/IWailaBlock.java b/src/api/java/mcp/mobius/waila/api/IWailaBlock.java index 8b4dd13..181f938 100644 --- a/src/api/java/mcp/mobius/waila/api/IWailaBlock.java +++ b/src/api/java/mcp/mobius/waila/api/IWailaBlock.java @@ -5,18 +5,19 @@ import java.util.List; import net.minecraft.item.ItemStack; @Deprecated -public interface IWailaBlock { +public interface IWailaBlock +{ /* * Use this method to return an item stack in case the default lookup system fails. * Return null if you want to use the default lookup system. * You get the world, the player and the location of the block. With that, it is easy to gather information & tile entities */ - ItemStack getWailaStack(IWailaDataAccessor accessor, IWailaConfigHandler config); - + ItemStack getWailaStack(IWailaDataAccessor accessor, IWailaConfigHandler config); + /* Waila HUD is divided into 3 zones. The head corresponds to the item name, * body to where you mostly want to put informations, and I reserve the tail for modname display - */ - + */ + /* Those 2 methods works exactly the same way, except they are related to a different zone in Waila HUD. * You get in input world, player and the block location. You also get the itemstack as returned by the default lookup system or getWailaStack(). * ConfigHandler provides the current Waila config state so you can show/hide elements depending on the configuration. Refer the ConfigHandler class for more info. @@ -27,8 +28,10 @@ public interface IWailaBlock { * * Always return the currenttip is you don't want to modify the current zone. */ - + List getWailaHead(ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config); + List getWailaBody(ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config); + List getWailaTail(ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config); } diff --git a/src/api/java/mcp/mobius/waila/api/IWailaBlockDecorator.java b/src/api/java/mcp/mobius/waila/api/IWailaBlockDecorator.java index 935d475..093d044 100644 --- a/src/api/java/mcp/mobius/waila/api/IWailaBlockDecorator.java +++ b/src/api/java/mcp/mobius/waila/api/IWailaBlockDecorator.java @@ -2,8 +2,9 @@ package mcp.mobius.waila.api; import net.minecraft.item.ItemStack; -public interface IWailaBlockDecorator { +public interface IWailaBlockDecorator +{ + + void decorateBlock(ItemStack itemStack, IWailaDataAccessor accessor, IWailaConfigHandler config); - void decorateBlock(ItemStack itemStack, IWailaDataAccessor accessor, IWailaConfigHandler config); - } diff --git a/src/api/java/mcp/mobius/waila/api/IWailaConfigHandler.java b/src/api/java/mcp/mobius/waila/api/IWailaConfigHandler.java index faede63..94e08d6 100644 --- a/src/api/java/mcp/mobius/waila/api/IWailaConfigHandler.java +++ b/src/api/java/mcp/mobius/waila/api/IWailaConfigHandler.java @@ -3,13 +3,14 @@ package mcp.mobius.waila.api; import java.util.HashMap; import java.util.Set; -public interface IWailaConfigHandler { +public interface IWailaConfigHandler +{ /* Returns a set of all the currently loaded modules in the config handler */ public Set getModuleNames(); - + /* Returns all the currently available options for a given module */ public HashMap getConfigKeys(String modName); - + /* Add a new option to a given module * * modName is the name of the module to add the option to (ie : Buildcraft, IndustrialCraft2, etc) @@ -17,12 +18,12 @@ public interface IWailaConfigHandler { * name is the human readable name of the option (ie : "Tank content", "Max EU Input") * */ //public void addConfig(String modName, String key, String name); - + /* Returns the current value of an option (true/false) with a default value defvalue if not set*/ public boolean getConfig(String key, boolean defvalue); - - /* Returns the current value of an option (true/false) with a default value true if not set*/ - public boolean getConfig(String key); - + + /* Returns the current value of an option (true/false) with a default value true if not set*/ + public boolean getConfig(String key); + //public void setConfig(String key, boolean value); } diff --git a/src/api/java/mcp/mobius/waila/api/IWailaDataAccessor.java b/src/api/java/mcp/mobius/waila/api/IWailaDataAccessor.java index 0288624..9d0a6fb 100644 --- a/src/api/java/mcp/mobius/waila/api/IWailaDataAccessor.java +++ b/src/api/java/mcp/mobius/waila/api/IWailaDataAccessor.java @@ -15,19 +15,32 @@ import net.minecraftforge.common.util.ForgeDirection; * It will also return things that are unmodified by the overriding systems (like getWailaStack). */ -public interface IWailaDataAccessor { - - World getWorld(); - EntityPlayer getPlayer(); - Block getBlock(); - int getBlockID(); - int getMetadata(); - TileEntity getTileEntity(); +public interface IWailaDataAccessor +{ + + World getWorld(); + + EntityPlayer getPlayer(); + + Block getBlock(); + + int getBlockID(); + + int getMetadata(); + + TileEntity getTileEntity(); + MovingObjectPosition getPosition(); - Vec3 getRenderingPosition(); - NBTTagCompound getNBTData(); - int getNBTInteger(NBTTagCompound tag, String keyname); - double getPartialFrame(); - ForgeDirection getSide(); - ItemStack getStack(); + + Vec3 getRenderingPosition(); + + NBTTagCompound getNBTData(); + + int getNBTInteger(NBTTagCompound tag, String keyname); + + double getPartialFrame(); + + ForgeDirection getSide(); + + ItemStack getStack(); } diff --git a/src/api/java/mcp/mobius/waila/api/IWailaDataProvider.java b/src/api/java/mcp/mobius/waila/api/IWailaDataProvider.java index 4859d9c..f0c886b 100644 --- a/src/api/java/mcp/mobius/waila/api/IWailaDataProvider.java +++ b/src/api/java/mcp/mobius/waila/api/IWailaDataProvider.java @@ -4,18 +4,19 @@ import java.util.List; import net.minecraft.item.ItemStack; -public interface IWailaDataProvider{ +public interface IWailaDataProvider +{ /* * Use this method to return an item stack in case the default lookup system fails. * Return null if you want to use the default lookup system. * You get the world, the player and the location of the block. With that, it is easy to gather information & tile entities */ - ItemStack getWailaStack(IWailaDataAccessor accessor, IWailaConfigHandler config); - + ItemStack getWailaStack(IWailaDataAccessor accessor, IWailaConfigHandler config); + /* Waila HUD is divided into 3 zones. The head corresponds to the item name, * body to where you mostly want to put informations, and I reserve the tail for modname display - */ - + */ + /* Those 2 methods works exactly the same way, except they are related to a different zone in Waila HUD. * You get in input world, player and the block location. You also get the itemstack as returned by the default lookup system or getWailaStack(). * ConfigHandler provides the current Waila config state so you can show/hide elements depending on the configuration. Refer the ConfigHandler class for more info. @@ -26,8 +27,10 @@ public interface IWailaDataProvider{ * * Always return the currenttip is you don't want to modify the current zone. */ - + List getWailaHead(ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config); + List getWailaBody(ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config); + List getWailaTail(ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config); } diff --git a/src/api/java/mcp/mobius/waila/api/IWailaEntityAccessor.java b/src/api/java/mcp/mobius/waila/api/IWailaEntityAccessor.java index 788067a..62e3352 100644 --- a/src/api/java/mcp/mobius/waila/api/IWailaEntityAccessor.java +++ b/src/api/java/mcp/mobius/waila/api/IWailaEntityAccessor.java @@ -12,13 +12,21 @@ import net.minecraft.world.World; * It will also return things that are unmodified by the overriding systems (like getWailaStack). */ -public interface IWailaEntityAccessor { - World getWorld(); - EntityPlayer getPlayer(); - Entity getEntity(); +public interface IWailaEntityAccessor +{ + World getWorld(); + + EntityPlayer getPlayer(); + + Entity getEntity(); + MovingObjectPosition getPosition(); - Vec3 getRenderingPosition(); - NBTTagCompound getNBTData(); - int getNBTInteger(NBTTagCompound tag, String keyname); - double getPartialFrame(); + + Vec3 getRenderingPosition(); + + NBTTagCompound getNBTData(); + + int getNBTInteger(NBTTagCompound tag, String keyname); + + double getPartialFrame(); } diff --git a/src/api/java/mcp/mobius/waila/api/IWailaEntityProvider.java b/src/api/java/mcp/mobius/waila/api/IWailaEntityProvider.java index 9548289..a7fe7a2 100644 --- a/src/api/java/mcp/mobius/waila/api/IWailaEntityProvider.java +++ b/src/api/java/mcp/mobius/waila/api/IWailaEntityProvider.java @@ -4,13 +4,16 @@ import java.util.List; import net.minecraft.entity.Entity; -public interface IWailaEntityProvider { - +public interface IWailaEntityProvider +{ + /* A way to get an override on the entity returned by the raytracing */ Entity getWailaOverride(IWailaEntityAccessor accessor, IWailaConfigHandler config); - + /* The classical HEAD/BODY/TAIL text getters */ List getWailaHead(Entity entity, List currenttip, IWailaEntityAccessor accessor, IWailaConfigHandler config); + List getWailaBody(Entity entity, List currenttip, IWailaEntityAccessor accessor, IWailaConfigHandler config); + List getWailaTail(Entity entity, List currenttip, IWailaEntityAccessor accessor, IWailaConfigHandler config); } diff --git a/src/api/java/mcp/mobius/waila/api/IWailaFMPAccessor.java b/src/api/java/mcp/mobius/waila/api/IWailaFMPAccessor.java index 19e01fa..a885ea7 100644 --- a/src/api/java/mcp/mobius/waila/api/IWailaFMPAccessor.java +++ b/src/api/java/mcp/mobius/waila/api/IWailaFMPAccessor.java @@ -1,7 +1,6 @@ package mcp.mobius.waila.api; import net.minecraft.entity.player.EntityPlayer; -import net.minecraft.item.ItemStack; import net.minecraft.nbt.NBTTagCompound; import net.minecraft.tileentity.TileEntity; import net.minecraft.util.MovingObjectPosition; @@ -13,15 +12,25 @@ import net.minecraft.world.World; * It will also return things that are unmodified by the overriding systems (like getWailaStack). */ -public interface IWailaFMPAccessor { - World getWorld(); - EntityPlayer getPlayer(); - TileEntity getTileEntity(); +public interface IWailaFMPAccessor +{ + World getWorld(); + + EntityPlayer getPlayer(); + + TileEntity getTileEntity(); + MovingObjectPosition getPosition(); - NBTTagCompound getNBTData(); - NBTTagCompound getFullNBTData(); - int getNBTInteger(NBTTagCompound tag, String keyname); - double getPartialFrame(); - Vec3 getRenderingPosition(); - String getID(); + + NBTTagCompound getNBTData(); + + NBTTagCompound getFullNBTData(); + + int getNBTInteger(NBTTagCompound tag, String keyname); + + double getPartialFrame(); + + Vec3 getRenderingPosition(); + + String getID(); } diff --git a/src/api/java/mcp/mobius/waila/api/IWailaFMPDecorator.java b/src/api/java/mcp/mobius/waila/api/IWailaFMPDecorator.java index 839af31..64d6e30 100644 --- a/src/api/java/mcp/mobius/waila/api/IWailaFMPDecorator.java +++ b/src/api/java/mcp/mobius/waila/api/IWailaFMPDecorator.java @@ -2,6 +2,7 @@ package mcp.mobius.waila.api; import net.minecraft.item.ItemStack; -public interface IWailaFMPDecorator { - void decorateBlock(ItemStack itemStack, IWailaFMPAccessor accessor, IWailaConfigHandler config); +public interface IWailaFMPDecorator +{ + void decorateBlock(ItemStack itemStack, IWailaFMPAccessor accessor, IWailaConfigHandler config); } diff --git a/src/api/java/mcp/mobius/waila/api/IWailaFMPProvider.java b/src/api/java/mcp/mobius/waila/api/IWailaFMPProvider.java index 232c83e..08f0ca3 100644 --- a/src/api/java/mcp/mobius/waila/api/IWailaFMPProvider.java +++ b/src/api/java/mcp/mobius/waila/api/IWailaFMPProvider.java @@ -4,9 +4,12 @@ import java.util.List; import net.minecraft.item.ItemStack; -public interface IWailaFMPProvider { +public interface IWailaFMPProvider +{ /* The classical HEAD/BODY/TAIL text getters */ List getWailaHead(ItemStack itemStack, List currenttip, IWailaFMPAccessor accessor, IWailaConfigHandler config); + List getWailaBody(ItemStack itemStack, List currenttip, IWailaFMPAccessor accessor, IWailaConfigHandler config); + List getWailaTail(ItemStack itemStack, List currenttip, IWailaFMPAccessor accessor, IWailaConfigHandler config); } diff --git a/src/api/java/mcp/mobius/waila/api/IWailaRegistrar.java b/src/api/java/mcp/mobius/waila/api/IWailaRegistrar.java index 162aeb6..8414a81 100644 --- a/src/api/java/mcp/mobius/waila/api/IWailaRegistrar.java +++ b/src/api/java/mcp/mobius/waila/api/IWailaRegistrar.java @@ -1,35 +1,47 @@ package mcp.mobius.waila.api; -public interface IWailaRegistrar { +public interface IWailaRegistrar +{ /* Add a config option in the section modname with displayed text configtext and access key keyname */ public void addConfig(String modname, String keyname, String configtext); - public void addConfigRemote(String modname, String keyname, String configtext); + + public void addConfigRemote(String modname, String keyname, String configtext); + public void addConfig(String modname, String keyname); - public void addConfigRemote(String modname, String keyname); - + + public void addConfigRemote(String modname, String keyname); + /* Register a stack overrider for the given blockID */ - public void registerStackProvider(IWailaDataProvider dataProvider, Class block); - + public void registerStackProvider(IWailaDataProvider dataProvider, Class block); + /* Same thing, but works on a class hierarchy instead */ - public void registerHeadProvider (IWailaDataProvider dataProvider, Class block); - public void registerBodyProvider (IWailaDataProvider dataProvider, Class block); - public void registerTailProvider (IWailaDataProvider dataProvider, Class block); + public void registerHeadProvider(IWailaDataProvider dataProvider, Class block); + + public void registerBodyProvider(IWailaDataProvider dataProvider, Class block); + + public void registerTailProvider(IWailaDataProvider dataProvider, Class block); /* Entity text registration methods */ - public void registerHeadProvider (IWailaEntityProvider dataProvider, Class entity); - public void registerBodyProvider (IWailaEntityProvider dataProvider, Class entity); - public void registerTailProvider (IWailaEntityProvider dataProvider, Class entity); - public void registerOverrideEntityProvider (IWailaEntityProvider dataProvider, Class entity); - + public void registerHeadProvider(IWailaEntityProvider dataProvider, Class entity); + + public void registerBodyProvider(IWailaEntityProvider dataProvider, Class entity); + + public void registerTailProvider(IWailaEntityProvider dataProvider, Class entity); + + public void registerOverrideEntityProvider(IWailaEntityProvider dataProvider, Class entity); + /* FMP Providers */ public void registerHeadProvider(IWailaFMPProvider dataProvider, String name); + public void registerBodyProvider(IWailaFMPProvider dataProvider, String name); + public void registerTailProvider(IWailaFMPProvider dataProvider, String name); - + /* The block decorators */ - public void registerDecorator (IWailaBlockDecorator decorator, Class block); - public void registerDecorator (IWailaFMPDecorator decorator, String name); - + public void registerDecorator(IWailaBlockDecorator decorator, Class block); + + public void registerDecorator(IWailaFMPDecorator decorator, String name); + /* Selective NBT key syncing. Will register a key to sync over the network for the given class (block, te or ent). * Accept * as a ending wildcard * registerNBTKey("bob.*", MyBlock.class) @@ -39,6 +51,7 @@ public interface IWailaRegistrar { public void registerSyncedNBTKey(String key, Class target); /* UNUSED FOR NOW (Will be used for the ingame wiki */ - public void registerDocTextFile (String filename); - public void registerShortDataProvider (IWailaSummaryProvider dataProvider, Class item); + public void registerDocTextFile(String filename); + + public void registerShortDataProvider(IWailaSummaryProvider dataProvider, Class item); } diff --git a/src/api/java/mcp/mobius/waila/api/IWailaSummaryProvider.java b/src/api/java/mcp/mobius/waila/api/IWailaSummaryProvider.java index f790649..3d7a349 100644 --- a/src/api/java/mcp/mobius/waila/api/IWailaSummaryProvider.java +++ b/src/api/java/mcp/mobius/waila/api/IWailaSummaryProvider.java @@ -4,9 +4,10 @@ import java.util.LinkedHashMap; import net.minecraft.item.ItemStack; -public interface IWailaSummaryProvider { +public interface IWailaSummaryProvider +{ /* This interface is used to control the display data in the description screen */ - + /* BASIC TOOLS & ITEMS DATA */ //EnumToolMaterial getMaterial(ItemStack stack); //String getMaterialName(ItemStack stack); @@ -16,6 +17,6 @@ public interface IWailaSummaryProvider { //int getEnchantability(ItemStack stack); //int getDamageVsEntity(ItemStack stack); //int getDurability(ItemStack stack); - + LinkedHashMap getSummary(ItemStack stack, LinkedHashMap currentSummary, IWailaConfigHandler config); } diff --git a/src/api/java/mcp/mobius/waila/api/SpecialChars.java b/src/api/java/mcp/mobius/waila/api/SpecialChars.java index 5bd92a8..a987a15 100644 --- a/src/api/java/mcp/mobius/waila/api/SpecialChars.java +++ b/src/api/java/mcp/mobius/waila/api/SpecialChars.java @@ -1,40 +1,41 @@ package mcp.mobius.waila.api; -public class SpecialChars { +public class SpecialChars +{ - public static String MCStyle = "\u00A7"; - - public static String BLACK = MCStyle + "0"; - public static String DBLUE = MCStyle + "1"; - public static String DGREEN = MCStyle + "2"; - public static String DAQUA = MCStyle + "3"; - public static String DRED = MCStyle + "4"; - public static String DPURPLE = MCStyle + "5"; - public static String GOLD = MCStyle + "6"; - public static String GRAY = MCStyle + "7"; - public static String DGRAY = MCStyle + "8"; - public static String BLUE = MCStyle + "9"; - public static String GREEN = MCStyle + "a"; - public static String AQUA = MCStyle + "b"; - public static String RED = MCStyle + "c"; - public static String LPURPLE = MCStyle + "d"; - public static String YELLOW = MCStyle + "e"; - public static String WHITE = MCStyle + "f"; - - public static String OBF = MCStyle + "k"; - public static String BOLD = MCStyle + "l"; - public static String STRIKE = MCStyle + "m"; - public static String UNDER = MCStyle + "n"; - public static String ITALIC = MCStyle + "o"; - public static String RESET = MCStyle + "r"; + public static String MCStyle = "\u00A7"; + + public static String BLACK = MCStyle + "0"; + public static String DBLUE = MCStyle + "1"; + public static String DGREEN = MCStyle + "2"; + public static String DAQUA = MCStyle + "3"; + public static String DRED = MCStyle + "4"; + public static String DPURPLE = MCStyle + "5"; + public static String GOLD = MCStyle + "6"; + public static String GRAY = MCStyle + "7"; + public static String DGRAY = MCStyle + "8"; + public static String BLUE = MCStyle + "9"; + public static String GREEN = MCStyle + "a"; + public static String AQUA = MCStyle + "b"; + public static String RED = MCStyle + "c"; + public static String LPURPLE = MCStyle + "d"; + public static String YELLOW = MCStyle + "e"; + public static String WHITE = MCStyle + "f"; + + public static String OBF = MCStyle + "k"; + public static String BOLD = MCStyle + "l"; + public static String STRIKE = MCStyle + "m"; + public static String UNDER = MCStyle + "n"; + public static String ITALIC = MCStyle + "o"; + public static String RESET = MCStyle + "r"; + + public static String WailaStyle = "\u00A4"; + public static String WailaIcon = "\u00A5"; + public static String TAB = WailaStyle + WailaStyle + "a"; + public static String ALIGNRIGHT = WailaStyle + WailaStyle + "b"; + public static String ALIGNCENTER = WailaStyle + WailaStyle + "c"; + public static String HEART = WailaStyle + WailaIcon + "a"; + public static String HHEART = WailaStyle + WailaIcon + "b"; + public static String EHEART = WailaStyle + WailaIcon + "c"; - public static String WailaStyle = "\u00A4"; - public static String WailaIcon = "\u00A5"; - public static String TAB = WailaStyle + WailaStyle +"a"; - public static String ALIGNRIGHT = WailaStyle + WailaStyle +"b"; - public static String ALIGNCENTER = WailaStyle + WailaStyle +"c"; - public static String HEART = WailaStyle + WailaIcon +"a"; - public static String HHEART = WailaStyle + WailaIcon +"b"; - public static String EHEART = WailaStyle + WailaIcon +"c"; - } diff --git a/src/api/java/mcp/mobius/waila/api/package-info.java b/src/api/java/mcp/mobius/waila/api/package-info.java index 9b5e663..82cf044 100644 --- a/src/api/java/mcp/mobius/waila/api/package-info.java +++ b/src/api/java/mcp/mobius/waila/api/package-info.java @@ -1,3 +1,5 @@ -@API(apiVersion="1.0",owner="Waila",provides="WailaAPI") +@API(apiVersion = "1.0", owner = "Waila", provides = "WailaAPI") package mcp.mobius.waila.api; -import cpw.mods.fml.common.API; \ No newline at end of file + +import cpw.mods.fml.common.API; + -- cgit v1.2.3