mcp.mobius.waila.api

Interface IWailaEntityProvider

public interface IWailaEntityProvider

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 IWailaRegistrar instance provided in the original registration callback method (cf. IWailaRegistrar documentation for more information).

Author:

ProfMobius

Method Summary

Modifier and Type	Method and Description
NBTTagCompound	getNBTData(EntityPlayerMP player, Entity ent, NBTTagCompound tag, World world) Callback used server side to return a custom synchronization NBTTagCompound. Will be used if the implementing class is registered via IWailaRegistrar.registerNBTProvider server and client side. You are supposed to always return the modified input NBTTagCompound tag.
List<String>	getWailaBody(Entity entity, List<String> 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 IWailaRegistrar.registerBodyProvider client side. You are supposed to always return the modified input currenttip.
List<String>	getWailaHead(Entity entity, List<String> 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 IWailaRegistrar.registerHeadProvider client side. You are supposed to always return the modified input currenttip.
Entity	getWailaOverride(IWailaEntityAccessor accessor, IWailaConfigHandler config) Callback used to override the default Waila lookup system. Will be used if the implementing class is registered via IWailaRegistrar.registerOverrideEntityProvider.
List<String>	getWailaTail(Entity entity, List<String> 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 IWailaRegistrar.registerTailProvider client side. You are supposed to always return the modified input currenttip.

Method Detail

getWailaOverride

Entity getWailaOverride(IWailaEntityAccessor accessor,
                        IWailaConfigHandler config)

Callback used to override the default Waila lookup system.
Will be used if the implementing class is registered via IWailaRegistrar.registerOverrideEntityProvider.

Parameters:

accessor - Contains most of the relevant information about the current environment.

config - Current configuration of Waila.

Returns:

null if override is not required, an Entity otherwise.

getWailaHead

List<String> getWailaHead(Entity entity,
                          List<String> 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 IWailaRegistrar.registerHeadProvider client side.
You are supposed to always return the modified input currenttip.

Parameters:

entity - Current Entity scanned.

currenttip - Current list of tooltip lines (might have been processed by other providers and might be processed by other providers).

accessor - Contains most of the relevant information about the current environment.

config - Current configuration of Waila.

Returns:

Modified input currenttip

getWailaBody

List<String> getWailaBody(Entity entity,
                          List<String> 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 IWailaRegistrar.registerBodyProvider client side.
You are supposed to always return the modified input currenttip.

Parameters:

entity - Current Entity scanned.

currenttip - Current list of tooltip lines (might have been processed by other providers and might be processed by other providers).

accessor - Contains most of the relevant information about the current environment.

config - Current configuration of Waila.

Returns:

Modified input currenttip

getWailaTail

List<String> getWailaTail(Entity entity,
                          List<String> 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 IWailaRegistrar.registerTailProvider client side.
You are supposed to always return the modified input currenttip.

Parameters:

entity - Current Entity scanned.

currenttip - Current list of tooltip lines (might have been processed by other providers and might be processed by other providers).

accessor - Contains most of the relevant information about the current environment.

config - Current configuration of Waila.

Returns:

Modified input currenttip

getNBTData

NBTTagCompound getNBTData(EntityPlayerMP player,
                          Entity ent,
                          NBTTagCompound tag,
                          World world)

Callback used server side to return a custom synchronization NBTTagCompound.
Will be used if the implementing class is registered via IWailaRegistrar.registerNBTProvider server and client side.
You are supposed to always return the modified input NBTTagCompound tag.

Parameters:

player - The player requesting data synchronization (The owner of the current connection).

ent - The Entity targeted for synchronization.

tag - Current synchronization tag (might have been processed by other providers and might be processed by other providers).

world - TileEntity's World.

Returns:

Modified input NBTTagCompound tag.