Improve JavaDoc links, fix some broken JavaDocs (#2833)

Improve JavaDoc links, fix broken JavaDocs
This commit is contained in:
mezz 2016-05-29 14:05:07 -07:00 committed by LexManos
parent 9bb927dc64
commit 86baf7462f
62 changed files with 353 additions and 163 deletions

View file

@ -3,6 +3,8 @@ package net.minecraftforge.client.event;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import net.minecraft.client.Minecraft;
import net.minecraft.client.renderer.InventoryEffectRenderer;
import org.lwjgl.input.Mouse; import org.lwjgl.input.Mouse;
import net.minecraft.client.gui.GuiButton; 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<GuiButton> getButtonList() public List<GuiButton> getButtonList()
{ {
@ -61,11 +63,10 @@ public class GuiScreenEvent extends Event
} }
/** /**
* This event fires just after initializing {@code GuiScreen.mc}, {@code GuiScreen.fontRendererObj}, * This event fires just after initializing {@link GuiScreen#mc}, {@link GuiScreen#fontRendererObj},
* {@code GuiScreen.width}, and {@code GuiScreen.height}, and just before calling {@code GuiScreen.buttonList.clear()} * {@link GuiScreen#width}, and {@link GuiScreen#height}.<br/><br/>
* and {@code GuiScreen.initGui()}. To skip or override a screen's initGui() method cancel the event.<br/><br/>
* *
* If canceled the following lines are skipped in {@code GuiScreen.setWorldAndResolution()}:<br/> * If canceled the following lines are skipped in {@link GuiScreen#setWorldAndResolution(Minecraft, int, int)}:<br/>
* {@code this.buttonList.clear();}<br/> * {@code this.buttonList.clear();}<br/>
* {@code this.initGui();}<br/> * {@code this.initGui();}<br/>
*/ */
@ -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. * This is a good place to alter a GuiScreen's component layout if desired.
*/ */
public static class Post extends InitGuiEvent 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. * This event fires just before {@link GuiScreen#drawScreen(int, int, float)} is called.
* Cancel this event to skip {@code GuiScreen.drawScreen()}. * Cancel this event to skip {@link GuiScreen#drawScreen(int, int, float)}.
*/ */
@Cancelable @Cancelable
public static class Pre extends DrawScreenEvent 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 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. * This allows drawing next to Guis, above the background but below any tooltips.
*/ */
public static class BackgroundDrawnEvent extends GuiScreenEvent 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. * when potion effects are active and the gui wants to move over.
* Cancel this event to prevent the Gui from being moved. * 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<GuiButton> getButtonList() public List<GuiButton> 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. * 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. * Replace button with a different button from buttonList to have that button's action executed.
*/ */
@Cancelable @Cancelable
@ -257,8 +258,8 @@ public class GuiScreenEvent extends Event
} }
/** /**
* This event fires after {@code GuiScreen.actionPerformed()} provided that the active * This event fires after {@link GuiScreen#actionPerformed(GuiButton)} provided that the active
* screen has not been changed as a result of {@code GuiScreen.actionPerformed()}. * screen has not been changed as a result of {@link GuiScreen#actionPerformed(GuiButton)}.
*/ */
public static class Post extends ActionPerformedEvent 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. * 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 @Cancelable
public static class Pre extends MouseInputEvent 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 * This event fires after {@link GuiScreen#handleMouseInput()} provided that the active
* screen has not been changed as a result of {@code GuiScreen.handleMouseInput()}. * screen has not been changed as a result of {@link GuiScreen#handleMouseInput()}.
*/ */
public static class Post extends MouseInputEvent 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. * 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 @Cancelable
public static class Pre extends KeyboardInputEvent 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 * This event fires after {@link GuiScreen#handleKeyboardInput()} provided that the active
* screen has not been changed as a result of {@code GuiScreen.handleKeyboardInput()}. * screen has not been changed as a result of {@link GuiScreen#handleKeyboardInput()}.
*/ */
public static class Post extends KeyboardInputEvent public static class Post extends KeyboardInputEvent
{ {

View file

@ -140,7 +140,7 @@ public class BiomeDictionary
* Registers a biome with a specific biome type * Registers a biome with a specific biome type
* *
* @param biome the biome to be registered * @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 * @return returns true if the biome was registered successfully
*/ */
public static boolean registerBiomeType(BiomeGenBase biome, Type ... types) public static boolean registerBiomeType(BiomeGenBase biome, Type ... types)

View file

@ -1,5 +1,9 @@
package net.minecraftforge.common; 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; import net.minecraftforge.common.util.EnumHelper;
public enum EnumPlantType 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} * 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)}.
* *
* <p>If your new plant grows on blocks like any one of them above, never create a new {@link EnumPlantType}. * <p>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 * 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. * which you are supposed to override this function in your new block and create a new plant type to grow on that block.
* *
* <p>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. * <p>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 * @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) public static EnumPlantType getPlantType(String name)
{ {

View file

@ -55,7 +55,7 @@ public class Capability<T>
* @param capability The Capability being stored. * @param capability The Capability being stored.
* @param instance An instance of that capabilities interface. * @param instance An instance of that capabilities interface.
* @param side The side of the object the instance is associated with. * @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<T> capability, T instance, EnumFacing side, NBTBase nbt); void readNBT(Capability<T> capability, T instance, EnumFacing side, NBTBase nbt);
} }

View file

@ -60,7 +60,7 @@ public enum CapabilityManager
* *
* @param type The Interface to be registered * @param type The Interface to be registered
* @param storage A default implementation of the storage handler. * @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 <T> void register(Class<T> type, Capability.IStorage<T> storage, Callable<? extends T> factory) public <T> void register(Class<T> type, Capability.IStorage<T> storage, Callable<? extends T> factory)
{ {

View file

@ -36,7 +36,10 @@ import java.util.regex.Pattern;
import com.google.common.base.CharMatcher; import com.google.common.base.CharMatcher;
import com.google.common.collect.ImmutableSet; 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.GuiConfigEntries.IConfigEntry;
import net.minecraftforge.fml.client.config.IConfigElement;
import net.minecraftforge.fml.common.FMLLog; import net.minecraftforge.fml.common.FMLLog;
import net.minecraftforge.fml.common.Loader; import net.minecraftforge.fml.common.Loader;
import net.minecraftforge.fml.relauncher.FMLInjectionData; 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 * 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 * navigates into the category). This class MUST provide a constructor with the following parameter types: {@link GuiConfig} (the parent
* GuiConfig screen will be provided), {@code GuiPropertyList} (the parent GuiPropertyList will be provided), {@code IConfigElement} * GuiConfig screen will be provided), {@link GuiConfigEntries} (the parent GuiConfigEntries will be provided), {@link IConfigElement}
* (the IConfigElement for this Property will be provided). * (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<? extends IConfigEntry> clazz) public Configuration setCategoryConfigEntryClass(String category, Class<? extends IConfigEntry> clazz)
{ {
@ -1561,7 +1570,7 @@ public class Configuration
* *
* @param name Name of the property. * @param name Name of the property.
* @param category Category 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. * @param comment A brief description what the property does.
* @return The value of the new string property. * @return The value of the new string property.
*/ */

View file

@ -9,8 +9,13 @@ import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.regex.Pattern; 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.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.GuiEditArrayEntries.IArrayEntry;
import net.minecraftforge.fml.client.config.IConfigElement;
public class Property 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 * 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), * MUST provide a constructor with the following parameter types: {@link GuiConfig} (the owning GuiConfig screen will be provided),
* {@code GuiConfigEntries} (the owning GuiConfigEntries will be provided), {@code IConfigElement} (the IConfigElement for this Property * {@link GuiConfigEntries} (the owning GuiConfigEntries will be provided), {@link IConfigElement} (the IConfigElement for this Property
* will be provided). * will be provided).
*
* @see GuiConfigEntries.ListEntryBase
* @see GuiConfigEntries.StringEntry
* @see GuiConfigEntries.BooleanEntry
* @see GuiConfigEntries.DoubleEntry
* @see GuiConfigEntries.IntegerEntry
*/ */
public Property setConfigEntryClass(Class<? extends IConfigEntry> clazz) public Property setConfigEntryClass(Class<? extends IConfigEntry> 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 * 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), * MUST provide a constructor with the following parameter types: {@link GuiEditArray} (the owning GuiEditArray screen will be provided),
* {@code GuiPropertyList} (the parent GuiPropertyList will be provided), {@code IConfigProperty} (the IConfigProperty for this Property * {@link GuiEditArrayEntries} (the parent GuiEditArrayEntries will be provided), {@link IConfigElement} (the IConfigElement for this Property
* will be provided). * 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<? extends IArrayEntry> clazz) public Property setArrayEntryClass(Class<? extends IArrayEntry> 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. * 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 * @return The value
*/ */
public double getDouble() public double getDouble()

View file

@ -1,5 +1,8 @@
package net.minecraftforge.event; 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.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraftforge.fml.common.eventhandler.Event;
import net.minecraft.command.ICommand; 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. * CommandEvent is fired whenever a command is scheduled to be executed.
* This event is fired during the invocation of CommandHandler#executeCommand(ICommandSender, String) * This event is fired during the invocation of {@link CommandHandler#executeCommand(ICommandSender, String)}
* and ClientCommandHandler#executeCommand(ICommandSender, String). <br> * and {@link ClientCommandHandler#executeCommand(ICommandSender, String)}. <br>
* <br> * <br>
* {@link #command} contains the instance of ICommand which is representative of the currently executing command.<br> * {@link #command} contains the instance of ICommand which is representative of the currently executing command.<br>
* {@link #sender} contains the instance of ICommandSender for the given command sender.<br> * {@link #sender} contains the instance of ICommandSender for the given command sender.<br>

View file

@ -1,5 +1,8 @@
package net.minecraftforge.event; 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.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraftforge.fml.common.eventhandler.Event;
import net.minecraft.entity.player.EntityPlayerMP; import net.minecraft.entity.player.EntityPlayerMP;
@ -7,8 +10,8 @@ import net.minecraft.util.text.ITextComponent;
/** /**
* ServerChatEvent is fired whenever a C01PacketChatMessage is processed. <br> * ServerChatEvent is fired whenever a C01PacketChatMessage is processed. <br>
* This event is fired via {@link ForgeHooks#onServerChatEvent(net.minecraft.network.NetHandlerPlayServer, String, ChatComponentTranslation)}, * This event is fired via {@link ForgeHooks#onServerChatEvent(NetHandlerPlayServer, String, ITextComponent)},
* which is executed by the NetHandlerPlayServer#processChatMessage(net.minecraft.network.play.client.C01PacketChatMessage)<br> * which is executed by the {@link NetHandlerPlayServer#processChatMessage(CPacketChatMessage)}<br>
* <br> * <br>
* {@link #username} contains the username of the player sending the chat message.<br> * {@link #username} contains the username of the player sending the chat message.<br>
* {@link #message} contains the message being sent.<br> * {@link #message} contains the message being sent.<br>

View file

@ -1,6 +1,8 @@
package net.minecraftforge.event.brewing; package net.minecraftforge.event.brewing;
import net.minecraft.item.ItemStack; 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.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraftforge.fml.common.eventhandler.Event;
import net.minecraftforge.fml.common.eventhandler.Event.HasResult; 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. * 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. * All changes made to the event's array will be made to the TileEntity if the event is canceled.
* <br> * <br>
* The event is fired during the TileEntityBrewingStand#brewPotions() method invocation.<br> * The event is fired during the {@link TileEntityBrewingStand#brewPotions()} method invocation.<br>
* <br> * <br>
* {@link #brewingStacks} contains the itemstack array from the TileEntityBrewer holding all items in Brewer.<br> * {@link #stacks} contains the itemstack array from the TileEntityBrewer holding all items in Brewer.<br>
* <br> * <br>
* This event is {@link Cancelable}.<br> * This event is {@link Cancelable}.<br>
* If the event is not canceled, the vanilla brewing will take place instead of modded brewing. * 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. * PotionBrewEvent.Post is fired when a potion is brewed in the brewing stand.
* <br> * <br>
* The event is fired during the TileEntityBrewingStand#brewPotions() method invocation.<br> * The event is fired during the {@link TileEntityBrewingStand#brewPotions()} method invocation.<br>
* <br> * <br>
* {@link #brewingStacks} contains the itemstack array from the TileEntityBrewer holding all items in Brewer.<br> * {@link #stacks} contains the itemstack array from the TileEntityBrewer holding all items in Brewer.<br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>

View file

@ -1,5 +1,9 @@
package net.minecraftforge.event.entity; 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.minecraftforge.fml.common.eventhandler.Event;
import net.minecraft.entity.Entity; import net.minecraft.entity.Entity;
@ -47,7 +51,7 @@ public class EntityEvent extends Event
/** /**
* CanUpdate is fired when an Entity is being created. <br> * CanUpdate is fired when an Entity is being created. <br>
* This event is fired whenever vanilla Minecraft determines that an entity<br> * This event is fired whenever vanilla Minecraft determines that an entity<br>
* cannot update in World#updateEntityWithOptionalForce(net.minecraft.entity.Entity, boolean) <br> * cannot update in {@link World#updateEntityWithOptionalForce(net.minecraft.entity.Entity, boolean)} <br>
* <br> * <br>
* {@link CanUpdate#canUpdate} contains the boolean value of whether this entity can update.<br> * {@link CanUpdate#canUpdate} contains the boolean value of whether this entity can update.<br>
* If the modder decides that this Entity can be updated, they may change canUpdate to true, <br> * If the modder decides that this Entity can be updated, they may change canUpdate to true, <br>
@ -79,7 +83,7 @@ public class EntityEvent extends Event
/** /**
* EnteringChunk is fired when an Entity enters a chunk. <br> * EnteringChunk is fired when an Entity enters a chunk. <br>
* This event is fired whenever vanilla Minecraft determines that an entity <br> * This event is fired whenever vanilla Minecraft determines that an entity <br>
* is entering a chunk in Chunk#addEntity(net.minecraft.entity.Entity) <br> * is entering a chunk in {@link Chunk#addEntity(net.minecraft.entity.Entity)} <br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>

View file

@ -1,13 +1,17 @@
package net.minecraftforge.event.entity; package net.minecraftforge.event.entity;
import net.minecraft.world.WorldServer;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.entity.Entity; import net.minecraft.entity.Entity;
import net.minecraft.world.World; import net.minecraft.world.World;
import java.util.Collection;
/** /**
* EntityJoinWorldEvent is fired when an Entity joins the world. <br> * EntityJoinWorldEvent is fired when an Entity joins the world. <br>
* This event is fired whenever an Entity is added to the world in * 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). <br> * {@link World#loadEntities(Collection)}, {@link WorldServer#loadEntities(Collection)} {@link World#joinEntityInSurroundings(Entity)}, and {@link World#spawnEntityInWorld(Entity)}. <br>
* <br> * <br>
* {@link #world} contains the world in which the entity is to join.<br> * {@link #world} contains the world in which the entity is to join.<br>
* <br> * <br>

View file

@ -2,6 +2,7 @@ package net.minecraftforge.event.entity;
import net.minecraft.entity.Entity; import net.minecraft.entity.Entity;
import net.minecraft.world.World; import net.minecraft.world.World;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event.HasResult; import net.minecraftforge.fml.common.eventhandler.Event.HasResult;

View file

@ -1,5 +1,7 @@
package net.minecraftforge.event.entity; package net.minecraftforge.event.entity;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.ForgeEventFactory;
import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.entity.Entity; import net.minecraft.entity.Entity;
import net.minecraft.entity.effect.EntityLightningBolt; 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.<br> * EntityStruckByLightningEvent is fired when an Entity is about to be struck by lightening.<br>
* This event is fired whenever an EntityLightningBolt is updated to strike an Entity in * This event is fired whenever an EntityLightningBolt is updated to strike an Entity in
* EntityLightningBolt#onUpdate() via {@link ForgeEventFactory#onEntityStruckByLightning(Entity, EntityLightningBolt)}.<br> * {@link EntityLightningBolt#onUpdate()} via {@link ForgeEventFactory#onEntityStruckByLightning(Entity, EntityLightningBolt)}.<br>
* <br> * <br>
* {@link #lightning} contains the instance of EntityLightningBolt attempting to strike an entity.<br> * {@link #lightning} contains the instance of EntityLightningBolt attempting to strike an entity.<br>
* <br> * <br>

View file

@ -1,6 +1,7 @@
package net.minecraftforge.event.entity; package net.minecraftforge.event.entity;
import net.minecraft.entity.Entity; import net.minecraft.entity.Entity;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event.HasResult; import net.minecraftforge.fml.common.eventhandler.Event.HasResult;

View file

@ -1,5 +1,10 @@
package net.minecraftforge.event.entity; 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.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.entity.Entity; import net.minecraft.entity.Entity;
import net.minecraft.util.SoundCategory; 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<br> * PlaySoundAtEntityEvent is fired a sound is to be played at an Entity<br>
* This event is fired whenever a sound is set to be played at an Entity such as in * 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), * {@link EntityPlayerSP#playSound(SoundEvent, float, float)} and {@link World#playSound(EntityPlayer, double, double, double, SoundEvent, SoundCategory, float, float)}.<br>
* and World#playerSoundToNearExcept(EntityPlayer, String, float, float).<br>
* <br> * <br>
* {@link #name} contains the name of the sound to be played at the Entity.<br> * {@link #name} contains the name of the sound to be played at the Entity.<br>
* {@link #volume} contains the volume at which the sound is to be played originally.<br> * {@link #volume} contains the volume at which the sound is to be played originally.<br>

View file

@ -1,5 +1,8 @@
package net.minecraftforge.event.entity.living; 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.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.util.DamageSource; import net.minecraft.util.DamageSource;
import net.minecraft.entity.EntityLivingBase; import net.minecraft.entity.EntityLivingBase;
@ -7,8 +10,8 @@ import net.minecraft.entity.EntityLivingBase;
/** /**
* LivingAttackEvent is fired when a living Entity is attacked. <br> * LivingAttackEvent is fired when a living Entity is attacked. <br>
* This event is fired whenever an Entity is attacked in * This event is fired whenever an Entity is attacked in
* EntityLivingBase#attackEntityFrom(DamageSource, float) and * {@link EntityLivingBase#attackEntityFrom(DamageSource, float)} and
* EntityPlayer#attackEntityFrom(DamageSource, float). <br> * {@link EntityPlayer#attackEntityFrom(DamageSource, float)}. <br>
* <br> * <br>
* This event is fired via the {@link ForgeHooks#onLivingAttack(EntityLivingBase, DamageSource, float)}.<br> * This event is fired via the {@link ForgeHooks#onLivingAttack(EntityLivingBase, DamageSource, float)}.<br>
* <br> * <br>

View file

@ -1,5 +1,9 @@
package net.minecraftforge.event.entity.living; 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.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.util.DamageSource; import net.minecraft.util.DamageSource;
import net.minecraft.entity.EntityLivingBase; import net.minecraft.entity.EntityLivingBase;
@ -7,9 +11,9 @@ import net.minecraft.entity.EntityLivingBase;
/** /**
* LivingDeathEvent is fired when an Entity dies. <br> * LivingDeathEvent is fired when an Entity dies. <br>
* This event is fired whenever an Entity dies in * This event is fired whenever an Entity dies in
* EntityLivingBase#onDeath(DamageSource), * {@link EntityLivingBase#onDeath(DamageSource)},
* EntityPlayer#onDeath(DamageSource), and * {@link EntityPlayer#onDeath(DamageSource)}, and
* EntityPlayerMP#onDeath(DamageSource). <br> * {@link EntityPlayerMP#onDeath(DamageSource)}. <br>
* <br> * <br>
* This event is fired via the {@link ForgeHooks#onLivingDeath(EntityLivingBase, DamageSource)}.<br> * This event is fired via the {@link ForgeHooks#onLivingDeath(EntityLivingBase, DamageSource)}.<br>
* <br> * <br>

View file

@ -1,7 +1,10 @@
package net.minecraftforge.event.entity.living; package net.minecraftforge.event.entity.living;
import java.util.ArrayList;
import java.util.List; import java.util.List;
import net.minecraftforge.common.ForgeHooks;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.util.DamageSource; import net.minecraft.util.DamageSource;
import net.minecraft.entity.item.EntityItem; 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.<br> * LivingDropsEvent is fired when an Entity's death causes dropped items to appear.<br>
* This event is fired whenever an Entity dies and drops items in * This event is fired whenever an Entity dies and drops items in
* EntityLivingBase#onDeath(DamageSource).<br> * {@link EntityLivingBase#onDeath(DamageSource)}.<br>
* <br> * <br>
* This event is fired via the {@link ForgeHooks#onLivingDrops(EntityLivingBase, DamageSource, ArrayList<EntityItem>, int, boolean, int)}.<br> * This event is fired via the {@link ForgeHooks#onLivingDrops(EntityLivingBase, DamageSource, ArrayList, int, boolean)}.<br>
* <br> * <br>
* {@link #source} contains the DamageSource that caused the drop to occur.<br> * {@link #source} contains the DamageSource that caused the drop to occur.<br>
* {@link #drops} contains the ArrayList of EntityItems that will be dropped.<br> * {@link #drops} contains the ArrayList of EntityItems that will be dropped.<br>

View file

@ -1,7 +1,12 @@
package net.minecraftforge.event.entity.living; package net.minecraftforge.event.entity.living;
import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event;
import net.minecraft.entity.EntityLivingBase; 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; import net.minecraftforge.event.entity.EntityEvent;
/** /**
@ -28,7 +33,7 @@ public class LivingEvent extends EntityEvent
/** /**
* LivingUpdateEvent is fired when an Entity is updated. <br> * LivingUpdateEvent is fired when an Entity is updated. <br>
* This event is fired whenever an Entity is updated in * This event is fired whenever an Entity is updated in
* EntityLivingBase#onUpdate(). <br> * {@link EntityLivingBase#onUpdate()}. <br>
* <br> * <br>
* This event is fired via the {@link ForgeHooks#onLivingUpdate(EntityLivingBase)}.<br> * This event is fired via the {@link ForgeHooks#onLivingUpdate(EntityLivingBase)}.<br>
* <br> * <br>
@ -48,8 +53,8 @@ public class LivingEvent extends EntityEvent
/** /**
* LivingJumpEvent is fired when an Entity jumps.<br> * LivingJumpEvent is fired when an Entity jumps.<br>
* This event is fired whenever an Entity jumps in * This event is fired whenever an Entity jumps in
* EntityLivingBase#jump(), EntityMagmaCube#jump(), * {@link EntityLivingBase#jump()}, {@link EntityMagmaCube#jump()},
* and EntityHorse#jump().<br> * and {@link EntityHorse#jump()}.<br>
* <br> * <br>
* This event is fired via the {@link ForgeHooks#onLivingJump(EntityLivingBase)}.<br> * This event is fired via the {@link ForgeHooks#onLivingJump(EntityLivingBase)}.<br>
* <br> * <br>

View file

@ -1,14 +1,16 @@
package net.minecraftforge.event.entity.living; 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.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.entity.EntityLivingBase; import net.minecraft.entity.EntityLivingBase;
/** /**
* LivingFallEvent is fired when an Entity is set to be falling.<br> * LivingFallEvent is fired when an Entity is set to be falling.<br>
* This event is fired whenever an Entity is set to fall in * This event is fired whenever an Entity is set to fall in
* EntityLivingBase#fall(float).<br> * {@link EntityLivingBase#fall(float, float)}.<br>
* <br> * <br>
* This event is fired via the {@link ForgeHooks#onLivingFall(EntityLivingBase, float)}.<br> * This event is fired via the {@link ForgeHooks#onLivingFall(EntityLivingBase, float, float)}.<br>
* <br> * <br>
* {@link #distance} contains the distance the Entity is to fall. If this event is canceled, this value is set to 0.0F. * {@link #distance} contains the distance the Entity is to fall. If this event is canceled, this value is set to 0.0F.
* <br> * <br>

View file

@ -1,13 +1,15 @@
package net.minecraftforge.event.entity.living; 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.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.entity.EntityLivingBase; import net.minecraft.entity.EntityLivingBase;
/** /**
* LivingHealEvent is fired when an Entity is set to be healed. <br> * LivingHealEvent is fired when an Entity is set to be healed. <br>
* This event is fired whenever an Entity is healed in EntityLivingBase#heal(float)<br> * This event is fired whenever an Entity is healed in {@link EntityLivingBase#heal(float)}<br>
* <br> * <br>
* This event is fired via the {@link ForgeHooks#onLivingHeal(EntityLivingBase, float)}.<br> * This event is fired via the {@link ForgeEventFactory#onLivingHeal(EntityLivingBase, float)}.<br>
* <br> * <br>
* {@link #amount} contains the amount of healing done to the Entity that was healed. <br> * {@link #amount} contains the amount of healing done to the Entity that was healed. <br>
* <br> * <br>

View file

@ -1,5 +1,8 @@
package net.minecraftforge.event.entity.living; 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.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.util.DamageSource; import net.minecraft.util.DamageSource;
import net.minecraft.entity.EntityLivingBase; 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. <br> * LivingHurtEvent is fired when an Entity is set to be hurt. <br>
* This event is fired whenever an Entity is hurt in * This event is fired whenever an Entity is hurt in
* EntityLivingBase#damageEntity(DamageSource, float) and * {@link EntityLivingBase#damageEntity(DamageSource, float)} and
* EntityPlayer#damageEntity(DamageSource, float).<br> * {@link EntityPlayer#damageEntity(DamageSource, float)}.<br>
* <br> * <br>
* This event is fired via the {@link ForgeHooks#onLivingHurt(EntityLivingBase, DamageSource, float)}.<br> * This event is fired via the {@link ForgeHooks#onLivingHurt(EntityLivingBase, DamageSource, float)}.<br>
* <br> * <br>

View file

@ -1,12 +1,16 @@
package net.minecraftforge.event.entity.living; package net.minecraftforge.event.entity.living;
import net.minecraft.entity.EntityLiving;
import net.minecraft.entity.EntityLivingBase; 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.<br> * LivingSetAttackTargetEvent is fired when an Entity sets a target to attack.<br>
* This event is fired whenever an Entity sets a target to attack in * This event is fired whenever an Entity sets a target to attack in
* EntityLiving#setAttackTarget(EntityLivingBase) and * {@link EntityLiving#setAttackTarget(EntityLivingBase)} and
* EntityLivingBase#setRevengeTarget(EntityLivingBase).<br> * {@link EntityLivingBase#setRevengeTarget(EntityLivingBase)}.<br>
* <br> * <br>
* This event is fired via the {@link ForgeHooks#onLivingSetAttackTarget(EntityLivingBase, EntityLivingBase)}.<br> * This event is fired via the {@link ForgeHooks#onLivingSetAttackTarget(EntityLivingBase, EntityLivingBase)}.<br>
* <br> * <br>

View file

@ -1,7 +1,11 @@
package net.minecraftforge.event.entity.living; 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.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event.HasResult; import net.minecraftforge.fml.common.eventhandler.Event;
import net.minecraft.entity.EntityLiving; import net.minecraft.entity.EntityLiving;
import net.minecraft.world.World; 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.<br> * SpecialSpawn is fired when an Entity is to be spawned from a mob spawner.<br>
* This event is fired whenever an Entity is spawned in a mob spawner in<br> * This event is fired whenever an Entity is spawned in a mob spawner in<br>
* SpawnerAnimals#findChunksForSpawning(WorldServer, boolean, boolean, boolean).<br> * {@link WorldEntitySpawner#findChunksForSpawning(WorldServer, boolean, boolean, boolean)}.<br>
* <br> * <br>
* This event is fired via the {@link ForgeHooks#doSpecialSpawn(EntityLiving, World, float, float, float)}.<br> * This event is fired via the {@link ForgeEventFactory#doSpecialSpawn(EntityLiving, World, float, float, float)}.<br>
* <br> * <br>
* This event is {@link Cancelable}.<br> * This event is {@link Cancelable}.<br>
* If this event is canceled, the Entity is not spawned.<br> * If this event is canceled, the Entity is not spawned.<br>

View file

@ -2,8 +2,14 @@ package net.minecraftforge.event.entity.living;
import net.minecraft.entity.EntityLivingBase; import net.minecraft.entity.EntityLivingBase;
import net.minecraft.entity.monster.EntityZombie; import net.minecraft.entity.monster.EntityZombie;
import net.minecraft.util.DamageSource;
import net.minecraft.world.World; 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.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. * 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. * SummonAidEvent is fired when a Zombie Entity is summoned.
* This event is fired whenever a Zombie Entity is summoned in * 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 #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. * {@link #world} contains the world that this summoning is occurring in.

View file

@ -2,11 +2,13 @@ package net.minecraftforge.event.entity.minecart;
import net.minecraft.entity.Entity; import net.minecraft.entity.Entity;
import net.minecraft.entity.item.EntityMinecart; 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. * MinecartCollisionEvent is fired when a minecart collides with an Entity.
* This event is fired whenever a minecraft collides in * 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. * {@link #collider} contains the Entity the Minecart collided with.
* *

View file

@ -1,7 +1,9 @@
package net.minecraftforge.event.entity.minecart; package net.minecraftforge.event.entity.minecart;
import net.minecraft.entity.item.EntityMinecart; import net.minecraft.entity.item.EntityMinecart;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.entity.EntityEvent; import net.minecraftforge.event.entity.EntityEvent;
import net.minecraftforge.fml.common.eventhandler.Event;
/** /**
* MinecartEvent is fired whenever an event involving minecart entities occurs. <br> * MinecartEvent is fired whenever an event involving minecart entities occurs. <br>

View file

@ -1,5 +1,10 @@
package net.minecraftforge.event.entity.minecart; 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.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.entity.item.EntityMinecart; import net.minecraft.entity.item.EntityMinecart;
import net.minecraft.entity.player.EntityPlayer; 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. <br> * MinecartInteractEvent is fired when a player interacts with a minecart. <br>
* This event is fired whenever a player interacts with a minecart in * This event is fired whenever a player interacts with a minecart in
* EntityMinecartContainer#interactFirst(EntityPlayer), * {@link EntityMinecartContainer#processInitialInteract(EntityPlayer, ItemStack, EnumHand)},
* EntityMinecartEmpty#interactFirst(EntityPlayer) * {@link EntityMinecartEmpty#processInitialInteract(EntityPlayer, ItemStack, EnumHand)},
* EntityMinecartFurnace#interactFirst(EntityPlayer) * {@link EntityMinecartFurnace#processInitialInteract(EntityPlayer, ItemStack, EnumHand)},
* EntityMinecartHopper#interactFirst(EntityPlayer).<br> * {@link EntityMinecartHopper#processInitialInteract(EntityPlayer, ItemStack, EnumHand)},
* etc.<br>
* <br> * <br>
* {@link #player} contains the EntityPlayer that is involved with this minecart interaction.<br> * {@link #player} contains the EntityPlayer that is involved with this minecart interaction.<br>
* <br> * <br>

View file

@ -2,11 +2,13 @@ package net.minecraftforge.event.entity.minecart;
import net.minecraft.entity.item.EntityMinecart; import net.minecraft.entity.item.EntityMinecart;
import net.minecraft.util.math.BlockPos; 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.<br> * MinecartUpdateEvent is fired when a minecart is updated.<br>
* This event is fired whenever a minecart is updated in * This event is fired whenever a minecart is updated in
* EntityMinecart#onUpdate().<br> * {@link EntityMinecart#onUpdate()}.<br>
* <br> * <br>
* {@link #pos} contains the coordinate of the track the entity is on {if applicable}.<br> * {@link #pos} contains the coordinate of the track the entity is on {if applicable}.<br>
* <br> * <br>

View file

@ -1,5 +1,8 @@
package net.minecraftforge.event.entity.player; 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.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.entity.player.EntityPlayer; import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.item.ItemStack; import net.minecraft.item.ItemStack;
@ -8,7 +11,7 @@ import net.minecraft.world.World;
/** /**
* ArrowLooseEvent is fired when a player stops using a bow.<br> * ArrowLooseEvent is fired when a player stops using a bow.<br>
* This event is fired whenever a player stops using a bow in * This event is fired whenever a player stops using a bow in
* ItemBow#onPlayerStoppedUsing(ItemStack, World, EntityPlayer, int).<br> * {@link ItemBow#onPlayerStoppedUsing(ItemStack, World, EntityLivingBase, int)}.<br>
* <br> * <br>
* {@link #bow} contains the ItemBow ItemStack that was used in this event.<br> * {@link #bow} contains the ItemBow ItemStack that was used in this event.<br>
* {@link #charge} contains the value for how much the player had charged before stopping the shot.<br> * {@link #charge} contains the value for how much the player had charged before stopping the shot.<br>

View file

@ -1,15 +1,17 @@
package net.minecraftforge.event.entity.player; package net.minecraftforge.event.entity.player;
import net.minecraft.entity.player.EntityPlayer; import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.item.ItemBow;
import net.minecraft.item.ItemStack; import net.minecraft.item.ItemStack;
import net.minecraft.util.ActionResult; import net.minecraft.util.ActionResult;
import net.minecraft.util.EnumHand; import net.minecraft.util.EnumHand;
import net.minecraft.world.World; import net.minecraft.world.World;
import net.minecraftforge.common.MinecraftForge;
/** /**
* ArrowNockEvent is fired when a player begins using a bow.<br> * ArrowNockEvent is fired when a player begins using a bow.<br>
* This event is fired whenever a player begins using a bow in * This event is fired whenever a player begins using a bow in
* ItemBow#onItemRightClick(ItemStack, World, EntityPlayer).<br> * {@link ItemBow#onItemRightClick(ItemStack, World, EntityPlayer, EnumHand)}.<br>
* <br> * <br>
* This event is fired on the {@link MinecraftForge#EVENT_BUS}. * This event is fired on the {@link MinecraftForge#EVENT_BUS}.
**/ **/

View file

@ -1,5 +1,6 @@
package net.minecraftforge.event.entity.player; package net.minecraftforge.event.entity.player;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.entity.Entity; import net.minecraft.entity.Entity;
import net.minecraft.entity.player.EntityPlayer; 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.<br> * AttackEntityEvent is fired when a player attacks an Entity.<br>
* This event is fired whenever a player attacks an Entity in * This event is fired whenever a player attacks an Entity in
* EntityPlayer#attackTargetEntityWithCurrentItem(Entity).<br> * {@link EntityPlayer#attackTargetEntityWithCurrentItem(Entity)}.<br>
* <br> * <br>
* {@link #target} contains the Entity that was damaged by the player. <br> * {@link #target} contains the Entity that was damaged by the player. <br>
* <br> * <br>

View file

@ -1,5 +1,19 @@
package net.minecraftforge.event.entity.player; 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.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.entity.player.EntityPlayer; import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.item.ItemStack; import net.minecraft.item.ItemStack;
@ -8,12 +22,13 @@ import net.minecraft.util.EnumHand;
/** /**
* PlayerDestroyItemEvent is fired when a player destroys an item.<br> * PlayerDestroyItemEvent is fired when a player destroys an item.<br>
* This event is fired whenever a player destroys an item in * This event is fired whenever a player destroys an item in
* PlayerControllerMP#onPlayerRightClick(EntityPlayer, World, ItemStack, int, int, int, int, Vec3), * {@link PlayerControllerMP#processRightClick(EntityPlayer, World, ItemStack, EnumHand)},
* PlayerControllerMP#sendUseItem(EntityPlayer, World, ItemStack), * {@link PlayerControllerMP#processRightClickBlock(EntityPlayerSP, WorldClient, ItemStack, BlockPos, EnumFacing, Vec3d, EnumHand)},
* EntityPlayer#destroyCurrentEquippedItem(), * {@link EntityPlayer#damageShield(float)},
* SlotCrafting#onPickupFromSlot(EntityPlayer, ItemStack), * {@link ForgeHooks#getContainerItem(ItemStack)},
* ItemInWorldManager#tryUseItem(EntityPlayer, World, ItemStack), * {@link PlayerInteractionManager#processRightClick(EntityPlayer, World, ItemStack, EnumHand)},
* and ItemInWorldManager#activateBlockOrUseItem(EntityPlayer, World, ItemStack, int, int, int, int, float, float, float).<br> * {@link NetHandlerPlayServer#processPlayerBlockPlacement(CPacketPlayerBlockPlacement)}
* and {@link NetHandlerPlayServer#processRightClickBlock(CPacketPlayerTryUseItem)}.<br>
* <br> * <br>
* {@link #original} contains the original ItemStack before the item was destroyed. <br> * {@link #original} contains the original ItemStack before the item was destroyed. <br>
* (@link #hand) contains the hand that the current item was held in.<br> * (@link #hand) contains the hand that the current item was held in.<br>
@ -22,6 +37,7 @@ import net.minecraft.util.EnumHand;
* <br> * <br>
* This event does not have a result. {@link HasResult}<br> * This event does not have a result. {@link HasResult}<br>
* <br> * <br>
* This event is fired from {@link ForgeEventFactory#onPlayerDestroyItem(EntityPlayer, ItemStack, EnumHand)}.<br>
* This event is fired on the {@link MinecraftForge#EVENT_BUS}. * This event is fired on the {@link MinecraftForge#EVENT_BUS}.
**/ **/
public class PlayerDestroyItemEvent extends PlayerEvent public class PlayerDestroyItemEvent extends PlayerEvent

View file

@ -1,6 +1,9 @@
package net.minecraftforge.event.entity.player; package net.minecraftforge.event.entity.player;
import java.io.File; import java.io.File;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.ForgeEventFactory;
import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraft.block.Block; import net.minecraft.block.Block;
import net.minecraft.block.state.IBlockState; import net.minecraft.block.state.IBlockState;
@ -8,6 +11,7 @@ import net.minecraft.entity.Entity;
import net.minecraft.entity.player.EntityPlayer; import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.util.math.BlockPos; import net.minecraft.util.math.BlockPos;
import net.minecraftforge.event.entity.living.LivingEvent; import net.minecraftforge.event.entity.living.LivingEvent;
import net.minecraftforge.fml.common.eventhandler.Event;
/** /**
* PlayerEvent is fired whenever an event involving Living entities occurs. <br> * PlayerEvent is fired whenever an event involving Living entities occurs. <br>
@ -33,11 +37,11 @@ public class PlayerEvent extends LivingEvent
/** /**
* HarvestCheck is fired when a player attempts to harvest a block.<br> * HarvestCheck is fired when a player attempts to harvest a block.<br>
* This event is fired whenever a player attempts to harvest a block in * This event is fired whenever a player attempts to harvest a block in
* EntityPlayer#canHarvestBlock(Block).<br> * {@link EntityPlayer#canHarvestBlock(IBlockState)}.<br>
* <br> * <br>
* This event is fired via the {@link ForgeEventFactory#doPlayerHarvestCheck(EntityPlayer, Block, boolean)}.<br> * This event is fired via the {@link ForgeEventFactory#doPlayerHarvestCheck(EntityPlayer, IBlockState, boolean)}.<br>
* <br> * <br>
* {@link #block} contains the Block that is being checked for harvesting. <br> * {@link #state} contains the {@link IBlockState} that is being checked for harvesting. <br>
* {@link #success} contains the boolean value for whether the Block will be successfully harvested. <br> * {@link #success} contains the boolean value for whether the Block will be successfully harvested. <br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
@ -66,7 +70,7 @@ public class PlayerEvent extends LivingEvent
/** /**
* BreakSpeed is fired when a player attempts to harvest a block.<br> * BreakSpeed is fired when a player attempts to harvest a block.<br>
* This event is fired whenever a player attempts to harvest a block in * This event is fired whenever a player attempts to harvest a block in
* EntityPlayer#canHarvestBlock(Block).<br> * {@link EntityPlayer#canHarvestBlock(IBlockState)}.<br>
* <br> * <br>
* This event is fired via the {@link ForgeEventFactory#getBreakSpeed(EntityPlayer, IBlockState, float, BlockPos)}.<br> * This event is fired via the {@link ForgeEventFactory#getBreakSpeed(EntityPlayer, IBlockState, float, BlockPos)}.<br>
* <br> * <br>
@ -109,7 +113,7 @@ public class PlayerEvent extends LivingEvent
/** /**
* NameFormat is fired when a player's display name is retrieved.<br> * NameFormat is fired when a player's display name is retrieved.<br>
* This event is fired whenever a player's name is retrieved in * This event is fired whenever a player's name is retrieved in
* EntityPlayer#getDisplayName() or EntityPlayer#refreshDisplayName().<br> * {@link EntityPlayer#getDisplayName()} or {@link EntityPlayer#refreshDisplayName()}.<br>
* <br> * <br>
* This event is fired via the {@link ForgeEventFactory#getPlayerDisplayName(EntityPlayer, String)}.<br> * This event is fired via the {@link ForgeEventFactory#getPlayerDisplayName(EntityPlayer, String)}.<br>
* <br> * <br>

View file

@ -3,12 +3,14 @@ package net.minecraftforge.event.entity.player;
import net.minecraft.entity.player.EntityPlayer; import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.entity.player.EntityPlayer.EnumStatus; import net.minecraft.entity.player.EntityPlayer.EnumStatus;
import net.minecraft.util.math.BlockPos; 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. * PlayerSleepInBedEvent is fired when a player sleeps in a bed.
* <br> * <br>
* This event is fired whenever a player sleeps in a bed in * This event is fired whenever a player sleeps in a bed in
* EntityPlayer#sleepInBedAt(BlockPos).<br> * {@link EntityPlayer#trySleep(BlockPos)}.<br>
* <br> * <br>
* {@link #result} contains whether the player is able to sleep. <br> * {@link #result} contains whether the player is able to sleep. <br>
* <br> * <br>

View file

@ -1,7 +1,11 @@
package net.minecraftforge.event.entity.player; 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.entity.player.EntityPlayer;
import net.minecraft.util.math.BlockPos; import net.minecraft.util.math.BlockPos;
import net.minecraft.world.IBlockAccess;
import net.minecraftforge.fml.common.eventhandler.Event.HasResult; 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}<br> * This event has a result. {@link HasResult}<br>
* *
* setResult(ALLOW) informs game that player is still "in bed"<br> * setResult(ALLOW) informs game that player is still "in bed"<br>
* 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 @HasResult
public class SleepingLocationCheckEvent extends PlayerEvent public class SleepingLocationCheckEvent extends PlayerEvent

View file

@ -1,5 +1,7 @@
package net.minecraftforge.event.terraingen; 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.minecraftforge.fml.common.eventhandler.Event;
import net.minecraft.block.state.IBlockState; import net.minecraft.block.state.IBlockState;
import net.minecraft.world.biome.BiomeDecorator; import net.minecraft.world.biome.BiomeDecorator;
@ -29,7 +31,7 @@ public class BiomeEvent extends Event
/** /**
* CreateDecorator is fired when a BiomeDecorator is created.<br> * CreateDecorator is fired when a BiomeDecorator is created.<br>
* This event is fired whenever a BiomeDecorator is created in * This event is fired whenever a BiomeDecorator is created in
* DeferredBiomeDecorator#fireCreateEventAndReplace(BiomeGenBase).<br> * {@link DeferredBiomeDecorator#fireCreateEventAndReplace(BiomeGenBase)}.<br>
* <br> * <br>
* {@link #originalBiomeDecorator} contains the original BiomeDecorator that would be used in vanilla. * {@link #originalBiomeDecorator} contains the original BiomeDecorator that would be used in vanilla.
* {@link #newBiomeDecorator} contains the new BiomeDecoration to be used by Minecraft. * {@link #newBiomeDecorator} contains the new BiomeDecoration to be used by Minecraft.

View file

@ -1,6 +1,10 @@
package net.minecraftforge.event.terraingen; package net.minecraftforge.event.terraingen;
import java.util.Random; 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;
import net.minecraftforge.fml.common.eventhandler.Event.HasResult; import net.minecraftforge.fml.common.eventhandler.Event.HasResult;
import net.minecraft.util.math.BlockPos; import net.minecraft.util.math.BlockPos;
@ -9,7 +13,7 @@ import net.minecraft.world.World;
/**DecorateBiomeEvent is fired when a BiomeDecorator is created. /**DecorateBiomeEvent is fired when a BiomeDecorator is created.
* <br> * <br>
* This event is fired whenever a BiomeDecorator is created in * This event is fired whenever a BiomeDecorator is created in
* DeferredBiomeDecorator#fireCreateEventAndReplace(BiomeGenBase).<br> * {@link DeferredBiomeDecorator#fireCreateEventAndReplace(BiomeGenBase)}.<br>
* <br> * <br>
* {@link #world} contains the world that is being decorated. <br> * {@link #world} contains the world that is being decorated. <br>
* {@link #rand} contains an instance of Random to be used. <br> * {@link #rand} contains an instance of Random to be used. <br>

View file

@ -1,6 +1,10 @@
package net.minecraftforge.event.terraingen; package net.minecraftforge.event.terraingen;
import java.util.Random; 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;
import net.minecraftforge.fml.common.eventhandler.Event.HasResult; import net.minecraftforge.fml.common.eventhandler.Event.HasResult;
import net.minecraft.util.math.BlockPos; 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.<br> * OreGenEvent.Pre is fired just before a chunk is populated with ores.<br>
* This event is fired just before ore generation in * This event is fired just before ore generation in
* BiomeDecorator#generateOres().<br> * {@link BiomeDecorator#generateOres(World, Random)}.<br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>
@ -68,7 +72,7 @@ public class OreGenEvent extends Event
/** /**
* OreGenEvent.Post is fired just after a chunk is populated with ores.<br> * OreGenEvent.Post is fired just after a chunk is populated with ores.<br>
* This event is fired just after ore generation in * This event is fired just after ore generation in
* BiomeDecorator#generateOres().<br> * {@link BiomeDecorator#generateOres(World, Random)}.<br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>
@ -87,7 +91,7 @@ public class OreGenEvent extends Event
/** /**
* GenerateMinable is fired when a mineable block is generated in a chunk.<br> * GenerateMinable is fired when a mineable block is generated in a chunk.<br>
* This event is fired just after ore generation in * This event is fired just after ore generation in
* BiomeDecorator#generateOres().<br> * {@link BiomeDecorator#generateOres(World, Random)}.<br>
* <br> * <br>
* {@link #type} contains the enum value for the Ore attempting to be generated.<br> * {@link #type} contains the enum value for the Ore attempting to be generated.<br>
* {@link #generator} contains the WorldGenerator generating this ore. <br> * {@link #generator} contains the WorldGenerator generating this ore. <br>

View file

@ -4,6 +4,9 @@ import java.util.Random;
import net.minecraft.world.World; import net.minecraft.world.World;
import net.minecraft.world.chunk.IChunkGenerator; 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.common.MinecraftForge;
import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event; 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.<br> * PopulateChunkEvent.Pre is fired just before a chunk is populated a terrain feature.<br>
* This event is fired just before terrain feature generation in * This event is fired just before terrain feature generation in
* ChunkProviderEnd#populate(IChunkProvider, int, int), * {@link ChunkProviderEnd#populate(int, int)},
* ChunkProviderGenerate#populate(IChunkProvider, int, int), * {@link ChunkProviderOverworld#populate(int, int)},
* and ChunkProviderHell#populate(IChunkProvider, int, int). <br> * and {@link ChunkProviderHell#populate(int, int)}. <br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>
@ -68,9 +71,9 @@ public class PopulateChunkEvent extends ChunkGeneratorEvent
/** /**
* PopulateChunkEvent.Post is fired just after a chunk is populated with a terrain feature.<br> * PopulateChunkEvent.Post is fired just after a chunk is populated with a terrain feature.<br>
* This event is fired just after terrain feature generation in * This event is fired just after terrain feature generation in
* ChunkProviderEnd#populate(IChunkProvider, int, int), * {@link ChunkProviderEnd#populate(int, int)},
* ChunkProviderGenerate#populate(IChunkProvider, int, int), * {@link ChunkProviderOverworld#populate(int, int)},
* and ChunkProviderHell#populate(IChunkProvider, int, int). <br> * and {@link ChunkProviderHell#populate(int, int)}. <br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>
@ -89,9 +92,9 @@ public class PopulateChunkEvent extends ChunkGeneratorEvent
/** /**
* PopulateChunkEvent.Populate is fired when a chunk is populated with a terrain feature.<br> * PopulateChunkEvent.Populate is fired when a chunk is populated with a terrain feature.<br>
* This event is fired during terrain feature generation in * This event is fired during terrain feature generation in
* ChunkProviderEnd#populate(IChunkProvider, int, int), * {@link ChunkProviderEnd#populate(int, int)},
* ChunkProviderGenerate#populate(IChunkProvider, int, int), * {@link ChunkProviderOverworld#populate(int, int)},
* and ChunkProviderHell#populate(IChunkProvider, int, int). <br> * and {@link ChunkProviderHell#populate(int, int)}. <br>
* <br> * <br>
* {@link #type} contains the enum value for the terrain feature being generated. <br> * {@link #type} contains the enum value for the terrain feature being generated. <br>
* <br> * <br>

View file

@ -1,6 +1,11 @@
package net.minecraftforge.event.terraingen; package net.minecraftforge.event.terraingen;
import java.util.Random; 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.minecraftforge.fml.common.eventhandler.Event.HasResult;
import net.minecraft.util.math.BlockPos; import net.minecraft.util.math.BlockPos;
import net.minecraft.world.World; 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.<br> * SaplingGrowTreeEvent is fired when a sapling grows into a tree.<br>
* This event is fired during sapling growth in * This event is fired during sapling growth in
* BlockSapling#func_149878_d(World, BlockPos, Random).<br> * {@link BlockSapling#generateTree(World, BlockPos, IBlockState, Random)}.<br>
* <br> * <br>
* {@link #pos} contains the coordinates of the growing sapling. <br> * {@link #pos} contains the coordinates of the growing sapling. <br>
* {@link #rand} contains an instance of Random for use. <br> * {@link #rand} contains an instance of Random for use. <br>

View file

@ -1,5 +1,8 @@
package net.minecraftforge.event.terraingen; 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.minecraftforge.fml.common.eventhandler.Event;
import net.minecraft.world.gen.layer.GenLayer; import net.minecraft.world.gen.layer.GenLayer;
import net.minecraft.world.WorldType; import net.minecraft.world.WorldType;
@ -30,7 +33,7 @@ public class WorldTypeEvent extends Event
/** /**
* BiomeSize is fired when vanilla Minecraft attempts to generate biomes.<br> * BiomeSize is fired when vanilla Minecraft attempts to generate biomes.<br>
* This event is fired during biome generation in * This event is fired during biome generation in
* GenLayer#initializeAllBiomeGenerators(long, WorldType). <br> * {@link GenLayer#initializeAllBiomeGenerators(long, WorldType, String)}. <br>
* <br> * <br>
* {@link #originalSize} the original size of the Biome. <br> * {@link #originalSize} the original size of the Biome. <br>
* {@link #newSize} the new size of the biome. Initially set to the {@link #originalSize}. <br> * {@link #newSize} the new size of the biome. Initially set to the {@link #originalSize}. <br>
@ -71,9 +74,9 @@ public class WorldTypeEvent extends Event
} }
/** /**
* InitBiomeGens is fired when vanilla Minecraft attempts to initialize the biome generators.<br> * InitBiomeGens is fired when vanilla Minecraft attempts to initialize the biome providers.<br>
* This event is fired just during biome generator initialization in * This event is fired just during biome provider initialization in
* WorldChunkManager#WorldChunkManager(long, WorldType). <br> * {@link BiomeProvider#BiomeProvider(long, WorldType, String)}. <br>
* <br> * <br>
* {@link #seed} the seed of the world. <br> * {@link #seed} the seed of the world. <br>
* {@link #originalBiomeGens} the array of GenLayers original intended for this Biome generation. <br> * {@link #originalBiomeGens} the array of GenLayers original intended for this Biome generation. <br>

View file

@ -1,7 +1,12 @@
package net.minecraftforge.event.world; package net.minecraftforge.event.world;
import net.minecraft.world.World;
import net.minecraft.world.chunk.Chunk; import net.minecraft.world.chunk.Chunk;
import net.minecraft.nbt.NBTTagCompound; 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.<br> * ChunkDataEvent is fired when an event involving chunk data occurs.<br>
@ -30,7 +35,7 @@ public class ChunkDataEvent extends ChunkEvent
/** /**
* ChunkDataEvent.Load is fired when vanilla Minecraft attempts to load Chunk data.<br> * ChunkDataEvent.Load is fired when vanilla Minecraft attempts to load Chunk data.<br>
* This event is fired during chunk loading in * This event is fired during chunk loading in
* ChunkIOProvider#callStage2(QueuedChunk, Chunk). <br> * {@link net.minecraftforge.common.chunkio.ChunkIOProvider#syncCallback()}.<br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>
@ -49,7 +54,7 @@ public class ChunkDataEvent extends ChunkEvent
/** /**
* ChunkDataEvent.Save is fired when vanilla Minecraft attempts to save Chunk data.<br> * ChunkDataEvent.Save is fired when vanilla Minecraft attempts to save Chunk data.<br>
* This event is fired during chunk saving in * This event is fired during chunk saving in
* AnvilChunkLoader#saveChunk(World, Chunk). <br> * {@link AnvilChunkLoader#saveChunk(World, Chunk)}. <br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>

View file

@ -1,6 +1,10 @@
package net.minecraftforge.event.world; package net.minecraftforge.event.world;
import net.minecraft.client.multiplayer.ChunkProviderClient;
import net.minecraft.world.chunk.Chunk; 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.<br> * ChunkEvent is fired when an event involving a chunk occurs.<br>
@ -29,7 +33,7 @@ public class ChunkEvent extends WorldEvent
/** /**
* ChunkEvent.Load is fired when vanilla Minecraft attempts to load a Chunk into the world.<br> * ChunkEvent.Load is fired when vanilla Minecraft attempts to load a Chunk into the world.<br>
* This event is fired during chunk loading in <br> * This event is fired during chunk loading in <br>
* ChunkProviderClient#loadChunk(int, int), <br> * {@link ChunkProviderClient#loadChunk(int, int)}, <br>
* Chunk.onChunkLoad(). <br> * Chunk.onChunkLoad(). <br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>

View file

@ -1,5 +1,8 @@
package net.minecraftforge.event.world; 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.minecraftforge.fml.common.eventhandler.Event;
import net.minecraft.world.ChunkCoordIntPair; import net.minecraft.world.ChunkCoordIntPair;
import net.minecraft.entity.player.EntityPlayerMP; 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.<br> * ChunkWatchEvent.Watch is fired when an EntityPlayer begins watching a chunk.<br>
* This event is fired when a chunk is added to the watched chunks of an EntityPlayer in * This event is fired when a chunk is added to the watched chunks of an EntityPlayer in
* EntityPlayerMP#onUpdate(). <br> * {@link EntityPlayerMP#onUpdate()}. <br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>
@ -54,7 +57,7 @@ public class ChunkWatchEvent extends Event
/** /**
* ChunkWatchEvent.UnWatch is fired when an EntityPlayer stops watching a chunk.<br> * ChunkWatchEvent.UnWatch is fired when an EntityPlayer stops watching a chunk.<br>
* This event is fired when a chunk is removed from the watched chunks of an EntityPlayer in * This event is fired when a chunk is removed from the watched chunks of an EntityPlayer in
* PlayerInstance#removePlayer(EntityPlayerMP). <br> * {@link PlayerManager.PlayerInstance#removePlayer(EntityPlayerMP)}. <br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>

View file

@ -2,6 +2,7 @@ package net.minecraftforge.event.world;
import java.util.List; import java.util.List;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.fml.common.eventhandler.Cancelable; import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event; import net.minecraftforge.fml.common.eventhandler.Event;
import net.minecraft.entity.Entity; import net.minecraft.entity.Entity;

View file

@ -1,13 +1,27 @@
package net.minecraftforge.event.world; package net.minecraftforge.event.world;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Hashtable;
import java.util.List; 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.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.util.math.BlockPos;
import net.minecraft.world.EnumDifficulty;
import net.minecraft.world.World; import net.minecraft.world.World;
import net.minecraft.world.WorldServer;
import net.minecraft.world.WorldSettings; import net.minecraft.world.WorldSettings;
import net.minecraft.world.WorldType;
import net.minecraft.world.biome.BiomeGenBase.SpawnListEntry; 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.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event; 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.<br> * WorldEvent.Load is fired when Minecraft loads a world.<br>
* This event is fired when a world is loaded in * This event is fired when a world is loaded in
* WorldClient#WorldClient(NetHandlerPlayClient, WorldSettings, int, EnumDifficulty, Profiler), * {@link WorldClient#WorldClient(NetHandlerPlayClient, WorldSettings, int, EnumDifficulty, Profiler)},
* MinecraftServer#loadAllWorlds(String, String, long, WorldType, String), * {@link MinecraftServer#loadAllWorlds(String, String, long, WorldType, String)},
* DimensionManager#initDimension(int), * {@link IntegratedServer#loadAllWorlds(String, String, long, WorldType, String)}
* and ForgeInternalHandler#onDimensionLoad(Load). <br> * {@link DimensionManager#initDimension(int)},
* and {@link ForgeInternalHandler#onDimensionLoad(Load)}. <br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>
@ -56,11 +71,10 @@ public class WorldEvent extends Event
/** /**
* WorldEvent.Unload is fired when Minecraft unloads a world.<br> * WorldEvent.Unload is fired when Minecraft unloads a world.<br>
* This event is fired when a world is unloaded in * This event is fired when a world is unloaded in
* Minecraft#loadWorld(WorldClient, String), * {@link Minecraft#loadWorld(WorldClient, String)},
* MinecraftServer#deleteWorldAndStopServer(), * {@link MinecraftServer#stopServer()},
* MinecraftServer#stopServer(), * {@link DimensionManager#unloadWorlds(Hashtable)},
* DimensionManager#unloadWorlds(Hashtable<Integer, long[]>), * {@link ForgeInternalHandler#onDimensionUnload(Unload)}. <br>
* ForgeInternalHandler#onDimensionUnload(Unload). <br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>
@ -76,8 +90,8 @@ public class WorldEvent extends Event
/** /**
* WorldEvent.Save is fired when Minecraft saves a world.<br> * WorldEvent.Save is fired when Minecraft saves a world.<br>
* This event is fired when a world is saved in * This event is fired when a world is saved in
* WorldServer#saveAllChunks(boolean, IProgressUpdate), * {@link WorldServer#saveAllChunks(boolean, IProgressUpdate)},
* ForgeInternalHandler#onDimensionSave(Save). <br> * {@link ForgeInternalHandler#onDimensionSave(Save)}. <br>
* <br> * <br>
* This event is not {@link Cancelable}.<br> * This event is not {@link Cancelable}.<br>
* <br> * <br>
@ -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. * 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. * 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 * The event is called in {@link WorldServer#getSpawnListEntryForTypeAt(EnumCreatureType, BlockPos)} as well as
* WorldServer#canCreatureTypeSpawnHere(EnumCreatureType creatureType, BiomeGenBase.SpawnListEntry spawnListEntry, BlockPos pos) * {@link WorldServer#canCreatureTypeSpawnHere(EnumCreatureType, SpawnListEntry, BlockPos)}
* where the latter checks for identity, meaning both events must add the same instance. * 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. * Canceling the event will result in a empty list, meaning no entity will be spawned.
*/ */

View file

@ -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 * Check to see if a block can be drained. This method should be called by devices such as
* pumps. * pumps.
* *
* @param doDrain
* If false, the drain will only be simulated.
* @return * @return
*/ */
boolean canDrain(World world, BlockPos pos); boolean canDrain(World world, BlockPos pos);

View file

@ -48,7 +48,7 @@ public interface IFluidContainerItem
* ItemStack which is the fluid container. * ItemStack which is the fluid container.
* @param maxDrain * @param maxDrain
* Maximum amount of fluid to be removed from the container. * Maximum amount of fluid to be removed from the container.
* @param doFill * @param doDrain
* If false, the drain will only be simulated. * If false, the drain will only be simulated.
* @return Amount of fluid that was (or would have been, if simulated) drained from the * @return Amount of fluid that was (or would have been, if simulated) drained from the
* container. * container.

View file

@ -46,8 +46,8 @@ public interface IFluidTank
* *
* @param maxDrain * @param maxDrain
* Maximum amount of fluid to be removed from the container. * Maximum amount of fluid to be removed from the container.
* @param doFill * @param doDrain
* If false, the fill will only be simulated. * If false, the drain will only be simulated.
* @return Amount of fluid that was removed from the tank. * @return Amount of fluid that was removed from the tank.
*/ */
FluidStack drain(int maxDrain, boolean doDrain); FluidStack drain(int maxDrain, boolean doDrain);

View file

@ -1694,18 +1694,18 @@ public class GuiConfigEntries extends GuiListExtended
public boolean enabled(); 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. * objects that should receive the input provided.
*/ */
public void keyTyped(char eventChar, int eventKey); 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(); 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); public void mouseClicked(int x, int y, int mouseEvent);

View file

@ -31,14 +31,26 @@ public interface IConfigElement
public boolean isProperty(); public boolean isProperty();
/** /**
* This method returns a class that implements {@code IConfigEntry} or null. This class MUST * This method returns a class that implements {@link IConfigEntry} or null. This class MUST
* provide a constructor with the following parameter types: {@code GuiConfig}, {@code GuiConfigEntries}, {@code IConfigElement} * 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<? extends IConfigEntry> getConfigEntryClass(); public Class<? extends IConfigEntry> getConfigEntryClass();
/** /**
* This method returns a class that implements {@code IArrayEntry}. This class MUST provide a constructor with the * This method returns a class that implements {@link IArrayEntry}. This class MUST provide a constructor with the
* following parameter types: {@code GuiEditArray}, {@code GuiEditArrayEntries}, {@code IConfigElement}, {@code Object} * 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<? extends IArrayEntry> getArrayEntryClass(); public Class<? extends IArrayEntry> getArrayEntryClass();

View file

@ -49,9 +49,6 @@ public class RenderingRegistry
* Register an entity rendering handler. This will, after mod initialization, be inserted into the main * Register an entity rendering handler. This will, after mod initialization, be inserted into the main
* render map for entities. * render map for entities.
* Call this during Preinitialization phase. * Call this during Preinitialization phase.
*
* @param entityClass
* @param renderer
*/ */
public static <T extends Entity> void registerEntityRenderingHandler(Class<T> entityClass, IRenderFactory<? super T> renderFactory) public static <T extends Entity> void registerEntityRenderingHandler(Class<T> entityClass, IRenderFactory<? super T> renderFactory)
{ {

View file

@ -942,10 +942,12 @@ public class Loader
* Fire a FMLMissingMappingsEvent to let mods determine how blocks/items defined in the world * Fire a FMLMissingMappingsEvent to let mods determine how blocks/items defined in the world
* save, but missing from the runtime, are to be handled. * 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 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. * @param remapBlocks Returns a map containing the remapped block names and an array containing the original and new id for the block.
* @return List with the mapping results. * @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<String> fireMissingMappingEvent(Map<ResourceLocation, Integer> missingBlocks, Map<ResourceLocation, Integer> missingItems, boolean isLocalWorld, Map<ResourceLocation, Integer[]> remapBlocks, Map<ResourceLocation, Integer[]> remapItems) public List<String> fireMissingMappingEvent(Map<ResourceLocation, Integer> missingBlocks, Map<ResourceLocation, Integer> missingItems, boolean isLocalWorld, Map<ResourceLocation, Integer[]> remapBlocks, Map<ResourceLocation, Integer[]> remapItems)
{ {

View file

@ -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. * 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<String,String>} and {@link Side}. It should return a boolean * The method should have two parameters, of types Map<String,String> and {@link Side}. It should return a boolean
* true indicating that the remote party is acceptable, or false if not. * true indicating that the remote party is acceptable, or false if not.
* *
* <p> * <p>

View file

@ -110,7 +110,7 @@ public enum NetworkRegistry
* <ul> * <ul>
* <li> {@link #newSimpleChannel(String)} provides {@link SimpleNetworkWrapper}, a simple implementation of a netty handler, suitable for those who don't * <li> {@link #newSimpleChannel(String)} provides {@link SimpleNetworkWrapper}, a simple implementation of a netty handler, suitable for those who don't
* wish to dive too deeply into netty. * wish to dive too deeply into netty.
* <li> {@link #newEventChannel(String)} provides {@link FMLEventChannel} an event driven implementation, with lower level * <li> {@link #newEventDrivenChannel(String)} (String)} provides {@link FMLEventChannel} an event driven implementation, with lower level
* access to the network data stream, for those with advanced bitbanging needs that don't wish to poke netty too hard. * access to the network data stream, for those with advanced bitbanging needs that don't wish to poke netty too hard.
* <li> Alternatively, simply use the netty features provided here and implement the full power of the netty stack. * <li> Alternatively, simply use the netty features provided here and implement the full power of the netty stack.
* </ul> * </ul>
@ -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 * 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 * 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, * For the client to server channel (source side : CLIENT) this is fixed as "TOSERVER". For SERVER to CLIENT packets,
* several possible values exist. * several possible values exist.
* *
@ -132,7 +132,7 @@ public enum NetworkRegistry
* a utility codec, {@link FMLIndexedMessageToMessageCodec} that transforms from {@link FMLProxyPacket} to a mod * 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. * 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. * channels.
* *
* @param name * @param name
@ -258,7 +258,7 @@ public enum NetworkRegistry
* @param x X coord * @param x X coord
* @param y Y coord * @param y Y coord
* @param z Z 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) public Object getLocalGuiContainer(ModContainer mc, EntityPlayer player, int modGuiId, World world, int x, int y, int z)
{ {

View file

@ -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 * 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, byte, net.minecraftforge.fml.relauncher.Side)} * 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. * to register both the message type and it's associated handler.
* *
* @author cpw * @author cpw

View file

@ -16,6 +16,7 @@ import net.minecraft.network.INetHandler;
import net.minecraft.network.Packet; import net.minecraft.network.Packet;
import net.minecraft.tileentity.TileEntity; import net.minecraft.tileentity.TileEntity;
import net.minecraftforge.fml.common.FMLLog; 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.event.FMLPreInitializationEvent;
import net.minecraftforge.fml.common.network.FMLEmbeddedChannel; import net.minecraftforge.fml.common.network.FMLEmbeddedChannel;
import net.minecraftforge.fml.common.network.FMLOutboundHandler; import net.minecraftforge.fml.common.network.FMLOutboundHandler;
@ -32,7 +33,7 @@ import net.minecraftforge.fml.relauncher.Side;
* Usage is simple:<ul> * Usage is simple:<ul>
* <li>construct, and store, an instance of this class. It will automatically register and configure your underlying netty channel. * <li>construct, and store, an instance of this class. It will automatically register and configure your underlying netty channel.
* *
* <li>Then, call {@link #registerMessage(Class, Class, byte, Side)} for each message type you want to exchange * <li>Then, call {@link #registerMessage(Class, Class, int, Side)} for each message type you want to exchange
* providing an {@link IMessageHandler} implementation class as well as an {@link IMessage} implementation class. The side parameter * providing an {@link IMessageHandler} implementation class as well as an {@link IMessage} implementation class. The side parameter
* to that method indicates which side (server or client) the <em>message processing</em> will occur on. The discriminator byte * to that method indicates which side (server or client) the <em>message processing</em> will occur on. The discriminator byte
* should be unique for this channelName - it is used to discriminate between different types of message that might * should be unique for this channelName - it is used to discriminate between different types of message that might
@ -193,7 +194,7 @@ public class SimpleNetworkWrapper {
/** /**
* Construct a minecraft packet from the supplied message. Can be used where minecraft packets are required, such as * Construct a minecraft packet from the supplied message. Can be used where minecraft packets are required, such as
* {@link TileEntity#func_145844_m}. * {@link TileEntity#getDescriptionPacket()}.
* *
* @param message The message to translate into packet form * @param message The message to translate into packet form
* @return A minecraft {@link Packet} suitable for use in minecraft APIs * @return A minecraft {@link Packet} suitable for use in minecraft APIs

View file

@ -12,7 +12,7 @@ import net.minecraftforge.fml.common.registry.VillagerRegistry.VillagerProfessio
/** /**
* A class that exposes static references to all vanilla and Forge registries. * A class that exposes static references to all vanilla and Forge registries.
* Created to have a central place to access the registries directly if modders need. * Created to have a central place to access the registries directly if modders need.
* It is still advised that if you are registering things to go through {@link GameRegistry.register} but queries and iterations can use this. * It is still advised that if you are registering things to go through {@link GameRegistry} register methods, but queries and iterations can use this.
*/ */
public class ForgeRegistries public class ForgeRegistries
{ {

View file

@ -32,7 +32,7 @@ public interface IEntityAdditionalSpawnData
* Called by the client when it receives a Entity spawn packet. * Called by the client when it receives a Entity spawn packet.
* Data should be read out of the stream in the same way as it was written. * Data should be read out of the stream in the same way as it was written.
* *
* @param data The packet data stream * @param additionalData The packet data stream
*/ */
public void readSpawnData(ByteBuf additionalData); public void readSpawnData(ByteBuf additionalData);
} }

View file

@ -14,7 +14,7 @@ import com.google.common.base.Throwables;
/** /**
* Internal class used in tracking {@link ItemStackHolder} references * Internal class used in tracking {@link GameRegistry.ItemStackHolder} references
* *
* @author cpw * @author cpw
* *