mcp.mobius.waila.api

Interface IWailaFMPProvider

public interface IWailaFMPProvider

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 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
List<String>	getWailaBody(ItemStack itemStack, List<String> 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 IWailaRegistrar.registerBodyProvider client side. You are supposed to always return the modified input currenttip.
List<String>	getWailaHead(ItemStack itemStack, List<String> 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 IWailaRegistrar.registerHeadProvider client side. You are supposed to always return the modified input currenttip.
List<String>	getWailaTail(ItemStack itemStack, List<String> 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 IWailaRegistrar.registerTailProvider client side. You are supposed to always return the modified input currenttip.

Method Detail

getWailaHead

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

Parameters:

itemStack - Current block scanned, in ItemStack form.

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

Parameters:

itemStack - Current block scanned, in ItemStack form.

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

Parameters:

itemStack - Current block scanned, in ItemStack form.

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