/* * The FML Forge Mod Loader suite. Copyright (C) 2012 cpw * * This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free * Software Foundation; either version 2.1 of the License, or any later version. * * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ package net.minecraft.src; import java.awt.image.BufferedImage; import java.util.Collections; import java.util.EnumSet; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.logging.Logger; import net.minecraft.client.Minecraft; import cpw.mods.fml.client.FMLClientHandler; import cpw.mods.fml.client.SpriteHelper; import cpw.mods.fml.common.FMLCommonHandler; 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.registry.FMLRegistry; import cpw.mods.fml.common.ObfuscationReflectionHelper; public class ModLoader { // TODO dirty workaround for millinaire @Deprecated public static final Map> localizedStrings=Collections.emptyMap(); /** * Not used on the server. * * @param achievement * @param name * @param description */ public static void addAchievementDesc(Achievement achievement, String name, String description) { String achName=achievement.func_44020_i(); addLocalization(achName, name); addLocalization(achName+".desc", description); } /** * This method is a call in hook from modified external code. Implemented elsewhere. * * {@link FMLCommonHandler#fuelLookup(int, int)} * * @param id * @param metadata * @return */ @Deprecated public static int addAllFuel(int id, int metadata) { return 0; } @Deprecated public static void addAllRenderers(Map, Render> renderers) { } public static void addAnimation(TextureFX anim) { FMLClientHandler.instance().addAnimation(anim); } /** * This method is unimplemented in server versions to date. * * @param armor * @return */ public static int addArmor(String armor) { return FMLClientHandler.instance().addNewArmourRendererPrefix(armor); } /** * This method adds the supplied biome to the set of candidate biomes for the default world generator type. * * @param biome */ public static void addBiome(BiomeGenBase biome) { FMLClientHandler.instance().addBiomeToDefaultWorldGenerator(biome); } /** * Add localization for the specified string * * @param key * @param value */ public static void addLocalization(String key, String value) { addLocalization(key, "en_US", value); } /** * Add localization for the specified string * * @param key * @param lang * @param value */ public static void addLocalization(String key, String lang, String value) { FMLCommonHandler.instance().addStringLocalization(key, lang, value); } /** * Name the specified minecraft object with the supplied name * * @param instance * @param name */ public static void addName(Object instance, String name) { addName(instance,"en_US",name); } /** * Unimplemented on the server as it does not generate names * * @param instance * @param lang * @param name */ public static void addName(Object instance, String lang, String name) { FMLCommonHandler.instance().addNameForObject(instance, lang, name); } /** * Unimplemented on the server as it does not render textures * * @param fileToOverride * @param fileToAdd * @return */ public static int addOverride(String fileToOverride, String fileToAdd) { int idx = SpriteHelper.getUniqueSpriteIndex(fileToOverride); addOverride(fileToOverride, fileToAdd, idx); return idx; } /** * Unimplemented on the server as it does not render textures * * @param path * @param overlayPath * @param index */ public static void addOverride(String path, String overlayPath, int index) { FMLClientHandler.instance().addNewTextureOverride(path, overlayPath, index); } /** * Add a Shaped Recipe * * @param output * @param params */ public static void addRecipe(ItemStack output, Object... params) { FMLRegistry.addRecipe(output, params); } /** * Add a shapeless recipe * * @param output * @param params */ public static void addShapelessRecipe(ItemStack output, Object... params) { FMLRegistry.addShapelessRecipe(output, params); } /** * Add a new product to be smelted * * @param input * @param output */ public static void addSmelting(int input, ItemStack output) { FMLRegistry.addSmelting(input, output); } /** * Add a mob to the spawn list * * @param entityClass * @param weightedProb * @param min * @param max * @param spawnList */ public static void addSpawn(Class entityClass, int weightedProb, int min, int max, EnumCreatureType spawnList) { FMLRegistry.addSpawn(entityClass, weightedProb, min, max, spawnList, FMLClientHandler.instance().getDefaultOverworldBiomes()); } /** * Add a mob to the spawn list * * @param entityClass * @param weightedProb * @param min * @param max * @param spawnList * @param biomes */ public static void addSpawn(Class entityClass, int weightedProb, int min, int max, EnumCreatureType spawnList, BiomeGenBase... biomes) { FMLRegistry.addSpawn(entityClass, weightedProb, min, max, spawnList, biomes); } /** * Add a mob to the spawn list * * @param entityName * @param weightedProb * @param min * @param max * @param spawnList */ public static void addSpawn(String entityName, int weightedProb, int min, int max, EnumCreatureType spawnList) { FMLRegistry.addSpawn(entityName, weightedProb, min, max, spawnList, FMLClientHandler.instance().getDefaultOverworldBiomes()); } /** * Add a mob to the spawn list * * @param entityName * @param weightedProb * @param min * @param max * @param spawnList * @param biomes */ public static void addSpawn(String entityName, int weightedProb, int min, int max, EnumCreatureType spawnList, BiomeGenBase... biomes) { FMLRegistry.addSpawn(entityName, weightedProb, min, max, spawnList, biomes); } /** * This method is a call in hook from modified external code. Implemented elsewhere. * {@link FMLClientHandler#tryDispensingEntity(World, double, double, double, byte, byte, ItemStack)} * * @param world * @param x * @param y * @param z * @param xVel * @param zVel * @param item * @return */ @Deprecated public static boolean dispenseEntity(World world, double x, double y, double z, int xVel, int zVel, ItemStack item) { return false; } /** * Remove a container and drop all the items in it on the ground around * * @param world * @param x * @param y * @param z */ public static void genericContainerRemoval(World world, int x, int y, int z) { TileEntity te = world.func_603_b(x, y, z); if (!(te instanceof IInventory)) { return; } IInventory inv = (IInventory)te; for (int l = 0; l < inv.func_469_c(); l++) { ItemStack itemstack = inv.func_468_c(l); if (itemstack == null) { continue; } float f = world.field_1037_n.nextFloat() * 0.8F + 0.1F; float f1 = world.field_1037_n.nextFloat() * 0.8F + 0.1F; float f2 = world.field_1037_n.nextFloat() * 0.8F + 0.1F; while (itemstack.field_1615_a > 0) { int i1 = world.field_1037_n.nextInt(21) + 10; if (i1 > itemstack.field_1615_a) { i1 = itemstack.field_1615_a; } itemstack.field_1615_a -= i1; EntityItem entityitem = new EntityItem(world, (float)te.field_823_f + f, (float)te.field_822_g + f1, (float)te.field_821_h + f2, new ItemStack(itemstack.field_1617_c, i1, itemstack.func_21181_i())); float f3 = 0.05F; entityitem.field_608_an = (float) world.field_1037_n.nextGaussian() * f3; entityitem.field_607_ao = (float) world.field_1037_n.nextGaussian() * f3 + 0.2F; entityitem.field_606_ap = (float) world.field_1037_n.nextGaussian() * f3; if (itemstack.func_40710_n()) { entityitem.field_801_a.func_40706_d((NBTTagCompound) itemstack.func_40709_o().func_40195_b()); } world.func_674_a(entityitem); } } } /** * Get a list of all BaseMod loaded into the system * {@link ModLoaderModContainer#findAll} * * @return */ public static List getLoadedMods() { return ModLoaderModContainer.findAll(BaseMod.class); } /** * Get a logger instance {@link FMLCommonHandler#getFMLLogger()} * * @return */ public static Logger getLogger() { return FMLCommonHandler.instance().getFMLLogger(); } public static Minecraft getMinecraftInstance() { return FMLClientHandler.instance().getClient(); } /** * This is not the server * {@link FMLClientHandler#getServer()} * * @return */ public static Object getMinecraftServerInstance() { return getMinecraftInstance(); } /** * Get a value from a field using reflection * {@link ObfuscationReflectionHelper#getPrivateValue(Class, Object, int)} * * @param instanceclass * @param instance * @param fieldindex * @return */ public static T getPrivateValue(Class instanceclass, E instance, int fieldindex) { return ObfuscationReflectionHelper.getPrivateValue(instanceclass, instance, fieldindex); } /** * Get a value from a field using reflection * {@link ObfuscationReflectionHelper#getPrivateValue(Class, Object, String)} * * @param instanceclass * @param instance * @param field * @return */ public static T getPrivateValue(Class instanceclass, E instance, String field) { return ObfuscationReflectionHelper.getPrivateValue(instanceclass, instance, field); } /** * Stubbed method on the server to return a unique model id * */ public static int getUniqueBlockModelID(BaseMod mod, boolean inventoryRenderer) { return FMLClientHandler.instance().obtainBlockModelIdFor(mod, inventoryRenderer); } /** * Get a new unique entity id * {@link Entity#getNextId()} * * @return */ public static int getUniqueEntityId() { return FMLCommonHandler.instance().nextUniqueEntityListId(); } public static int getUniqueSpriteIndex(String path) { return SpriteHelper.getUniqueSpriteIndex(path); } /** * To properly implement packet 250 protocol you should always check your * channel is active prior to sending the packet * * @param player * @param channel * @return */ public static boolean isChannelActive(EntityPlayer player, String channel) { return FMLCommonHandler.instance().isChannelActive(channel, player); } public static boolean isGUIOpen(Class gui) { return FMLClientHandler.instance().getClient().field_6313_p!=null && FMLClientHandler.instance().getClient().field_6313_p.equals(gui); } /** * Is the named mod loaded? * {@link Loader#isModLoaded(String)} * * @param modname * @return */ public static boolean isModLoaded(String modname) { return Loader.isModLoaded(modname); } /** * Implemented elsewhere */ @Deprecated public static void loadConfig() { } public static BufferedImage loadImage(RenderEngine renderEngine, String path) throws Exception { return FMLClientHandler.instance().loadImageFromTexturePack(renderEngine, path); } /** * Call in from elsewhere. Unimplemented here. * @param player * @param item */ @Deprecated public static void onItemPickup(EntityPlayer player, ItemStack item) { } /** * Call in from elsewhere. Unimplemented here. */ @Deprecated public static void onTick(float tick, Minecraft game) { } public static void openGUI(EntityPlayer player, GuiScreen gui) { FMLClientHandler.instance().displayGuiScreen(player, gui); } @Deprecated public static void populateChunk(IChunkProvider generator, int chunkX, int chunkZ, World world) { } /** * This method is a call in hook from modified external code. Implemented elsewhere. * {@link FMLServerHandler#handlePacket250(Packet250CustomPayload, EntityPlayer)} * * @param packet */ @Deprecated public static void receivePacket(Packet250CustomPayload packet) { } @Deprecated public static KeyBinding[] registerAllKeys(KeyBinding[] keys) { return keys; } @Deprecated public static void registerAllTextureOverrides(RenderEngine cache) { } /** * Register a new block * * @param block */ public static void registerBlock(Block block) { FMLRegistry.registerBlock(block); } /** * Register a new block * * @param block * @param itemclass */ public static void registerBlock(Block block, Class itemclass) { FMLRegistry.registerBlock(block, itemclass); } /** * Register a new entity ID * * @param entityClass * @param entityName * @param id */ public static void registerEntityID(Class entityClass, String entityName, int id) { FMLRegistry.registerEntityID(entityClass, entityName, id); } /** * Register a new entity ID * * @param entityClass * @param entityName * @param id * @param background * @param foreground */ public static void registerEntityID(Class entityClass, String entityName, int id, int background, int foreground) { FMLRegistry.registerEntityID(entityClass, entityName, id, background, foreground); } public static void registerKey(BaseMod mod, KeyBinding keyHandler, boolean allowRepeat) { FMLClientHandler.instance().registerModLoaderKeyHandler(mod, keyHandler, allowRepeat); } /** * Register the mod for packets on this channel. This only registers the * channel with Forge Mod Loader, not with clients connecting- use * BaseMod.onClientLogin to tell them about your custom channel * {@link FMLCommonHandler#registerChannel(cpw.mods.fml.common.ModContainer, String)} * * @param mod * @param channel */ public static void registerPacketChannel(BaseMod mod, String channel) { FMLCommonHandler.instance().registerChannel(FMLCommonHandler.instance().findContainerFor(mod), channel); } /** * Register a new tile entity class * * @param tileEntityClass * @param id */ public static void registerTileEntity(Class tileEntityClass, String id) { FMLRegistry.registerTileEntity(tileEntityClass, id); } public static void registerTileEntity(Class tileEntityClass, String id, TileEntitySpecialRenderer renderer) { ClientRegistry.instance().registerTileEntity(tileEntityClass, id, renderer); } /** * Remove a biome from the list of generated biomes * * @param biome */ public static void removeBiome(BiomeGenBase biome) { FMLRegistry.removeBiome(biome); } /** * Remove a spawn * * @param entityClass * @param spawnList */ public static void removeSpawn(Class entityClass, EnumCreatureType spawnList) { FMLRegistry.removeSpawn(entityClass, spawnList, FMLClientHandler.instance().getDefaultOverworldBiomes()); } /** * Remove a spawn * * @param entityClass * @param spawnList * @param biomes */ public static void removeSpawn(Class entityClass, EnumCreatureType spawnList, BiomeGenBase... biomes) { FMLRegistry.removeSpawn(entityClass, spawnList, biomes); } /** * Remove a spawn * * @param entityName * @param spawnList */ public static void removeSpawn(String entityName, EnumCreatureType spawnList) { FMLRegistry.removeSpawn(entityName, spawnList, FMLClientHandler.instance().getDefaultOverworldBiomes()); } /** * Remove a spawn * * @param entityName * @param spawnList * @param biomes */ public static void removeSpawn(String entityName, EnumCreatureType spawnList, BiomeGenBase... biomes) { FMLRegistry.removeSpawn(entityName, spawnList, biomes); } @Deprecated public static boolean renderBlockIsItemFull3D(int modelID) { return FMLClientHandler.instance().renderItemAsFull3DBlock(modelID); } @Deprecated public static void renderInvBlock(RenderBlocks renderer, Block block, int metadata, int modelID) { FMLClientHandler.instance().renderInventoryBlock(renderer, block, metadata, modelID); } @Deprecated public static boolean renderWorldBlock(RenderBlocks renderer, IBlockAccess world, int x, int y, int z, Block block, int modelID) { return FMLClientHandler.instance().renderWorldBlock(renderer, world, x, y, z, block, modelID); } /** * Configuration is handled elsewhere * {@link ModLoaderModContainer} */ @Deprecated public static void saveConfig() { } public static void sendPacket(Packet packet) { FMLClientHandler.instance().sendPacket(packet); } /** * Send a chat message to the server * {@link FMLClientHandler#handleChatPacket(Packet3Chat, EntityPlayer)} * * @param text */ @Deprecated public static void serverChat(String text) { //TODO } @Deprecated public static void serverLogin(NetClientHandler handler, Packet1Login loginPacket) { //TODO } /** * Indicate that you want to receive ticks * * @param mod receiving the events * @param enable indicates whether you want to recieve them or not * @param useClock don't receive render subticks, just world ticks */ public static void setInGameHook(BaseMod mod, boolean enable, boolean useClock) { ModLoaderHelper.updateStandardTicks(mod, enable, useClock); } public static void setInGUIHook(BaseMod mod, boolean enable, boolean useClock) { ModLoaderHelper.updateGUITicks(mod, enable, useClock); } /** * Set a private field to a value using reflection * {@link ObfuscationReflectionHelper#setPrivateValue(Class, Object, int, Object)} * * @param instanceclass * @param instance * @param fieldindex * @param value */ public static void setPrivateValue(Class instanceclass, T instance, int fieldindex, E value) { ObfuscationReflectionHelper.setPrivateValue(instanceclass, instance, value, fieldindex); } /** * Set a private field to a value using reflection * {@link ObfuscationReflectionHelper#setPrivateValue(Class, Object, String, Object)} * * @param instanceclass * @param instance * @param field * @param value */ public static void setPrivateValue(Class instanceclass, T instance, String field, E value) { ObfuscationReflectionHelper.setPrivateValue(instanceclass, instance, value, field); } /** * This method is a call in hook from modified external code. Implemented elsewhere. * {@link FMLClientHandler#onItemCrafted(EntityPlayer, ItemStack, IInventory)} * * @param player * @param item * @param matrix */ @Deprecated public static void takenFromCrafting(EntityPlayer player, ItemStack item, IInventory matrix) { } /** * This method is a call in hook from modified external code. Implemented elsewhere. * {@link FMLClientHandler#onItemSmelted(EntityPlayer, ItemStack)} * * @param player * @param item */ @Deprecated public static void takenFromFurnace(EntityPlayer player, ItemStack item) { } /** * Throw the offered exception. Likely will stop the game. * {@link FMLClientHandler#raiseException(Throwable, String, boolean)} * * @param message * @param e */ public static void throwException(String message, Throwable e) { FMLCommonHandler.instance().raiseException(e, message, true); } public static void throwException(Throwable e) { throwException("Exception in ModLoader", e); } }