diff --git a/src/main/java/net/minecraftforge/client/event/GuiScreenEvent.java b/src/main/java/net/minecraftforge/client/event/GuiScreenEvent.java index 1017218a2..31aebe70a 100644 --- a/src/main/java/net/minecraftforge/client/event/GuiScreenEvent.java +++ b/src/main/java/net/minecraftforge/client/event/GuiScreenEvent.java @@ -3,6 +3,8 @@ package net.minecraftforge.client.event; import java.util.ArrayList; import java.util.List; +import net.minecraft.client.Minecraft; +import net.minecraft.client.renderer.InventoryEffectRenderer; import org.lwjgl.input.Mouse; import net.minecraft.client.gui.GuiButton; @@ -48,7 +50,7 @@ public class GuiScreenEvent extends Event } /** - * The {@code buttonList} field from the GuiScreen object referenced by {@code gui}. + * The {@link #buttonList} field from the GuiScreen object referenced by {@link #gui}. */ public List getButtonList() { @@ -61,11 +63,10 @@ public class GuiScreenEvent extends Event } /** - * This event fires just after initializing {@code GuiScreen.mc}, {@code GuiScreen.fontRendererObj}, - * {@code GuiScreen.width}, and {@code GuiScreen.height}, and just before calling {@code GuiScreen.buttonList.clear()} - * and {@code GuiScreen.initGui()}. To skip or override a screen's initGui() method cancel the event.

+ * This event fires just after initializing {@link GuiScreen#mc}, {@link GuiScreen#fontRendererObj}, + * {@link GuiScreen#width}, and {@link GuiScreen#height}.

* - * If canceled the following lines are skipped in {@code GuiScreen.setWorldAndResolution()}:
+ * If canceled the following lines are skipped in {@link GuiScreen#setWorldAndResolution(Minecraft, int, int)}:
* {@code this.buttonList.clear();}
* {@code this.initGui();}
*/ @@ -79,7 +80,7 @@ public class GuiScreenEvent extends Event } /** - * This event fires right after {@code GuiScreen.initGui()}. + * This event fires right after {@link GuiScreen#initGui()}. * This is a good place to alter a GuiScreen's component layout if desired. */ public static class Post extends InitGuiEvent @@ -130,8 +131,8 @@ public class GuiScreenEvent extends Event } /** - * This event fires just before {@code GuiScreen.drawScreen()} is called. - * Cancel this event to skip {@code GuiScreen.drawScreen()}. + * This event fires just before {@link GuiScreen#drawScreen(int, int, float)} is called. + * Cancel this event to skip {@link GuiScreen#drawScreen(int, int, float)}. */ @Cancelable public static class Pre extends DrawScreenEvent @@ -143,7 +144,7 @@ public class GuiScreenEvent extends Event } /** - * This event fires just after {@code GuiScreen.drawScreen()} is called. + * This event fires just after {@link GuiScreen#drawScreen(int, int, float)} is called. */ public static class Post extends DrawScreenEvent { @@ -155,7 +156,7 @@ public class GuiScreenEvent extends Event } /** - * This event fires at the end of {@code GuiScreen.drawDefaultBackground()} and before the rest of the Gui draws. + * This event fires at the end of {@link GuiScreen#drawDefaultBackground()} and before the rest of the Gui draws. * This allows drawing next to Guis, above the background but below any tooltips. */ public static class BackgroundDrawnEvent extends GuiScreenEvent @@ -191,7 +192,7 @@ public class GuiScreenEvent extends Event } /** - * This event fires in {@code InventoryEffectRenderer.updateActivePotionEffects()} + * This event fires in {@link InventoryEffectRenderer#updateActivePotionEffects()} * when potion effects are active and the gui wants to move over. * Cancel this event to prevent the Gui from being moved. */ @@ -230,7 +231,7 @@ public class GuiScreenEvent extends Event } /** - * A COPY of the {@code buttonList} field from the GuiScreen referenced by {@code gui}. + * A COPY of the {@link #buttonList} field from the GuiScreen referenced by {@link #gui}. */ public List getButtonList() { @@ -244,7 +245,7 @@ public class GuiScreenEvent extends Event /** * This event fires once it has been determined that a GuiButton object has been clicked. - * Cancel this event to bypass {@code GuiScreen.actionPerformed()}. + * Cancel this event to bypass {@link GuiScreen#actionPerformed(GuiButton)}. * Replace button with a different button from buttonList to have that button's action executed. */ @Cancelable @@ -257,8 +258,8 @@ public class GuiScreenEvent extends Event } /** - * This event fires after {@code GuiScreen.actionPerformed()} provided that the active - * screen has not been changed as a result of {@code GuiScreen.actionPerformed()}. + * This event fires after {@link GuiScreen#actionPerformed(GuiButton)} provided that the active + * screen has not been changed as a result of {@link GuiScreen#actionPerformed(GuiButton)}. */ public static class Post extends ActionPerformedEvent { @@ -278,7 +279,7 @@ public class GuiScreenEvent extends Event /** * This event fires when mouse input is detected by a GuiScreen. - * Cancel this event to bypass {@code GuiScreen.handleMouseInput()}. + * Cancel this event to bypass {@link GuiScreen#handleMouseInput()}. */ @Cancelable public static class Pre extends MouseInputEvent @@ -290,8 +291,8 @@ public class GuiScreenEvent extends Event } /** - * This event fires after {@code GuiScreen.handleMouseInput()} provided that the active - * screen has not been changed as a result of {@code GuiScreen.handleMouseInput()}. + * This event fires after {@link GuiScreen#handleMouseInput()} provided that the active + * screen has not been changed as a result of {@link GuiScreen#handleMouseInput()}. */ public static class Post extends MouseInputEvent { @@ -311,7 +312,7 @@ public class GuiScreenEvent extends Event /** * This event fires when keyboard input is detected by a GuiScreen. - * Cancel this event to bypass {@code GuiScreen.handleKeyboardInput()}. + * Cancel this event to bypass {@link GuiScreen#handleKeyboardInput()}. */ @Cancelable public static class Pre extends KeyboardInputEvent @@ -323,8 +324,8 @@ public class GuiScreenEvent extends Event } /** - * This event fires after {@code GuiScreen.handleKeyboardInput()} provided that the active - * screen has not been changed as a result of {@code GuiScreen.handleKeyboardInput()}. + * This event fires after {@link GuiScreen#handleKeyboardInput()} provided that the active + * screen has not been changed as a result of {@link GuiScreen#handleKeyboardInput()}. */ public static class Post extends KeyboardInputEvent { diff --git a/src/main/java/net/minecraftforge/common/BiomeDictionary.java b/src/main/java/net/minecraftforge/common/BiomeDictionary.java index 3b535e9e7..1f7241c2e 100644 --- a/src/main/java/net/minecraftforge/common/BiomeDictionary.java +++ b/src/main/java/net/minecraftforge/common/BiomeDictionary.java @@ -140,7 +140,7 @@ public class BiomeDictionary * Registers a biome with a specific biome type * * @param biome the biome to be registered - * @param type the type to register the biome as + * @param types the types to register the biome as * @return returns true if the biome was registered successfully */ public static boolean registerBiomeType(BiomeGenBase biome, Type ... types) diff --git a/src/main/java/net/minecraftforge/common/EnumPlantType.java b/src/main/java/net/minecraftforge/common/EnumPlantType.java index 648d3dcff..f7f4520bc 100644 --- a/src/main/java/net/minecraftforge/common/EnumPlantType.java +++ b/src/main/java/net/minecraftforge/common/EnumPlantType.java @@ -1,5 +1,9 @@ package net.minecraftforge.common; +import net.minecraft.block.state.IBlockState; +import net.minecraft.util.EnumFacing; +import net.minecraft.util.math.BlockPos; +import net.minecraft.world.IBlockAccess; import net.minecraftforge.common.util.EnumHelper; public enum EnumPlantType @@ -14,16 +18,16 @@ public enum EnumPlantType /** * Getting a custom {@link EnumPlantType}, or an existing one if it has the same name as that one. Your plant should implement {@link IPlantable} - * and return this custom type in {@link IPlantable#getPlantType(net.minecraft.world.IBlockAccess, net.minecraft.util.BlockPos)}. + * and return this custom type in {@link IPlantable#getPlantType(IBlockAccess, BlockPos)}. * *

If your new plant grows on blocks like any one of them above, never create a new {@link EnumPlantType}. * This enumeration is only functioning in - * {@link net.minecraft.block.Block#canSustainPlant(net.minecraft.world.IBlockAccess, net.minecraft.util.BlockPos, net.minecraft.util.EnumFacing, IPlantable)}, + * {@link net.minecraft.block.Block#canSustainPlant(IBlockState, IBlockAccess, BlockPos, EnumFacing, IPlantable)}, * which you are supposed to override this function in your new block and create a new plant type to grow on that block. * *

You can create an instance of your plant type in your API and let your/others mods access it. It will be faster than calling this method. * @param name the name of the type of plant, you had better follow the style above - * @return the acquired {@EnumPlantType}, a new one if not found. + * @return the acquired {@link EnumPlantType}, a new one if not found. */ public static EnumPlantType getPlantType(String name) { diff --git a/src/main/java/net/minecraftforge/common/capabilities/Capability.java b/src/main/java/net/minecraftforge/common/capabilities/Capability.java index 0e3a0fb5c..e71337ca6 100644 --- a/src/main/java/net/minecraftforge/common/capabilities/Capability.java +++ b/src/main/java/net/minecraftforge/common/capabilities/Capability.java @@ -55,7 +55,7 @@ public class Capability * @param capability The Capability being stored. * @param instance An instance of that capabilities interface. * @param side The side of the object the instance is associated with. - * @param A NBT holding the data. Must not be null, as doesn't make sense to call this function with nothing to read... + * @param nbt A NBT holding the data. Must not be null, as doesn't make sense to call this function with nothing to read... */ void readNBT(Capability capability, T instance, EnumFacing side, NBTBase nbt); } diff --git a/src/main/java/net/minecraftforge/common/capabilities/CapabilityManager.java b/src/main/java/net/minecraftforge/common/capabilities/CapabilityManager.java index 9c9f08ade..d131b7656 100644 --- a/src/main/java/net/minecraftforge/common/capabilities/CapabilityManager.java +++ b/src/main/java/net/minecraftforge/common/capabilities/CapabilityManager.java @@ -60,7 +60,7 @@ public enum CapabilityManager * * @param type The Interface to be registered * @param storage A default implementation of the storage handler. - * @param factor A Factory that will produce new instances of the default implementation. + * @param factory A Factory that will produce new instances of the default implementation. */ public void register(Class type, Capability.IStorage storage, Callable factory) { diff --git a/src/main/java/net/minecraftforge/common/config/Configuration.java b/src/main/java/net/minecraftforge/common/config/Configuration.java index 13c34e06c..96451e674 100644 --- a/src/main/java/net/minecraftforge/common/config/Configuration.java +++ b/src/main/java/net/minecraftforge/common/config/Configuration.java @@ -36,7 +36,10 @@ import java.util.regex.Pattern; import com.google.common.base.CharMatcher; import com.google.common.collect.ImmutableSet; +import net.minecraftforge.fml.client.config.GuiConfig; +import net.minecraftforge.fml.client.config.GuiConfigEntries; import net.minecraftforge.fml.client.config.GuiConfigEntries.IConfigEntry; +import net.minecraftforge.fml.client.config.IConfigElement; import net.minecraftforge.fml.common.FMLLog; import net.minecraftforge.fml.common.Loader; import net.minecraftforge.fml.relauncher.FMLInjectionData; @@ -1215,9 +1218,15 @@ public class Configuration /** * Sets the custom IConfigEntry class that should be used in place of the standard entry class (which is just a button that - * navigates into the category). This class MUST provide a constructor with the following parameter types: {@code GuiConfig} (the parent - * GuiConfig screen will be provided), {@code GuiPropertyList} (the parent GuiPropertyList will be provided), {@code IConfigElement} + * navigates into the category). This class MUST provide a constructor with the following parameter types: {@link GuiConfig} (the parent + * GuiConfig screen will be provided), {@link GuiConfigEntries} (the parent GuiConfigEntries will be provided), {@link IConfigElement} * (the IConfigElement for this Property will be provided). + * + * @see GuiConfigEntries.ListEntryBase + * @see GuiConfigEntries.StringEntry + * @see GuiConfigEntries.BooleanEntry + * @see GuiConfigEntries.DoubleEntry + * @see GuiConfigEntries.IntegerEntry */ public Configuration setCategoryConfigEntryClass(String category, Class clazz) { @@ -1561,7 +1570,7 @@ public class Configuration * * @param name Name of the property. * @param category Category of the property. - * @param defaultValue Default value of the property. + * @param defaultValues Default values of the property. * @param comment A brief description what the property does. * @return The value of the new string property. */ diff --git a/src/main/java/net/minecraftforge/common/config/Property.java b/src/main/java/net/minecraftforge/common/config/Property.java index d42bbad48..eea18f496 100644 --- a/src/main/java/net/minecraftforge/common/config/Property.java +++ b/src/main/java/net/minecraftforge/common/config/Property.java @@ -9,8 +9,13 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.regex.Pattern; +import net.minecraftforge.fml.client.config.GuiConfig; +import net.minecraftforge.fml.client.config.GuiConfigEntries; import net.minecraftforge.fml.client.config.GuiConfigEntries.IConfigEntry; +import net.minecraftforge.fml.client.config.GuiEditArray; +import net.minecraftforge.fml.client.config.GuiEditArrayEntries; import net.minecraftforge.fml.client.config.GuiEditArrayEntries.IArrayEntry; +import net.minecraftforge.fml.client.config.IConfigElement; public class Property { @@ -383,9 +388,15 @@ public class Property /** * Sets a custom IConfigEntry class that should be used in place of the standard entry class for this Property type. This class - * MUST provide a constructor with the following parameter types: {@code GuiConfig} (the owning GuiConfig screen will be provided), - * {@code GuiConfigEntries} (the owning GuiConfigEntries will be provided), {@code IConfigElement} (the IConfigElement for this Property + * MUST provide a constructor with the following parameter types: {@link GuiConfig} (the owning GuiConfig screen will be provided), + * {@link GuiConfigEntries} (the owning GuiConfigEntries will be provided), {@link IConfigElement} (the IConfigElement for this Property * will be provided). + * + * @see GuiConfigEntries.ListEntryBase + * @see GuiConfigEntries.StringEntry + * @see GuiConfigEntries.BooleanEntry + * @see GuiConfigEntries.DoubleEntry + * @see GuiConfigEntries.IntegerEntry */ public Property setConfigEntryClass(Class clazz) { @@ -406,11 +417,15 @@ public class Property /** * Sets a custom IGuiEditListEntry class that should be used in place of the standard entry class for this Property type. This class - * MUST provide a constructor with the following parameter types: {@code GuiEditList} (the owning GuiEditList screen will be provided), - * {@code GuiPropertyList} (the parent GuiPropertyList will be provided), {@code IConfigProperty} (the IConfigProperty for this Property - * will be provided). + * MUST provide a constructor with the following parameter types: {@link GuiEditArray} (the owning GuiEditArray screen will be provided), + * {@link GuiEditArrayEntries} (the parent GuiEditArrayEntries will be provided), {@link IConfigElement} (the IConfigElement for this Property + * will be provided), and {@link Object} for the property's value. * - * @param clazz a class that implements IConfigEntry + * @see GuiEditArrayEntries.BaseEntry + * @see GuiEditArrayEntries.StringEntry + * @see GuiEditArrayEntries.BooleanEntry + * @see GuiEditArrayEntries.DoubleEntry + * @see GuiEditArrayEntries.IntegerEntry */ public Property setArrayEntryClass(Class clazz) { @@ -855,7 +870,6 @@ public class Property /** * Returns the value in this property as a double, if the value is not a valid double, it will return the provided default. * - * @param _default The default to provide if the current value is not a valid double * @return The value */ public double getDouble() diff --git a/src/main/java/net/minecraftforge/event/CommandEvent.java b/src/main/java/net/minecraftforge/event/CommandEvent.java index 58f294308..f44c9747d 100644 --- a/src/main/java/net/minecraftforge/event/CommandEvent.java +++ b/src/main/java/net/minecraftforge/event/CommandEvent.java @@ -1,5 +1,8 @@ package net.minecraftforge.event; +import net.minecraft.command.CommandHandler; +import net.minecraftforge.client.ClientCommandHandler; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraft.command.ICommand; @@ -7,8 +10,8 @@ import net.minecraft.command.ICommandSender; /** * CommandEvent is fired whenever a command is scheduled to be executed. - * This event is fired during the invocation of CommandHandler#executeCommand(ICommandSender, String) - * and ClientCommandHandler#executeCommand(ICommandSender, String).
+ * This event is fired during the invocation of {@link CommandHandler#executeCommand(ICommandSender, String)} + * and {@link ClientCommandHandler#executeCommand(ICommandSender, String)}.
*
* {@link #command} contains the instance of ICommand which is representative of the currently executing command.
* {@link #sender} contains the instance of ICommandSender for the given command sender.
diff --git a/src/main/java/net/minecraftforge/event/ServerChatEvent.java b/src/main/java/net/minecraftforge/event/ServerChatEvent.java index af326955c..748c9980a 100644 --- a/src/main/java/net/minecraftforge/event/ServerChatEvent.java +++ b/src/main/java/net/minecraftforge/event/ServerChatEvent.java @@ -1,5 +1,8 @@ package net.minecraftforge.event; +import net.minecraft.network.NetHandlerPlayServer; +import net.minecraft.network.play.client.CPacketChatMessage; +import net.minecraftforge.common.ForgeHooks; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraft.entity.player.EntityPlayerMP; @@ -7,8 +10,8 @@ import net.minecraft.util.text.ITextComponent; /** * ServerChatEvent is fired whenever a C01PacketChatMessage is processed.
- * This event is fired via {@link ForgeHooks#onServerChatEvent(net.minecraft.network.NetHandlerPlayServer, String, ChatComponentTranslation)}, - * which is executed by the NetHandlerPlayServer#processChatMessage(net.minecraft.network.play.client.C01PacketChatMessage)
+ * This event is fired via {@link ForgeHooks#onServerChatEvent(NetHandlerPlayServer, String, ITextComponent)}, + * which is executed by the {@link NetHandlerPlayServer#processChatMessage(CPacketChatMessage)}
*
* {@link #username} contains the username of the player sending the chat message.
* {@link #message} contains the message being sent.
diff --git a/src/main/java/net/minecraftforge/event/brewing/PotionBrewEvent.java b/src/main/java/net/minecraftforge/event/brewing/PotionBrewEvent.java index b3c194d80..97a7d497f 100644 --- a/src/main/java/net/minecraftforge/event/brewing/PotionBrewEvent.java +++ b/src/main/java/net/minecraftforge/event/brewing/PotionBrewEvent.java @@ -1,6 +1,8 @@ package net.minecraftforge.event.brewing; import net.minecraft.item.ItemStack; +import net.minecraft.tileentity.TileEntityBrewingStand; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraftforge.fml.common.eventhandler.Event.HasResult; @@ -38,9 +40,9 @@ public class PotionBrewEvent extends Event * PotionBrewEvent.Pre is fired before vanilla brewing takes place. * All changes made to the event's array will be made to the TileEntity if the event is canceled. *
- * The event is fired during the TileEntityBrewingStand#brewPotions() method invocation.
+ * The event is fired during the {@link TileEntityBrewingStand#brewPotions()} method invocation.
*
- * {@link #brewingStacks} contains the itemstack array from the TileEntityBrewer holding all items in Brewer.
+ * {@link #stacks} contains the itemstack array from the TileEntityBrewer holding all items in Brewer.
*
* This event is {@link Cancelable}.
* If the event is not canceled, the vanilla brewing will take place instead of modded brewing. @@ -63,9 +65,9 @@ public class PotionBrewEvent extends Event /** * PotionBrewEvent.Post is fired when a potion is brewed in the brewing stand. *
- * The event is fired during the TileEntityBrewingStand#brewPotions() method invocation.
+ * The event is fired during the {@link TileEntityBrewingStand#brewPotions()} method invocation.
*
- * {@link #brewingStacks} contains the itemstack array from the TileEntityBrewer holding all items in Brewer.
+ * {@link #stacks} contains the itemstack array from the TileEntityBrewer holding all items in Brewer.
*
* This event is not {@link Cancelable}.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/EntityEvent.java b/src/main/java/net/minecraftforge/event/entity/EntityEvent.java index 462de61a3..50f82f98c 100644 --- a/src/main/java/net/minecraftforge/event/entity/EntityEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/EntityEvent.java @@ -1,5 +1,9 @@ package net.minecraftforge.event.entity; +import net.minecraft.world.World; +import net.minecraft.world.chunk.Chunk; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraft.entity.Entity; @@ -47,7 +51,7 @@ public class EntityEvent extends Event /** * CanUpdate is fired when an Entity is being created.
* This event is fired whenever vanilla Minecraft determines that an entity
- * cannot update in World#updateEntityWithOptionalForce(net.minecraft.entity.Entity, boolean)
+ * cannot update in {@link World#updateEntityWithOptionalForce(net.minecraft.entity.Entity, boolean)}
*
* {@link CanUpdate#canUpdate} contains the boolean value of whether this entity can update.
* If the modder decides that this Entity can be updated, they may change canUpdate to true,
@@ -79,7 +83,7 @@ public class EntityEvent extends Event /** * EnteringChunk is fired when an Entity enters a chunk.
* This event is fired whenever vanilla Minecraft determines that an entity
- * is entering a chunk in Chunk#addEntity(net.minecraft.entity.Entity)
+ * is entering a chunk in {@link Chunk#addEntity(net.minecraft.entity.Entity)}
*
* This event is not {@link Cancelable}.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/EntityJoinWorldEvent.java b/src/main/java/net/minecraftforge/event/entity/EntityJoinWorldEvent.java index a7ac55244..a768ed28e 100644 --- a/src/main/java/net/minecraftforge/event/entity/EntityJoinWorldEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/EntityJoinWorldEvent.java @@ -1,13 +1,17 @@ package net.minecraftforge.event.entity; +import net.minecraft.world.WorldServer; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.entity.Entity; import net.minecraft.world.World; +import java.util.Collection; + /** * EntityJoinWorldEvent is fired when an Entity joins the world.
* This event is fired whenever an Entity is added to the world in - * World#addLoadedEntities(java.util.List), World#joinEntityInSurroundings(Entity), and World#spawnEntityInWorld(Entity).
+ * {@link World#loadEntities(Collection)}, {@link WorldServer#loadEntities(Collection)} {@link World#joinEntityInSurroundings(Entity)}, and {@link World#spawnEntityInWorld(Entity)}.
*
* {@link #world} contains the world in which the entity is to join.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/EntityMountEvent.java b/src/main/java/net/minecraftforge/event/entity/EntityMountEvent.java index 921917eb6..dcf4b3899 100644 --- a/src/main/java/net/minecraftforge/event/entity/EntityMountEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/EntityMountEvent.java @@ -2,6 +2,7 @@ package net.minecraftforge.event.entity; import net.minecraft.entity.Entity; import net.minecraft.world.World; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event.HasResult; diff --git a/src/main/java/net/minecraftforge/event/entity/EntityStruckByLightningEvent.java b/src/main/java/net/minecraftforge/event/entity/EntityStruckByLightningEvent.java index 24e3cc2f1..2c66c1380 100644 --- a/src/main/java/net/minecraftforge/event/entity/EntityStruckByLightningEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/EntityStruckByLightningEvent.java @@ -1,5 +1,7 @@ package net.minecraftforge.event.entity; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.event.ForgeEventFactory; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.entity.Entity; import net.minecraft.entity.effect.EntityLightningBolt; @@ -7,7 +9,7 @@ import net.minecraft.entity.effect.EntityLightningBolt; /** * EntityStruckByLightningEvent is fired when an Entity is about to be struck by lightening.
* This event is fired whenever an EntityLightningBolt is updated to strike an Entity in - * EntityLightningBolt#onUpdate() via {@link ForgeEventFactory#onEntityStruckByLightning(Entity, EntityLightningBolt)}.
+ * {@link EntityLightningBolt#onUpdate()} via {@link ForgeEventFactory#onEntityStruckByLightning(Entity, EntityLightningBolt)}.
*
* {@link #lightning} contains the instance of EntityLightningBolt attempting to strike an entity.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/EntityTravelToDimensionEvent.java b/src/main/java/net/minecraftforge/event/entity/EntityTravelToDimensionEvent.java index ebfc21a15..89fe4f916 100644 --- a/src/main/java/net/minecraftforge/event/entity/EntityTravelToDimensionEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/EntityTravelToDimensionEvent.java @@ -1,6 +1,7 @@ package net.minecraftforge.event.entity; import net.minecraft.entity.Entity; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event.HasResult; diff --git a/src/main/java/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.java b/src/main/java/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.java index 7ca05f304..c48946b05 100644 --- a/src/main/java/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.java @@ -1,5 +1,10 @@ package net.minecraftforge.event.entity; +import net.minecraft.client.entity.EntityPlayerSP; +import net.minecraft.entity.player.EntityPlayer; +import net.minecraft.util.math.BlockPos; +import net.minecraft.world.World; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.entity.Entity; import net.minecraft.util.SoundCategory; @@ -8,8 +13,7 @@ import net.minecraft.util.SoundEvent; /** * PlaySoundAtEntityEvent is fired a sound is to be played at an Entity
* This event is fired whenever a sound is set to be played at an Entity such as in - * EntityPlayerSP#playSound(String, float, float), World#playSoundAtEntity(Entity, String, float, float), - * and World#playerSoundToNearExcept(EntityPlayer, String, float, float).
+ * {@link EntityPlayerSP#playSound(SoundEvent, float, float)} and {@link World#playSound(EntityPlayer, double, double, double, SoundEvent, SoundCategory, float, float)}.
*
* {@link #name} contains the name of the sound to be played at the Entity.
* {@link #volume} contains the volume at which the sound is to be played originally.
diff --git a/src/main/java/net/minecraftforge/event/entity/living/LivingAttackEvent.java b/src/main/java/net/minecraftforge/event/entity/living/LivingAttackEvent.java index ec99b75a6..660d002fb 100644 --- a/src/main/java/net/minecraftforge/event/entity/living/LivingAttackEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/living/LivingAttackEvent.java @@ -1,5 +1,8 @@ package net.minecraftforge.event.entity.living; +import net.minecraft.entity.player.EntityPlayer; +import net.minecraftforge.common.ForgeHooks; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.util.DamageSource; import net.minecraft.entity.EntityLivingBase; @@ -7,8 +10,8 @@ import net.minecraft.entity.EntityLivingBase; /** * LivingAttackEvent is fired when a living Entity is attacked.
* This event is fired whenever an Entity is attacked in - * EntityLivingBase#attackEntityFrom(DamageSource, float) and - * EntityPlayer#attackEntityFrom(DamageSource, float).
+ * {@link EntityLivingBase#attackEntityFrom(DamageSource, float)} and + * {@link EntityPlayer#attackEntityFrom(DamageSource, float)}.
*
* This event is fired via the {@link ForgeHooks#onLivingAttack(EntityLivingBase, DamageSource, float)}.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/living/LivingDeathEvent.java b/src/main/java/net/minecraftforge/event/entity/living/LivingDeathEvent.java index 328737479..818aed711 100644 --- a/src/main/java/net/minecraftforge/event/entity/living/LivingDeathEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/living/LivingDeathEvent.java @@ -1,5 +1,9 @@ package net.minecraftforge.event.entity.living; +import net.minecraft.entity.player.EntityPlayer; +import net.minecraft.entity.player.EntityPlayerMP; +import net.minecraftforge.common.ForgeHooks; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.util.DamageSource; import net.minecraft.entity.EntityLivingBase; @@ -7,9 +11,9 @@ import net.minecraft.entity.EntityLivingBase; /** * LivingDeathEvent is fired when an Entity dies.
* This event is fired whenever an Entity dies in - * EntityLivingBase#onDeath(DamageSource), - * EntityPlayer#onDeath(DamageSource), and - * EntityPlayerMP#onDeath(DamageSource).
+ * {@link EntityLivingBase#onDeath(DamageSource)}, + * {@link EntityPlayer#onDeath(DamageSource)}, and + * {@link EntityPlayerMP#onDeath(DamageSource)}.
*
* This event is fired via the {@link ForgeHooks#onLivingDeath(EntityLivingBase, DamageSource)}.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/living/LivingDropsEvent.java b/src/main/java/net/minecraftforge/event/entity/living/LivingDropsEvent.java index 4f2a82a29..fd923b847 100644 --- a/src/main/java/net/minecraftforge/event/entity/living/LivingDropsEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/living/LivingDropsEvent.java @@ -1,7 +1,10 @@ package net.minecraftforge.event.entity.living; +import java.util.ArrayList; import java.util.List; +import net.minecraftforge.common.ForgeHooks; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.util.DamageSource; import net.minecraft.entity.item.EntityItem; @@ -10,9 +13,9 @@ import net.minecraft.entity.EntityLivingBase; /** * LivingDropsEvent is fired when an Entity's death causes dropped items to appear.
* This event is fired whenever an Entity dies and drops items in - * EntityLivingBase#onDeath(DamageSource).
+ * {@link EntityLivingBase#onDeath(DamageSource)}.
*
- * This event is fired via the {@link ForgeHooks#onLivingDrops(EntityLivingBase, DamageSource, ArrayList, int, boolean, int)}.
+ * This event is fired via the {@link ForgeHooks#onLivingDrops(EntityLivingBase, DamageSource, ArrayList, int, boolean)}.
*
* {@link #source} contains the DamageSource that caused the drop to occur.
* {@link #drops} contains the ArrayList of EntityItems that will be dropped.
diff --git a/src/main/java/net/minecraftforge/event/entity/living/LivingEvent.java b/src/main/java/net/minecraftforge/event/entity/living/LivingEvent.java index 0f899e639..0021bff20 100644 --- a/src/main/java/net/minecraftforge/event/entity/living/LivingEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/living/LivingEvent.java @@ -1,7 +1,12 @@ package net.minecraftforge.event.entity.living; import net.minecraftforge.fml.common.eventhandler.Cancelable; +import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraft.entity.EntityLivingBase; +import net.minecraft.entity.monster.EntityMagmaCube; +import net.minecraft.entity.passive.EntityHorse; +import net.minecraftforge.common.ForgeHooks; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.event.entity.EntityEvent; /** @@ -28,7 +33,7 @@ public class LivingEvent extends EntityEvent /** * LivingUpdateEvent is fired when an Entity is updated.
* This event is fired whenever an Entity is updated in - * EntityLivingBase#onUpdate().
+ * {@link EntityLivingBase#onUpdate()}.
*
* This event is fired via the {@link ForgeHooks#onLivingUpdate(EntityLivingBase)}.
*
@@ -48,8 +53,8 @@ public class LivingEvent extends EntityEvent /** * LivingJumpEvent is fired when an Entity jumps.
* This event is fired whenever an Entity jumps in - * EntityLivingBase#jump(), EntityMagmaCube#jump(), - * and EntityHorse#jump().
+ * {@link EntityLivingBase#jump()}, {@link EntityMagmaCube#jump()}, + * and {@link EntityHorse#jump()}.
*
* This event is fired via the {@link ForgeHooks#onLivingJump(EntityLivingBase)}.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/living/LivingFallEvent.java b/src/main/java/net/minecraftforge/event/entity/living/LivingFallEvent.java index 0cc1d0e82..4307ae70a 100644 --- a/src/main/java/net/minecraftforge/event/entity/living/LivingFallEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/living/LivingFallEvent.java @@ -1,14 +1,16 @@ package net.minecraftforge.event.entity.living; +import net.minecraftforge.common.ForgeHooks; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.entity.EntityLivingBase; /** * LivingFallEvent is fired when an Entity is set to be falling.
* This event is fired whenever an Entity is set to fall in - * EntityLivingBase#fall(float).
+ * {@link EntityLivingBase#fall(float, float)}.
*
- * This event is fired via the {@link ForgeHooks#onLivingFall(EntityLivingBase, float)}.
+ * This event is fired via the {@link ForgeHooks#onLivingFall(EntityLivingBase, float, float)}.
*
* {@link #distance} contains the distance the Entity is to fall. If this event is canceled, this value is set to 0.0F. *
diff --git a/src/main/java/net/minecraftforge/event/entity/living/LivingHealEvent.java b/src/main/java/net/minecraftforge/event/entity/living/LivingHealEvent.java index 04be4cc15..834b15ea2 100644 --- a/src/main/java/net/minecraftforge/event/entity/living/LivingHealEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/living/LivingHealEvent.java @@ -1,13 +1,15 @@ package net.minecraftforge.event.entity.living; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.event.ForgeEventFactory; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.entity.EntityLivingBase; /** * LivingHealEvent is fired when an Entity is set to be healed.
- * This event is fired whenever an Entity is healed in EntityLivingBase#heal(float)
+ * This event is fired whenever an Entity is healed in {@link EntityLivingBase#heal(float)}
*
- * This event is fired via the {@link ForgeHooks#onLivingHeal(EntityLivingBase, float)}.
+ * This event is fired via the {@link ForgeEventFactory#onLivingHeal(EntityLivingBase, float)}.
*
* {@link #amount} contains the amount of healing done to the Entity that was healed.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/living/LivingHurtEvent.java b/src/main/java/net/minecraftforge/event/entity/living/LivingHurtEvent.java index 0c17934cf..22815378c 100644 --- a/src/main/java/net/minecraftforge/event/entity/living/LivingHurtEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/living/LivingHurtEvent.java @@ -1,5 +1,8 @@ package net.minecraftforge.event.entity.living; +import net.minecraft.entity.player.EntityPlayer; +import net.minecraftforge.common.ForgeHooks; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.util.DamageSource; import net.minecraft.entity.EntityLivingBase; @@ -7,8 +10,8 @@ import net.minecraft.entity.EntityLivingBase; /** * LivingHurtEvent is fired when an Entity is set to be hurt.
* This event is fired whenever an Entity is hurt in - * EntityLivingBase#damageEntity(DamageSource, float) and - * EntityPlayer#damageEntity(DamageSource, float).
+ * {@link EntityLivingBase#damageEntity(DamageSource, float)} and + * {@link EntityPlayer#damageEntity(DamageSource, float)}.
*
* This event is fired via the {@link ForgeHooks#onLivingHurt(EntityLivingBase, DamageSource, float)}.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/living/LivingSetAttackTargetEvent.java b/src/main/java/net/minecraftforge/event/entity/living/LivingSetAttackTargetEvent.java index ef1a29458..cb5baf26a 100644 --- a/src/main/java/net/minecraftforge/event/entity/living/LivingSetAttackTargetEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/living/LivingSetAttackTargetEvent.java @@ -1,12 +1,16 @@ package net.minecraftforge.event.entity.living; +import net.minecraft.entity.EntityLiving; import net.minecraft.entity.EntityLivingBase; +import net.minecraftforge.common.ForgeHooks; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; /** * LivingSetAttackTargetEvent is fired when an Entity sets a target to attack.
* This event is fired whenever an Entity sets a target to attack in - * EntityLiving#setAttackTarget(EntityLivingBase) and - * EntityLivingBase#setRevengeTarget(EntityLivingBase).
+ * {@link EntityLiving#setAttackTarget(EntityLivingBase)} and + * {@link EntityLivingBase#setRevengeTarget(EntityLivingBase)}.
*
* This event is fired via the {@link ForgeHooks#onLivingSetAttackTarget(EntityLivingBase, EntityLivingBase)}.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/living/LivingSpawnEvent.java b/src/main/java/net/minecraftforge/event/entity/living/LivingSpawnEvent.java index 6a538b21b..3cd35d043 100644 --- a/src/main/java/net/minecraftforge/event/entity/living/LivingSpawnEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/living/LivingSpawnEvent.java @@ -1,7 +1,11 @@ package net.minecraftforge.event.entity.living; +import net.minecraft.world.WorldEntitySpawner; +import net.minecraft.world.WorldServer; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.event.ForgeEventFactory; import net.minecraftforge.fml.common.eventhandler.Cancelable; -import net.minecraftforge.fml.common.eventhandler.Event.HasResult; +import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraft.entity.EntityLiving; import net.minecraft.world.World; @@ -58,9 +62,9 @@ public class LivingSpawnEvent extends LivingEvent /** * SpecialSpawn is fired when an Entity is to be spawned from a mob spawner.
* This event is fired whenever an Entity is spawned in a mob spawner in
- * SpawnerAnimals#findChunksForSpawning(WorldServer, boolean, boolean, boolean).
+ * {@link WorldEntitySpawner#findChunksForSpawning(WorldServer, boolean, boolean, boolean)}.
*
- * This event is fired via the {@link ForgeHooks#doSpecialSpawn(EntityLiving, World, float, float, float)}.
+ * This event is fired via the {@link ForgeEventFactory#doSpecialSpawn(EntityLiving, World, float, float, float)}.
*
* This event is {@link Cancelable}.
* If this event is canceled, the Entity is not spawned.
diff --git a/src/main/java/net/minecraftforge/event/entity/living/ZombieEvent.java b/src/main/java/net/minecraftforge/event/entity/living/ZombieEvent.java index f5d2ec9b7..19e2b9982 100644 --- a/src/main/java/net/minecraftforge/event/entity/living/ZombieEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/living/ZombieEvent.java @@ -2,8 +2,14 @@ package net.minecraftforge.event.entity.living; import net.minecraft.entity.EntityLivingBase; import net.minecraft.entity.monster.EntityZombie; +import net.minecraft.util.DamageSource; import net.minecraft.world.World; +import net.minecraftforge.common.ForgeHooks; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.event.ForgeEventFactory; import net.minecraftforge.event.entity.EntityEvent; +import net.minecraftforge.fml.common.eventhandler.Cancelable; +import net.minecraftforge.fml.common.eventhandler.Event; /** * ZombieEvent is fired whenever a zombie is spawned for aid. @@ -27,9 +33,9 @@ public class ZombieEvent extends EntityEvent { /** * SummonAidEvent is fired when a Zombie Entity is summoned. * This event is fired whenever a Zombie Entity is summoned in - * EntityZombie#attackEntityFrom(DamageSource, float). + * {@link EntityZombie#attackEntityFrom(DamageSource, float)}. * - * This event is fired via the {@link ForgeHooks#fireZombieSummonAid(EntityZombie, World, int, int, int, EntityLivingBase, double)}. + * This event is fired via the {@link ForgeEventFactory#fireZombieSummonAid(EntityZombie, World, int, int, int, EntityLivingBase, double)}. * * {@link #customSummonedAid} remains null, but can be populated with a custom EntityZombie which will be spawned. * {@link #world} contains the world that this summoning is occurring in. diff --git a/src/main/java/net/minecraftforge/event/entity/minecart/MinecartCollisionEvent.java b/src/main/java/net/minecraftforge/event/entity/minecart/MinecartCollisionEvent.java index 94664fe11..4c6156954 100644 --- a/src/main/java/net/minecraftforge/event/entity/minecart/MinecartCollisionEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/minecart/MinecartCollisionEvent.java @@ -2,11 +2,13 @@ package net.minecraftforge.event.entity.minecart; import net.minecraft.entity.Entity; import net.minecraft.entity.item.EntityMinecart; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; /** * MinecartCollisionEvent is fired when a minecart collides with an Entity. * This event is fired whenever a minecraft collides in - * EntityMinecart#applyEntityCollision(Entity). + * {@link EntityMinecart#applyEntityCollision(Entity)}. * * {@link #collider} contains the Entity the Minecart collided with. * diff --git a/src/main/java/net/minecraftforge/event/entity/minecart/MinecartEvent.java b/src/main/java/net/minecraftforge/event/entity/minecart/MinecartEvent.java index 0479a067c..af0643540 100644 --- a/src/main/java/net/minecraftforge/event/entity/minecart/MinecartEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/minecart/MinecartEvent.java @@ -1,7 +1,9 @@ package net.minecraftforge.event.entity.minecart; import net.minecraft.entity.item.EntityMinecart; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.event.entity.EntityEvent; +import net.minecraftforge.fml.common.eventhandler.Event; /** * MinecartEvent is fired whenever an event involving minecart entities occurs.
diff --git a/src/main/java/net/minecraftforge/event/entity/minecart/MinecartInteractEvent.java b/src/main/java/net/minecraftforge/event/entity/minecart/MinecartInteractEvent.java index 819cb7823..6f6884789 100644 --- a/src/main/java/net/minecraftforge/event/entity/minecart/MinecartInteractEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/minecart/MinecartInteractEvent.java @@ -1,5 +1,10 @@ package net.minecraftforge.event.entity.minecart; +import net.minecraft.entity.item.EntityMinecartContainer; +import net.minecraft.entity.item.EntityMinecartEmpty; +import net.minecraft.entity.item.EntityMinecartFurnace; +import net.minecraft.entity.item.EntityMinecartHopper; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.entity.item.EntityMinecart; import net.minecraft.entity.player.EntityPlayer; @@ -9,10 +14,11 @@ import net.minecraft.util.EnumHand; /** * MinecartInteractEvent is fired when a player interacts with a minecart.
* This event is fired whenever a player interacts with a minecart in - * EntityMinecartContainer#interactFirst(EntityPlayer), - * EntityMinecartEmpty#interactFirst(EntityPlayer) - * EntityMinecartFurnace#interactFirst(EntityPlayer) - * EntityMinecartHopper#interactFirst(EntityPlayer).
+ * {@link EntityMinecartContainer#processInitialInteract(EntityPlayer, ItemStack, EnumHand)}, + * {@link EntityMinecartEmpty#processInitialInteract(EntityPlayer, ItemStack, EnumHand)}, + * {@link EntityMinecartFurnace#processInitialInteract(EntityPlayer, ItemStack, EnumHand)}, + * {@link EntityMinecartHopper#processInitialInteract(EntityPlayer, ItemStack, EnumHand)}, + * etc.
*
* {@link #player} contains the EntityPlayer that is involved with this minecart interaction.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/minecart/MinecartUpdateEvent.java b/src/main/java/net/minecraftforge/event/entity/minecart/MinecartUpdateEvent.java index 6ba3f4bdf..a59bbde9e 100644 --- a/src/main/java/net/minecraftforge/event/entity/minecart/MinecartUpdateEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/minecart/MinecartUpdateEvent.java @@ -2,11 +2,13 @@ package net.minecraftforge.event.entity.minecart; import net.minecraft.entity.item.EntityMinecart; import net.minecraft.util.math.BlockPos; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; /** * MinecartUpdateEvent is fired when a minecart is updated.
* This event is fired whenever a minecart is updated in - * EntityMinecart#onUpdate().
+ * {@link EntityMinecart#onUpdate()}.
*
* {@link #pos} contains the coordinate of the track the entity is on {if applicable}.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/player/ArrowLooseEvent.java b/src/main/java/net/minecraftforge/event/entity/player/ArrowLooseEvent.java index 6250e3d7a..6b750bec7 100644 --- a/src/main/java/net/minecraftforge/event/entity/player/ArrowLooseEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/player/ArrowLooseEvent.java @@ -1,5 +1,8 @@ package net.minecraftforge.event.entity.player; +import net.minecraft.entity.EntityLivingBase; +import net.minecraft.item.ItemBow; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.entity.player.EntityPlayer; import net.minecraft.item.ItemStack; @@ -8,7 +11,7 @@ import net.minecraft.world.World; /** * ArrowLooseEvent is fired when a player stops using a bow.
* This event is fired whenever a player stops using a bow in - * ItemBow#onPlayerStoppedUsing(ItemStack, World, EntityPlayer, int).
+ * {@link ItemBow#onPlayerStoppedUsing(ItemStack, World, EntityLivingBase, int)}.
*
* {@link #bow} contains the ItemBow ItemStack that was used in this event.
* {@link #charge} contains the value for how much the player had charged before stopping the shot.
diff --git a/src/main/java/net/minecraftforge/event/entity/player/ArrowNockEvent.java b/src/main/java/net/minecraftforge/event/entity/player/ArrowNockEvent.java index 888f0e3db..e0fdd7c1f 100644 --- a/src/main/java/net/minecraftforge/event/entity/player/ArrowNockEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/player/ArrowNockEvent.java @@ -1,15 +1,17 @@ package net.minecraftforge.event.entity.player; import net.minecraft.entity.player.EntityPlayer; +import net.minecraft.item.ItemBow; import net.minecraft.item.ItemStack; import net.minecraft.util.ActionResult; import net.minecraft.util.EnumHand; import net.minecraft.world.World; +import net.minecraftforge.common.MinecraftForge; /** * ArrowNockEvent is fired when a player begins using a bow.
* This event is fired whenever a player begins using a bow in - * ItemBow#onItemRightClick(ItemStack, World, EntityPlayer).
+ * {@link ItemBow#onItemRightClick(ItemStack, World, EntityPlayer, EnumHand)}.
*
* This event is fired on the {@link MinecraftForge#EVENT_BUS}. **/ diff --git a/src/main/java/net/minecraftforge/event/entity/player/AttackEntityEvent.java b/src/main/java/net/minecraftforge/event/entity/player/AttackEntityEvent.java index f81f10cd7..de5584d90 100644 --- a/src/main/java/net/minecraftforge/event/entity/player/AttackEntityEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/player/AttackEntityEvent.java @@ -1,5 +1,6 @@ package net.minecraftforge.event.entity.player; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.entity.Entity; import net.minecraft.entity.player.EntityPlayer; @@ -7,7 +8,7 @@ import net.minecraft.entity.player.EntityPlayer; /** * AttackEntityEvent is fired when a player attacks an Entity.
* This event is fired whenever a player attacks an Entity in - * EntityPlayer#attackTargetEntityWithCurrentItem(Entity).
+ * {@link EntityPlayer#attackTargetEntityWithCurrentItem(Entity)}.
*
* {@link #target} contains the Entity that was damaged by the player.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/player/PlayerDestroyItemEvent.java b/src/main/java/net/minecraftforge/event/entity/player/PlayerDestroyItemEvent.java index 35d2d3357..ac1ed2432 100644 --- a/src/main/java/net/minecraftforge/event/entity/player/PlayerDestroyItemEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/player/PlayerDestroyItemEvent.java @@ -1,5 +1,19 @@ package net.minecraftforge.event.entity.player; +import net.minecraft.client.entity.EntityPlayerSP; +import net.minecraft.client.multiplayer.PlayerControllerMP; +import net.minecraft.client.multiplayer.WorldClient; +import net.minecraft.network.NetHandlerPlayServer; +import net.minecraft.network.play.client.CPacketPlayerBlockPlacement; +import net.minecraft.network.play.client.CPacketPlayerTryUseItem; +import net.minecraft.server.management.PlayerInteractionManager; +import net.minecraft.util.EnumFacing; +import net.minecraft.util.math.BlockPos; +import net.minecraft.util.math.Vec3d; +import net.minecraft.world.World; +import net.minecraftforge.common.ForgeHooks; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.event.ForgeEventFactory; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.entity.player.EntityPlayer; import net.minecraft.item.ItemStack; @@ -8,12 +22,13 @@ import net.minecraft.util.EnumHand; /** * PlayerDestroyItemEvent is fired when a player destroys an item.
* This event is fired whenever a player destroys an item in - * PlayerControllerMP#onPlayerRightClick(EntityPlayer, World, ItemStack, int, int, int, int, Vec3), - * PlayerControllerMP#sendUseItem(EntityPlayer, World, ItemStack), - * EntityPlayer#destroyCurrentEquippedItem(), - * SlotCrafting#onPickupFromSlot(EntityPlayer, ItemStack), - * ItemInWorldManager#tryUseItem(EntityPlayer, World, ItemStack), - * and ItemInWorldManager#activateBlockOrUseItem(EntityPlayer, World, ItemStack, int, int, int, int, float, float, float).
+ * {@link PlayerControllerMP#processRightClick(EntityPlayer, World, ItemStack, EnumHand)}, + * {@link PlayerControllerMP#processRightClickBlock(EntityPlayerSP, WorldClient, ItemStack, BlockPos, EnumFacing, Vec3d, EnumHand)}, + * {@link EntityPlayer#damageShield(float)}, + * {@link ForgeHooks#getContainerItem(ItemStack)}, + * {@link PlayerInteractionManager#processRightClick(EntityPlayer, World, ItemStack, EnumHand)}, + * {@link NetHandlerPlayServer#processPlayerBlockPlacement(CPacketPlayerBlockPlacement)} + * and {@link NetHandlerPlayServer#processRightClickBlock(CPacketPlayerTryUseItem)}.
*
* {@link #original} contains the original ItemStack before the item was destroyed.
* (@link #hand) contains the hand that the current item was held in.
@@ -22,6 +37,7 @@ import net.minecraft.util.EnumHand; *
* This event does not have a result. {@link HasResult}
*
+ * This event is fired from {@link ForgeEventFactory#onPlayerDestroyItem(EntityPlayer, ItemStack, EnumHand)}.
* This event is fired on the {@link MinecraftForge#EVENT_BUS}. **/ public class PlayerDestroyItemEvent extends PlayerEvent diff --git a/src/main/java/net/minecraftforge/event/entity/player/PlayerEvent.java b/src/main/java/net/minecraftforge/event/entity/player/PlayerEvent.java index 864242dd9..1d7c70b08 100644 --- a/src/main/java/net/minecraftforge/event/entity/player/PlayerEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/player/PlayerEvent.java @@ -1,6 +1,9 @@ package net.minecraftforge.event.entity.player; import java.io.File; + +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.event.ForgeEventFactory; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraft.block.Block; import net.minecraft.block.state.IBlockState; @@ -8,6 +11,7 @@ import net.minecraft.entity.Entity; import net.minecraft.entity.player.EntityPlayer; import net.minecraft.util.math.BlockPos; import net.minecraftforge.event.entity.living.LivingEvent; +import net.minecraftforge.fml.common.eventhandler.Event; /** * PlayerEvent is fired whenever an event involving Living entities occurs.
@@ -33,11 +37,11 @@ public class PlayerEvent extends LivingEvent /** * HarvestCheck is fired when a player attempts to harvest a block.
* This event is fired whenever a player attempts to harvest a block in - * EntityPlayer#canHarvestBlock(Block).
+ * {@link EntityPlayer#canHarvestBlock(IBlockState)}.
*
- * This event is fired via the {@link ForgeEventFactory#doPlayerHarvestCheck(EntityPlayer, Block, boolean)}.
+ * This event is fired via the {@link ForgeEventFactory#doPlayerHarvestCheck(EntityPlayer, IBlockState, boolean)}.
*
- * {@link #block} contains the Block that is being checked for harvesting.
+ * {@link #state} contains the {@link IBlockState} that is being checked for harvesting.
* {@link #success} contains the boolean value for whether the Block will be successfully harvested.
*
* This event is not {@link Cancelable}.
@@ -66,7 +70,7 @@ public class PlayerEvent extends LivingEvent /** * BreakSpeed is fired when a player attempts to harvest a block.
* This event is fired whenever a player attempts to harvest a block in - * EntityPlayer#canHarvestBlock(Block).
+ * {@link EntityPlayer#canHarvestBlock(IBlockState)}.
*
* This event is fired via the {@link ForgeEventFactory#getBreakSpeed(EntityPlayer, IBlockState, float, BlockPos)}.
*
@@ -109,7 +113,7 @@ public class PlayerEvent extends LivingEvent /** * NameFormat is fired when a player's display name is retrieved.
* This event is fired whenever a player's name is retrieved in - * EntityPlayer#getDisplayName() or EntityPlayer#refreshDisplayName().
+ * {@link EntityPlayer#getDisplayName()} or {@link EntityPlayer#refreshDisplayName()}.
*
* This event is fired via the {@link ForgeEventFactory#getPlayerDisplayName(EntityPlayer, String)}.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/player/PlayerSleepInBedEvent.java b/src/main/java/net/minecraftforge/event/entity/player/PlayerSleepInBedEvent.java index 29aa31a4a..8da4b0518 100644 --- a/src/main/java/net/minecraftforge/event/entity/player/PlayerSleepInBedEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/player/PlayerSleepInBedEvent.java @@ -3,12 +3,14 @@ package net.minecraftforge.event.entity.player; import net.minecraft.entity.player.EntityPlayer; import net.minecraft.entity.player.EntityPlayer.EnumStatus; import net.minecraft.util.math.BlockPos; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; /** * PlayerSleepInBedEvent is fired when a player sleeps in a bed. *
* This event is fired whenever a player sleeps in a bed in - * EntityPlayer#sleepInBedAt(BlockPos).
+ * {@link EntityPlayer#trySleep(BlockPos)}.
*
* {@link #result} contains whether the player is able to sleep.
*
diff --git a/src/main/java/net/minecraftforge/event/entity/player/SleepingLocationCheckEvent.java b/src/main/java/net/minecraftforge/event/entity/player/SleepingLocationCheckEvent.java index 148a5f276..7f6f2f697 100644 --- a/src/main/java/net/minecraftforge/event/entity/player/SleepingLocationCheckEvent.java +++ b/src/main/java/net/minecraftforge/event/entity/player/SleepingLocationCheckEvent.java @@ -1,7 +1,11 @@ package net.minecraftforge.event.entity.player; +import net.minecraft.block.Block; +import net.minecraft.block.state.IBlockState; +import net.minecraft.entity.Entity; import net.minecraft.entity.player.EntityPlayer; import net.minecraft.util.math.BlockPos; +import net.minecraft.world.IBlockAccess; import net.minecraftforge.fml.common.eventhandler.Event.HasResult; /** @@ -11,7 +15,7 @@ import net.minecraftforge.fml.common.eventhandler.Event.HasResult; * This event has a result. {@link HasResult}
* * setResult(ALLOW) informs game that player is still "in bed"
- * setResult(DEFAULT) causes game to check {@link net.minecraft.block.Block#isBed(net.minecraft.world.IBlockAccess, BlockPos, net.minecraft.entity.Entity)} instead + * setResult(DEFAULT) causes game to check {@link Block#isBed(IBlockState, IBlockAccess, BlockPos, Entity)} instead */ @HasResult public class SleepingLocationCheckEvent extends PlayerEvent diff --git a/src/main/java/net/minecraftforge/event/terraingen/BiomeEvent.java b/src/main/java/net/minecraftforge/event/terraingen/BiomeEvent.java index acf68c04a..a4d330270 100644 --- a/src/main/java/net/minecraftforge/event/terraingen/BiomeEvent.java +++ b/src/main/java/net/minecraftforge/event/terraingen/BiomeEvent.java @@ -1,5 +1,7 @@ package net.minecraftforge.event.terraingen; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraft.block.state.IBlockState; import net.minecraft.world.biome.BiomeDecorator; @@ -29,7 +31,7 @@ public class BiomeEvent extends Event /** * CreateDecorator is fired when a BiomeDecorator is created.
* This event is fired whenever a BiomeDecorator is created in - * DeferredBiomeDecorator#fireCreateEventAndReplace(BiomeGenBase).
+ * {@link DeferredBiomeDecorator#fireCreateEventAndReplace(BiomeGenBase)}.
*
* {@link #originalBiomeDecorator} contains the original BiomeDecorator that would be used in vanilla. * {@link #newBiomeDecorator} contains the new BiomeDecoration to be used by Minecraft. diff --git a/src/main/java/net/minecraftforge/event/terraingen/DecorateBiomeEvent.java b/src/main/java/net/minecraftforge/event/terraingen/DecorateBiomeEvent.java index ff4c0c6b7..4332fa3f0 100644 --- a/src/main/java/net/minecraftforge/event/terraingen/DecorateBiomeEvent.java +++ b/src/main/java/net/minecraftforge/event/terraingen/DecorateBiomeEvent.java @@ -1,6 +1,10 @@ package net.minecraftforge.event.terraingen; import java.util.Random; + +import net.minecraft.world.biome.BiomeGenBase; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraftforge.fml.common.eventhandler.Event.HasResult; import net.minecraft.util.math.BlockPos; @@ -9,7 +13,7 @@ import net.minecraft.world.World; /**DecorateBiomeEvent is fired when a BiomeDecorator is created. *
* This event is fired whenever a BiomeDecorator is created in - * DeferredBiomeDecorator#fireCreateEventAndReplace(BiomeGenBase).
+ * {@link DeferredBiomeDecorator#fireCreateEventAndReplace(BiomeGenBase)}.
*
* {@link #world} contains the world that is being decorated.
* {@link #rand} contains an instance of Random to be used.
diff --git a/src/main/java/net/minecraftforge/event/terraingen/OreGenEvent.java b/src/main/java/net/minecraftforge/event/terraingen/OreGenEvent.java index 0977129f1..36de4f716 100644 --- a/src/main/java/net/minecraftforge/event/terraingen/OreGenEvent.java +++ b/src/main/java/net/minecraftforge/event/terraingen/OreGenEvent.java @@ -1,6 +1,10 @@ package net.minecraftforge.event.terraingen; import java.util.Random; + +import net.minecraft.world.biome.BiomeDecorator; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraftforge.fml.common.eventhandler.Event.HasResult; import net.minecraft.util.math.BlockPos; @@ -49,7 +53,7 @@ public class OreGenEvent extends Event /** * OreGenEvent.Pre is fired just before a chunk is populated with ores.
* This event is fired just before ore generation in - * BiomeDecorator#generateOres().
+ * {@link BiomeDecorator#generateOres(World, Random)}.
*
* This event is not {@link Cancelable}.
*
@@ -68,7 +72,7 @@ public class OreGenEvent extends Event /** * OreGenEvent.Post is fired just after a chunk is populated with ores.
* This event is fired just after ore generation in - * BiomeDecorator#generateOres().
+ * {@link BiomeDecorator#generateOres(World, Random)}.
*
* This event is not {@link Cancelable}.
*
@@ -87,7 +91,7 @@ public class OreGenEvent extends Event /** * GenerateMinable is fired when a mineable block is generated in a chunk.
* This event is fired just after ore generation in - * BiomeDecorator#generateOres().
+ * {@link BiomeDecorator#generateOres(World, Random)}.
*
* {@link #type} contains the enum value for the Ore attempting to be generated.
* {@link #generator} contains the WorldGenerator generating this ore.
diff --git a/src/main/java/net/minecraftforge/event/terraingen/PopulateChunkEvent.java b/src/main/java/net/minecraftforge/event/terraingen/PopulateChunkEvent.java index 08ece413b..ce7e26f5e 100644 --- a/src/main/java/net/minecraftforge/event/terraingen/PopulateChunkEvent.java +++ b/src/main/java/net/minecraftforge/event/terraingen/PopulateChunkEvent.java @@ -4,6 +4,9 @@ import java.util.Random; import net.minecraft.world.World; import net.minecraft.world.chunk.IChunkGenerator; +import net.minecraft.world.gen.ChunkProviderEnd; +import net.minecraft.world.gen.ChunkProviderHell; +import net.minecraft.world.gen.ChunkProviderOverworld; import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event; @@ -47,9 +50,9 @@ public class PopulateChunkEvent extends ChunkGeneratorEvent /** * PopulateChunkEvent.Pre is fired just before a chunk is populated a terrain feature.
* This event is fired just before terrain feature generation in - * ChunkProviderEnd#populate(IChunkProvider, int, int), - * ChunkProviderGenerate#populate(IChunkProvider, int, int), - * and ChunkProviderHell#populate(IChunkProvider, int, int).
+ * {@link ChunkProviderEnd#populate(int, int)}, + * {@link ChunkProviderOverworld#populate(int, int)}, + * and {@link ChunkProviderHell#populate(int, int)}.
*
* This event is not {@link Cancelable}.
*
@@ -68,9 +71,9 @@ public class PopulateChunkEvent extends ChunkGeneratorEvent /** * PopulateChunkEvent.Post is fired just after a chunk is populated with a terrain feature.
* This event is fired just after terrain feature generation in - * ChunkProviderEnd#populate(IChunkProvider, int, int), - * ChunkProviderGenerate#populate(IChunkProvider, int, int), - * and ChunkProviderHell#populate(IChunkProvider, int, int).
+ * {@link ChunkProviderEnd#populate(int, int)}, + * {@link ChunkProviderOverworld#populate(int, int)}, + * and {@link ChunkProviderHell#populate(int, int)}.
*
* This event is not {@link Cancelable}.
*
@@ -89,9 +92,9 @@ public class PopulateChunkEvent extends ChunkGeneratorEvent /** * PopulateChunkEvent.Populate is fired when a chunk is populated with a terrain feature.
* This event is fired during terrain feature generation in - * ChunkProviderEnd#populate(IChunkProvider, int, int), - * ChunkProviderGenerate#populate(IChunkProvider, int, int), - * and ChunkProviderHell#populate(IChunkProvider, int, int).
+ * {@link ChunkProviderEnd#populate(int, int)}, + * {@link ChunkProviderOverworld#populate(int, int)}, + * and {@link ChunkProviderHell#populate(int, int)}.
*
* {@link #type} contains the enum value for the terrain feature being generated.
*
diff --git a/src/main/java/net/minecraftforge/event/terraingen/SaplingGrowTreeEvent.java b/src/main/java/net/minecraftforge/event/terraingen/SaplingGrowTreeEvent.java index e12002b25..97a42d62c 100644 --- a/src/main/java/net/minecraftforge/event/terraingen/SaplingGrowTreeEvent.java +++ b/src/main/java/net/minecraftforge/event/terraingen/SaplingGrowTreeEvent.java @@ -1,6 +1,11 @@ package net.minecraftforge.event.terraingen; import java.util.Random; + +import net.minecraft.block.BlockSapling; +import net.minecraft.block.state.IBlockState; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event.HasResult; import net.minecraft.util.math.BlockPos; import net.minecraft.world.World; @@ -9,7 +14,7 @@ import net.minecraftforge.event.world.WorldEvent; /** * SaplingGrowTreeEvent is fired when a sapling grows into a tree.
* This event is fired during sapling growth in - * BlockSapling#func_149878_d(World, BlockPos, Random).
+ * {@link BlockSapling#generateTree(World, BlockPos, IBlockState, Random)}.
*
* {@link #pos} contains the coordinates of the growing sapling.
* {@link #rand} contains an instance of Random for use.
diff --git a/src/main/java/net/minecraftforge/event/terraingen/WorldTypeEvent.java b/src/main/java/net/minecraftforge/event/terraingen/WorldTypeEvent.java index cb3f21dac..1741e29d6 100644 --- a/src/main/java/net/minecraftforge/event/terraingen/WorldTypeEvent.java +++ b/src/main/java/net/minecraftforge/event/terraingen/WorldTypeEvent.java @@ -1,5 +1,8 @@ package net.minecraftforge.event.terraingen; +import net.minecraft.world.biome.BiomeProvider; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraft.world.gen.layer.GenLayer; import net.minecraft.world.WorldType; @@ -30,7 +33,7 @@ public class WorldTypeEvent extends Event /** * BiomeSize is fired when vanilla Minecraft attempts to generate biomes.
* This event is fired during biome generation in - * GenLayer#initializeAllBiomeGenerators(long, WorldType).
+ * {@link GenLayer#initializeAllBiomeGenerators(long, WorldType, String)}.
*
* {@link #originalSize} the original size of the Biome.
* {@link #newSize} the new size of the biome. Initially set to the {@link #originalSize}.
@@ -71,9 +74,9 @@ public class WorldTypeEvent extends Event } /** - * InitBiomeGens is fired when vanilla Minecraft attempts to initialize the biome generators.
- * This event is fired just during biome generator initialization in - * WorldChunkManager#WorldChunkManager(long, WorldType).
+ * InitBiomeGens is fired when vanilla Minecraft attempts to initialize the biome providers.
+ * This event is fired just during biome provider initialization in + * {@link BiomeProvider#BiomeProvider(long, WorldType, String)}.
*
* {@link #seed} the seed of the world.
* {@link #originalBiomeGens} the array of GenLayers original intended for this Biome generation.
diff --git a/src/main/java/net/minecraftforge/event/world/ChunkDataEvent.java b/src/main/java/net/minecraftforge/event/world/ChunkDataEvent.java index d9bc6588a..8e2fe3ca8 100644 --- a/src/main/java/net/minecraftforge/event/world/ChunkDataEvent.java +++ b/src/main/java/net/minecraftforge/event/world/ChunkDataEvent.java @@ -1,7 +1,12 @@ package net.minecraftforge.event.world; +import net.minecraft.world.World; import net.minecraft.world.chunk.Chunk; import net.minecraft.nbt.NBTTagCompound; +import net.minecraft.world.chunk.storage.AnvilChunkLoader; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; +import net.minecraftforge.fml.common.eventhandler.Event; /** * ChunkDataEvent is fired when an event involving chunk data occurs.
@@ -30,7 +35,7 @@ public class ChunkDataEvent extends ChunkEvent /** * ChunkDataEvent.Load is fired when vanilla Minecraft attempts to load Chunk data.
* This event is fired during chunk loading in - * ChunkIOProvider#callStage2(QueuedChunk, Chunk).
+ * {@link net.minecraftforge.common.chunkio.ChunkIOProvider#syncCallback()}.
*
* This event is not {@link Cancelable}.
*
@@ -49,7 +54,7 @@ public class ChunkDataEvent extends ChunkEvent /** * ChunkDataEvent.Save is fired when vanilla Minecraft attempts to save Chunk data.
* This event is fired during chunk saving in - * AnvilChunkLoader#saveChunk(World, Chunk).
+ * {@link AnvilChunkLoader#saveChunk(World, Chunk)}.
*
* This event is not {@link Cancelable}.
*
diff --git a/src/main/java/net/minecraftforge/event/world/ChunkEvent.java b/src/main/java/net/minecraftforge/event/world/ChunkEvent.java index e58516f92..0a3d59d68 100644 --- a/src/main/java/net/minecraftforge/event/world/ChunkEvent.java +++ b/src/main/java/net/minecraftforge/event/world/ChunkEvent.java @@ -1,6 +1,10 @@ package net.minecraftforge.event.world; +import net.minecraft.client.multiplayer.ChunkProviderClient; import net.minecraft.world.chunk.Chunk; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; +import net.minecraftforge.fml.common.eventhandler.Event; /** * ChunkEvent is fired when an event involving a chunk occurs.
@@ -29,7 +33,7 @@ public class ChunkEvent extends WorldEvent /** * ChunkEvent.Load is fired when vanilla Minecraft attempts to load a Chunk into the world.
* This event is fired during chunk loading in
- * ChunkProviderClient#loadChunk(int, int),
+ * {@link ChunkProviderClient#loadChunk(int, int)},
* Chunk.onChunkLoad().
*
* This event is not {@link Cancelable}.
diff --git a/src/main/java/net/minecraftforge/event/world/ChunkWatchEvent.java b/src/main/java/net/minecraftforge/event/world/ChunkWatchEvent.java index bc33653b0..73b78f113 100644 --- a/src/main/java/net/minecraftforge/event/world/ChunkWatchEvent.java +++ b/src/main/java/net/minecraftforge/event/world/ChunkWatchEvent.java @@ -1,5 +1,8 @@ package net.minecraftforge.event.world; +import net.minecraft.server.management.PlayerManager; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraft.world.ChunkCoordIntPair; import net.minecraft.entity.player.EntityPlayerMP; @@ -38,7 +41,7 @@ public class ChunkWatchEvent extends Event /** * ChunkWatchEvent.Watch is fired when an EntityPlayer begins watching a chunk.
* This event is fired when a chunk is added to the watched chunks of an EntityPlayer in - * EntityPlayerMP#onUpdate().
+ * {@link EntityPlayerMP#onUpdate()}.
*
* This event is not {@link Cancelable}.
*
@@ -54,7 +57,7 @@ public class ChunkWatchEvent extends Event /** * ChunkWatchEvent.UnWatch is fired when an EntityPlayer stops watching a chunk.
* This event is fired when a chunk is removed from the watched chunks of an EntityPlayer in - * PlayerInstance#removePlayer(EntityPlayerMP).
+ * {@link PlayerManager.PlayerInstance#removePlayer(EntityPlayerMP)}.
*
* This event is not {@link Cancelable}.
*
diff --git a/src/main/java/net/minecraftforge/event/world/ExplosionEvent.java b/src/main/java/net/minecraftforge/event/world/ExplosionEvent.java index 5a93fdb3d..8f6665da4 100644 --- a/src/main/java/net/minecraftforge/event/world/ExplosionEvent.java +++ b/src/main/java/net/minecraftforge/event/world/ExplosionEvent.java @@ -2,6 +2,7 @@ package net.minecraftforge.event.world; import java.util.List; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraft.entity.Entity; diff --git a/src/main/java/net/minecraftforge/event/world/WorldEvent.java b/src/main/java/net/minecraftforge/event/world/WorldEvent.java index d54bd3b77..d87aa936e 100644 --- a/src/main/java/net/minecraftforge/event/world/WorldEvent.java +++ b/src/main/java/net/minecraftforge/event/world/WorldEvent.java @@ -1,13 +1,27 @@ package net.minecraftforge.event.world; import java.util.ArrayList; +import java.util.Hashtable; import java.util.List; +import net.minecraft.client.Minecraft; +import net.minecraft.client.multiplayer.WorldClient; +import net.minecraft.client.network.NetHandlerPlayClient; import net.minecraft.entity.EnumCreatureType; +import net.minecraft.profiler.Profiler; +import net.minecraft.server.MinecraftServer; +import net.minecraft.server.integrated.IntegratedServer; +import net.minecraft.util.IProgressUpdate; import net.minecraft.util.math.BlockPos; +import net.minecraft.world.EnumDifficulty; import net.minecraft.world.World; +import net.minecraft.world.WorldServer; import net.minecraft.world.WorldSettings; +import net.minecraft.world.WorldType; import net.minecraft.world.biome.BiomeGenBase.SpawnListEntry; +import net.minecraftforge.common.DimensionManager; +import net.minecraftforge.common.ForgeInternalHandler; +import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Event; @@ -37,10 +51,11 @@ public class WorldEvent extends Event /** * WorldEvent.Load is fired when Minecraft loads a world.
* This event is fired when a world is loaded in - * WorldClient#WorldClient(NetHandlerPlayClient, WorldSettings, int, EnumDifficulty, Profiler), - * MinecraftServer#loadAllWorlds(String, String, long, WorldType, String), - * DimensionManager#initDimension(int), - * and ForgeInternalHandler#onDimensionLoad(Load).
+ * {@link WorldClient#WorldClient(NetHandlerPlayClient, WorldSettings, int, EnumDifficulty, Profiler)}, + * {@link MinecraftServer#loadAllWorlds(String, String, long, WorldType, String)}, + * {@link IntegratedServer#loadAllWorlds(String, String, long, WorldType, String)} + * {@link DimensionManager#initDimension(int)}, + * and {@link ForgeInternalHandler#onDimensionLoad(Load)}.
*
* This event is not {@link Cancelable}.
*
@@ -56,11 +71,10 @@ public class WorldEvent extends Event /** * WorldEvent.Unload is fired when Minecraft unloads a world.
* This event is fired when a world is unloaded in - * Minecraft#loadWorld(WorldClient, String), - * MinecraftServer#deleteWorldAndStopServer(), - * MinecraftServer#stopServer(), - * DimensionManager#unloadWorlds(Hashtable), - * ForgeInternalHandler#onDimensionUnload(Unload).
+ * {@link Minecraft#loadWorld(WorldClient, String)}, + * {@link MinecraftServer#stopServer()}, + * {@link DimensionManager#unloadWorlds(Hashtable)}, + * {@link ForgeInternalHandler#onDimensionUnload(Unload)}.
*
* This event is not {@link Cancelable}.
*
@@ -76,8 +90,8 @@ public class WorldEvent extends Event /** * WorldEvent.Save is fired when Minecraft saves a world.
* This event is fired when a world is saved in - * WorldServer#saveAllChunks(boolean, IProgressUpdate), - * ForgeInternalHandler#onDimensionSave(Save).
+ * {@link WorldServer#saveAllChunks(boolean, IProgressUpdate)}, + * {@link ForgeInternalHandler#onDimensionSave(Save)}.
*
* This event is not {@link Cancelable}.
*
@@ -93,8 +107,8 @@ public class WorldEvent extends Event /** * Called by WorldServer to gather a list of all possible entities that can spawn at the specified location. * If an entry is added to the list, it needs to be a globally unique instance. - * The event is called in WorldServer#getSpawnListEntryForTypeAt(EnumCreatureType, BlockPos) as well as - * WorldServer#canCreatureTypeSpawnHere(EnumCreatureType creatureType, BiomeGenBase.SpawnListEntry spawnListEntry, BlockPos pos) + * The event is called in {@link WorldServer#getSpawnListEntryForTypeAt(EnumCreatureType, BlockPos)} as well as + * {@link WorldServer#canCreatureTypeSpawnHere(EnumCreatureType, SpawnListEntry, BlockPos)} * where the latter checks for identity, meaning both events must add the same instance. * Canceling the event will result in a empty list, meaning no entity will be spawned. */ diff --git a/src/main/java/net/minecraftforge/fluids/IFluidBlock.java b/src/main/java/net/minecraftforge/fluids/IFluidBlock.java index 5bd19dbfd..a434aff3a 100644 --- a/src/main/java/net/minecraftforge/fluids/IFluidBlock.java +++ b/src/main/java/net/minecraftforge/fluids/IFluidBlock.java @@ -31,8 +31,6 @@ public interface IFluidBlock * Check to see if a block can be drained. This method should be called by devices such as * pumps. * - * @param doDrain - * If false, the drain will only be simulated. * @return */ boolean canDrain(World world, BlockPos pos); diff --git a/src/main/java/net/minecraftforge/fluids/IFluidContainerItem.java b/src/main/java/net/minecraftforge/fluids/IFluidContainerItem.java index f640403e8..6ba66cca0 100644 --- a/src/main/java/net/minecraftforge/fluids/IFluidContainerItem.java +++ b/src/main/java/net/minecraftforge/fluids/IFluidContainerItem.java @@ -48,7 +48,7 @@ public interface IFluidContainerItem * ItemStack which is the fluid container. * @param maxDrain * Maximum amount of fluid to be removed from the container. - * @param doFill + * @param doDrain * If false, the drain will only be simulated. * @return Amount of fluid that was (or would have been, if simulated) drained from the * container. diff --git a/src/main/java/net/minecraftforge/fluids/IFluidTank.java b/src/main/java/net/minecraftforge/fluids/IFluidTank.java index ec64a9475..fbf5d6bb1 100644 --- a/src/main/java/net/minecraftforge/fluids/IFluidTank.java +++ b/src/main/java/net/minecraftforge/fluids/IFluidTank.java @@ -46,8 +46,8 @@ public interface IFluidTank * * @param maxDrain * Maximum amount of fluid to be removed from the container. - * @param doFill - * If false, the fill will only be simulated. + * @param doDrain + * If false, the drain will only be simulated. * @return Amount of fluid that was removed from the tank. */ FluidStack drain(int maxDrain, boolean doDrain); diff --git a/src/main/java/net/minecraftforge/fml/client/config/GuiConfigEntries.java b/src/main/java/net/minecraftforge/fml/client/config/GuiConfigEntries.java index e4780b3e6..a0e1d1381 100644 --- a/src/main/java/net/minecraftforge/fml/client/config/GuiConfigEntries.java +++ b/src/main/java/net/minecraftforge/fml/client/config/GuiConfigEntries.java @@ -1694,18 +1694,18 @@ public class GuiConfigEntries extends GuiListExtended public boolean enabled(); /** - * Handles user keystrokes for any GuiTextField objects in this entry. Call {@code GuiTextField.keyTyped()} for any GuiTextField + * Handles user keystrokes for any GuiTextField objects in this entry. Call {@link GuiTextField#textboxKeyTyped(char, int)} for any GuiTextField * objects that should receive the input provided. */ public void keyTyped(char eventChar, int eventKey); /** - * Call {@code GuiTextField.updateCursorCounter()} for any GuiTextField objects in this entry. + * Call {@link GuiTextField#updateCursorCounter()} for any GuiTextField objects in this entry. */ public void updateCursorCounter(); /** - * Call {@code GuiTextField.mouseClicked()} for and GuiTextField objects in this entry. + * Call {@link GuiTextField#mouseClicked(int, int, int)} for and GuiTextField objects in this entry. */ public void mouseClicked(int x, int y, int mouseEvent); diff --git a/src/main/java/net/minecraftforge/fml/client/config/IConfigElement.java b/src/main/java/net/minecraftforge/fml/client/config/IConfigElement.java index efeae9693..283eb99da 100644 --- a/src/main/java/net/minecraftforge/fml/client/config/IConfigElement.java +++ b/src/main/java/net/minecraftforge/fml/client/config/IConfigElement.java @@ -31,14 +31,26 @@ public interface IConfigElement public boolean isProperty(); /** - * This method returns a class that implements {@code IConfigEntry} or null. This class MUST - * provide a constructor with the following parameter types: {@code GuiConfig}, {@code GuiConfigEntries}, {@code IConfigElement} + * This method returns a class that implements {@link IConfigEntry} or null. This class MUST + * provide a constructor with the following parameter types: {@link GuiConfig}, {@link GuiConfigEntries}, {@link IConfigElement} + * + * @see GuiConfigEntries.ListEntryBase + * @see GuiConfigEntries.StringEntry + * @see GuiConfigEntries.BooleanEntry + * @see GuiConfigEntries.DoubleEntry + * @see GuiConfigEntries.IntegerEntry */ public Class getConfigEntryClass(); /** - * This method returns a class that implements {@code IArrayEntry}. This class MUST provide a constructor with the - * following parameter types: {@code GuiEditArray}, {@code GuiEditArrayEntries}, {@code IConfigElement}, {@code Object} + * This method returns a class that implements {@link IArrayEntry}. This class MUST provide a constructor with the + * following parameter types: {@link GuiEditArray}, {@link GuiEditArrayEntries}, {@link IConfigElement}, {@link Object} + * + * @see GuiEditArrayEntries.BaseEntry + * @see GuiEditArrayEntries.StringEntry + * @see GuiEditArrayEntries.BooleanEntry + * @see GuiEditArrayEntries.DoubleEntry + * @see GuiEditArrayEntries.IntegerEntry */ public Class getArrayEntryClass(); diff --git a/src/main/java/net/minecraftforge/fml/client/registry/RenderingRegistry.java b/src/main/java/net/minecraftforge/fml/client/registry/RenderingRegistry.java index 736c447aa..b3ec8b29f 100644 --- a/src/main/java/net/minecraftforge/fml/client/registry/RenderingRegistry.java +++ b/src/main/java/net/minecraftforge/fml/client/registry/RenderingRegistry.java @@ -49,9 +49,6 @@ public class RenderingRegistry * Register an entity rendering handler. This will, after mod initialization, be inserted into the main * render map for entities. * Call this during Preinitialization phase. - * - * @param entityClass - * @param renderer */ public static void registerEntityRenderingHandler(Class entityClass, IRenderFactory renderFactory) { diff --git a/src/main/java/net/minecraftforge/fml/common/Loader.java b/src/main/java/net/minecraftforge/fml/common/Loader.java index f4b514205..8ce745ad1 100644 --- a/src/main/java/net/minecraftforge/fml/common/Loader.java +++ b/src/main/java/net/minecraftforge/fml/common/Loader.java @@ -942,10 +942,12 @@ public class Loader * Fire a FMLMissingMappingsEvent to let mods determine how blocks/items defined in the world * save, but missing from the runtime, are to be handled. * - * @param missing Map containing missing names with their associated id, blocks need to come before items for remapping. + * @param missingBlocks Map containing the missing block names with their associated id. Remapped blocks will be removed from it. + * @param missingItems Map containing the missing block names with their associated id. Remapped items will be removed from it. * @param isLocalWorld Whether this is executing for a world load (local/server) or a client. - * @param gameData GameData instance where the new map's config is to be loaded into. - * @return List with the mapping results. + * @param remapBlocks Returns a map containing the remapped block names and an array containing the original and new id for the block. + * @param remapItems Returns a map containing the remapped item names and an array containing the original and new id for the item. + * @return List with the names of the failed remappings. */ public List fireMissingMappingEvent(Map missingBlocks, Map missingItems, boolean isLocalWorld, Map remapBlocks, Map remapItems) { diff --git a/src/main/java/net/minecraftforge/fml/common/network/NetworkCheckHandler.java b/src/main/java/net/minecraftforge/fml/common/network/NetworkCheckHandler.java index a8bc380b8..622abc9a1 100644 --- a/src/main/java/net/minecraftforge/fml/common/network/NetworkCheckHandler.java +++ b/src/main/java/net/minecraftforge/fml/common/network/NetworkCheckHandler.java @@ -9,7 +9,7 @@ import net.minecraftforge.fml.relauncher.Side; /** * A method annotated with this will be called when a remote network connection is offered. - * The method should have two parameters, of types {@link Map} and {@link Side}. It should return a boolean + * The method should have two parameters, of types Map and {@link Side}. It should return a boolean * true indicating that the remote party is acceptable, or false if not. * *

diff --git a/src/main/java/net/minecraftforge/fml/common/network/NetworkRegistry.java b/src/main/java/net/minecraftforge/fml/common/network/NetworkRegistry.java index 3251d9d3d..fd13fa7f5 100644 --- a/src/main/java/net/minecraftforge/fml/common/network/NetworkRegistry.java +++ b/src/main/java/net/minecraftforge/fml/common/network/NetworkRegistry.java @@ -110,7 +110,7 @@ public enum NetworkRegistry *

@@ -124,7 +124,7 @@ public enum NetworkRegistry * * The first handler in the pipeline is special and should not be removed or moved from the head - it transforms * packets from the outbound of this pipeline into custom packets, based on the current {@link AttributeKey} value - * {@link NetworkRegistry#FML_MESSAGETARGET} and {@link NetworkRegistry#FML_MESSAGETARGETARGS} set on the channel. + * {@link FMLOutboundHandler#FML_MESSAGETARGET} and {@link FMLOutboundHandler#FML_MESSAGETARGETARGS} set on the channel. * For the client to server channel (source side : CLIENT) this is fixed as "TOSERVER". For SERVER to CLIENT packets, * several possible values exist. * @@ -132,7 +132,7 @@ public enum NetworkRegistry * a utility codec, {@link FMLIndexedMessageToMessageCodec} that transforms from {@link FMLProxyPacket} to a mod * message using a message discriminator byte. This is optional, but highly recommended for use. * - * Note also that the handlers supplied need to be {@link ChannelHandler.Shareable} - they are injected into two + * Note also that the handlers supplied need to be {@link ChannelHandler.Sharable} - they are injected into two * channels. * * @param name @@ -258,7 +258,7 @@ public enum NetworkRegistry * @param x X coord * @param y Y coord * @param z Z coord - * @return The client side GUI object (An instance of {@link GUI}) + * @return The client side GUI object (An instance of {@link net.minecraft.client.gui.Gui}) */ public Object getLocalGuiContainer(ModContainer mc, EntityPlayer player, int modGuiId, World world, int x, int y, int z) { diff --git a/src/main/java/net/minecraftforge/fml/common/network/simpleimpl/IMessageHandler.java b/src/main/java/net/minecraftforge/fml/common/network/simpleimpl/IMessageHandler.java index ff15fb7be..008f27cf0 100644 --- a/src/main/java/net/minecraftforge/fml/common/network/simpleimpl/IMessageHandler.java +++ b/src/main/java/net/minecraftforge/fml/common/network/simpleimpl/IMessageHandler.java @@ -2,8 +2,8 @@ package net.minecraftforge.fml.common.network.simpleimpl; /** - * A message handler based on {@link IMessage}. Implement and override {@link #onMessage(IMessage)} to - * process your packet. Supply the class to {@link SimpleNetworkWrapper#registerMessage(Class, Class, byte, net.minecraftforge.fml.relauncher.Side)} + * A message handler based on {@link IMessage}. Implement and override {@link #onMessage(IMessage, MessageContext)} to + * process your packet. Supply the class to {@link SimpleNetworkWrapper#registerMessage(Class, Class, int, net.minecraftforge.fml.relauncher.Side)} * to register both the message type and it's associated handler. * * @author cpw diff --git a/src/main/java/net/minecraftforge/fml/common/network/simpleimpl/SimpleNetworkWrapper.java b/src/main/java/net/minecraftforge/fml/common/network/simpleimpl/SimpleNetworkWrapper.java index 7f18106e3..660391cf1 100644 --- a/src/main/java/net/minecraftforge/fml/common/network/simpleimpl/SimpleNetworkWrapper.java +++ b/src/main/java/net/minecraftforge/fml/common/network/simpleimpl/SimpleNetworkWrapper.java @@ -16,6 +16,7 @@ import net.minecraft.network.INetHandler; import net.minecraft.network.Packet; import net.minecraft.tileentity.TileEntity; import net.minecraftforge.fml.common.FMLLog; +import net.minecraftforge.fml.common.event.FMLInitializationEvent; import net.minecraftforge.fml.common.event.FMLPreInitializationEvent; import net.minecraftforge.fml.common.network.FMLEmbeddedChannel; import net.minecraftforge.fml.common.network.FMLOutboundHandler; @@ -32,7 +33,7 @@ import net.minecraftforge.fml.relauncher.Side; * Usage is simple: