Remove a bunch of warning about javadoc, not a real fix, but no more warning.

This commit is contained in:
LexManos committed 2012-09-15 18:04:56 -07:00
1 parent 3420ea7a2d
commit f24ff07b30
41 files changed
+103 -352

No files matched your search

@@ -66,8 +66,8 @@ import cpw.mods.fml.common.registry.LanguageRegistry;
/**
* Handles primary communication from hooked code into the system
*
* The FML entry point is {@link #beginMinecraftLoading(MinecraftServer)} called from
* {@link MinecraftServer}
* The FML entry point is {@link #beginMinecraftLoading(Minecraft)} called from
* {@link Minecraft}
*
* Obfuscated code should focus on this class and other members of the "server"
* (or "client") code
@@ -94,13 +94,6 @@ public class FMLClientHandler implements IFMLSidedHandler
*/
private Minecraft client;
/**
* Called to start the whole game off from
* {@link MinecraftServer#startServer}
*
* @param minecraftServer
*/
private DummyModContainer optifineContainer;
private boolean guiLoaded;
@@ -111,6 +104,12 @@ public class FMLClientHandler implements IFMLSidedHandler
private boolean loading;
/**
* Called to start the whole game off from
* {@link MinecraftServer#startServer}
*
* @param minecraftServer
*/
public void beginMinecraftLoading(Minecraft minecraft)
{
if (minecraft.func_71355_q())
@@ -201,8 +200,6 @@ public class FMLClientHandler implements IFMLSidedHandler
}
/**
* Get the server instance
*
* @return
*/
public Minecraft getClient()
{
@@ -397,7 +394,6 @@ public class FMLClientHandler implements IFMLSidedHandler
/**
* If the client is in the midst of loading, we disable saving so that custom settings aren't wiped out
* @return
*/
public boolean isLoading()
{
+1 -5
View File
@@ -46,7 +46,7 @@ public class GuiModList extends GuiScreen
private ArrayList<ModContainer> mods;
/**
* @param guiMainMenu
* @param mainMenu
*/
public GuiModList(GuiScreen mainMenu)
{
@@ -174,10 +174,6 @@ public class GuiModList extends GuiScreen
}
}
/**
* @param var1
* @return
*/
public boolean modIndexSelected(int var1)
{
return var1==selected;
@@ -130,10 +130,6 @@ public class SpriteHelper
return next;
}
/**
* @param textureToOverride
* @return
*/
public static int freeSlotCount(String textureToOverride)
{
return spriteInfo.get(textureToOverride).cardinality();
@@ -213,9 +213,6 @@ public class TextureFXManager
return textureDims.get(id);
}
/**
* @param anim
*/
public void addAnimation(TextureFX anim)
{
OverrideInfo info=new OverrideInfo();
@@ -229,9 +226,6 @@ public class TextureFXManager
}
/**
* @param p_6531_1_
*/
public void loadTextures(TexturePackBase texturePack)
{
registerTextureOverrides(client.field_71446_o);
@@ -263,16 +257,10 @@ public class TextureFXManager
}
}
/**
* @param mod
*/
protected void registerAnimatedTexturesFor(ModContainer mod)
{
}
/**
* @param field_6539_c
*/
public void onEarlyTexturePackLoad(TexturePackBase fallback)
{
if (client==null) {
@@ -313,11 +301,6 @@ public class TextureFXManager
FMLLog.fine("Overriding %s @ %d with %s. %d slots remaining",textureToOverride, location, overridingTexturePath, SpriteHelper.freeSlotCount(textureToOverride));
}
/**
* @param renderEngine
* @param path
* @return
*/
public BufferedImage loadImageFromTexturePack(RenderEngine renderEngine, String path) throws IOException
{
InputStream image=client.field_71418_C.func_77292_e().func_77532_a(path);
@@ -41,12 +41,6 @@ import cpw.mods.fml.common.registry.EntityRegistry.EntityRegistration;
public class ModLoaderClientHelper implements IModLoaderSidedHelper
{
/**
* @param mod
* @param inventoryRenderer
* @return
*/
public static int obtainBlockModelIdFor(BaseMod mod, boolean inventoryRenderer)
{
int renderId=RenderingRegistry.getNextAvailableRenderId();
@@ -40,9 +40,6 @@ public class ModLoaderKeyBindingHandler extends KeyBindingRegistry.KeyHandler
private boolean[] mlRepeats = new boolean[0];
private boolean[] armed = new boolean[0];
/**
* @param keyHandler
*/
public ModLoaderKeyBindingHandler()
{
super(new KeyBinding[0], new boolean[0]);
@@ -129,7 +129,7 @@ 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)
* @see #keyUp(EnumSet, KeyBinding, 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
@@ -139,7 +139,7 @@ public class KeyBindingRegistry
/**
* Fired once when the key changes state from down to up
*
* @see #keyDown(EnumSet, boolean, boolean)
* @see #keyDown(EnumSet, KeyBinding, 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
@@ -36,7 +36,6 @@ public class RenderingRegistry
* Add a new armour prefix to the RenderPlayer
*
* @param armor
* @return
*/
public static int addNewArmourRendererPrefix(String armor)
{
@@ -80,8 +79,6 @@ public class RenderingRegistry
}
/**
* Get the next available renderId from the block render ID list
*
* @return
*/
public static int getNextAvailableRenderId()
{
@@ -93,7 +90,6 @@ public class RenderingRegistry
*
* @param fileToOverride
* @param fileToAdd
* @return
*/
public static int addTextureOverride(String fileToOverride, String fileToAdd)
{
@@ -118,7 +114,6 @@ public class RenderingRegistry
* Get and reserve a unique texture index for the supplied path
*
* @param path
* @return
*/
public static int getUniqueTextureIndex(String path)
{
@@ -141,16 +136,6 @@ public class RenderingRegistry
private Render renderer;
}
/**
* @param renderer
* @param world
* @param x
* @param y
* @param z
* @param block
* @param modelId
* @return
*/
public boolean renderWorldBlock(RenderBlocks renderer, IBlockAccess world, int x, int y, int z, Block block, int modelId)
{
if (!blockRenderers.containsKey(modelId)) { return false; }
@@ -158,12 +143,6 @@ public class RenderingRegistry
return bri.renderWorldBlock(world, x, y, z, block, modelId, renderer);
}
/**
* @param renderer
* @param block
* @param metadata
* @param modelID
*/
public void renderInventoryBlock(RenderBlocks renderer, Block block, int metadata, int modelID)
{
if (!blockRenderers.containsKey(modelID)) { return; }
@@ -171,10 +150,6 @@ public class RenderingRegistry
bri.renderInventoryBlock(block, metadata, modelID, renderer);
}
/**
* @param p_1219_0_
* @return
*/
public boolean renderItemAsFull3DBlock(int modelId)
{
ISimpleBlockRenderingHandler bri = blockRenderers.get(modelId);
+4 -41
View File
@@ -51,23 +51,12 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
return true;
}
/**
* @param minecraftInstance
* @return
*//*
*//**
* @param renderers
*//*
/*
public final void onRenderHarvest(Map renderers)
{
addRenderer((Map<Class<? extends Entity>,Render>)renderers);
}
*//**
*
*//*
public final void onRegisterAnimations()
{
registerAnimation(FMLClientHandler.instance().getClient());
@@ -155,23 +144,20 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
generateNether(w, random, chunkX << 4, chunkZ << 4);
}
}
*//**
* NO-OP on client side
*//*
@Override
public final boolean handleCommand(String command, Object... data)
{
return false;
}
*/ // BASEMOD API
*/
// BASEMOD API
/**
* Override if you wish to provide a fuel item for the furnace and return the fuel value of the item
*
* @param id
* @param metadata
* @return
*/
public int addFuel(int id, int metadata)
{
@@ -193,7 +179,6 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
* @param xVel
* @param zVel
* @param item
* @return
*/
@Override
public int dispenseEntity(World world, ItemStack item, Random rnd, int x, int y, int z, int xVel, int zVel, double entX, double entY, double entZ)
@@ -232,7 +217,6 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
* @param x
* @param y
* @param z
* @return
*/
@SideOnly(CLIENT)
public GuiContainer getContainerGUI(EntityClientPlayerMP player, int containerID, int x, int y, int z)
@@ -242,8 +226,6 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
/**
* Return the name of your mod. Defaults to the class name
*
* @return
*/
public String getName()
{
@@ -252,8 +234,6 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
/**
* Get your mod priorities
*
* @return
*/
public String getPriorities()
{
@@ -262,8 +242,6 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
/**
* Return the version of your mod
*
* @return
*/
public abstract String getVersion();
@@ -328,7 +306,6 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
@Override
public void clientChat(String text)
{
// TODO
}
/**
@@ -339,7 +316,6 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
@Override
public void receiveCustomPacket(Packet250CustomPayload packet)
{
// TODO
}
@SideOnly(CLIENT)
@@ -408,10 +384,6 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
/**
* Called when a chat message is received. Return true to stop further processing
*
* @param source
* @param chat
* @return true if you want to consume the message so it is not available for further processing
*/
@Override
public void serverChat(NetServerHandler source, String message)
@@ -429,8 +401,6 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
/**
* Called when a client logs out of the server.
*
* @param player
*/
@Override
public void onClientLogout(NetworkManager mgr)
@@ -439,14 +409,7 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
}
/**
*
* Spawn the entity of the supplied type, if it is your mod's
* @param entityId
* @param world
* @param scaledX
* @param scaledY
* @param scaledZ
* @return
*/
@SideOnly(CLIENT)
public Entity spawnEntity(int entityId, World world, double scaledX, double scaledY, double scaledZ)
+61 -53
View File
@@ -45,22 +45,19 @@ import cpw.mods.fml.common.registry.GameRegistry;
import cpw.mods.fml.common.registry.LanguageRegistry;
import cpw.mods.fml.server.FMLServerHandler;
/**
* @author cpw
*
*/
public class ModLoader
{
public static final String fmlMarker = "This is an FML marker";
// TODO dirty workaround for millinaire
@Deprecated
public static final Map<String,Map<String,String>> localizedStrings=Collections.emptyMap();
/**
* Not used on the server.
* Adds localization info for an achievement, Not used on the server.
*
* @param achievement
* @param name
* @param description
* @param achievement The achievement to name
* @param name The name
* @param description The description
*/
public static void addAchievementDesc(Achievement achievement, String name, String description)
{
@@ -72,11 +69,11 @@ public class ModLoader
/**
* This method is a call in hook from modified external code. Implemented elsewhere.
*
* {@link FMLCommonHandler#fuelLookup(int, int)}
* {@link GameRegistry#getFuelValue(ItemStack))}
*
* @param id
* @param metadata
* @return
* @param id The Item ID
* @param metadata The Item Metadata
* @return The fuel strength, in ticks, 0 if unhandled
*/
@Deprecated
public static int addAllFuel(int id, int metadata)
@@ -97,9 +94,12 @@ public class ModLoader
}
/**
*
* @param armor
* @return
* Adds a new prefix to the armor texture list
*
* {@link RenderingRegistry#addNewArmourRendererPrefix(String))}
*
* @param armor The new armor prefix
* @return The new armor index
*/
@SideOnly(CLIENT)
public static int addArmor(String armor)
@@ -110,7 +110,7 @@ public class ModLoader
/**
* This method adds the supplied biome to the set of candidate biomes for the default world generator type.
*
* @param biome
* @param biome The biome to add
*/
public static void addBiome(BiomeGenBase biome)
{
@@ -129,8 +129,8 @@ public class ModLoader
/**
* Add localization for the specified string
*
* @param key
* @param value
* @param key Key
* @param value Value
*/
public static void addLocalization(String key, String value)
{
@@ -140,9 +140,9 @@ public class ModLoader
/**
* Add localization for the specified string
*
* @param key
* @param lang
* @param value
* @param key Key
* @param lang Language identifier
* @param value Value
*/
public static void addLocalization(String key, String lang, String value)
{
@@ -152,8 +152,8 @@ public class ModLoader
/**
* Name the specified minecraft object with the supplied name
*
* @param instance
* @param name
* @param instance Item to name
* @param name The name to give it
*/
public static void addName(Object instance, String name)
{
@@ -163,9 +163,9 @@ public class ModLoader
/**
* Unimplemented on the server as it does not generate names
*
* @param instance
* @param lang
* @param name
* @param instance Item to name
* @param lang Languge identifier
* @param name Name to give it
*/
public static void addName(Object instance, String lang, String name)
{
@@ -173,11 +173,18 @@ public class ModLoader
}
/**
* Attempts to register a small image to be applied to a larger texture image,
* typically how old ModLoader mods add custom Item/Block textures.
*
* Forge mods should use setTextureFile in Item/Block
*
* Will return the icon index it was applied to.
*
* Unimplemented on the server as it does not render textures
*
* @param fileToOverride
* @param fileToAdd
* @return
* @param fileToOverride The texture to apply the new image to
* @param fileToAdd The new image
* @return The 'icon index' in the main image that the new image will be applied to
*/
@SideOnly(CLIENT)
public static int addOverride(String fileToOverride, String fileToAdd)
@@ -186,11 +193,16 @@ public class ModLoader
}
/**
* Attempts to register a small image to be applied to a larger texture image,
* typically how old ModLoader mods add custom Item/Block textures.
*
* Forge mods should use setTextureFile in Item/Block
*
* Unimplemented on the server as it does not render textures
*
* @param path
* @param overlayPath
* @param index
* @param path The texture to apply the new image to
* @param overlayPath The new image
* @param index Where on the texture to apply it
*/
@SideOnly(CLIENT)
public static void addOverride(String path, String overlayPath, int index)
@@ -201,8 +213,8 @@ public class ModLoader
/**
* Add a Shaped Recipe
*
* @param output
* @param params
* @param output The result
* @param params The input
*/
public static void addRecipe(ItemStack output, Object... params)
{
@@ -212,8 +224,8 @@ public class ModLoader
/**
* Add a shapeless recipe
*
* @param output
* @param params
* @param output The result
* @param params The input
*/
public static void addShapelessRecipe(ItemStack output, Object... params)
{
@@ -322,7 +334,7 @@ public class ModLoader
* @param xVel
* @param zVel
* @param item
* @return
* @return Always false, not implemented here
*/
@Deprecated
public static boolean dispenseEntity(World world, double x, double y, double z, int xVel, int zVel, ItemStack item)
@@ -392,7 +404,7 @@ public class ModLoader
* Get a list of all BaseMod loaded into the system
* {@link ModLoaderModContainer#findAll}
*
* @return
* @return A list containing all loaded ModLoader mods
*/
public static List<BaseMod> getLoadedMods()
{
@@ -402,7 +414,7 @@ public class ModLoader
/**
* Get a logger instance {@link FMLCommonHandler#getFMLLogger()}
*
* @return
* @return The current logger
*/
public static Logger getLogger()
{
@@ -415,10 +427,6 @@ public class ModLoader
return FMLClientHandler.instance().getClient();
}
/**
*
* @return
*/
public static MinecraftServer getMinecraftServerInstance()
{
return FMLCommonHandler.instance().getMinecraftServerInstance();
@@ -431,7 +439,7 @@ public class ModLoader
* @param instanceclass
* @param instance
* @param fieldindex
* @return
* @return The value in the specified field.
*/
public static <T, E> T getPrivateValue(Class<? super E> instanceclass, E instance, int fieldindex)
{
@@ -440,12 +448,12 @@ public class ModLoader
/**
* Get a value from a field using reflection
* {@link ObfuscationReflectionHelper#getPrivateValue(Class, Object, String)}
* {@link ObfuscationReflectionHelper#getPrivateValue(Class, Object, String[])}
*
* @param instanceclass
* @param instance
* @param field
* @return
* @return The value in the specified field.
*/
public static <T, E> T getPrivateValue(Class<? super E> instanceclass, E instance, String field)
{
@@ -464,9 +472,9 @@ public class ModLoader
/**
* Get a new unique entity id
* {@link Entity#getNextId()}
* {@link EntityRegistry#findGlobalUniqueEntityId()}
*
* @return
* @return A unique entity ID
*/
public static int getUniqueEntityId()
{
@@ -485,7 +493,7 @@ public class ModLoader
*
* @param player
* @param channel
* @return
* @return If the channel is registered to the current connection.
*/
public static boolean isChannelActive(EntityPlayer player, String channel)
{
@@ -503,7 +511,7 @@ public class ModLoader
* {@link Loader#isModLoaded(String)}
*
* @param modname
* @return
* @return If the specified mod is loaded
*/
public static boolean isModLoaded(String modname)
{
@@ -555,7 +563,7 @@ public class ModLoader
/**
* This method is a call in hook from modified external code. Implemented elsewhere.
* {@link FMLServerHandler#handlePacket250(Packet250CustomPayload, EntityPlayer)}
* {@link FMLNetworkHandler#handlePacket250(Packet250CustomPayload, NetworkManager, NetHandler)}
*
* @param packet
*/
@@ -636,7 +644,7 @@ public class ModLoader
/**
* Register the mod for packets on this channel.
* {@link FMLCommonHandler#registerChannel(cpw.mods.fml.common.ModContainer, String)}
* {@link NetworkRegistry#registerChannel(IPacketHandler, String)}
*
* @param mod
* @param channel
@@ -759,7 +767,7 @@ public class ModLoader
}
/**
* Send a chat message to the server
* {@link FMLClientHandler#handleChatPacket(Packet3Chat, EntityPlayer)}
* {@link FMLNetworkHandler#handleChatMessage(NetHandler, Packet3Chat)}
*
* @param text
*/
@@ -138,7 +138,6 @@ public class FMLCommonHandler
/**
* Find the container that associates with the supplied mod object
* @param mod
* @return
*/
public ModContainer findContainerFor(Object mod)
{
@@ -153,16 +152,6 @@ public class FMLCommonHandler
return FMLLog.getLogger();
}
/**
* @param key
* @param lang
* @param value
*/
/**
* @param languagePack
* @param lang
*/
public Side getSide()
{
return sidedDelegate.getSide();
@@ -172,8 +161,6 @@ public class FMLCommonHandler
* Return the effective side for the context in the game. This is dependent
* on thread analysis to try and determine whether the code is running in the
* server or not. Use at your own risk
*
* @return
*/
public Side getEffectiveSide()
{
@@ -187,10 +174,6 @@ public class FMLCommonHandler
}
/**
* Raise an exception
*
* @param exception
* @param message
* @param stopGame
*/
public void raiseException(Throwable exception, String message, boolean stopGame)
{
@@ -229,10 +212,7 @@ public class FMLCommonHandler
return null;
}
}
/**
* @param string
* @return
*/
public void computeBranding()
{
if (brandings == null)
@@ -268,9 +248,6 @@ public class FMLCommonHandler
return ImmutableList.copyOf(brandings);
}
/**
* @return
*/
public IFMLSidedHandler getSidedDelegate()
{
return sidedDelegate;
@@ -29,15 +29,15 @@ public interface ICraftingHandler
* The object array contains these three arguments
*
* @param player
* @param craftedItem
* @param craftingGrid
* @param item
* @param craftMatrix
*/
void onCrafting(EntityPlayer player, ItemStack item, IInventory craftMatrix);
/**
* The object array contains these two arguments
* @param player
* @param smeltedItem
* @param item
*/
void onSmelting(EntityPlayer player, ItemStack item);
}
@@ -35,7 +35,6 @@ public interface IDispenseHandler
* @param entX
* @param entY
* @param entZ
* @return
*/
@Deprecated
int dispense(double x, double y, double z, int xVelocity, int zVelocity, World world, ItemStack item, Random random, double entX, double entY, double entZ);
@@ -24,7 +24,6 @@ public interface IDispenserHandler
* @param entX
* @param entY
* @param entZ
* @return
*/
int dispense(int x, int y, int z, int xVelocity, int zVelocity, World world, ItemStack item, Random random, double entX, double entY, double entZ);
}
@@ -6,8 +6,7 @@ public interface IScheduledTickHandler extends ITickHandler
* Return the number of actual ticks that will pass
* before your next tick will fire. This will be called
* just after your last tick fired to compute the next delay.
* @param tick
* @return
* @return Time until next tick
*/
public int nextTickSpacing();
}
@@ -51,14 +51,11 @@ public interface ITickHandler
/**
* Returns the list of ticks this tick handler is interested in receiving at the minute
*
* @return
*/
public EnumSet<TickType> ticks();
/**
* A profiling label for this tick handler
* @return
*/
public String getLabel();
}
@@ -19,8 +19,7 @@ import net.minecraft.src.IChunkProvider;
import net.minecraft.src.World;
/**
* This is called back during world generation. The {@link #generate(Random, int, int, Object...)} method passes in some additional data that
* can be cast into minecraft objects.
* This is called back during world generation.
*
* @author cpw
*
@@ -34,7 +33,7 @@ public interface IWorldGenerator
* @param chunkX the chunk X coordinate of this chunk.
* @param chunkZ the chunk Z coordinate of this chunk.
* @param world : additionalData[0] The minecraft {@link World} we're generating for.
* @param generator : additionalData[1] The {@link IChunkProvider} that is generating.
* @param chunkGenerator : additionalData[1] The {@link IChunkProvider} that is generating.
* @param chunkProvider : additionalData[2] {@link IChunkProvider} that is requesting the world generation.
*
*/
+2 -11
View File
@@ -424,7 +424,7 @@ public class Loader
/**
* Called from the hook to start mod loading. We trigger the
* {@link #identifyMods()} and {@link #preModInit()} phases here. Finally,
* {@link #identifyMods()} and Constructing, Preinitalization, and Initalization phases here. Finally,
* the mod list is frozen completely and is consider immutable from then on.
*/
public void loadMods()
@@ -512,16 +512,13 @@ public class Loader
* Query if we know of a mod named modname
*
* @param modname
* @return
* @return If the mod is loaded
*/
public static boolean isModLoaded(String modname)
{
return instance().namedMods.containsKey(modname) && instance().modController.getModState(instance.namedMods.get(modname))!=ModState.DISABLED;
}
/**
* @return
*/
public File getConfigDir()
{
return canonicalConfigDir;
@@ -540,17 +537,11 @@ public class Loader
return ret.toString();
}
/**
* @return
*/
public String getFMLVersionString()
{
return String.format("%s.%s.%s.%s", major, minor, rev, build);
}
/**
* @return
*/
public ClassLoader getModClassLoader()
{
return modClassLoader;
-11
View File
@@ -32,28 +32,23 @@ public @interface Mod
{
/**
* The unique mod identifier for this mod
* @return
*/
String modid();
/**
* A user friendly name for the mod
* @return
*/
String name() default "";
/**
* A version string for this mod
* @return
*/
String version() default "";
/**
* A simple dependency string for this mod (see modloader's "priorities" string specification)
* @return
*/
String dependencies() default "";
/**
* Whether to use the mcmod.info metadata by default for this mod.
* If true, settings in the mcmod.info file will override settings in these annotations.
* @return
*/
boolean useMetadata() default false;
@@ -115,7 +110,6 @@ public @interface Mod
public @interface Instance {
/**
* The mod object to inject into this field
* @return
*/
String value() default "";
}
@@ -129,7 +123,6 @@ public @interface Mod
public @interface Metadata {
/**
* The mod id specifying the metadata to load here
* @return
*/
String value() default "";
}
@@ -143,12 +136,10 @@ public @interface Mod
public @interface Block {
/**
* The block's name
* @return
*/
String name();
/**
* The associated ItemBlock subtype for the item (can be null for an ItemBlock)
* @return
*/
Class<?> itemTypeClass() default ItemBlock.class;
}
@@ -162,12 +153,10 @@ public @interface Mod
public @interface Item {
/**
* The name of the item
* @return
*/
String name();
/**
* The type of the item
* @return
*/
String typeClass();
}
@@ -38,66 +38,48 @@ public interface ModContainer
{
/**
* The globally unique modid for this mod
*
* @return
*/
String getModId();
/**
* A human readable name
*
* @return
*/
String getName();
/**
* A human readable version identifier
*
* @return
*/
String getVersion();
/**
* The location on the file system which this mod came from
*
* @return
*/
File getSource();
/**
* The metadata for this mod
*
* @return
*/
ModMetadata getMetadata();
/**
* Attach this mod to it's metadata from the supplied metadata collection
*
* @param mc
*/
void bindMetadata(MetadataCollection mc);
/**
* Set the enabled/disabled state of this mod
*
* @param enabled
*/
void setEnabledState(boolean enabled);
/**
* A list of the modids that this mod requires loaded prior to loading
*
* @return
*/
Set<ArtifactVersion> getRequirements();
/**
* A list of modids that should be loaded prior to this one. The special
* value <strong>*</strong> indicates to load <em>before</em> any other mod.
*
* @return
*/
List<ArtifactVersion> getDependencies();
@@ -105,16 +87,12 @@ public interface ModContainer
* A list of modids that should be loaded <em>after</em> this one. The
* special value <strong>*</strong> indicates to load <em>after</em> any
* other mod.
*
* @return
*/
List<ArtifactVersion> getDependants();
/**
* A representative string encapsulating the sorting preferences for this
* mod
*
* @return
*/
String getSortingRules();
@@ -126,7 +104,6 @@ public interface ModContainer
*
* @param bus
* @param controller
* @return
*/
boolean registerBus(EventBus bus, LoadController controller);
@@ -134,14 +111,11 @@ public interface ModContainer
* Does this mod match the supplied mod
*
* @param mod
* @return
*/
boolean matches(Object mod);
/**
* Get the actual mod object
*
* @return
*/
Object getMod();
+1 -10
View File
@@ -91,10 +91,6 @@ public class ModMetadata
public List<ArtifactVersion> dependants;
public boolean autogenerated;
/**
* @param mod2
* @param type2
*/
public ModMetadata(JsonNode node)
{
Map<JsonStringNode, Object> processedFields = Maps.transformValues(node.getFields(), new JsonStringConverter());
@@ -145,9 +141,7 @@ public class ModMetadata
}
return res;
}
/**
* @return
*/
public String getChildModCountString()
{
return String.format("%d child mod%s", childMods.size(), childMods.size() != 1 ? "s" : "");
@@ -158,9 +152,6 @@ public class ModMetadata
return Joiner.on(", ").join(authorList);
}
/**
* @return
*/
public String getChildModList()
{
return Joiner.on(", ").join(Lists.transform(childMods, new ModNameFunction()));
+2 -2
View File
@@ -18,7 +18,7 @@ public enum Side {
CLIENT, SERVER, BUKKIT;
/**
* @return
* @return If this is the server environment
*/
public boolean isServer()
{
@@ -26,7 +26,7 @@ public enum Side {
}
/**
* @return
* @return if this is the Client environment
*/
public boolean isClient()
{
@@ -29,13 +29,11 @@ public @interface SidedProxy
{
/**
* The name of the client side class to load and populate
* @return
*/
String clientSide() default "";
/**
* The name of the server side class to load and populate
* @return
*/
String serverSide() default "";
-2
View File
@@ -69,8 +69,6 @@ public enum TickType {
/**
* Partner ticks that are also cancelled by returning false from onTickInGame
*
* @return
*/
public EnumSet<TickType> partnerTicks()
{
@@ -40,29 +40,14 @@ import cpw.mods.fml.common.asm.SideOnly;
*/
public interface BaseModProxy
{
/**
*
*/
void modsLoaded();
/**
*
*/
void load();
/**
* @return
*/
String getName();
/**
* @return
*/
String getPriorities();
/**
* @return
*/
String getVersion();
boolean doTickInGUI(TickType type, boolean end, Object... tickData);
@@ -122,9 +122,6 @@ public class BaseModTicker implements ITickHandler
return mod.getClass().getSimpleName();
}
/**
* @param mod2
*/
public void setMod(BaseModProxy mod)
{
this.mod = mod;
@@ -357,7 +357,6 @@ public class ModLoaderModContainer implements ModContainer
/**
* Find all the BaseMods in the system
* @param <A>
* @return
*/
public static <A extends BaseModProxy> List<A> findAll(Class<A> clazz)
{
@@ -426,16 +425,11 @@ public class ModLoaderModContainer implements ModContainer
return mod.getVersion();
}
/**
* @return
*/
public BaseModTicker getGameTickHandler()
{
return this.gameTickHandler;
}
/**
* @return
*/
public BaseModTicker getGUITickHandler()
{
return this.guiTickHandler;
@@ -41,30 +41,22 @@ public class ModProperty
{
this(field, (String)annotationInfo.get("info"), (Double)annotationInfo.get("min"), (Double)annotationInfo.get("max"), (String)annotationInfo.get("name"));
}
/**
* @return
*/
public String name()
{
return name;
}
/**
* @return
*/
public double min()
{
return min;
}
/**
* @return
*/
public double max()
{
return max;
}
/**
* @return
*/
public String info()
{
return info;
@@ -18,7 +18,6 @@ public interface IChatListener
*
* @param handler
* @param message
* @return
*/
public Packet3Chat clientChat(NetHandler handler, Packet3Chat message);
}
@@ -27,7 +27,6 @@ public interface IConnectionHandler
*
* @param netHandler
* @param manager
* @return
*/
String connectionReceived(NetLoginHandler netHandler, NetworkManager manager);
@@ -73,7 +73,7 @@ public class ModListRequestPacket extends FMLPacket
* This packet is executed on the client to evaluate the server's mod list against
* the client
*
* @see cpw.mods.fml.common.network.FMLPacket#execute()
* @see cpw.mods.fml.common.network.FMLPacket#execute(NetworkManager, FMLNetworkHandler, NetHandler, String)
*/
@Override
public void execute(NetworkManager mgr, FMLNetworkHandler handler, NetHandler netHandler, String userName)
@@ -13,25 +13,19 @@ public @interface NetworkMod
{
/**
* Does this mod require the client side to be present when installed on a server?
*
* @return
*/
boolean clientSideRequired() default false;
/**
* Does this mod require the server side to be present when installed on a client?
* @return
*/
boolean serverSideRequired() default false;
/**
* A list of Packet250 network channels to register for this mod - these channels
* will be universal and will require a universal packethandler to handle them
*
* @return
*/
String[] channels() default {};
/**
* An optional range check for client to server communication version compatibility
* @return
*/
String versionBounds() default "";
@@ -39,34 +33,25 @@ public @interface NetworkMod
* A packet handler implementation for channels registered through this annotation
* - this packet handler will be universal and handle both client and server
* requests.
*
* @return
*/
Class<? extends IPacketHandler> packetHandler() default NULL.class;
/**
* A tiny packet handler implementation based on {@link Packet131MapData} for "small"
* data packet loads.
*
* @return
*/
Class<? extends ITinyPacketHandler> tinyPacketHandler() default NULL.class;
/**
* A connection handler implementation for this network mod
*
* @return
*/
Class<? extends IConnectionHandler> connectionHandler() default NULL.class;
/**
* A packet handler and channels to register for the client side
*
* @return
*/
SidedPacketHandler clientPacketHandlerSpec() default @SidedPacketHandler(channels = {}, packetHandler = NULL.class );
/**
* A packet handler and channels to register for the server side
* @return
*/
SidedPacketHandler serverPacketHandlerSpec() default @SidedPacketHandler(channels = {}, packetHandler = NULL.class );
@@ -80,7 +80,6 @@ public class NetworkRegistry
* Is the specified channel active for the player?
* @param channel
* @param player
* @return
*/
public boolean isChannelActive(String channel, Player player)
{
@@ -267,10 +266,7 @@ public class NetworkRegistry
deactivateChannel(player, channel);
}
}
/**
* @param packet
* @return
*/
private List<String> extractChannelList(Packet250CustomPayload packet)
{
String request = new String(packet.field_73629_c, Charsets.UTF_8);
@@ -363,7 +363,6 @@ public class EntityRegistry
* @param updateRange
* @param updateInterval
* @param sendVelocityInfo
* @return
*/
@Deprecated
public static EntityRegistration registerModLoaderEntity(Object mod, Class<? extends Entity> entityClass, int entityTypeId, int updateRange, int updateInterval,
@@ -118,7 +118,6 @@ public class GameRegistry
* @param xVelocity
* @param zVelocity
* @param item
* @return
*/
public static int tryDispense(World world, int x, int y, int z, int xVelocity, int zVelocity, ItemStack item, Random random, double entX, double entY, double entZ)
{
@@ -137,7 +136,6 @@ public class GameRegistry
* @param container
* @param type
* @param annotation
* @return
* @throws Exception
*/
public static Object buildBlock(ModContainer container, Class<?> type, Block annotation) throws Exception
@@ -50,13 +50,11 @@ public class VillagerRegistry
*
* @param random
* @param i
* @return
*/
StructureVillagePieceWeight getVillagePieceWeight(Random random, int i);
/**
* The class of the root structure component to add to the village
* @return
*/
Class<?> getComponentClass();
@@ -72,7 +70,6 @@ public class VillagerRegistry
* @param p3
* @param p4
* @param p5
* @return
*/
Object buildComponent(StructureVillagePieceWeight villagePiece, ComponentVillageStartPiece startPiece, List pieces, Random random, int p1,
int p2, int p3, int p4, int p5);
@@ -92,7 +89,6 @@ public class VillagerRegistry
*
* @param villager
* @param recipeList
* @param random
*/
void manipulateTradesForVillager(EntityVillager villager, MerchantRecipeList recipeList, Random random);
}
@@ -145,7 +141,6 @@ public class VillagerRegistry
*
* @param villagerType
* @param defaultSkin
* @return
*/
public static String getVillagerSkin(int villagerType, String defaultSkin)
{
@@ -125,7 +125,7 @@ public class TopologicalSort
*
* Uses the reverse depth first search as outlined in ...
* @param graph
* @return
* @return The sorted mods list.
*/
public static <T> List<T> topologicalSort(DirectedGraph<T> graph)
{
@@ -18,12 +18,12 @@ public interface IFMLLoadingPlugin
/**
* Return a list of classes that implement the ILibrarySet interface
*
* @return
* @return a list of classes that implement the ILibrarySet interface
*/
String[] getLibraryRequestClass();
/**
* Return a list of classes that implements the IClassTransformer interface
* @return
* @return a list of classes that implements the IClassTransformer interface
*/
String[] getASMTransformerClass();
@@ -12,19 +12,19 @@ public interface ILibrarySet
/**
* Return a list of libraries available from a common location
*
* @return
* @return a list of libraries available from a common location
*/
String[] getLibraries();
/**
* Return the string encoded sha1 hash for each library in the returned list
*
* @return
* @return the string encoded sha1 hash for each library in the returned list
*/
String[] getHashes();
/**
* Return the root URL format string from which this library set can be obtained
* There needs to be a single %s string substitution which is the library name
* @return
* @return the root URL format string from which this library set can be obtained
*/
String getRootURL();
}
@@ -126,11 +126,6 @@ public class RelaunchClassLoader extends URLClassLoader
}
}
/**
* @param name
* @return
* @throws IOException
*/
public byte[] getClassBytes(String name) throws IOException
{
InputStream classStream = null;
@@ -35,8 +35,8 @@ import cpw.mods.fml.common.registry.LanguageRegistry;
/**
* Handles primary communication from hooked code into the system
*
* The FML entry point is {@link #onPreLoad(MinecraftServer)} called from
* {@link MinecraftServer}
* The FML entry point is {@link #beginServerLoading(MinecraftServer)} called from
* {@link DedicatedServer}
*
* Obfuscated code should focus on this class and other members of the "server"
* (or "client") code
@@ -97,8 +97,6 @@ public class FMLServerHandler implements IFMLSidedHandler
/**
* Get the server instance
*
* @return
*/
public MinecraftServer getServer()
{