mcp.mobius.waila.api

Interface IWailaRegistrar

public interface IWailaRegistrar

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(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 IWailaConfigHandler). Those keys are shared across Waila, keep them unique !

Author:

ProfMobius

Method Summary

Modifier and Type	Method and Description
void	addConfig(String modname, String keyname)
void	addConfig(String modname, String keyname, boolean defvalue)
void	addConfig(String modname, String keyname, String configtext)
void	addConfig(String modname, String keyname, String configtext, boolean defvalue)
void	addConfigRemote(String modname, String keyname)
void	addConfigRemote(String modname, String keyname, boolean defvalue)
void	addConfigRemote(String modname, String keyname, String configtext)
void	addConfigRemote(String modname, String keyname, String configtext, boolean defvalue)
void	registerBodyProvider(IWailaDataProvider dataProvider, Class block)
void	registerBodyProvider(IWailaEntityProvider dataProvider, Class entity)
void	registerBodyProvider(IWailaFMPProvider dataProvider, String name)
void	registerDecorator(IWailaBlockDecorator decorator, Class block)
void	registerDecorator(IWailaFMPDecorator decorator, String name)
void	registerHeadProvider(IWailaDataProvider dataProvider, Class block)
void	registerHeadProvider(IWailaEntityProvider dataProvider, Class entity)
void	registerHeadProvider(IWailaFMPProvider dataProvider, String name)
void	registerNBTProvider(IWailaDataProvider dataProvider, Class block)
void	registerNBTProvider(IWailaEntityProvider dataProvider, Class entity)
void	registerOverrideEntityProvider(IWailaEntityProvider dataProvider, Class entity)
void	registerStackProvider(IWailaDataProvider dataProvider, Class block)
void	registerSyncedNBTKey(String key, Class target) Deprecated.
void	registerTailProvider(IWailaDataProvider dataProvider, Class block)
void	registerTailProvider(IWailaEntityProvider dataProvider, Class entity)
void	registerTailProvider(IWailaFMPProvider dataProvider, String name)

Method Detail

addConfig

void addConfig(String modname,
               String keyname,
               String configtext)

addConfig

void addConfig(String modname,
               String keyname,
               String configtext,
               boolean defvalue)

addConfigRemote

void addConfigRemote(String modname,
                     String keyname,
                     String configtext)

addConfigRemote

void addConfigRemote(String modname,
                     String keyname,
                     String configtext,
                     boolean defvalue)

addConfig

void addConfig(String modname,
               String keyname)

addConfig

void addConfig(String modname,
               String keyname,
               boolean defvalue)

addConfigRemote

void addConfigRemote(String modname,
                     String keyname)

addConfigRemote

void addConfigRemote(String modname,
                     String keyname,
                     boolean defvalue)

registerStackProvider

void registerStackProvider(IWailaDataProvider dataProvider,
                           Class block)

registerHeadProvider

void registerHeadProvider(IWailaDataProvider dataProvider,
                          Class block)

registerBodyProvider

void registerBodyProvider(IWailaDataProvider dataProvider,
                          Class block)

registerTailProvider

void registerTailProvider(IWailaDataProvider dataProvider,
                          Class block)

registerNBTProvider

void registerNBTProvider(IWailaDataProvider dataProvider,
                         Class block)

registerHeadProvider

void registerHeadProvider(IWailaEntityProvider dataProvider,
                          Class entity)

registerBodyProvider

void registerBodyProvider(IWailaEntityProvider dataProvider,
                          Class entity)

registerTailProvider

void registerTailProvider(IWailaEntityProvider dataProvider,
                          Class entity)

registerOverrideEntityProvider

void registerOverrideEntityProvider(IWailaEntityProvider dataProvider,
                                    Class entity)

registerNBTProvider

void registerNBTProvider(IWailaEntityProvider dataProvider,
                         Class entity)

registerHeadProvider

void registerHeadProvider(IWailaFMPProvider dataProvider,
                          String name)

registerBodyProvider

void registerBodyProvider(IWailaFMPProvider dataProvider,
                          String name)

registerTailProvider

void registerTailProvider(IWailaFMPProvider dataProvider,
                          String name)

registerDecorator

void registerDecorator(IWailaBlockDecorator decorator,
                       Class block)

registerDecorator

void registerDecorator(IWailaFMPDecorator decorator,
                       String name)

registerSyncedNBTKey

@Deprecated
void registerSyncedNBTKey(String key,
                                      Class target)

Deprecated.