diff --git a/src/api/java/mcp/mobius/waila/api/ITaggedList.java b/src/api/java/mcp/mobius/waila/api/ITaggedList.java new file mode 100644 index 000000000..7413c2849 --- /dev/null +++ b/src/api/java/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/src/api/java/mcp/mobius/waila/api/IWailaBlock.java b/src/api/java/mcp/mobius/waila/api/IWailaBlock.java new file mode 100644 index 000000000..8b4dd131e --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/IWailaBlock.java @@ -0,0 +1,34 @@ +package mcp.mobius.waila.api; + +import java.util.List; + +import net.minecraft.item.ItemStack; + +@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/src/api/java/mcp/mobius/waila/api/IWailaBlockDecorator.java b/src/api/java/mcp/mobius/waila/api/IWailaBlockDecorator.java new file mode 100644 index 000000000..7dc6ba03c --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/IWailaBlockDecorator.java @@ -0,0 +1,24 @@ +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/src/api/java/mcp/mobius/waila/api/IWailaCommonAccessor.java b/src/api/java/mcp/mobius/waila/api/IWailaCommonAccessor.java new file mode 100644 index 000000000..982f50bec --- /dev/null +++ b/src/api/java/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/src/api/java/mcp/mobius/waila/api/IWailaConfigHandler.java b/src/api/java/mcp/mobius/waila/api/IWailaConfigHandler.java new file mode 100644 index 000000000..9752e423f --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/IWailaConfigHandler.java @@ -0,0 +1,44 @@ +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. + * + * @return + */ + public Set getModuleNames(); + + /** + * Returns all the currently available options for a given module + * + * @param modName Module name + * @return + */ + public HashMap getConfigKeys(String modName); + + /** + * Returns the current value of an option (true/false) with a default value 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 + * + * @param key Option to lookup + * @return Value of the option or true if not set. + */ + public boolean getConfig(String key); +} diff --git a/src/api/java/mcp/mobius/waila/api/IWailaDataAccessor.java b/src/api/java/mcp/mobius/waila/api/IWailaDataAccessor.java new file mode 100644 index 000000000..7b87217ac --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/IWailaDataAccessor.java @@ -0,0 +1,37 @@ +package mcp.mobius.waila.api; + +import net.minecraft.block.Block; +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).
+ * An instance of this interface is passed to most of Waila Block/TileEntity callbacks. + * @author ProfMobius + * + */ + +public interface IWailaDataAccessor{ + + World getWorld(); + EntityPlayer getPlayer(); + Block getBlock(); + int getBlockID(); + String getBlockQualifiedName(); + int getMetadata(); + TileEntity getTileEntity(); + MovingObjectPosition getPosition(); + 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 new file mode 100644 index 000000000..eb7e98bfa --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/IWailaDataProvider.java @@ -0,0 +1,83 @@ +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{ + + /** + * 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); + + /** + * 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, 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/src/api/java/mcp/mobius/waila/api/IWailaEntityAccessor.java b/src/api/java/mcp/mobius/waila/api/IWailaEntityAccessor.java new file mode 100644 index 000000000..a4c00760c --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/IWailaEntityAccessor.java @@ -0,0 +1,27 @@ +package mcp.mobius.waila.api; + +import net.minecraft.entity.Entity; +import net.minecraft.entity.player.EntityPlayer; +import net.minecraft.nbt.NBTTagCompound; +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).
+ * An instance of this interface is passed to most of Waila Entity callbacks. + * @author ProfMobius + * + */ + +public interface IWailaEntityAccessor { + World getWorld(); + EntityPlayer getPlayer(); + Entity getEntity(); + MovingObjectPosition getPosition(); + 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 new file mode 100644 index 000000000..5a9acd8da --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/IWailaEntityProvider.java @@ -0,0 +1,79 @@ +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 { + + /** + * 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); + + /** + * 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/src/api/java/mcp/mobius/waila/api/IWailaFMPAccessor.java b/src/api/java/mcp/mobius/waila/api/IWailaFMPAccessor.java new file mode 100644 index 000000000..99fb5e8ae --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/IWailaFMPAccessor.java @@ -0,0 +1,29 @@ +package mcp.mobius.waila.api; + +import net.minecraft.entity.player.EntityPlayer; +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; + +/** + * 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 { + World getWorld(); + EntityPlayer getPlayer(); + TileEntity getTileEntity(); + MovingObjectPosition getPosition(); + 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 new file mode 100644 index 000000000..5484a566e --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/IWailaFMPDecorator.java @@ -0,0 +1,23 @@ +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/src/api/java/mcp/mobius/waila/api/IWailaFMPProvider.java b/src/api/java/mcp/mobius/waila/api/IWailaFMPProvider.java new file mode 100644 index 000000000..6db02fb27 --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/IWailaFMPProvider.java @@ -0,0 +1,54 @@ +package mcp.mobius.waila.api; + +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 { + /** + * 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/src/api/java/mcp/mobius/waila/api/IWailaRegistrar.java b/src/api/java/mcp/mobius/waila/api/IWailaRegistrar.java new file mode 100644 index 000000000..66f43ada2 --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/IWailaRegistrar.java @@ -0,0 +1,77 @@ +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); + + /* 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); + + /* 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); + 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); + + /* 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) + * 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); +} diff --git a/src/api/java/mcp/mobius/waila/api/IWailaSummaryProvider.java b/src/api/java/mcp/mobius/waila/api/IWailaSummaryProvider.java new file mode 100644 index 000000000..f79064981 --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/IWailaSummaryProvider.java @@ -0,0 +1,21 @@ +package mcp.mobius.waila.api; + +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 */ + + /* BASIC TOOLS & ITEMS DATA */ + //EnumToolMaterial getMaterial(ItemStack stack); + //String getMaterialName(ItemStack stack); + //String getEffectiveBlock(ItemStack stack); + //int getHarvestLevel(ItemStack stack); + //float getEfficiencyOnProperMaterial(ItemStack stack); + //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/IWailaTooltipRenderer.java b/src/api/java/mcp/mobius/waila/api/IWailaTooltipRenderer.java new file mode 100644 index 000000000..700a27814 --- /dev/null +++ b/src/api/java/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/src/api/java/mcp/mobius/waila/api/SpecialChars.java b/src/api/java/mcp/mobius/waila/api/SpecialChars.java new file mode 100644 index 000000000..f2630cc72 --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/SpecialChars.java @@ -0,0 +1,70 @@ +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"; + + 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 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/src/api/java/mcp/mobius/waila/api/package-info.java b/src/api/java/mcp/mobius/waila/api/package-info.java new file mode 100644 index 000000000..5fc5aa6f3 --- /dev/null +++ b/src/api/java/mcp/mobius/waila/api/package-info.java @@ -0,0 +1,3 @@ +@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/main/java/mekanism/common/Mekanism.java b/src/main/java/mekanism/common/Mekanism.java index f46132cdb..204612721 100644 --- a/src/main/java/mekanism/common/Mekanism.java +++ b/src/main/java/mekanism/common/Mekanism.java @@ -1203,9 +1203,14 @@ public class Mekanism addRecipes(); addEntities(); + //Integrate certain OreDictionary recipes registerOreDict(); + //Set up multiparts new MultipartMekanism(); + + //Integrate with Waila + FMLInterModComms.sendMessage("Waila", "register", "mekanism.common.integration.WailaDataProvider.register"); //Packet registrations packetHandler.initialize(); diff --git a/src/main/java/mekanism/common/integration/WailaDataProvider.java b/src/main/java/mekanism/common/integration/WailaDataProvider.java new file mode 100644 index 000000000..5beb930f5 --- /dev/null +++ b/src/main/java/mekanism/common/integration/WailaDataProvider.java @@ -0,0 +1,77 @@ +package mekanism.common.integration; + +import java.util.List; + +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 mekanism.api.EnumColor; +import mekanism.common.tile.TileEntityInductionCell; +import mekanism.common.tile.TileEntityInductionProvider; +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; +import cpw.mods.fml.common.Optional.Interface; +import cpw.mods.fml.common.Optional.Method; + +@Interface(iface = "mcp.mobius.waila.api.IWailaDataProvider", modid = "Waila") +public class WailaDataProvider implements IWailaDataProvider +{ + @Method(modid = "Waila") + public static void register(IWailaRegistrar registrar) + { + WailaDataProvider provider = new WailaDataProvider(); + + registrar.registerHeadProvider(provider, TileEntityInductionCell.class); + registrar.registerHeadProvider(provider, TileEntityInductionProvider.class); + } + + @Override + @Method(modid = "Waila") + public ItemStack getWailaStack(IWailaDataAccessor accessor, IWailaConfigHandler config) + { + return null; + } + + @Override + @Method(modid = "Waila") + public List getWailaHead(ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config) + { + TileEntity tile = accessor.getTileEntity(); + + if(tile instanceof TileEntityInductionCell) + { + currenttip.set(0, EnumColor.WHITE + ((TileEntityInductionCell)tile).getInventoryName()); + } + else if(tile instanceof TileEntityInductionProvider) + { + currenttip.set(0, EnumColor.WHITE + ((TileEntityInductionProvider)tile).getInventoryName()); + } + + return currenttip; + } + + @Override + @Method(modid = "Waila") + public List getWailaBody(ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config) + { + return currenttip; + } + + @Override + @Method(modid = "Waila") + public List getWailaTail(ItemStack itemStack, List currenttip, IWailaDataAccessor accessor, IWailaConfigHandler config) + { + return currenttip; + } + + @Override + @Method(modid = "Waila") + public NBTTagCompound getNBTData(EntityPlayerMP player, TileEntity te, NBTTagCompound tag, World world, int x, int y, int z) + { + return tag; + } +} diff --git a/src/main/java/mekanism/common/tile/TileEntityInductionCell.java b/src/main/java/mekanism/common/tile/TileEntityInductionCell.java index 6df55a759..7d9152a33 100644 --- a/src/main/java/mekanism/common/tile/TileEntityInductionCell.java +++ b/src/main/java/mekanism/common/tile/TileEntityInductionCell.java @@ -24,6 +24,11 @@ public class TileEntityInductionCell extends TileEntityBasicBlock implements ISt return false; } + public String getInventoryName() + { + return MekanismUtils.localize(getBlockType().getUnlocalizedName() + ".InductionCell" + tier.getBaseTier().getName() + ".name"); + } + @Override public void handlePacketData(ByteBuf dataStream) { diff --git a/src/main/java/mekanism/common/tile/TileEntityInductionProvider.java b/src/main/java/mekanism/common/tile/TileEntityInductionProvider.java index 02142b4a9..e055fc322 100644 --- a/src/main/java/mekanism/common/tile/TileEntityInductionProvider.java +++ b/src/main/java/mekanism/common/tile/TileEntityInductionProvider.java @@ -21,6 +21,11 @@ public class TileEntityInductionProvider extends TileEntityBasicBlock return false; } + public String getInventoryName() + { + return MekanismUtils.localize(getBlockType().getUnlocalizedName() + ".InductionProvider" + tier.getBaseTier().getName() + ".name"); + } + @Override public void handlePacketData(ByteBuf dataStream) {