From b5c4b8a294b0c668bc9baf1cef016a10816a2d84 Mon Sep 17 00:00:00 2001 From: Justin Aquadro Date: Fri, 27 Feb 2015 21:54:04 -0500 Subject: [PATCH] Update WAILA API (internal dev use, it doesn't get packed). --- api/mcp/mobius/waila/api/ITaggedList.java | 21 +++++ api/mcp/mobius/waila/api/IWailaBlock.java | 34 -------- .../waila/api/IWailaBlockDecorator.java | 15 ++++ .../waila/api/IWailaCommonAccessor.java | 37 ++++++++ .../mobius/waila/api/IWailaConfigHandler.java | 42 +++++++--- .../mobius/waila/api/IWailaDataAccessor.java | 12 ++- .../mobius/waila/api/IWailaDataProvider.java | 84 +++++++++++++++---- .../waila/api/IWailaEntityAccessor.java | 9 +- .../waila/api/IWailaEntityProvider.java | 67 ++++++++++++++- .../mobius/waila/api/IWailaFMPAccessor.java | 9 +- .../mobius/waila/api/IWailaFMPDecorator.java | 16 ++++ .../mobius/waila/api/IWailaFMPProvider.java | 48 ++++++++++- api/mcp/mobius/waila/api/IWailaRegistrar.java | 39 ++++++++- .../waila/api/IWailaSummaryProvider.java | 4 +- .../waila/api/IWailaTooltipRenderer.java | 24 ++++++ api/mcp/mobius/waila/api/SpecialChars.java | 30 +++++++ api/mcp/mobius/waila/api/package-info.java | 2 +- .../storagedrawers/integration/Waila.java | 9 ++ 18 files changed, 417 insertions(+), 85 deletions(-) create mode 100644 api/mcp/mobius/waila/api/ITaggedList.java delete mode 100644 api/mcp/mobius/waila/api/IWailaBlock.java create mode 100644 api/mcp/mobius/waila/api/IWailaCommonAccessor.java create mode 100644 api/mcp/mobius/waila/api/IWailaTooltipRenderer.java diff --git a/api/mcp/mobius/waila/api/ITaggedList.java b/api/mcp/mobius/waila/api/ITaggedList.java new file mode 100644 index 0000000..7413c28 --- /dev/null +++ b/api/mcp/mobius/waila/api/ITaggedList.java @@ -0,0 +1,21 @@ +package mcp.mobius.waila.api; + +import java.util.Collection; +import java.util.HashSet; +import java.util.List; +import java.util.Set; +import java.util.Map.Entry; + +public interface ITaggedList extends List { + public boolean add(E e, T tag); + public boolean add(E e, Collection taglst); + public Set getTags(E e); + public Set getTags(int index); + public void addTag(E e, T tag); + public void addTag(int index, T tag); + public void removeTag(E e, T tag); + public void removeTag(int index, T tag); + public Set getEntries(T tag); + public void removeEntries(T tag); + public String getTagsAsString(E e); +} diff --git a/api/mcp/mobius/waila/api/IWailaBlock.java b/api/mcp/mobius/waila/api/IWailaBlock.java deleted file mode 100644 index 545f379..0000000 --- a/api/mcp/mobius/waila/api/IWailaBlock.java +++ /dev/null @@ -1,34 +0,0 @@ -package mcp.mobius.waila.api; - -import net.minecraft.item.ItemStack; - -import java.util.List; - -@Deprecated -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); - - /* 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. - * currenttip represents the current list of text lines in the tooltip zone. - * For example, getWailaHead() will have the current item name as currenttip. - * You can modify the tips, add more, remove some, etc. - * When you are done, just returns the currenttip and it will display in Waila. - * - * 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/api/mcp/mobius/waila/api/IWailaBlockDecorator.java b/api/mcp/mobius/waila/api/IWailaBlockDecorator.java index 935d475..7dc6ba0 100644 --- a/api/mcp/mobius/waila/api/IWailaBlockDecorator.java +++ b/api/mcp/mobius/waila/api/IWailaBlockDecorator.java @@ -2,8 +2,23 @@ package mcp.mobius.waila.api; import net.minecraft.item.ItemStack; +/** + * Callback class interface used to provide Block/TileEntity decorator.
+ * All methods in this interface shouldn't to be called by the implementing mod. An instance of the class is to be + * registered to Waila via the {@link IWailaRegistrar} instance provided in the original registration callback method + * (cf. {@link IWailaRegistrar} documentation for more information). + * @author ProfMobius + * + */ public interface IWailaBlockDecorator { + /** + * Callback for the decorator. It provides a standard GL stack positioned on the block.
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerDecorator}.
+ * @param itemStack Current block scanned, in ItemStack form. + * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + */ void decorateBlock(ItemStack itemStack, IWailaDataAccessor accessor, IWailaConfigHandler config); } diff --git a/api/mcp/mobius/waila/api/IWailaCommonAccessor.java b/api/mcp/mobius/waila/api/IWailaCommonAccessor.java new file mode 100644 index 0000000..982f50b --- /dev/null +++ b/api/mcp/mobius/waila/api/IWailaCommonAccessor.java @@ -0,0 +1,37 @@ +package mcp.mobius.waila.api; + +import net.minecraft.block.Block; +import net.minecraft.entity.Entity; +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; +import net.minecraft.util.Vec3; +import net.minecraft.world.World; +import net.minecraftforge.common.util.ForgeDirection; + +/** + * The Accessor is used to get some basic data out of the game without having to request direct access to the game engine.
+ * It will also return things that are unmodified by the overriding systems (like getWailaStack).
+ * Common accessor for both Entity and Block/TileEntity.
+ * Available data depends on what it is called upon (ie : getEntity() will return null if looking at a block, etc).
+ * + */ +public interface IWailaCommonAccessor { + World getWorld(); + EntityPlayer getPlayer(); + Block getBlock(); + int getBlockID(); + String getBlockQualifiedName(); + int getMetadata(); + TileEntity getTileEntity(); + Entity getEntity(); + MovingObjectPosition getPosition(); + Vec3 getRenderingPosition(); + NBTTagCompound getNBTData(); + int getNBTInteger(NBTTagCompound tag, String keyname); + double getPartialFrame(); + ForgeDirection getSide(); + ItemStack getStack(); +} diff --git a/api/mcp/mobius/waila/api/IWailaConfigHandler.java b/api/mcp/mobius/waila/api/IWailaConfigHandler.java index faede63..9752e42 100644 --- a/api/mcp/mobius/waila/api/IWailaConfigHandler.java +++ b/api/mcp/mobius/waila/api/IWailaConfigHandler.java @@ -3,26 +3,42 @@ package mcp.mobius.waila.api; import java.util.HashMap; import java.util.Set; +/** + * Read-only interface for Waila internal config storage.
+ * An instance of this interface is passed to most of Waila callbacks as a way to change the behavior depending on client settings. + * + * @author ProfMobius + * + */ public interface IWailaConfigHandler { - /* Returns a set of all the currently loaded modules in the config handler */ + /** Returns a set of all the currently loaded modules in the config handler. + * + * @return + */ public Set getModuleNames(); - /* Returns all the currently available options for a given module */ + /** + * Returns all the currently available options for a given module + * + * @param modName Module name + * @return + */ public HashMap getConfigKeys(String modName); - /* Add a new option to a given module + /** + * Returns the current value of an option (true/false) with a default value if not set. * - * modName is the name of the module to add the option to (ie : Buildcraft, IndustrialCraft2, etc) - * key is the config key (ie : bc.tankcontent, ic2.inputvalue) - * 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*/ + * @param key Option to lookup + * @param defvalue Default values + * @return Value of the option or 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*/ + /** + * Returns the current value of an option (true/false) with a default value true if not set + * + * @param key Option to lookup + * @return Value of the option or true if not set. + */ public boolean getConfig(String key); - - //public void setConfig(String key, boolean value); } diff --git a/api/mcp/mobius/waila/api/IWailaDataAccessor.java b/api/mcp/mobius/waila/api/IWailaDataAccessor.java index 0288624..7b87217 100644 --- a/api/mcp/mobius/waila/api/IWailaDataAccessor.java +++ b/api/mcp/mobius/waila/api/IWailaDataAccessor.java @@ -10,17 +10,21 @@ import net.minecraft.util.Vec3; import net.minecraft.world.World; import net.minecraftforge.common.util.ForgeDirection; -/* The Accessor is used to get some basic data out of the game without having to request - * direct access to the game engine. - * It will also return things that are unmodified by the overriding systems (like getWailaStack). +/** + * The Accessor is used to get some basic data out of the game without having to request direct access to the game engine.
+ * It will also return things that are unmodified by the overriding systems (like getWailaStack).
+ * An instance of this interface is passed to most of Waila Block/TileEntity callbacks. + * @author ProfMobius + * */ -public interface IWailaDataAccessor { +public interface IWailaDataAccessor{ World getWorld(); EntityPlayer getPlayer(); Block getBlock(); int getBlockID(); + String getBlockQualifiedName(); int getMetadata(); TileEntity getTileEntity(); MovingObjectPosition getPosition(); diff --git a/api/mcp/mobius/waila/api/IWailaDataProvider.java b/api/mcp/mobius/waila/api/IWailaDataProvider.java index 4859d9c..eb7e98b 100644 --- a/api/mcp/mobius/waila/api/IWailaDataProvider.java +++ b/api/mcp/mobius/waila/api/IWailaDataProvider.java @@ -2,32 +2,82 @@ package mcp.mobius.waila.api; import java.util.List; +import net.minecraft.entity.player.EntityPlayerMP; import net.minecraft.item.ItemStack; +import net.minecraft.nbt.NBTTagCompound; +import net.minecraft.tileentity.TileEntity; +import net.minecraft.world.World; +/** + * Callback class interface used to provide Block/TileEntity tooltip informations to Waila.
+ * All methods in this interface shouldn't to be called by the implementing mod. An instance of the class is to be + * registered to Waila via the {@link IWailaRegistrar} instance provided in the original registration callback method + * (cf. {@link IWailaRegistrar} documentation for more information). + * @author ProfMobius + * + */ 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 + + /** + * Callback used to override the default Waila lookup system.
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerStackProvider}.
+ * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + * @return null if override is not required, an ItemStack otherwise. */ 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. - * currenttip represents the current list of text lines in the tooltip zone. - * For example, getWailaHead() will have the current item name as currenttip. - * You can modify the tips, add more, remove some, etc. - * When you are done, just returns the currenttip and it will display in Waila. + /** + * Callback used to add lines to one of the three sections of the tooltip (Head, Body, Tail).
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerHeadProvider} client side.
+ * You are supposed to always return the modified input currenttip.
* - * Always return the currenttip is you don't want to modify the current zone. + * @param itemStack Current block scanned, in ItemStack form. + * @param currenttip Current list of tooltip lines (might have been processed by other providers and might be processed by other providers). + * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + * @return Modified input currenttip */ - List getWailaHead(ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config); + + /** + * Callback used to add lines to one of the three sections of the tooltip (Head, Body, Tail).
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerBodyProvider} client side.
+ * You are supposed to always return the modified input currenttip.
+ * + * @param itemStack Current block scanned, in ItemStack form. + * @param currenttip Current list of tooltip lines (might have been processed by other providers and might be processed by other providers). + * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + * @return Modified input currenttip + */ List getWailaBody(ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config); + + /** + * Callback used to add lines to one of the three sections of the tooltip (Head, Body, Tail).
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerTailProvider} client side.
+ * You are supposed to always return the modified input currenttip.
+ * + * @param itemStack Current block scanned, in ItemStack form. + * @param currenttip Current list of tooltip lines (might have been processed by other providers and might be processed by other providers). + * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + * @return Modified input currenttip + */ List getWailaTail(ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config); + + /** + * Callback used server side to return a custom synchronization NBTTagCompound.
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerNBTProvider} server and client side.
+ * You are supposed to always return the modified input NBTTagCompound tag.
+ * @param player The player requesting data synchronization (The owner of the current connection). + * @param te The TileEntity targeted for synchronization. + * @param tag Current synchronization tag (might have been processed by other providers and might be processed by other providers). + * @param world TileEntity's World. + * @param x X position of the TileEntity. + * @param y Y position of the TileEntity. + * @param z Z position of the TileEntity. + * @return Modified input NBTTagCompound tag. + */ + NBTTagCompound getNBTData(EntityPlayerMP player, TileEntity te, NBTTagCompound tag, World world, int x, int y, int z); } diff --git a/api/mcp/mobius/waila/api/IWailaEntityAccessor.java b/api/mcp/mobius/waila/api/IWailaEntityAccessor.java index 788067a..a4c0076 100644 --- a/api/mcp/mobius/waila/api/IWailaEntityAccessor.java +++ b/api/mcp/mobius/waila/api/IWailaEntityAccessor.java @@ -7,9 +7,12 @@ import net.minecraft.util.MovingObjectPosition; import net.minecraft.util.Vec3; import net.minecraft.world.World; -/* The Accessor is used to get some basic data out of the game without having to request - * direct access to the game engine. - * It will also return things that are unmodified by the overriding systems (like getWailaStack). +/** + * The Accessor is used to get some basic data out of the game without having to request direct access to the game engine.
+ * It will also return things that are unmodified by the overriding systems (like getWailaStack).
+ * An instance of this interface is passed to most of Waila Entity callbacks. + * @author ProfMobius + * */ public interface IWailaEntityAccessor { diff --git a/api/mcp/mobius/waila/api/IWailaEntityProvider.java b/api/mcp/mobius/waila/api/IWailaEntityProvider.java index 9548289..5a9acd8 100644 --- a/api/mcp/mobius/waila/api/IWailaEntityProvider.java +++ b/api/mcp/mobius/waila/api/IWailaEntityProvider.java @@ -3,14 +3,77 @@ package mcp.mobius.waila.api; import java.util.List; import net.minecraft.entity.Entity; +import net.minecraft.entity.player.EntityPlayerMP; +import net.minecraft.nbt.NBTTagCompound; +import net.minecraft.world.World; +/** + * Callback class interface used to provide Entity tooltip informations to Waila.
+ * All methods in this interface shouldn't to be called by the implementing mod. An instance of the class is to be + * registered to Waila via the {@link IWailaRegistrar} instance provided in the original registration callback method + * (cf. {@link IWailaRegistrar} documentation for more information). + * @author ProfMobius + * + */ public interface IWailaEntityProvider { - /* A way to get an override on the entity returned by the raytracing */ + /** + * Callback used to override the default Waila lookup system.
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerOverrideEntityProvider}.
+ * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + * @return null if override is not required, an Entity otherwise. + */ Entity getWailaOverride(IWailaEntityAccessor accessor, IWailaConfigHandler config); - /* The classical HEAD/BODY/TAIL text getters */ + /** + * Callback used to add lines to one of the three sections of the tooltip (Head, Body, Tail).
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerHeadProvider} client side.
+ * You are supposed to always return the modified input currenttip.
+ * + * @param entity Current Entity scanned. + * @param currenttip Current list of tooltip lines (might have been processed by other providers and might be processed by other providers). + * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + * @return Modified input currenttip + */ List getWailaHead(Entity entity, List currenttip, IWailaEntityAccessor accessor, IWailaConfigHandler config); + + /** + * Callback used to add lines to one of the three sections of the tooltip (Head, Body, Tail).
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerBodyProvider} client side.
+ * You are supposed to always return the modified input currenttip.
+ * + * @param entity Current Entity scanned. + * @param currenttip Current list of tooltip lines (might have been processed by other providers and might be processed by other providers). + * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + * @return Modified input currenttip + */ List getWailaBody(Entity entity, List currenttip, IWailaEntityAccessor accessor, IWailaConfigHandler config); + + /** + * Callback used to add lines to one of the three sections of the tooltip (Head, Body, Tail).
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerTailProvider} client side.
+ * You are supposed to always return the modified input currenttip.
+ * + * @param entity Current Entity scanned. + * @param currenttip Current list of tooltip lines (might have been processed by other providers and might be processed by other providers). + * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + * @return Modified input currenttip + */ List getWailaTail(Entity entity, List currenttip, IWailaEntityAccessor accessor, IWailaConfigHandler config); + + /** + * Callback used server side to return a custom synchronization NBTTagCompound.
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerNBTProvider} server and client side.
+ * You are supposed to always return the modified input NBTTagCompound tag.
+ * @param player The player requesting data synchronization (The owner of the current connection). + * @param ent The Entity targeted for synchronization. + * @param tag Current synchronization tag (might have been processed by other providers and might be processed by other providers). + * @param world TileEntity's World. + * @return Modified input NBTTagCompound tag. + */ + NBTTagCompound getNBTData(EntityPlayerMP player, Entity ent, NBTTagCompound tag, World world); } diff --git a/api/mcp/mobius/waila/api/IWailaFMPAccessor.java b/api/mcp/mobius/waila/api/IWailaFMPAccessor.java index be44b7b..99fb5e8 100644 --- a/api/mcp/mobius/waila/api/IWailaFMPAccessor.java +++ b/api/mcp/mobius/waila/api/IWailaFMPAccessor.java @@ -7,9 +7,12 @@ import net.minecraft.util.MovingObjectPosition; import net.minecraft.util.Vec3; import net.minecraft.world.World; -/* The Accessor is used to get some basic data out of the game without having to request - * direct access to the game engine. - * It will also return things that are unmodified by the overriding systems (like getWailaStack). +/** + * The Accessor is used to get some basic data out of the game without having to request direct access to the game engine.
+ * It will also return things that are unmodified by the overriding systems (like getWailaStack).
+ * An instance of this interface is passed to most of Waila FMP callbacks. + * @author ProfMobius + * */ public interface IWailaFMPAccessor { diff --git a/api/mcp/mobius/waila/api/IWailaFMPDecorator.java b/api/mcp/mobius/waila/api/IWailaFMPDecorator.java index 839af31..5484a56 100644 --- a/api/mcp/mobius/waila/api/IWailaFMPDecorator.java +++ b/api/mcp/mobius/waila/api/IWailaFMPDecorator.java @@ -2,6 +2,22 @@ package mcp.mobius.waila.api; import net.minecraft.item.ItemStack; +/** + * Callback class interface used to provide FMP decorator.
+ * All methods in this interface shouldn't to be called by the implementing mod. An instance of the class is to be + * registered to Waila via the {@link IWailaRegistrar} instance provided in the original registration callback method + * (cf. {@link IWailaRegistrar} documentation for more information). + * @author ProfMobius + * + */ public interface IWailaFMPDecorator { + + /** + * Callback for the decorator. It provides a standard GL stack positioned on the block.
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerDecorator}.
+ * @param itemStack Current block scanned, in ItemStack form. + * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + */ void decorateBlock(ItemStack itemStack, IWailaFMPAccessor accessor, IWailaConfigHandler config); } diff --git a/api/mcp/mobius/waila/api/IWailaFMPProvider.java b/api/mcp/mobius/waila/api/IWailaFMPProvider.java index 87a5623..6db02fb 100644 --- a/api/mcp/mobius/waila/api/IWailaFMPProvider.java +++ b/api/mcp/mobius/waila/api/IWailaFMPProvider.java @@ -1,12 +1,54 @@ package mcp.mobius.waila.api; -import net.minecraft.item.ItemStack; - import java.util.List; +import net.minecraft.item.ItemStack; + +/** + * Callback class interface used to provide FMP tooltip informations to Waila.
+ * All methods in this interface shouldn't to be called by the implementing mod. An instance of the class is to be + * registered to Waila via the {@link IWailaRegistrar} instance provided in the original registration callback method + * (cf. {@link IWailaRegistrar} documentation for more information). + * @author ProfMobius + * + */ public interface IWailaFMPProvider { - /* The classical HEAD/BODY/TAIL text getters */ + /** + * Callback used to add lines to one of the three sections of the tooltip (Head, Body, Tail).
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerHeadProvider} client side.
+ * You are supposed to always return the modified input currenttip.
+ * + * @param itemStack Current block scanned, in ItemStack form. + * @param currenttip Current list of tooltip lines (might have been processed by other providers and might be processed by other providers). + * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + * @return Modified input currenttip + */ List getWailaHead(ItemStack itemStack, List currenttip, IWailaFMPAccessor accessor, IWailaConfigHandler config); + + /** + * Callback used to add lines to one of the three sections of the tooltip (Head, Body, Tail).
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerBodyProvider} client side.
+ * You are supposed to always return the modified input currenttip.
+ * + * @param itemStack Current block scanned, in ItemStack form. + * @param currenttip Current list of tooltip lines (might have been processed by other providers and might be processed by other providers). + * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + * @return Modified input currenttip + */ List getWailaBody(ItemStack itemStack, List currenttip, IWailaFMPAccessor accessor, IWailaConfigHandler config); + + /** + * Callback used to add lines to one of the three sections of the tooltip (Head, Body, Tail).
+ * Will be used if the implementing class is registered via {@link IWailaRegistrar}.{@link registerTailProvider} client side.
+ * You are supposed to always return the modified input currenttip.
+ * + * @param itemStack Current block scanned, in ItemStack form. + * @param currenttip Current list of tooltip lines (might have been processed by other providers and might be processed by other providers). + * @param accessor Contains most of the relevant information about the current environment. + * @param config Current configuration of Waila. + * @return Modified input currenttip + */ List getWailaTail(ItemStack itemStack, List currenttip, IWailaFMPAccessor accessor, IWailaConfigHandler config); } diff --git a/api/mcp/mobius/waila/api/IWailaRegistrar.java b/api/mcp/mobius/waila/api/IWailaRegistrar.java index 162aeb6..66f43ad 100644 --- a/api/mcp/mobius/waila/api/IWailaRegistrar.java +++ b/api/mcp/mobius/waila/api/IWailaRegistrar.java @@ -1,11 +1,32 @@ package mcp.mobius.waila.api; +/** + * Main registration interface. An instance will be provided to a method specified in an IMC msg formatted as follow
+ * FMLInterModComms.sendMessage("Waila", "register", "fully.qualified.path.to.registration.method");
+ * The registration method need to follow this signature
+ * public static void callbackRegister({@link IWailaRegistrar} registrar)

+ * If not specified otherwise, all the registration methods taking a class can take classes as well as interfaces. + * Waila will do a lookup using instanceof on the registered classes, meaning that if all your targets inherit one interface, you only need + * to specify it to cover the whole hierarchy.
+ * For the registration of blocks, both Blocks and TileEntities are accepted.

+ * For the configuration keys :
+ * modname refers to a String used for display in Waila's config panel.
+ * keyname refers to an unique key used internally for config query (cf {@link IWailaConfigHandler}). Those keys are shared across Waila, keep them unique !
+ * + * + * @author ProfMobius + * + */ 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 addConfig(String modname, String keyname, String configtext, boolean defvalue); public void addConfigRemote(String modname, String keyname, String configtext); + public void addConfigRemote(String modname, String keyname, String configtext, boolean defvalue); public void addConfig(String modname, String keyname); + public void addConfig(String modname, String keyname, boolean defvalue); public void addConfigRemote(String modname, String keyname); + public void addConfigRemote(String modname, String keyname, boolean defvalue); /* Register a stack overrider for the given blockID */ public void registerStackProvider(IWailaDataProvider dataProvider, Class block); @@ -15,11 +36,17 @@ public interface IWailaRegistrar { public void registerBodyProvider (IWailaDataProvider dataProvider, Class block); public void registerTailProvider (IWailaDataProvider dataProvider, Class block); + /* Registering an NBT Provider provides a way to override the default "writeToNBT" way of doing things. */ + public void registerNBTProvider(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); + + /* Registering an NBT Provider provides a way to override the default "writeToNBT" way of doing things. */ + public void registerNBTProvider(IWailaEntityProvider dataProvider, Class entity); /* FMP Providers */ public void registerHeadProvider(IWailaFMPProvider dataProvider, String name); @@ -35,10 +62,16 @@ public interface IWailaRegistrar { * registerNBTKey("bob.*", MyBlock.class) * registerNBTKey("data.life", MyEntity.class) * registerNBTKey("*", MyTileEntity.class) will reproduce the full tag syncing from 1.4.5 + * + * This registration method is deprecated in favor to registerNBTProvider. + * It will be removed in MC 1.8 !!! * */ + @Deprecated public void registerSyncedNBTKey(String key, Class target); - + + public void registerTooltipRenderer(String name, IWailaTooltipRenderer renderer); + /* 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/api/mcp/mobius/waila/api/IWailaSummaryProvider.java b/api/mcp/mobius/waila/api/IWailaSummaryProvider.java index 03d94eb..f790649 100644 --- a/api/mcp/mobius/waila/api/IWailaSummaryProvider.java +++ b/api/mcp/mobius/waila/api/IWailaSummaryProvider.java @@ -1,9 +1,9 @@ package mcp.mobius.waila.api; -import net.minecraft.item.ItemStack; - import java.util.LinkedHashMap; +import net.minecraft.item.ItemStack; + public interface IWailaSummaryProvider { /* This interface is used to control the display data in the description screen */ diff --git a/api/mcp/mobius/waila/api/IWailaTooltipRenderer.java b/api/mcp/mobius/waila/api/IWailaTooltipRenderer.java new file mode 100644 index 0000000..700a278 --- /dev/null +++ b/api/mcp/mobius/waila/api/IWailaTooltipRenderer.java @@ -0,0 +1,24 @@ +package mcp.mobius.waila.api; + +import java.awt.Dimension; +import java.awt.Point; + + +public interface IWailaTooltipRenderer { + /** + * + * @param params Array of string parameters as passed to the RENDER arg in the tooltip ({rendername,param1,param2,...}) + * @param accessor A global accessor for TileEntities and Entities + * @return Dimension of the reserved area + */ + Dimension getSize(String[] params, IWailaCommonAccessor accessor); + + /** + * Draw method for the renderer. The GL matrice is automatically moved to the top left of the reserved zone.
+ * All calls should be relative to (0,0) + * + * @param params Array of string parameters as passed to the RENDER arg in the tooltip ({rendername,param1,param2,...}) + * @param accessor A global accessor for TileEntities and Entities + */ + void draw (String[] params, IWailaCommonAccessor accessor); +} diff --git a/api/mcp/mobius/waila/api/SpecialChars.java b/api/mcp/mobius/waila/api/SpecialChars.java index 5bd92a8..f2630cc 100644 --- a/api/mcp/mobius/waila/api/SpecialChars.java +++ b/api/mcp/mobius/waila/api/SpecialChars.java @@ -1,5 +1,10 @@ package mcp.mobius.waila.api; +import static mcp.mobius.waila.api.SpecialChars.RENDER; +import static mcp.mobius.waila.api.SpecialChars.WailaStyle; + +import java.util.regex.Pattern; + public class SpecialChars { public static String MCStyle = "\u00A7"; @@ -30,11 +35,36 @@ public class SpecialChars { public static String WailaStyle = "\u00A4"; public static String WailaIcon = "\u00A5"; + public static String WailaRenderer = "\u00A6"; 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 RENDER = WailaStyle + WailaRenderer +"a"; + public static final Pattern patternMinecraft = Pattern.compile("(?i)" + MCStyle + "[0-9A-FK-OR]"); + public static final Pattern patternWaila = Pattern.compile("(?i)(" + WailaStyle + "(?..))"); + public static final Pattern patternRender = Pattern.compile("(?i)(" + RENDER + "\\{(?[^,}]*),?(?[^}]*)\\})"); + public static final Pattern patternTab = Pattern.compile("(?i)" + TAB); + public static final Pattern patternRight = Pattern.compile("(?i)" + ALIGNRIGHT); + public static final Pattern patternCenter = Pattern.compile("(?i)" + ALIGNCENTER); + public static final Pattern patternIcon = Pattern.compile("(?i)(" + WailaStyle + WailaIcon + "(?[0-9a-z]))"); + public static final Pattern patternLineSplit = Pattern.compile("(?i)(" + WailaStyle + WailaStyle + "[^" + WailaStyle + "]+|" + WailaStyle + WailaIcon + "[0-9A-Z]|" + WailaStyle + WailaRenderer + "a\\{([^,}]*),?([^}]*)\\}|[^" + WailaStyle + "]+)"); + + /** + * Helper method to get a proper RENDER string. Just put the name of the renderer and the params in, and it will give back a directly usable String for the tooltip. + * @param name + * @param params + * @return + */ + public static String getRenderString(String name, String... params){ + String result = RENDER + "{" + name; + for (String s : params){ + result += "," + s; + } + result += "}"; + return result; + } } diff --git a/api/mcp/mobius/waila/api/package-info.java b/api/mcp/mobius/waila/api/package-info.java index 9b5e663..5fc5aa6 100644 --- a/api/mcp/mobius/waila/api/package-info.java +++ b/api/mcp/mobius/waila/api/package-info.java @@ -1,3 +1,3 @@ -@API(apiVersion="1.0",owner="Waila",provides="WailaAPI") +@API(apiVersion="1.2",owner="Waila",provides="WailaAPI") package mcp.mobius.waila.api; import cpw.mods.fml.common.API; \ No newline at end of file diff --git a/src/com/jaquadro/minecraft/storagedrawers/integration/Waila.java b/src/com/jaquadro/minecraft/storagedrawers/integration/Waila.java index ec849a3..1a4597e 100644 --- a/src/com/jaquadro/minecraft/storagedrawers/integration/Waila.java +++ b/src/com/jaquadro/minecraft/storagedrawers/integration/Waila.java @@ -10,8 +10,12 @@ import mcp.mobius.waila.api.IWailaConfigHandler; import mcp.mobius.waila.api.IWailaDataAccessor; import mcp.mobius.waila.api.IWailaDataProvider; import mcp.mobius.waila.api.IWailaRegistrar; +import net.minecraft.entity.player.EntityPlayerMP; import net.minecraft.item.ItemStack; +import net.minecraft.nbt.NBTTagCompound; +import net.minecraft.tileentity.TileEntity; import net.minecraft.util.StatCollector; +import net.minecraft.world.World; import java.util.List; @@ -78,5 +82,10 @@ public class Waila extends IntegrationModule public List getWailaTail (ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config) { return currenttip; } + + @Override + public NBTTagCompound getNBTData (EntityPlayerMP player, TileEntity te, NBTTagCompound tag, World world, int x, int y, int z) { + return null; + } } }