Tidy up some APIs, expose the addOverride mechanism. This should be pluggable by forge

but may need work to allow for each mod to have it's own override set
This commit is contained in:
Christian committed 2012-08-13 19:57:40 -04:00
1 parent 6a273dd98f
commit fa38c1a6b3
8 files changed
+168 -42

No files matched your search

@@ -146,8 +146,6 @@ public class FMLClientHandler implements IFMLSidedHandler
*/
private Minecraft client;
private boolean firstTick;
/**
* Called to start the whole game off from
* {@link MinecraftServer#startServer}
@@ -210,6 +208,7 @@ public class FMLClientHandler implements IFMLSidedHandler
* Also initializes key bindings
*
*/
@SuppressWarnings("deprecation")
public void finishMinecraftLoading()
{
try
@@ -223,10 +222,12 @@ public class FMLClientHandler implements IFMLSidedHandler
}
RenderingRegistry.instance().loadEntityRenderers((Map<Class<? extends Entity>, Render>)RenderManager.field_78727_a.field_78729_o);
KeyBindingRegistry.uploadKeyBindingsToGame(client.field_71474_y);
KeyBindingRegistry.instance().uploadKeyBindingsToGame(client.field_71474_y);
}
// Mark this as a "first tick"
firstTick = true;
public void reloadTextureFX()
{
TextureFXManager.instance().loadTextures(client.field_71418_C.func_77292_e());
}
/**
* Get the server instance
@@ -241,10 +241,6 @@ public class TextureFXManager
public void registerTextureOverrides(RenderEngine renderer) {
for (ModContainer mod : Loader.instance().getActiveModList()) {
registerAnimatedTexturesFor(mod);
}
for (OverrideInfo animationOverride : animationSet) {
renderer.func_78355_a(animationOverride.textureFX);
addedTextureFX.add(animationOverride.textureFX);
@@ -272,7 +268,7 @@ public class TextureFXManager
/**
* @param mod
*/
private void registerAnimatedTexturesFor(ModContainer mod)
protected void registerAnimatedTexturesFor(ModContainer mod)
{
}
@@ -24,9 +24,9 @@ public class ModLoaderClientHelper implements IModLoaderSidedHelper
*/
public static int obtainBlockModelIdFor(BaseMod mod, boolean inventoryRenderer)
{
int renderId=RenderingRegistry.instance().getNextAvailableRenderId();
int renderId=RenderingRegistry.getNextAvailableRenderId();
ModLoaderBlockRendererHandler bri=new ModLoaderBlockRendererHandler(renderId, inventoryRenderer, mod);
RenderingRegistry.instance().registerBlockHandler(bri);
RenderingRegistry.registerBlockHandler(bri);
return renderId;
}
@@ -41,7 +41,7 @@ public class ModLoaderClientHelper implements IModLoaderSidedHelper
for (Entry<Class<? extends Entity>, Render> e : renderers.entrySet())
{
RenderingRegistry.instance().registerEntityRenderingHandler(e.getKey(), e.getValue());
RenderingRegistry.registerEntityRenderingHandler(e.getKey(), e.getValue());
}
mod.registerAnimation(game);
@@ -19,6 +19,25 @@ import cpw.mods.fml.common.registry.TickRegistry;
public class KeyBindingRegistry
{
/**
* Register a KeyHandler to the game. This handler will be called on certain tick events
* if any of its key is inactive or has recently changed state
*
* @param handler
*/
public static void registerKeyBinding(KeyHandler handler) {
instance().keyHandlers.add(handler);
TickRegistry.registerTickHandler(handler, Side.CLIENT);
}
/**
* Extend this class to register a KeyBinding and recieve callback
* when the key binding is triggered
*
* @author cpw
*
*/
public static abstract class KeyHandler implements ITickHandler
{
protected KeyBinding keyBinding;
@@ -36,12 +55,18 @@ public class KeyBindingRegistry
return this.keyBinding;
}
/**
* Not to be overridden - KeyBindings are tickhandlers under the covers
*/
@Override
public final void tickStart(EnumSet<TickType> type, Object... tickData)
{
keyTick(type, false);
}
/**
* Not to be overridden - KeyBindings are tickhandlers under the covers
*/
@Override
public final void tickEnd(EnumSet<TickType> type, Object... tickData)
{
@@ -66,18 +91,49 @@ public class KeyBindingRegistry
}
}
/**
* Called when the key is first in the down position on any tick from the {@link #ticks()}
* set. Will be called subsequently with isRepeat set to true
*
* @see #keyUp(EnumSet, boolean)
*
* @param types the type(s) of tick that fired when this key was first down
* @param tickEnd was it an end or start tick which fired the key
* @param isRepeat is it a repeat key event
*/
public abstract void keyDown(EnumSet<TickType> types, boolean tickEnd, boolean isRepeat);
/**
* Fired once when the key changes state from down to up
*
* @see #keyDown(EnumSet, boolean, boolean)
*
* @param types the type(s) of tick that fired when this key was first down
* @param tickEnd was it an end or start tick which fired the key
*/
public abstract void keyUp(EnumSet<TickType> types, boolean tickEnd);
/**
* This is the list of ticks for which the key binding should trigger. The only
* valid ticks are client side ticks, obviously.
*
* @see cpw.mods.fml.common.ITickHandler#ticks()
*/
public abstract EnumSet<TickType> ticks();
}
private static List<KeyHandler> keyHandlers = Lists.newArrayList();
private static final KeyBindingRegistry INSTANCE = new KeyBindingRegistry();
public static void registerKeyBinding(KeyHandler handler) {
keyHandlers.add(handler);
TickRegistry.registerTickHandler(handler, Side.CLIENT);
private List<KeyHandler> keyHandlers = Lists.newArrayList();
@Deprecated
public static KeyBindingRegistry instance()
{
return INSTANCE;
}
public static void uploadKeyBindingsToGame(GameSettings settings)
public void uploadKeyBindingsToGame(GameSettings settings)
{
ArrayList<KeyBinding> harvestedBindings = Lists.newArrayList();
for (KeyHandler key : keyHandlers)
@@ -14,6 +14,8 @@ import net.minecraft.src.IBlockAccess;
import net.minecraft.src.Render;
import net.minecraft.src.RenderBlocks;
import net.minecraft.src.RenderPlayer;
import cpw.mods.fml.client.SpriteHelper;
import cpw.mods.fml.client.TextureFXManager;
import cpw.mods.fml.client.modloader.ModLoaderBlockRendererHandler;
import cpw.mods.fml.common.ObfuscationReflectionHelper;
@@ -27,18 +29,93 @@ public class RenderingRegistry
private List<EntityRendererInfo> entityRenderers = Lists.newArrayList();
public int addNewArmourRendererPrefix(String armor)
/**
* Add a new armour prefix to the RenderPlayer
*
* @param armor
* @return
*/
public static int addNewArmourRendererPrefix(String armor)
{
RenderPlayer.field_77110_j = ObjectArrays.concat(RenderPlayer.field_77110_j, armor);
return RenderPlayer.field_77110_j.length - 1;
}
public static RenderingRegistry instance()
/**
* Register an entity rendering handler. This will, after mod initialization, be inserted into the main
* render map for entities
*
* @param entityClass
* @param renderer
*/
public static void registerEntityRenderingHandler(Class<? extends Entity> entityClass, Render renderer)
{
instance().entityRenderers.add(new EntityRendererInfo(entityClass, renderer));
}
/**
* Register a simple block rendering handler
*
* @param handler
*/
public static void registerBlockHandler(ISimpleBlockRenderingHandler handler)
{
instance().blockRenderers.put(handler.getRenderId(), handler);
}
/**
* Get the next available renderId from the block render ID list
*
* @return
*/
public static int getNextAvailableRenderId()
{
return instance().nextRenderId++;
}
/**
* Add a texture override for the given path and return the used index
*
* @param fileToOverride
* @param fileToAdd
* @return
*/
public static int addTextureOverride(String fileToOverride, String fileToAdd)
{
int idx = SpriteHelper.getUniqueSpriteIndex(fileToOverride);
addTextureOverride(fileToOverride, fileToAdd, idx);
return idx;
}
/**
* Add a texture override for the given path and index
*
* @param path
* @param overlayPath
* @param index
*/
public static void addTextureOverride(String path, String overlayPath, int index)
{
TextureFXManager.instance().addNewTextureOverride(path, overlayPath, index);
}
/**
* Get and reserve a unique texture index for the supplied path
*
* @param path
* @return
*/
public static int getUniqueTextureIndex(String path)
{
return SpriteHelper.getUniqueSpriteIndex(path);
}
@Deprecated public static RenderingRegistry instance()
{
return INSTANCE;
}
private class EntityRendererInfo
private static class EntityRendererInfo
{
public EntityRendererInfo(Class<? extends Entity> target, Render renderer)
{
@@ -49,20 +126,6 @@ public class RenderingRegistry
private Render renderer;
}
public void registerEntityRenderingHandler(Class<? extends Entity> entityClass, Render renderer)
{
entityRenderers.add(new EntityRendererInfo(entityClass, renderer));
}
public void registerBlockHandler(ISimpleBlockRenderingHandler handler)
{
blockRenderers.put(handler.getRenderId(), handler);
}
public int getNextAvailableRenderId()
{
return nextRenderId++;
}
/**
* @param renderer
* @param world
@@ -74,16 +74,19 @@ public class FMLRenderAccessLibrary
TextureFXManager.instance().onTexturePackChange(engine, texturePack, textureFXList);
}
@SuppressWarnings("deprecation")
public static boolean renderWorldBlock(RenderBlocks renderer, IBlockAccess world, int x, int y, int z, Block block, int modelId)
{
return RenderingRegistry.instance().renderWorldBlock(renderer, world, x, y, z, block, modelId);
}
@SuppressWarnings("deprecation")
public static void renderInventoryBlock(RenderBlocks renderer, Block block, int metadata, int modelID)
{
RenderingRegistry.instance().renderInventoryBlock(renderer, block, metadata, modelID);
}
@SuppressWarnings("deprecation")
public static boolean renderItemAsFull3DBlock(int modelId)
{
return RenderingRegistry.instance().renderItemAsFull3DBlock(modelId);
+10 -7
View File
@@ -37,6 +37,7 @@ import cpw.mods.fml.common.Loader;
import cpw.mods.fml.common.modloader.ModLoaderHelper;
import cpw.mods.fml.common.modloader.ModLoaderModContainer;
import cpw.mods.fml.common.network.NetworkRegistry;
import cpw.mods.fml.common.network.PacketDispatcher;
import cpw.mods.fml.common.network.Player;
import cpw.mods.fml.common.registry.EntityRegistry;
import cpw.mods.fml.common.registry.GameRegistry;
@@ -96,7 +97,7 @@ public class ModLoader
*/
public static int addArmor(String armor)
{
return RenderingRegistry.instance().addNewArmourRendererPrefix(armor);
return RenderingRegistry.addNewArmourRendererPrefix(armor);
}
/**
@@ -164,9 +165,7 @@ public class ModLoader
*/
public static int addOverride(String fileToOverride, String fileToAdd)
{
int idx = SpriteHelper.getUniqueSpriteIndex(fileToOverride);
addOverride(fileToOverride, fileToAdd, idx);
return idx;
return RenderingRegistry.addTextureOverride(fileToOverride, fileToAdd);
}
/**
@@ -178,7 +177,7 @@ public class ModLoader
*/
public static void addOverride(String path, String overlayPath, int index)
{
TextureFXManager.instance().addNewTextureOverride(path, overlayPath, index);
RenderingRegistry.addTextureOverride(path, overlayPath, index);
}
/**
@@ -695,9 +694,13 @@ public class ModLoader
{
}
/**
* Send a packet from client to server
*
* @param packet
*/
public static void sendPacket(Packet packet) {
// TODO
// FMLClientHandler.instance().sendPacket(packet);
PacketDispatcher.sendPacketToServer(packet);
}
/**
* Send a chat message to the server
@@ -20,6 +20,10 @@ public class LanguageRegistry
return INSTANCE;
}
public void addStringLocalization(String key, String value)
{
addStringLocalization(key, "en_US", value);
}
public void addStringLocalization(String key, String lang, String value)
{
Properties langPack=modLanguageData.get(lang);