[1.11.2] [SOLVED] Waila / Hwyla intregration

[Bektor]

Hi,

 

I'm currently wondering how I can add Waila / Hwyla intregration to my mod:

 

My blocks should basically be able to show via Waila / Hwyla the stored amount of energy and how much can be stored max.

I also want to show the unit the energy is stored in, like if it is stored in Tesla or Forge Energy etc.

 

My main problem is now: How can I achieve this easy without having to register the handler for each block which can store energy?

In the methods from Waila / Hwyla itself, like getWailaBody I could just ask if the block is an instance of the base energy block, but

as I have to register this handler, I don't know how to achieve this in the best way.

 

Thx in advance.

Bektor

Edited April 22, 2017 by Bektor

[Choonster]

If all of your energy-using blocks extend a common class or implement a common interface, you can pass this type as the second argument when calling IWailaRegistrar#register[Head/Body/Tail]Provider(IWailaDataProvider, Class). The IWailaDataProvider will be used for any block that extends/implements that type.

[Bektor]

17 minutes ago, Choonster said:

If all of your energy-using blocks extend a common class or implement a common interface, you can pass this type as the second argument when calling IWailaRegistrar#register[Head/Body/Tail]Provider(IWailaDataProvider, Class). The IWailaDataProvider will be used for any block that extends/implements that type.

Ah, ok thx.

Just one question: What is the best way to get the energy stored from a block  to show it with Waila / Hwyla? Because my blocks are using Telsa and Forge Energy, they are all Capability based?

Besides, my solar panel for example only exposed the capability to the bottom, because why should it expose it to other sides if it should only be able to extract energy from the bottom.

I am also wondering why this site states that information is only obtained using the side null and everything else handles it not correclty.

[Choonster]

4 minutes ago, Bektor said:

Just one question: What is the best way to get the energy stored from a block  to show it with Waila / Hwyla? Because my blocks are using Telsa and Forge Energy, they are all Capability based?

Besides, my solar panel for example only exposed the capability to the bottom, because why should it expose it to other sides if it should only be able to extract energy from the bottom.

I am also wondering why this site states that information is only obtained using the side null and everything else handles it not correclty.

 

Use IWailaDataAccessor#getTileEntity to get the TileEntity, then use either ICapabilityProvider#getCapability or your own method to get the Tesla/Forge energy storage from it.

 

ICapabilityProvider defines an EnumFacing of null to represent "internal" or "self". Hwyla doesn't interact directly with any specific side of a block, so it uses null as the EnumFacing when getting capabilities.

 

I recommend exposing your capabilities for the null EnumFacing (in addition to any existing non-null EnumFacings) and using this when getting them in the Hwyla HUD handlers.

[Bektor]

2 minutes ago, Choonster said:

 

Use IWailaDataAccessor#getTileEntity to get the TileEntity, then use either ICapabilityProvider#getCapability or your own method to get the Tesla/Forge energy storage from it.

 

ICapabilityProvider defines an EnumFacing of null to represent "internal" or "self". Hwyla doesn't interact directly with any specific side of a block, so it uses null as the EnumFacing when getting capabilities.

 

I recommend exposing your capabilities for the null EnumFacing (in addition to any existing non-null EnumFacings) and using this when getting them in the Hwyla HUD handlers.

Hm.. if I expose my Capability to null and non-null EnumFacing's, how can I prevent mods from receiving energy from the wrong side of my block?

 

And yeah, I got my own implementation. Basically a wrapper class which is an instance of EnergyStorage and does this in getCapability for Forge Energy and Tesla:

CapabilityEnergy.ENERGY.cast(energyStorage);

 

But could you explain the ICapabilityProvider with some more details? As of I only know it provides the methods getCapability and hasCapability and that's all I know about it.

[Choonster]

2 minutes ago, Bektor said:

Hm.. if I expose my Capability to null and non-null EnumFacing's, how can I prevent mods from receiving energy from the wrong side of my block?

 

Only expose it for the non-null EnumFacings that are appropriate for your block (e.g. only EnumFacing.DOWN), but also expose it for the null EnumFacing so it can be accessed by things that aren't directly interacting with a side of your block.

 

Adjacent blocks like power cables or machines should only use the EnumFacing that they're attached to, they're not likely to use null.

 

 

2 minutes ago, Bektor said:

But could you explain the ICapabilityProvider with some more details? As of I only know it provides the methods getCapability and hasCapability and that's all I know about it.

 

That's pretty much all there is to it.

[loordgek]

there is a enumfacing in IWailaDataAccessor

[Bektor]

2 hours ago, Choonster said:

Only expose it for the non-null EnumFacings that are appropriate for your block (e.g. only EnumFacing.DOWN), but also expose it for the null EnumFacing so it can be accessed by things that aren't directly interacting with a side of your block.

 

Adjacent blocks like power cables or machines should only use the EnumFacing that they're attached to, they're not likely to use null.

 

So for example the generator "Solar Panel" has only the EnumFacing null for Waila etc. and the EnumFacing.DOWN so cables can get energy from it and you have to place the cables under the solar panel for it to work. Correct?

 

And cables and machines like electro furnaces aren't using null.?

I'm wondering why they're not likely to use null.

[Draco18s]

Null sides are essentially for "internal" use. Such as a block being broken being able to drop all of its contained items

[Draco18s]

14 minutes ago, diesieben07 said:

Nothing to do with "internal". Null can be used to mean anything, really. For inventories it usually means "give a combined handler of all the inventories".

From the javadoc on the method itself

Quote

     * @param facing The Side to check from:
     *   CAN BE NULL. Null is defined to represent 'internal' or 'self'

 

[Choonster]

4 hours ago, Bektor said:

So for example the generator "Solar Panel" has only the EnumFacing null for Waila etc. and the EnumFacing.DOWN so cables can get energy from it and you have to place the cables under the solar panel for it to work. Correct?

 

And cables and machines like electro furnaces aren't using null.?

I'm wondering why they're not likely to use null.

 

That's correct.

 

Cables and machines acting on adjacent blocks generally use the EnumFacing they're attached to to ensure they get the right inventory, tank, energy storage, etc. If a block has an energy storage that can only be accessed from the bottom, you wouldn't expect a cable attached to the top or side to access it. If there's a block like the furnace that has different slot groups, you wouldn't expect a hopper on the side to put items into the bottom slot group.

[Bektor]

14 hours ago, Choonster said:

 

That's correct.

 

Cables and machines acting on adjacent blocks generally use the EnumFacing they're attached to to ensure they get the right inventory, tank, energy storage, etc. If a block has an energy storage that can only be accessed from the bottom, you wouldn't expect a cable attached to the top or side to access it. If there's a block like the furnace that has different slot groups, you wouldn't expect a hopper on the side to put items into the bottom slot group.

Ok, thx.