From 0427ab89f1753a44b30cbc35ce021cbbdc845109 Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Thu, 10 Aug 2017 18:52:45 +0300 Subject: fix missing source folder --- .../classloading/FMLForgePlugin.html | 438 +++++ .../minecraftforge/classloading/package-frame.html | 19 + .../classloading/package-summary.html | 131 ++ .../minecraftforge/classloading/package-tree.html | 126 ++ .../client/ClientCommandHandler.html | 348 ++++ .../minecraftforge/client/EnumHelperClient.html | 319 ++++ .../minecraftforge/client/ForgeHooksClient.html | 663 +++++++ .../net/minecraftforge/client/GuiIngameForge.html | 796 ++++++++ .../client/IItemRenderer.ItemRenderType.html | 412 ++++ .../client/IItemRenderer.ItemRendererHelper.html | 382 ++++ .../net/minecraftforge/client/IItemRenderer.html | 281 +++ .../client/IRenderContextHandler.html | 223 +++ .../net/minecraftforge/client/IRenderHandler.html | 258 +++ .../client/MinecraftForgeClient.html | 338 ++++ .../client/event/ClientChatReceivedEvent.html | 289 +++ .../client/event/DrawBlockHighlightEvent.html | 364 ++++ .../event/EntityViewRenderEvent.FogColors.html | 352 ++++ .../event/EntityViewRenderEvent.FogDensity.html | 322 ++++ .../EntityViewRenderEvent.RenderFogEvent.html | 336 ++++ .../client/event/EntityViewRenderEvent.html | 365 ++++ .../client/event/FOVUpdateEvent.html | 319 ++++ .../minecraftforge/client/event/GuiOpenEvent.html | 292 +++ .../GuiScreenEvent.ActionPerformedEvent.Post.html | 309 +++ .../GuiScreenEvent.ActionPerformedEvent.Pre.html | 310 +++ .../event/GuiScreenEvent.ActionPerformedEvent.html | 359 ++++ .../event/GuiScreenEvent.DrawScreenEvent.Post.html | 310 +++ .../event/GuiScreenEvent.DrawScreenEvent.Pre.html | 311 +++ .../event/GuiScreenEvent.DrawScreenEvent.html | 376 ++++ .../event/GuiScreenEvent.InitGuiEvent.Post.html | 307 +++ .../event/GuiScreenEvent.InitGuiEvent.Pre.html | 312 +++ .../client/event/GuiScreenEvent.InitGuiEvent.html | 342 ++++ .../client/event/GuiScreenEvent.html | 316 ++++ .../minecraftforge/client/event/MouseEvent.html | 382 ++++ .../event/RenderBlockOverlayEvent.OverlayType.html | 333 ++++ .../client/event/RenderBlockOverlayEvent.html | 400 ++++ .../client/event/RenderGameOverlayEvent.Chat.html | 334 ++++ .../event/RenderGameOverlayEvent.ElementType.html | 501 +++++ .../client/event/RenderGameOverlayEvent.Post.html | 322 ++++ .../client/event/RenderGameOverlayEvent.Pre.html | 290 +++ .../client/event/RenderGameOverlayEvent.Text.html | 334 ++++ .../client/event/RenderGameOverlayEvent.html | 378 ++++ .../client/event/RenderHandEvent.html | 319 ++++ .../client/event/RenderItemInFrameEvent.html | 320 ++++ .../client/event/RenderLivingEvent.Post.html | 292 +++ .../client/event/RenderLivingEvent.Pre.html | 292 +++ .../event/RenderLivingEvent.Specials.Post.html | 304 +++ .../event/RenderLivingEvent.Specials.Pre.html | 304 +++ .../client/event/RenderLivingEvent.Specials.html | 311 +++ .../client/event/RenderLivingEvent.html | 372 ++++ .../client/event/RenderPlayerEvent.Post.html | 345 ++++ .../client/event/RenderPlayerEvent.Pre.html | 345 ++++ .../event/RenderPlayerEvent.SetArmorModel.html | 408 ++++ .../event/RenderPlayerEvent.Specials.Post.html | 357 ++++ .../event/RenderPlayerEvent.Specials.Pre.html | 411 ++++ .../client/event/RenderPlayerEvent.Specials.html | 364 ++++ .../client/event/RenderPlayerEvent.html | 390 ++++ .../client/event/RenderWorldEvent.Post.html | 291 +++ .../client/event/RenderWorldEvent.Pre.html | 292 +++ .../client/event/RenderWorldEvent.html | 357 ++++ .../client/event/RenderWorldLastEvent.html | 304 +++ .../client/event/TextureStitchEvent.Post.html | 287 +++ .../client/event/TextureStitchEvent.Pre.html | 287 +++ .../client/event/TextureStitchEvent.html | 313 +++ .../minecraftforge/client/event/package-frame.html | 70 + .../client/event/package-summary.html | 381 ++++ .../minecraftforge/client/event/package-tree.html | 240 +++ .../event/sound/PlayBackgroundMusicEvent.html | 302 +++ .../client/event/sound/PlaySoundEffectEvent.html | 305 +++ .../event/sound/PlaySoundEffectSourceEvent.html | 334 ++++ .../client/event/sound/PlaySoundEvent.html | 378 ++++ .../client/event/sound/PlaySoundEvent17.html | 362 ++++ .../client/event/sound/PlaySoundSourceEvent.html | 420 +++++ .../client/event/sound/PlayStreamingEvent.html | 375 ++++ .../event/sound/PlayStreamingSourceEvent.html | 420 +++++ .../event/sound/SoundEvent.SoundSourceEvent.html | 353 ++++ .../client/event/sound/SoundEvent.html | 336 ++++ .../client/event/sound/SoundLoadEvent.html | 314 ++++ .../client/event/sound/SoundResultEvent.html | 408 ++++ .../client/event/sound/SoundSetupEvent.html | 314 ++++ .../client/event/sound/package-frame.html | 31 + .../client/event/sound/package-summary.html | 187 ++ .../client/event/sound/package-tree.html | 151 ++ ...Factory.ForgeConfigGui.AddModOverrideEntry.html | 344 ++++ ...GuiFactory.ForgeConfigGui.ChunkLoaderEntry.html | 322 ++++ ...orgeGuiFactory.ForgeConfigGui.GeneralEntry.html | 322 ++++ .../ForgeGuiFactory.ForgeConfigGui.ModIDEntry.html | 344 ++++ ...uiFactory.ForgeConfigGui.ModOverridesEntry.html | 392 ++++ .../client/gui/ForgeGuiFactory.ForgeConfigGui.html | 340 ++++ .../minecraftforge/client/gui/ForgeGuiFactory.html | 429 +++++ .../minecraftforge/client/gui/package-frame.html | 25 + .../minecraftforge/client/gui/package-summary.html | 167 ++ .../minecraftforge/client/gui/package-tree.html | 160 ++ .../client/model/AdvancedModelLoader.html | 297 +++ .../minecraftforge/client/model/IModelCustom.html | 260 +++ .../client/model/IModelCustomLoader.html | 251 +++ .../client/model/ModelFormatException.html | 292 +++ .../net/minecraftforge/client/model/obj/Face.html | 357 ++++ .../client/model/obj/GroupObject.html | 355 ++++ .../client/model/obj/ObjModelLoader.html | 313 +++ .../client/model/obj/TextureCoordinate.html | 306 +++ .../minecraftforge/client/model/obj/Vertex.html | 306 +++ .../client/model/obj/WavefrontObject.html | 486 +++++ .../client/model/obj/package-frame.html | 24 + .../client/model/obj/package-summary.html | 154 ++ .../client/model/obj/package-tree.html | 131 ++ .../minecraftforge/client/model/package-frame.html | 28 + .../client/model/package-summary.html | 172 ++ .../minecraftforge/client/model/package-tree.html | 144 ++ .../client/model/techne/TechneModel.html | 390 ++++ .../client/model/techne/TechneModelLoader.html | 313 +++ .../client/model/techne/package-frame.html | 20 + .../client/model/techne/package-summary.html | 137 ++ .../client/model/techne/package-tree.html | 131 ++ .../net/minecraftforge/client/package-frame.html | 34 + .../net/minecraftforge/client/package-summary.html | 191 ++ .../net/minecraftforge/client/package-tree.html | 165 ++ .../net/minecraftforge/common/AchievementPage.html | 369 ++++ .../common/BiomeDictionary.Type.html | 712 +++++++ .../net/minecraftforge/common/BiomeDictionary.html | 442 +++++ .../common/BiomeManager.BiomeEntry.html | 280 +++ .../common/BiomeManager.BiomeType.html | 358 ++++ .../net/minecraftforge/common/BiomeManager.html | 530 ++++++ .../net/minecraftforge/common/ChestGenHooks.html | 683 +++++++ .../minecraftforge/common/DimensionManager.html | 575 ++++++ .../common/DungeonHooks.DungeonMob.html | 312 +++ .../net/minecraftforge/common/DungeonHooks.html | 323 ++++ .../net/minecraftforge/common/EnumPlantType.html | 377 ++++ .../common/FishingHooks.FishableCategory.html | 369 ++++ .../net/minecraftforge/common/FishingHooks.html | 389 ++++ .../common/ForgeChunkManager.ForceChunkEvent.html | 308 +++ .../common/ForgeChunkManager.LoadingCallback.html | 225 +++ .../ForgeChunkManager.OrderedLoadingCallback.html | 244 +++ ...eChunkManager.PlayerOrderedLoadingCallback.html | 235 +++ .../common/ForgeChunkManager.Ticket.html | 435 +++++ .../common/ForgeChunkManager.Type.html | 327 ++++ .../ForgeChunkManager.UnforceChunkEvent.html | 308 +++ .../minecraftforge/common/ForgeChunkManager.html | 694 +++++++ javadoc/net/minecraftforge/common/ForgeHooks.html | 704 +++++++ .../common/ForgeInternalHandler.html | 293 +++ .../minecraftforge/common/ForgeModContainer.html | 733 ++++++++ .../minecraftforge/common/ForgeVersion.Status.html | 381 ++++ .../net/minecraftforge/common/ForgeVersion.html | 443 +++++ .../common/IExtendedEntityProperties.html | 253 +++ .../common/IMinecartCollisionHandler.html | 274 +++ javadoc/net/minecraftforge/common/IPlantable.html | 252 +++ javadoc/net/minecraftforge/common/IShearable.html | 264 +++ .../common/ISpecialArmor.ArmorProperties.html | 400 ++++ .../net/minecraftforge/common/ISpecialArmor.html | 296 +++ .../net/minecraftforge/common/MinecraftForge.html | 375 ++++ .../net/minecraftforge/common/UsernameCache.html | 339 ++++ .../common/WorldSpecificSaveHandler.html | 422 +++++ .../common/chunkio/ChunkIOExecutor.html | 330 ++++ .../common/chunkio/package-frame.html | 19 + .../common/chunkio/package-summary.html | 131 ++ .../common/chunkio/package-tree.html | 126 ++ .../common/config/ConfigCategory.html | 929 +++++++++ .../common/config/ConfigElement.html | 919 +++++++++ .../Configuration.UnicodeInputStreamReader.html | 340 ++++ .../common/config/Configuration.html | 1988 ++++++++++++++++++++ .../common/config/Property.Type.html | 395 ++++ .../net/minecraftforge/common/config/Property.html | 1733 +++++++++++++++++ .../common/config/package-frame.html | 27 + .../common/config/package-summary.html | 167 ++ .../minecraftforge/common/config/package-tree.html | 146 ++ .../common/network/DimensionMessageHandler.html | 349 ++++ .../network/FluidIdRegistryMessageHandler.html | 349 ++++ .../ForgeMessage.DimensionRegisterMessage.html | 264 +++ .../network/ForgeMessage.FluidIdMapMessage.html | 250 +++ .../common/network/ForgeMessage.html | 253 +++ .../common/network/ForgeNetworkHandler.html | 256 +++ .../common/network/ForgeRuntimeCodec.html | 386 ++++ ...ServerToClientConnectionEstablishedHandler.html | 314 ++++ .../common/network/package-frame.html | 26 + .../common/network/package-summary.html | 159 ++ .../common/network/package-tree.html | 160 ++ .../net/minecraftforge/common/package-frame.html | 59 + .../net/minecraftforge/common/package-summary.html | 308 +++ .../net/minecraftforge/common/package-tree.html | 189 ++ .../AsynchronousExecutor.CallBackProvider.html | 280 +++ .../common/util/AsynchronousExecutor.html | 474 +++++ .../minecraftforge/common/util/BlockSnapshot.html | 697 +++++++ .../common/util/ChunkCoordComparator.html | 272 +++ .../minecraftforge/common/util/Constants.NBT.html | 439 +++++ .../net/minecraftforge/common/util/Constants.html | 252 +++ .../net/minecraftforge/common/util/EnumHelper.html | 544 ++++++ .../net/minecraftforge/common/util/FakePlayer.html | 558 ++++++ .../common/util/FakePlayerFactory.html | 289 +++ .../minecraftforge/common/util/ForgeDirection.html | 551 ++++++ .../minecraftforge/common/util/RotationHelper.html | 279 +++ .../minecraftforge/common/util/package-frame.html | 35 + .../common/util/package-summary.html | 207 ++ .../minecraftforge/common/util/package-tree.html | 170 ++ .../net/minecraftforge/event/AnvilUpdateEvent.html | 364 ++++ javadoc/net/minecraftforge/event/CommandEvent.html | 347 ++++ .../minecraftforge/event/ForgeEventFactory.html | 846 +++++++++ .../net/minecraftforge/event/ServerChatEvent.html | 347 ++++ .../event/brewing/PotionBrewEvent.Post.html | 307 +++ .../event/brewing/PotionBrewEvent.Pre.html | 291 +++ .../event/brewing/PotionBrewEvent.html | 334 ++++ .../event/brewing/PotionBrewedEvent.html | 334 ++++ .../event/brewing/package-frame.html | 22 + .../event/brewing/package-summary.html | 147 ++ .../minecraftforge/event/brewing/package-tree.html | 139 ++ .../event/entity/EntityEvent.CanUpdate.html | 323 ++++ .../event/entity/EntityEvent.EnteringChunk.html | 368 ++++ .../entity/EntityEvent.EntityConstructing.html | 292 +++ .../minecraftforge/event/entity/EntityEvent.html | 325 ++++ .../event/entity/EntityJoinWorldEvent.html | 322 ++++ .../event/entity/EntityStruckByLightningEvent.html | 322 ++++ .../event/entity/PlaySoundAtEntityEvent.html | 356 ++++ .../event/entity/item/ItemEvent.html | 323 ++++ .../event/entity/item/ItemExpireEvent.html | 330 ++++ .../event/entity/item/ItemTossEvent.html | 333 ++++ .../event/entity/item/package-frame.html | 21 + .../event/entity/item/package-summary.html | 147 ++ .../event/entity/item/package-tree.html | 139 ++ .../event/entity/living/EnderTeleportEvent.html | 375 ++++ .../event/entity/living/LivingAttackEvent.html | 360 ++++ .../event/entity/living/LivingDeathEvent.html | 345 ++++ .../event/entity/living/LivingDropsEvent.html | 411 ++++ .../entity/living/LivingEvent.LivingJumpEvent.html | 315 ++++ .../living/LivingEvent.LivingUpdateEvent.html | 315 ++++ .../event/entity/living/LivingEvent.html | 345 ++++ .../event/entity/living/LivingFallEvent.html | 343 ++++ .../event/entity/living/LivingHealEvent.html | 342 ++++ .../event/entity/living/LivingHurtEvent.html | 360 ++++ .../event/entity/living/LivingPackSizeEvent.html | 337 ++++ .../entity/living/LivingSetAttackTargetEvent.html | 343 ++++ .../living/LivingSpawnEvent.AllowDespawn.html | 330 ++++ .../entity/living/LivingSpawnEvent.CheckSpawn.html | 336 ++++ .../living/LivingSpawnEvent.SpecialSpawn.html | 342 ++++ .../event/entity/living/LivingSpawnEvent.html | 422 +++++ .../entity/living/ZombieEvent.SummonAidEvent.html | 445 +++++ .../event/entity/living/ZombieEvent.html | 330 ++++ .../event/entity/living/package-frame.html | 36 + .../event/entity/living/package-summary.html | 287 +++ .../event/entity/living/package-tree.html | 160 ++ .../entity/minecart/MinecartCollisionEvent.html | 333 ++++ .../event/entity/minecart/MinecartEvent.html | 319 ++++ .../entity/minecart/MinecartInteractEvent.html | 337 ++++ .../event/entity/minecart/MinecartUpdateEvent.html | 365 ++++ .../event/entity/minecart/package-frame.html | 22 + .../event/entity/minecart/package-summary.html | 161 ++ .../event/entity/minecart/package-tree.html | 140 ++ .../minecraftforge/event/entity/package-frame.html | 25 + .../event/entity/package-summary.html | 197 ++ .../minecraftforge/event/entity/package-tree.html | 139 ++ .../event/entity/player/AchievementEvent.html | 349 ++++ .../event/entity/player/AnvilRepairEvent.html | 398 ++++ .../event/entity/player/ArrowLooseEvent.html | 376 ++++ .../event/entity/player/ArrowNockEvent.html | 360 ++++ .../event/entity/player/AttackEntityEvent.html | 360 ++++ .../event/entity/player/BonemealEvent.html | 417 ++++ .../event/entity/player/EntityInteractEvent.html | 360 ++++ .../event/entity/player/EntityItemPickupEvent.html | 358 ++++ .../event/entity/player/FillBucketEvent.html | 401 ++++ .../event/entity/player/ItemTooltipEvent.html | 390 ++++ .../entity/player/PlayerDestroyItemEvent.html | 364 ++++ .../event/entity/player/PlayerDropsEvent.html | 354 ++++ .../entity/player/PlayerEvent.BreakSpeed.html | 482 +++++ .../event/entity/player/PlayerEvent.Clone.html | 376 ++++ .../entity/player/PlayerEvent.HarvestCheck.html | 381 ++++ .../entity/player/PlayerEvent.LoadFromFile.html | 412 ++++ .../entity/player/PlayerEvent.NameFormat.html | 379 ++++ .../entity/player/PlayerEvent.SaveToFile.html | 419 +++++ .../entity/player/PlayerEvent.StartTracking.html | 356 ++++ .../entity/player/PlayerEvent.StopTracking.html | 356 ++++ .../event/entity/player/PlayerEvent.html | 409 ++++ .../entity/player/PlayerFlyableFallEvent.html | 349 ++++ .../entity/player/PlayerInteractEvent.Action.html | 333 ++++ .../event/entity/player/PlayerInteractEvent.html | 549 ++++++ .../entity/player/PlayerOpenContainerEvent.html | 358 ++++ .../event/entity/player/PlayerPickupXpEvent.html | 350 ++++ .../event/entity/player/PlayerSleepInBedEvent.html | 403 ++++ .../entity/player/PlayerUseItemEvent.Finish.html | 382 ++++ .../entity/player/PlayerUseItemEvent.Start.html | 353 ++++ .../entity/player/PlayerUseItemEvent.Stop.html | 355 ++++ .../entity/player/PlayerUseItemEvent.Tick.html | 348 ++++ .../event/entity/player/PlayerUseItemEvent.html | 360 ++++ .../event/entity/player/PlayerWakeUpEvent.html | 409 ++++ .../event/entity/player/UseHoeEvent.html | 418 ++++ .../event/entity/player/package-frame.html | 55 + .../event/entity/player/package-summary.html | 376 ++++ .../event/entity/player/package-tree.html | 192 ++ .../net/minecraftforge/event/package-frame.html | 22 + .../net/minecraftforge/event/package-summary.html | 149 ++ javadoc/net/minecraftforge/event/package-tree.html | 133 ++ .../event/terraingen/BiomeEvent.BiomeColor.html | 336 ++++ .../terraingen/BiomeEvent.CreateDecorator.html | 339 ++++ .../terraingen/BiomeEvent.GetFoliageColor.html | 299 +++ .../event/terraingen/BiomeEvent.GetGrassColor.html | 299 +++ .../terraingen/BiomeEvent.GetVillageBlockID.html | 346 ++++ .../terraingen/BiomeEvent.GetVillageBlockMeta.html | 346 ++++ .../event/terraingen/BiomeEvent.GetWaterColor.html | 299 +++ .../event/terraingen/BiomeEvent.html | 353 ++++ .../ChunkProviderEvent.InitNoiseField.html | 407 ++++ .../ChunkProviderEvent.ReplaceBiomeBlocks.html | 443 +++++ .../event/terraingen/ChunkProviderEvent.html | 313 +++ .../DecorateBiomeEvent.Decorate.EventType.html | 478 +++++ .../terraingen/DecorateBiomeEvent.Decorate.html | 336 ++++ .../event/terraingen/DecorateBiomeEvent.Post.html | 291 +++ .../event/terraingen/DecorateBiomeEvent.Pre.html | 291 +++ .../event/terraingen/DecorateBiomeEvent.html | 378 ++++ .../event/terraingen/DeferredBiomeDecorator.html | 306 +++ .../terraingen/InitMapGenEvent.EventType.html | 406 ++++ .../event/terraingen/InitMapGenEvent.html | 294 +++ .../event/terraingen/InitNoiseGensEvent.html | 338 ++++ .../OreGenEvent.GenerateMinable.EventType.html | 417 ++++ .../terraingen/OreGenEvent.GenerateMinable.html | 359 ++++ .../event/terraingen/OreGenEvent.Post.html | 299 +++ .../event/terraingen/OreGenEvent.Pre.html | 299 +++ .../event/terraingen/OreGenEvent.html | 390 ++++ .../PopulateChunkEvent.Populate.EventType.html | 406 ++++ .../terraingen/PopulateChunkEvent.Populate.html | 370 ++++ .../event/terraingen/PopulateChunkEvent.Post.html | 324 ++++ .../event/terraingen/PopulateChunkEvent.Pre.html | 324 ++++ .../event/terraingen/PopulateChunkEvent.html | 422 +++++ .../event/terraingen/SaplingGrowTreeEvent.html | 370 ++++ .../event/terraingen/TerrainGen.html | 363 ++++ .../event/terraingen/WorldTypeEvent.BiomeSize.html | 340 ++++ .../terraingen/WorldTypeEvent.InitBiomeGens.html | 356 ++++ .../event/terraingen/WorldTypeEvent.html | 323 ++++ .../event/terraingen/package-frame.html | 56 + .../event/terraingen/package-summary.html | 409 ++++ .../event/terraingen/package-tree.html | 204 ++ .../event/world/BlockEvent.BreakEvent.html | 360 ++++ .../event/world/BlockEvent.HarvestDropsEvent.html | 391 ++++ .../event/world/BlockEvent.MultiPlaceEvent.html | 339 ++++ .../event/world/BlockEvent.PlaceEvent.html | 375 ++++ .../net/minecraftforge/event/world/BlockEvent.html | 401 ++++ .../event/world/ChunkDataEvent.Load.html | 333 ++++ .../event/world/ChunkDataEvent.Save.html | 333 ++++ .../minecraftforge/event/world/ChunkDataEvent.html | 363 ++++ .../event/world/ChunkEvent.Load.html | 313 +++ .../event/world/ChunkEvent.Unload.html | 312 +++ .../net/minecraftforge/event/world/ChunkEvent.html | 343 ++++ .../event/world/ChunkWatchEvent.UnWatch.html | 295 +++ .../event/world/ChunkWatchEvent.Watch.html | 295 +++ .../event/world/ChunkWatchEvent.html | 339 ++++ .../event/world/ExplosionEvent.Detonate.html | 340 ++++ .../event/world/ExplosionEvent.Start.html | 291 +++ .../minecraftforge/event/world/ExplosionEvent.html | 336 ++++ .../event/world/NoteBlockEvent.Change.html | 358 ++++ .../event/world/NoteBlockEvent.Instrument.html | 359 ++++ .../event/world/NoteBlockEvent.Note.html | 443 +++++ .../event/world/NoteBlockEvent.Octave.html | 335 ++++ .../event/world/NoteBlockEvent.Play.html | 345 ++++ .../minecraftforge/event/world/NoteBlockEvent.html | 375 ++++ .../world/WorldEvent.CreateSpawnPosition.html | 316 ++++ .../event/world/WorldEvent.Load.html | 296 +++ .../event/world/WorldEvent.PotentialSpawns.html | 376 ++++ .../event/world/WorldEvent.Save.html | 294 +++ .../event/world/WorldEvent.Unload.html | 297 +++ .../net/minecraftforge/event/world/WorldEvent.html | 351 ++++ .../minecraftforge/event/world/package-frame.html | 50 + .../event/world/package-summary.html | 370 ++++ .../minecraftforge/event/world/package-tree.html | 193 ++ .../net/minecraftforge/fluids/BlockFluidBase.html | 1161 ++++++++++++ .../minecraftforge/fluids/BlockFluidClassic.html | 698 +++++++ .../minecraftforge/fluids/BlockFluidFinite.html | 470 +++++ javadoc/net/minecraftforge/fluids/Fluid.html | 1169 ++++++++++++ .../FluidContainerRegistry.FluidContainerData.html | 344 ++++ ...tainerRegistry.FluidContainerRegisterEvent.html | 293 +++ .../fluids/FluidContainerRegistry.html | 586 ++++++ .../fluids/FluidEvent.FluidDrainingEvent.html | 374 ++++ .../fluids/FluidEvent.FluidFillingEvent.html | 374 ++++ .../fluids/FluidEvent.FluidMotionEvent.html | 300 +++ .../fluids/FluidEvent.FluidSpilledEvent.html | 301 +++ javadoc/net/minecraftforge/fluids/FluidEvent.html | 419 +++++ .../fluids/FluidRegistry.FluidRegisterEvent.html | 308 +++ .../net/minecraftforge/fluids/FluidRegistry.html | 488 +++++ javadoc/net/minecraftforge/fluids/FluidStack.html | 569 ++++++ javadoc/net/minecraftforge/fluids/FluidTank.html | 507 +++++ .../net/minecraftforge/fluids/FluidTankInfo.html | 290 +++ javadoc/net/minecraftforge/fluids/IFluidBlock.html | 294 +++ .../minecraftforge/fluids/IFluidContainerItem.html | 271 +++ .../net/minecraftforge/fluids/IFluidHandler.html | 328 ++++ javadoc/net/minecraftforge/fluids/IFluidTank.html | 295 +++ .../minecraftforge/fluids/ItemFluidContainer.html | 426 +++++ .../minecraftforge/fluids/RenderBlockFluid.html | 403 ++++ .../minecraftforge/fluids/TileFluidHandler.html | 491 +++++ .../net/minecraftforge/fluids/package-frame.html | 45 + .../net/minecraftforge/fluids/package-summary.html | 284 +++ .../net/minecraftforge/fluids/package-tree.html | 174 ++ .../oredict/OreDictionary.OreRegisterEvent.html | 308 +++ .../net/minecraftforge/oredict/OreDictionary.html | 601 ++++++ .../oredict/RecipeSorter.Category.html | 333 ++++ .../net/minecraftforge/oredict/RecipeSorter.html | 366 ++++ .../minecraftforge/oredict/ShapedOreRecipe.html | 378 ++++ .../minecraftforge/oredict/ShapelessOreRecipe.html | 365 ++++ .../net/minecraftforge/oredict/package-frame.html | 27 + .../minecraftforge/oredict/package-summary.html | 162 ++ .../net/minecraftforge/oredict/package-tree.html | 146 ++ .../minecraftforge/server/ForgeTimeTracker.html | 334 ++++ .../server/command/ForgeCommand.html | 315 ++++ .../server/command/package-frame.html | 19 + .../server/command/package-summary.html | 131 ++ .../server/command/package-tree.html | 130 ++ .../net/minecraftforge/server/package-frame.html | 19 + .../net/minecraftforge/server/package-summary.html | 131 ++ .../net/minecraftforge/server/package-tree.html | 126 ++ .../transformers/ForgeAccessTransformer.html | 245 +++ .../minecraftforge/transformers/package-frame.html | 19 + .../transformers/package-summary.html | 131 ++ .../minecraftforge/transformers/package-tree.html | 130 ++ 405 files changed, 133961 insertions(+) create mode 100644 javadoc/net/minecraftforge/classloading/FMLForgePlugin.html create mode 100644 javadoc/net/minecraftforge/classloading/package-frame.html create mode 100644 javadoc/net/minecraftforge/classloading/package-summary.html create mode 100644 javadoc/net/minecraftforge/classloading/package-tree.html create mode 100644 javadoc/net/minecraftforge/client/ClientCommandHandler.html create mode 100644 javadoc/net/minecraftforge/client/EnumHelperClient.html create mode 100644 javadoc/net/minecraftforge/client/ForgeHooksClient.html create mode 100644 javadoc/net/minecraftforge/client/GuiIngameForge.html create mode 100644 javadoc/net/minecraftforge/client/IItemRenderer.ItemRenderType.html create mode 100644 javadoc/net/minecraftforge/client/IItemRenderer.ItemRendererHelper.html create mode 100644 javadoc/net/minecraftforge/client/IItemRenderer.html create mode 100644 javadoc/net/minecraftforge/client/IRenderContextHandler.html create mode 100644 javadoc/net/minecraftforge/client/IRenderHandler.html create mode 100644 javadoc/net/minecraftforge/client/MinecraftForgeClient.html create mode 100644 javadoc/net/minecraftforge/client/event/ClientChatReceivedEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/DrawBlockHighlightEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.FogColors.html create mode 100644 javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.FogDensity.html create mode 100644 javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.RenderFogEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/FOVUpdateEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/GuiOpenEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/GuiScreenEvent.ActionPerformedEvent.Post.html create mode 100644 javadoc/net/minecraftforge/client/event/GuiScreenEvent.ActionPerformedEvent.Pre.html create mode 100644 javadoc/net/minecraftforge/client/event/GuiScreenEvent.ActionPerformedEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/GuiScreenEvent.DrawScreenEvent.Post.html create mode 100644 javadoc/net/minecraftforge/client/event/GuiScreenEvent.DrawScreenEvent.Pre.html create mode 100644 javadoc/net/minecraftforge/client/event/GuiScreenEvent.DrawScreenEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/GuiScreenEvent.InitGuiEvent.Post.html create mode 100644 javadoc/net/minecraftforge/client/event/GuiScreenEvent.InitGuiEvent.Pre.html create mode 100644 javadoc/net/minecraftforge/client/event/GuiScreenEvent.InitGuiEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/GuiScreenEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/MouseEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderBlockOverlayEvent.OverlayType.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderBlockOverlayEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Chat.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.ElementType.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Post.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Pre.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Text.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderHandEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderItemInFrameEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderLivingEvent.Post.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderLivingEvent.Pre.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderLivingEvent.Specials.Post.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderLivingEvent.Specials.Pre.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderLivingEvent.Specials.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderLivingEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Post.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Pre.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderPlayerEvent.SetArmorModel.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Specials.Post.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Specials.Pre.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Specials.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderPlayerEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderWorldEvent.Post.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderWorldEvent.Pre.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderWorldEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/RenderWorldLastEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/TextureStitchEvent.Post.html create mode 100644 javadoc/net/minecraftforge/client/event/TextureStitchEvent.Pre.html create mode 100644 javadoc/net/minecraftforge/client/event/TextureStitchEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/package-frame.html create mode 100644 javadoc/net/minecraftforge/client/event/package-summary.html create mode 100644 javadoc/net/minecraftforge/client/event/package-tree.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/PlayBackgroundMusicEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/PlaySoundEffectEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/PlaySoundEffectSourceEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/PlaySoundEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/PlaySoundEvent17.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/PlaySoundSourceEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/PlayStreamingEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/PlayStreamingSourceEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/SoundEvent.SoundSourceEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/SoundEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/SoundLoadEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/SoundResultEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/SoundSetupEvent.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/package-frame.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/package-summary.html create mode 100644 javadoc/net/minecraftforge/client/event/sound/package-tree.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.AddModOverrideEntry.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ChunkLoaderEntry.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.GeneralEntry.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModIDEntry.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.html create mode 100644 javadoc/net/minecraftforge/client/gui/package-frame.html create mode 100644 javadoc/net/minecraftforge/client/gui/package-summary.html create mode 100644 javadoc/net/minecraftforge/client/gui/package-tree.html create mode 100644 javadoc/net/minecraftforge/client/model/AdvancedModelLoader.html create mode 100644 javadoc/net/minecraftforge/client/model/IModelCustom.html create mode 100644 javadoc/net/minecraftforge/client/model/IModelCustomLoader.html create mode 100644 javadoc/net/minecraftforge/client/model/ModelFormatException.html create mode 100644 javadoc/net/minecraftforge/client/model/obj/Face.html create mode 100644 javadoc/net/minecraftforge/client/model/obj/GroupObject.html create mode 100644 javadoc/net/minecraftforge/client/model/obj/ObjModelLoader.html create mode 100644 javadoc/net/minecraftforge/client/model/obj/TextureCoordinate.html create mode 100644 javadoc/net/minecraftforge/client/model/obj/Vertex.html create mode 100644 javadoc/net/minecraftforge/client/model/obj/WavefrontObject.html create mode 100644 javadoc/net/minecraftforge/client/model/obj/package-frame.html create mode 100644 javadoc/net/minecraftforge/client/model/obj/package-summary.html create mode 100644 javadoc/net/minecraftforge/client/model/obj/package-tree.html create mode 100644 javadoc/net/minecraftforge/client/model/package-frame.html create mode 100644 javadoc/net/minecraftforge/client/model/package-summary.html create mode 100644 javadoc/net/minecraftforge/client/model/package-tree.html create mode 100644 javadoc/net/minecraftforge/client/model/techne/TechneModel.html create mode 100644 javadoc/net/minecraftforge/client/model/techne/TechneModelLoader.html create mode 100644 javadoc/net/minecraftforge/client/model/techne/package-frame.html create mode 100644 javadoc/net/minecraftforge/client/model/techne/package-summary.html create mode 100644 javadoc/net/minecraftforge/client/model/techne/package-tree.html create mode 100644 javadoc/net/minecraftforge/client/package-frame.html create mode 100644 javadoc/net/minecraftforge/client/package-summary.html create mode 100644 javadoc/net/minecraftforge/client/package-tree.html create mode 100644 javadoc/net/minecraftforge/common/AchievementPage.html create mode 100644 javadoc/net/minecraftforge/common/BiomeDictionary.Type.html create mode 100644 javadoc/net/minecraftforge/common/BiomeDictionary.html create mode 100644 javadoc/net/minecraftforge/common/BiomeManager.BiomeEntry.html create mode 100644 javadoc/net/minecraftforge/common/BiomeManager.BiomeType.html create mode 100644 javadoc/net/minecraftforge/common/BiomeManager.html create mode 100644 javadoc/net/minecraftforge/common/ChestGenHooks.html create mode 100644 javadoc/net/minecraftforge/common/DimensionManager.html create mode 100644 javadoc/net/minecraftforge/common/DungeonHooks.DungeonMob.html create mode 100644 javadoc/net/minecraftforge/common/DungeonHooks.html create mode 100644 javadoc/net/minecraftforge/common/EnumPlantType.html create mode 100644 javadoc/net/minecraftforge/common/FishingHooks.FishableCategory.html create mode 100644 javadoc/net/minecraftforge/common/FishingHooks.html create mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html create mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html create mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html create mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html create mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html create mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.Type.html create mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html create mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.html create mode 100644 javadoc/net/minecraftforge/common/ForgeHooks.html create mode 100644 javadoc/net/minecraftforge/common/ForgeInternalHandler.html create mode 100644 javadoc/net/minecraftforge/common/ForgeModContainer.html create mode 100644 javadoc/net/minecraftforge/common/ForgeVersion.Status.html create mode 100644 javadoc/net/minecraftforge/common/ForgeVersion.html create mode 100644 javadoc/net/minecraftforge/common/IExtendedEntityProperties.html create mode 100644 javadoc/net/minecraftforge/common/IMinecartCollisionHandler.html create mode 100644 javadoc/net/minecraftforge/common/IPlantable.html create mode 100644 javadoc/net/minecraftforge/common/IShearable.html create mode 100644 javadoc/net/minecraftforge/common/ISpecialArmor.ArmorProperties.html create mode 100644 javadoc/net/minecraftforge/common/ISpecialArmor.html create mode 100644 javadoc/net/minecraftforge/common/MinecraftForge.html create mode 100644 javadoc/net/minecraftforge/common/UsernameCache.html create mode 100644 javadoc/net/minecraftforge/common/WorldSpecificSaveHandler.html create mode 100644 javadoc/net/minecraftforge/common/chunkio/ChunkIOExecutor.html create mode 100644 javadoc/net/minecraftforge/common/chunkio/package-frame.html create mode 100644 javadoc/net/minecraftforge/common/chunkio/package-summary.html create mode 100644 javadoc/net/minecraftforge/common/chunkio/package-tree.html create mode 100644 javadoc/net/minecraftforge/common/config/ConfigCategory.html create mode 100644 javadoc/net/minecraftforge/common/config/ConfigElement.html create mode 100644 javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html create mode 100644 javadoc/net/minecraftforge/common/config/Configuration.html create mode 100644 javadoc/net/minecraftforge/common/config/Property.Type.html create mode 100644 javadoc/net/minecraftforge/common/config/Property.html create mode 100644 javadoc/net/minecraftforge/common/config/package-frame.html create mode 100644 javadoc/net/minecraftforge/common/config/package-summary.html create mode 100644 javadoc/net/minecraftforge/common/config/package-tree.html create mode 100644 javadoc/net/minecraftforge/common/network/DimensionMessageHandler.html create mode 100644 javadoc/net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html create mode 100644 javadoc/net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html create mode 100644 javadoc/net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html create mode 100644 javadoc/net/minecraftforge/common/network/ForgeMessage.html create mode 100644 javadoc/net/minecraftforge/common/network/ForgeNetworkHandler.html create mode 100644 javadoc/net/minecraftforge/common/network/ForgeRuntimeCodec.html create mode 100644 javadoc/net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html create mode 100644 javadoc/net/minecraftforge/common/network/package-frame.html create mode 100644 javadoc/net/minecraftforge/common/network/package-summary.html create mode 100644 javadoc/net/minecraftforge/common/network/package-tree.html create mode 100644 javadoc/net/minecraftforge/common/package-frame.html create mode 100644 javadoc/net/minecraftforge/common/package-summary.html create mode 100644 javadoc/net/minecraftforge/common/package-tree.html create mode 100644 javadoc/net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html create mode 100644 javadoc/net/minecraftforge/common/util/AsynchronousExecutor.html create mode 100644 javadoc/net/minecraftforge/common/util/BlockSnapshot.html create mode 100644 javadoc/net/minecraftforge/common/util/ChunkCoordComparator.html create mode 100644 javadoc/net/minecraftforge/common/util/Constants.NBT.html create mode 100644 javadoc/net/minecraftforge/common/util/Constants.html create mode 100644 javadoc/net/minecraftforge/common/util/EnumHelper.html create mode 100644 javadoc/net/minecraftforge/common/util/FakePlayer.html create mode 100644 javadoc/net/minecraftforge/common/util/FakePlayerFactory.html create mode 100644 javadoc/net/minecraftforge/common/util/ForgeDirection.html create mode 100644 javadoc/net/minecraftforge/common/util/RotationHelper.html create mode 100644 javadoc/net/minecraftforge/common/util/package-frame.html create mode 100644 javadoc/net/minecraftforge/common/util/package-summary.html create mode 100644 javadoc/net/minecraftforge/common/util/package-tree.html create mode 100644 javadoc/net/minecraftforge/event/AnvilUpdateEvent.html create mode 100644 javadoc/net/minecraftforge/event/CommandEvent.html create mode 100644 javadoc/net/minecraftforge/event/ForgeEventFactory.html create mode 100644 javadoc/net/minecraftforge/event/ServerChatEvent.html create mode 100644 javadoc/net/minecraftforge/event/brewing/PotionBrewEvent.Post.html create mode 100644 javadoc/net/minecraftforge/event/brewing/PotionBrewEvent.Pre.html create mode 100644 javadoc/net/minecraftforge/event/brewing/PotionBrewEvent.html create mode 100644 javadoc/net/minecraftforge/event/brewing/PotionBrewedEvent.html create mode 100644 javadoc/net/minecraftforge/event/brewing/package-frame.html create mode 100644 javadoc/net/minecraftforge/event/brewing/package-summary.html create mode 100644 javadoc/net/minecraftforge/event/brewing/package-tree.html create mode 100644 javadoc/net/minecraftforge/event/entity/EntityEvent.CanUpdate.html create mode 100644 javadoc/net/minecraftforge/event/entity/EntityEvent.EnteringChunk.html create mode 100644 javadoc/net/minecraftforge/event/entity/EntityEvent.EntityConstructing.html create mode 100644 javadoc/net/minecraftforge/event/entity/EntityEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/EntityJoinWorldEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/EntityStruckByLightningEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/item/ItemEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/item/ItemExpireEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/item/ItemTossEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/item/package-frame.html create mode 100644 javadoc/net/minecraftforge/event/entity/item/package-summary.html create mode 100644 javadoc/net/minecraftforge/event/entity/item/package-tree.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/EnderTeleportEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingAttackEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingDeathEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingDropsEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingEvent.LivingJumpEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingEvent.LivingUpdateEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingFallEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingHealEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingHurtEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingPackSizeEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingSetAttackTargetEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.AllowDespawn.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.CheckSpawn.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.SpecialSpawn.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/ZombieEvent.SummonAidEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/ZombieEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/package-frame.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/package-summary.html create mode 100644 javadoc/net/minecraftforge/event/entity/living/package-tree.html create mode 100644 javadoc/net/minecraftforge/event/entity/minecart/MinecartCollisionEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/minecart/MinecartEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/minecart/MinecartInteractEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/minecart/MinecartUpdateEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/minecart/package-frame.html create mode 100644 javadoc/net/minecraftforge/event/entity/minecart/package-summary.html create mode 100644 javadoc/net/minecraftforge/event/entity/minecart/package-tree.html create mode 100644 javadoc/net/minecraftforge/event/entity/package-frame.html create mode 100644 javadoc/net/minecraftforge/event/entity/package-summary.html create mode 100644 javadoc/net/minecraftforge/event/entity/package-tree.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/AchievementEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/AnvilRepairEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/ArrowLooseEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/ArrowNockEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/AttackEntityEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/BonemealEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/EntityInteractEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/EntityItemPickupEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/FillBucketEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/ItemTooltipEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerDestroyItemEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerDropsEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerEvent.BreakSpeed.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerEvent.Clone.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerEvent.HarvestCheck.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerEvent.LoadFromFile.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerEvent.NameFormat.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerEvent.SaveToFile.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerEvent.StartTracking.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerEvent.StopTracking.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerFlyableFallEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerInteractEvent.Action.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerInteractEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerOpenContainerEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerPickupXpEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerSleepInBedEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Finish.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Start.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Stop.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Tick.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/PlayerWakeUpEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/UseHoeEvent.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/package-frame.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/package-summary.html create mode 100644 javadoc/net/minecraftforge/event/entity/player/package-tree.html create mode 100644 javadoc/net/minecraftforge/event/package-frame.html create mode 100644 javadoc/net/minecraftforge/event/package-summary.html create mode 100644 javadoc/net/minecraftforge/event/package-tree.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/BiomeEvent.BiomeColor.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/BiomeEvent.CreateDecorator.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetFoliageColor.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetGrassColor.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetVillageBlockID.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetVillageBlockMeta.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetWaterColor.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/BiomeEvent.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/ChunkProviderEvent.InitNoiseField.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/ChunkProviderEvent.ReplaceBiomeBlocks.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/ChunkProviderEvent.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Decorate.EventType.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Decorate.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Post.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Pre.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/DeferredBiomeDecorator.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/InitMapGenEvent.EventType.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/InitMapGenEvent.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/InitNoiseGensEvent.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/OreGenEvent.GenerateMinable.EventType.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/OreGenEvent.GenerateMinable.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/OreGenEvent.Post.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/OreGenEvent.Pre.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/OreGenEvent.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Populate.EventType.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Populate.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Post.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Pre.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/SaplingGrowTreeEvent.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/TerrainGen.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/WorldTypeEvent.BiomeSize.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/WorldTypeEvent.InitBiomeGens.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/WorldTypeEvent.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/package-frame.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/package-summary.html create mode 100644 javadoc/net/minecraftforge/event/terraingen/package-tree.html create mode 100644 javadoc/net/minecraftforge/event/world/BlockEvent.BreakEvent.html create mode 100644 javadoc/net/minecraftforge/event/world/BlockEvent.HarvestDropsEvent.html create mode 100644 javadoc/net/minecraftforge/event/world/BlockEvent.MultiPlaceEvent.html create mode 100644 javadoc/net/minecraftforge/event/world/BlockEvent.PlaceEvent.html create mode 100644 javadoc/net/minecraftforge/event/world/BlockEvent.html create mode 100644 javadoc/net/minecraftforge/event/world/ChunkDataEvent.Load.html create mode 100644 javadoc/net/minecraftforge/event/world/ChunkDataEvent.Save.html create mode 100644 javadoc/net/minecraftforge/event/world/ChunkDataEvent.html create mode 100644 javadoc/net/minecraftforge/event/world/ChunkEvent.Load.html create mode 100644 javadoc/net/minecraftforge/event/world/ChunkEvent.Unload.html create mode 100644 javadoc/net/minecraftforge/event/world/ChunkEvent.html create mode 100644 javadoc/net/minecraftforge/event/world/ChunkWatchEvent.UnWatch.html create mode 100644 javadoc/net/minecraftforge/event/world/ChunkWatchEvent.Watch.html create mode 100644 javadoc/net/minecraftforge/event/world/ChunkWatchEvent.html create mode 100644 javadoc/net/minecraftforge/event/world/ExplosionEvent.Detonate.html create mode 100644 javadoc/net/minecraftforge/event/world/ExplosionEvent.Start.html create mode 100644 javadoc/net/minecraftforge/event/world/ExplosionEvent.html create mode 100644 javadoc/net/minecraftforge/event/world/NoteBlockEvent.Change.html create mode 100644 javadoc/net/minecraftforge/event/world/NoteBlockEvent.Instrument.html create mode 100644 javadoc/net/minecraftforge/event/world/NoteBlockEvent.Note.html create mode 100644 javadoc/net/minecraftforge/event/world/NoteBlockEvent.Octave.html create mode 100644 javadoc/net/minecraftforge/event/world/NoteBlockEvent.Play.html create mode 100644 javadoc/net/minecraftforge/event/world/NoteBlockEvent.html create mode 100644 javadoc/net/minecraftforge/event/world/WorldEvent.CreateSpawnPosition.html create mode 100644 javadoc/net/minecraftforge/event/world/WorldEvent.Load.html create mode 100644 javadoc/net/minecraftforge/event/world/WorldEvent.PotentialSpawns.html create mode 100644 javadoc/net/minecraftforge/event/world/WorldEvent.Save.html create mode 100644 javadoc/net/minecraftforge/event/world/WorldEvent.Unload.html create mode 100644 javadoc/net/minecraftforge/event/world/WorldEvent.html create mode 100644 javadoc/net/minecraftforge/event/world/package-frame.html create mode 100644 javadoc/net/minecraftforge/event/world/package-summary.html create mode 100644 javadoc/net/minecraftforge/event/world/package-tree.html create mode 100644 javadoc/net/minecraftforge/fluids/BlockFluidBase.html create mode 100644 javadoc/net/minecraftforge/fluids/BlockFluidClassic.html create mode 100644 javadoc/net/minecraftforge/fluids/BlockFluidFinite.html create mode 100644 javadoc/net/minecraftforge/fluids/Fluid.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerData.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerRegisterEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidContainerRegistry.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidEvent.FluidDrainingEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidEvent.FluidFillingEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidEvent.FluidMotionEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidEvent.FluidSpilledEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidRegistry.FluidRegisterEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidRegistry.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidStack.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidTank.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidTankInfo.html create mode 100644 javadoc/net/minecraftforge/fluids/IFluidBlock.html create mode 100644 javadoc/net/minecraftforge/fluids/IFluidContainerItem.html create mode 100644 javadoc/net/minecraftforge/fluids/IFluidHandler.html create mode 100644 javadoc/net/minecraftforge/fluids/IFluidTank.html create mode 100644 javadoc/net/minecraftforge/fluids/ItemFluidContainer.html create mode 100644 javadoc/net/minecraftforge/fluids/RenderBlockFluid.html create mode 100644 javadoc/net/minecraftforge/fluids/TileFluidHandler.html create mode 100644 javadoc/net/minecraftforge/fluids/package-frame.html create mode 100644 javadoc/net/minecraftforge/fluids/package-summary.html create mode 100644 javadoc/net/minecraftforge/fluids/package-tree.html create mode 100644 javadoc/net/minecraftforge/oredict/OreDictionary.OreRegisterEvent.html create mode 100644 javadoc/net/minecraftforge/oredict/OreDictionary.html create mode 100644 javadoc/net/minecraftforge/oredict/RecipeSorter.Category.html create mode 100644 javadoc/net/minecraftforge/oredict/RecipeSorter.html create mode 100644 javadoc/net/minecraftforge/oredict/ShapedOreRecipe.html create mode 100644 javadoc/net/minecraftforge/oredict/ShapelessOreRecipe.html create mode 100644 javadoc/net/minecraftforge/oredict/package-frame.html create mode 100644 javadoc/net/minecraftforge/oredict/package-summary.html create mode 100644 javadoc/net/minecraftforge/oredict/package-tree.html create mode 100644 javadoc/net/minecraftforge/server/ForgeTimeTracker.html create mode 100644 javadoc/net/minecraftforge/server/command/ForgeCommand.html create mode 100644 javadoc/net/minecraftforge/server/command/package-frame.html create mode 100644 javadoc/net/minecraftforge/server/command/package-summary.html create mode 100644 javadoc/net/minecraftforge/server/command/package-tree.html create mode 100644 javadoc/net/minecraftforge/server/package-frame.html create mode 100644 javadoc/net/minecraftforge/server/package-summary.html create mode 100644 javadoc/net/minecraftforge/server/package-tree.html create mode 100644 javadoc/net/minecraftforge/transformers/ForgeAccessTransformer.html create mode 100644 javadoc/net/minecraftforge/transformers/package-frame.html create mode 100644 javadoc/net/minecraftforge/transformers/package-summary.html create mode 100644 javadoc/net/minecraftforge/transformers/package-tree.html (limited to 'javadoc/net/minecraftforge') diff --git a/javadoc/net/minecraftforge/classloading/FMLForgePlugin.html b/javadoc/net/minecraftforge/classloading/FMLForgePlugin.html new file mode 100644 index 0000000..b4d9889 --- /dev/null +++ b/javadoc/net/minecraftforge/classloading/FMLForgePlugin.html @@ -0,0 +1,438 @@ + + + + + +FMLForgePlugin (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.classloading
+

Class FMLForgePlugin

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.io.FileforgeLocation 
      static booleanRUNTIME_DEOBF 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FMLForgePlugin() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetAccessTransformerClass() +
      Return an optional access transformer class for this coremod.
      +
      java.lang.String[]getASMTransformerClass() +
      Return a list of classes that implements the IClassTransformer interface
      +
      java.lang.StringgetModContainerClass() +
      Return a class name that implements "ModContainer" for injection into the mod list + The "getName" function should return a name that other mods can, if need be, + depend on.
      +
      java.lang.StringgetSetupClass() +
      Return the class name of an implementor of "IFMLCallHook", that will be run, in the + main thread, to perform any additional setup this coremod may require.
      +
      voidinjectData(java.util.Map<java.lang.String,java.lang.Object> data) +
      Inject coremod data into this coremod + This data includes: + "mcLocation" : the location of the minecraft directory, + "coremodList" : the list of coremods + "coremodLocation" : the file this coremod loaded from,
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        RUNTIME_DEOBF

        +
        public static boolean RUNTIME_DEOBF
        +
        • +
      + + + +
        +
      • +

        forgeLocation

        +
        public static java.io.File forgeLocation
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLForgePlugin

        +
        public FMLForgePlugin()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getASMTransformerClass

        +
        public java.lang.String[] getASMTransformerClass()
        +
        Description copied from interface: IFMLLoadingPlugin
        +
        Return a list of classes that implements the IClassTransformer interface
        +
        +
        Specified by:
        +
        getASMTransformerClass in interface IFMLLoadingPlugin
        +
        Returns:
        a list of classes that implements the IClassTransformer interface
        +
        • +
      + + + +
        +
      • +

        getModContainerClass

        +
        public java.lang.String getModContainerClass()
        +
        Description copied from interface: IFMLLoadingPlugin
        +
        Return a class name that implements "ModContainer" for injection into the mod list + The "getName" function should return a name that other mods can, if need be, + depend on. + Trivially, this modcontainer will be loaded before all regular mod containers, + which means it will be forced to be "immutable" - not susceptible to normal + sorting behaviour. + All other mod behaviours are available however- this container can receive and handle + normal loading events
        +
        +
        Specified by:
        +
        getModContainerClass in interface IFMLLoadingPlugin
        +
        +
        • +
      + + + +
        +
      • +

        getSetupClass

        +
        public java.lang.String getSetupClass()
        +
        Description copied from interface: IFMLLoadingPlugin
        +
        Return the class name of an implementor of "IFMLCallHook", that will be run, in the + main thread, to perform any additional setup this coremod may require. It will be + run prior to Minecraft starting, so it CANNOT operate on minecraft + itself. The game will deliberately crash if this code is detected to trigger a + minecraft class loading (TODO: implement crash ;) )
        +
        +
        Specified by:
        +
        getSetupClass in interface IFMLLoadingPlugin
        +
        +
        • +
      + + + +
        +
      • +

        injectData

        +
        public void injectData(java.util.Map<java.lang.String,java.lang.Object> data)
        +
        Description copied from interface: IFMLLoadingPlugin
        +
        Inject coremod data into this coremod + This data includes: + "mcLocation" : the location of the minecraft directory, + "coremodList" : the list of coremods + "coremodLocation" : the file this coremod loaded from,
        +
        +
        Specified by:
        +
        injectData in interface IFMLLoadingPlugin
        +
        +
        • +
      + + + +
        +
      • +

        getAccessTransformerClass

        +
        public java.lang.String getAccessTransformerClass()
        +
        Description copied from interface: IFMLLoadingPlugin
        +
        Return an optional access transformer class for this coremod. It will be injected post-deobf + so ensure your ATs conform to the new srgnames scheme.
        +
        +
        Specified by:
        +
        getAccessTransformerClass in interface IFMLLoadingPlugin
        +
        Returns:
        the name of an access transformer class or null if none is provided
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/classloading/package-frame.html b/javadoc/net/minecraftforge/classloading/package-frame.html new file mode 100644 index 0000000..613e5c7 --- /dev/null +++ b/javadoc/net/minecraftforge/classloading/package-frame.html @@ -0,0 +1,19 @@ + + + + + +net.minecraftforge.classloading (Forge API) + + + + +

net.minecraftforge.classloading

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/classloading/package-summary.html b/javadoc/net/minecraftforge/classloading/package-summary.html new file mode 100644 index 0000000..81e5204 --- /dev/null +++ b/javadoc/net/minecraftforge/classloading/package-summary.html @@ -0,0 +1,131 @@ + + + + + +net.minecraftforge.classloading (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.classloading

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/classloading/package-tree.html b/javadoc/net/minecraftforge/classloading/package-tree.html new file mode 100644 index 0000000..4e7c8dd --- /dev/null +++ b/javadoc/net/minecraftforge/classloading/package-tree.html @@ -0,0 +1,126 @@ + + + + + +net.minecraftforge.classloading Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.classloading

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/ClientCommandHandler.html b/javadoc/net/minecraftforge/client/ClientCommandHandler.html new file mode 100644 index 0000000..741582b --- /dev/null +++ b/javadoc/net/minecraftforge/client/ClientCommandHandler.html @@ -0,0 +1,348 @@ + + + + + +ClientCommandHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client
+

Class ClientCommandHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    ICommandManager
    +
    +
    +
    +
    public class ClientCommandHandler
+extends CommandHandler
    +
    The class that handles client-side chat commands. You should register any + commands that you want handled on the client with this command handler. + + If there is a command with the same name registered both on the server and + client, the client takes precedence!
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        latestAutoComplete

        +
        public java.lang.String[] latestAutoComplete
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ClientCommandHandler

        +
        public ClientCommandHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        executeCommand

        +
        public int executeCommand(ICommandSender sender,
+                 java.lang.String message)
        +
        +
        Specified by:
        +
        executeCommand in interface ICommandManager
        +
        Overrides:
        +
        executeCommand in class CommandHandler
        +
        Returns:
        1 if successfully executed, -1 if no permission or wrong usage, + 0 if it doesn't exist or it was canceled (it's sent to the server)
        +
        • +
      + + + +
        +
      • +

        autoComplete

        +
        public void autoComplete(java.lang.String leftOfCursor,
+                java.lang.String full)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/EnumHelperClient.html b/javadoc/net/minecraftforge/client/EnumHelperClient.html new file mode 100644 index 0000000..514fc1e --- /dev/null +++ b/javadoc/net/minecraftforge/client/EnumHelperClient.html @@ -0,0 +1,319 @@ + + + + + +EnumHelperClient (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.client
+

Class EnumHelperClient

+
+
+ +
+
    +
  • +
    +
    +
    public class EnumHelperClient
+extends EnumHelper
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EnumHelperClient

        +
        public EnumHelperClient()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addGameType

        +
        public static WorldSettings.GameType addGameType(java.lang.String name,
+                                 int id,
+                                 java.lang.String displayName)
        +
        • +
      + + + +
        +
      • +

        addOptions

        +
        public static GameSettings.Options addOptions(java.lang.String name,
+                              java.lang.String langName,
+                              boolean isSlider,
+                              boolean isToggle)
        +
        • +
      + + + +
        +
      • +

        addOS2

        +
        public static Util.EnumOS addOS2(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        addEnum

        +
        public static <T extends java.lang.Enum<?>> T addEnum(java.lang.Class<T> enumType,
+                                      java.lang.String enumName,
+                                      java.lang.Object... paramValues)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/ForgeHooksClient.html b/javadoc/net/minecraftforge/client/ForgeHooksClient.html new file mode 100644 index 0000000..bc64f83 --- /dev/null +++ b/javadoc/net/minecraftforge/client/ForgeHooksClient.html @@ -0,0 +1,663 @@ + + + + + +ForgeHooksClient (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.client
+

Class ForgeHooksClient

+
+
+ +
+
    +
  • +
    +
    +
    public class ForgeHooksClient
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeHooksClient

        +
        public ForgeHooksClient()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getArmorTexture

        +
        public static java.lang.String getArmorTexture(Entity entity,
+                               ItemStack armor,
+                               java.lang.String _default,
+                               int slot,
+                               java.lang.String type)
        +
        • +
      + + + +
        +
      • +

        renderEntityItem

        +
        public static boolean renderEntityItem(EntityItem entity,
+                       ItemStack item,
+                       float bobing,
+                       float rotation,
+                       java.util.Random random,
+                       TextureManager engine,
+                       RenderBlocks renderBlocks,
+                       int count)
        +
        • +
      + + + +
        +
      • +

        renderInventoryItem

        +
        public static boolean renderInventoryItem(RenderBlocks renderBlocks,
+                          TextureManager engine,
+                          ItemStack item,
+                          boolean inColor,
+                          float zLevel,
+                          float x,
+                          float y)
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        dispatchRenderLast

        +
        public static void dispatchRenderLast(RenderGlobal context,
+                      float partialTicks)
        +
        • +
      + + + +
        +
      • +

        renderFirstPersonHand

        +
        public static boolean renderFirstPersonHand(RenderGlobal context,
+                            float partialTicks,
+                            int renderPass)
        +
        • +
      + + + +
        +
      • +

        onTextureStitchedPre

        +
        public static void onTextureStitchedPre(TextureMap map)
        +
        • +
      + + + +
        +
      • +

        onTextureStitchedPost

        +
        public static void onTextureStitchedPost(TextureMap map)
        +
        • +
      + + + +
        +
      • +

        onTextureLoadPre

        +
        public static void onTextureLoadPre(java.lang.String texture)
        +
        This is added for Optifine's convenience. And to explode if a ModMaker is developing.
        +
        Parameters:
        texture -
        +
        • +
      + + + +
        +
      • +

        setRenderPass

        +
        public static void setRenderPass(int pass)
        +
        • +
      + + + + + + + +
        +
      • +

        createDisplay

        +
        public static void createDisplay()
+                          throws org.lwjgl.LWJGLException
        +
        Throws:
        +
        org.lwjgl.LWJGLException
        +
        • +
      + + + +
        +
      • +

        fixDomain

        +
        public static java.lang.String fixDomain(java.lang.String base,
+                         java.lang.String complex)
        +
        • +
      + + + +
        +
      • +

        postMouseEvent

        +
        public static boolean postMouseEvent()
        +
        • +
      + + + +
        +
      • +

        getOffsetFOV

        +
        public static float getOffsetFOV(EntityPlayerSP entity,
+                 float fov)
        +
        • +
      + + + +
        +
      • +

        getSkyBlendColour

        +
        public static int getSkyBlendColour(World world,
+                    int playerX,
+                    int playerY,
+                    int playerZ)
        +
        • +
      + + + +
        +
      • +

        renderMainMenu

        +
        public static void renderMainMenu(GuiMainMenu gui,
+                  FontRenderer font,
+                  int width,
+                  int height)
        +
        • +
      + + + + + + + +
        +
      • +

        getWorldRenderPass

        +
        public static int getWorldRenderPass()
        +
        • +
      + + + +
        +
      • +

        setWorldRendererRB

        +
        public static void setWorldRendererRB(RenderBlocks renderBlocks)
        +
        • +
      + + + +
        +
      • +

        onPreRenderWorld

        +
        public static void onPreRenderWorld(WorldRenderer worldRenderer,
+                    int pass)
        +
        • +
      + + + +
        +
      • +

        onPostRenderWorld

        +
        public static void onPostRenderWorld(WorldRenderer worldRenderer,
+                     int pass)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/GuiIngameForge.html b/javadoc/net/minecraftforge/client/GuiIngameForge.html new file mode 100644 index 0000000..64c02c8 --- /dev/null +++ b/javadoc/net/minecraftforge/client/GuiIngameForge.html @@ -0,0 +1,796 @@ + + + + + +GuiIngameForge (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client
+

Class GuiIngameForge

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiIngameForge
+extends GuiIngame
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        renderHelmet

        +
        public static boolean renderHelmet
        +
        • +
      + + + +
        +
      • +

        renderPortal

        +
        public static boolean renderPortal
        +
        • +
      + + + +
        +
      • +

        renderHotbar

        +
        public static boolean renderHotbar
        +
        • +
      + + + +
        +
      • +

        renderCrosshairs

        +
        public static boolean renderCrosshairs
        +
        • +
      + + + +
        +
      • +

        renderBossHealth

        +
        public static boolean renderBossHealth
        +
        • +
      + + + +
        +
      • +

        renderHealth

        +
        public static boolean renderHealth
        +
        • +
      + + + +
        +
      • +

        renderArmor

        +
        public static boolean renderArmor
        +
        • +
      + + + +
        +
      • +

        renderFood

        +
        public static boolean renderFood
        +
        • +
      + + + +
        +
      • +

        renderHealthMount

        +
        public static boolean renderHealthMount
        +
        • +
      + + + +
        +
      • +

        renderAir

        +
        public static boolean renderAir
        +
        • +
      + + + +
        +
      • +

        renderExperiance

        +
        public static boolean renderExperiance
        +
        • +
      + + + +
        +
      • +

        renderJumpBar

        +
        public static boolean renderJumpBar
        +
        • +
      + + + +
        +
      • +

        renderObjective

        +
        public static boolean renderObjective
        +
        • +
      + + + +
        +
      • +

        left_height

        +
        public static int left_height
        +
        • +
      + + + +
        +
      • +

        right_height

        +
        public static int right_height
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiIngameForge

        +
        public GuiIngameForge(Minecraft mc)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        renderGameOverlay

        +
        public void renderGameOverlay(float partialTicks,
+                     boolean hasScreen,
+                     int mouseX,
+                     int mouseY)
        +
        +
        Overrides:
        +
        renderGameOverlay in class GuiIngame
        +
        +
        • +
      + + + + + + + +
        +
      • +

        renderHotbar

        +
        protected void renderHotbar(int width,
+                int height,
+                float partialTicks)
        +
        • +
      + + + +
        +
      • +

        renderCrosshairs

        +
        protected void renderCrosshairs(int width,
+                    int height)
        +
        • +
      + + + + + + + +
        +
      • +

        renderArmor

        +
        protected void renderArmor(int width,
+               int height)
        +
        • +
      + + + +
        +
      • +

        renderPortal

        +
        protected void renderPortal(int width,
+                int height,
+                float partialTicks)
        +
        • +
      + + + +
        +
      • +

        renderAir

        +
        protected void renderAir(int width,
+             int height)
        +
        • +
      + + + +
        +
      • +

        renderHealth

        +
        public void renderHealth(int width,
+                int height)
        +
        • +
      + + + +
        +
      • +

        renderFood

        +
        public void renderFood(int width,
+              int height)
        +
        • +
      + + + +
        +
      • +

        renderSleepFade

        +
        protected void renderSleepFade(int width,
+                   int height)
        +
        • +
      + + + +
        +
      • +

        renderExperience

        +
        protected void renderExperience(int width,
+                    int height)
        +
        • +
      + + + +
        +
      • +

        renderJumpBar

        +
        protected void renderJumpBar(int width,
+                 int height)
        +
        • +
      + + + +
        +
      • +

        renderToolHightlight

        +
        protected void renderToolHightlight(int width,
+                        int height)
        +
        • +
      + + + +
        +
      • +

        renderHUDText

        +
        protected void renderHUDText(int width,
+                 int height)
        +
        • +
      + + + +
        +
      • +

        renderRecordOverlay

        +
        protected void renderRecordOverlay(int width,
+                       int height,
+                       float partialTicks)
        +
        • +
      + + + +
        +
      • +

        renderChat

        +
        protected void renderChat(int width,
+              int height)
        +
        • +
      + + + +
        +
      • +

        renderPlayerList

        +
        protected void renderPlayerList(int width,
+                    int height)
        +
        • +
      + + + +
        +
      • +

        renderHealthMount

        +
        protected void renderHealthMount(int width,
+                     int height)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/IItemRenderer.ItemRenderType.html b/javadoc/net/minecraftforge/client/IItemRenderer.ItemRenderType.html new file mode 100644 index 0000000..89400d6 --- /dev/null +++ b/javadoc/net/minecraftforge/client/IItemRenderer.ItemRenderType.html @@ -0,0 +1,412 @@ + + + + + +IItemRenderer.ItemRenderType (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client
+

Enum IItemRenderer.ItemRenderType

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      ENTITY +
      Called to render an in-world item, e.g.
      +
      EQUIPPED +
      Called to render an item currently held in-hand by a living entity.
      +
      EQUIPPED_FIRST_PERSON +
      Called to render an item currently held in-hand by a living entity in + first person.
      +
      FIRST_PERSON_MAP +
      The render type used for when a ItemMap is rendered in first person, + All appropriate rotations have been applied, and the player's hands, + and the map BG are already rendered.
      +
      INVENTORY +
      Called to render an item in a GUI inventory slot.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static IItemRenderer.ItemRenderTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static IItemRenderer.ItemRenderType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        ENTITY

        +
        public static final IItemRenderer.ItemRenderType ENTITY
        +
        Called to render an in-world item, e.g. one that has been thrown or + dropped. The appropriate OpenGL transformations and scaling have already + been applied, so Tessellator location (0,0,0) is the center of the + EntityItem. + + Data parameters: + RenderBlocks render - The RenderBlocks instance + EntityItem entity - The in-world item to be rendered
        +
        • +
      + + + +
        +
      • +

        EQUIPPED

        +
        public static final IItemRenderer.ItemRenderType EQUIPPED
        +
        Called to render an item currently held in-hand by a living entity. If + rendering as a 3D block, the item will be rotated to a 45-degree angle. + To render a 2D texture with some thickness (like default items), see + net.minecraft.src.ItemRenderer. In either case, rendering should be done + in local coordinates from (0,0,0)-(1,1,1). + + Data parameters: + RenderBlocks render - The RenderBlocks instance + EntityLiving entity - The entity holding this item
        +
        • +
      + + + +
        +
      • +

        EQUIPPED_FIRST_PERSON

        +
        public static final IItemRenderer.ItemRenderType EQUIPPED_FIRST_PERSON
        +
        Called to render an item currently held in-hand by a living entity in + first person. If rendering as a 3D block, the item will be rotated to a + 45-degree angle. To render a 2D texture with some thickness, see + net.minecraft.src.ItemRenderer. In either case, rendering should be done + in local coordinates from (0,0,0)-(1,1,1). + + Data parameters: + RenderBlocks render - The RenderBlocks instance + EntityLiving entity - The entity holding this item
        +
        • +
      + + + +
        +
      • +

        INVENTORY

        +
        public static final IItemRenderer.ItemRenderType INVENTORY
        +
        Called to render an item in a GUI inventory slot. If rendering as a 3D + block, the appropriate OpenGL translations and scaling have already been + applied, and the rendering should be done in local coordinates from + (0,0,0)-(1,1,1). If rendering as a 2D texture, the rendering should be in + GUI pixel coordinates from (0, 0, 0)-(16, 16, 0). + + Data parameters: + RenderBlocks render - The RenderBlocks instance
        +
        • +
      + + + +
        +
      • +

        FIRST_PERSON_MAP

        +
        public static final IItemRenderer.ItemRenderType FIRST_PERSON_MAP
        +
        The render type used for when a ItemMap is rendered in first person, + All appropriate rotations have been applied, and the player's hands, + and the map BG are already rendered. + + Data Parameters: + EntityPlayer player - The player holding the map + RenderEngine engine - The RenderEngine instance + MapData mapData - The map data
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static IItemRenderer.ItemRenderType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (IItemRenderer.ItemRenderType c : IItemRenderer.ItemRenderType.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static IItemRenderer.ItemRenderType valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/IItemRenderer.ItemRendererHelper.html b/javadoc/net/minecraftforge/client/IItemRenderer.ItemRendererHelper.html new file mode 100644 index 0000000..6078f44 --- /dev/null +++ b/javadoc/net/minecraftforge/client/IItemRenderer.ItemRendererHelper.html @@ -0,0 +1,382 @@ + + + + + +IItemRenderer.ItemRendererHelper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client
+

Enum IItemRenderer.ItemRendererHelper

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      BLOCK_3D +
      Determines if the item should equate to a block that has + RenderBlocks.renderItemIn3d return true
      +
      ENTITY_BOBBING +
      Determines if an up-and-down bobbing effect should be used when + rendering an EntityItem, like most default items do.
      +
      ENTITY_ROTATION +
      Determines if a rotation effect should be used when rendering an + EntityItem, like most default blocks do.
      +
      EQUIPPED_BLOCK +
      Determines if the currently equipped item should be rendered as a 3D + block or as a 2D texture.
      +
      INVENTORY_BLOCK +
      Determines if the item should be rendered in GUI inventory slots as a 3D + block or as a 2D texture.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static IItemRenderer.ItemRendererHelpervalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static IItemRenderer.ItemRendererHelper[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        ENTITY_ROTATION

        +
        public static final IItemRenderer.ItemRendererHelper ENTITY_ROTATION
        +
        Determines if a rotation effect should be used when rendering an + EntityItem, like most default blocks do.
        +
        • +
      + + + +
        +
      • +

        ENTITY_BOBBING

        +
        public static final IItemRenderer.ItemRendererHelper ENTITY_BOBBING
        +
        Determines if an up-and-down bobbing effect should be used when + rendering an EntityItem, like most default items do.
        +
        • +
      + + + +
        +
      • +

        EQUIPPED_BLOCK

        +
        public static final IItemRenderer.ItemRendererHelper EQUIPPED_BLOCK
        +
        Determines if the currently equipped item should be rendered as a 3D + block or as a 2D texture.
        +
        • +
      + + + +
        +
      • +

        BLOCK_3D

        +
        public static final IItemRenderer.ItemRendererHelper BLOCK_3D
        +
        Determines if the item should equate to a block that has + RenderBlocks.renderItemIn3d return true
        +
        • +
      + + + +
        +
      • +

        INVENTORY_BLOCK

        +
        public static final IItemRenderer.ItemRendererHelper INVENTORY_BLOCK
        +
        Determines if the item should be rendered in GUI inventory slots as a 3D + block or as a 2D texture.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static IItemRenderer.ItemRendererHelper[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (IItemRenderer.ItemRendererHelper c : IItemRenderer.ItemRendererHelper.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static IItemRenderer.ItemRendererHelper valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/IItemRenderer.html b/javadoc/net/minecraftforge/client/IItemRenderer.html new file mode 100644 index 0000000..8f73bff --- /dev/null +++ b/javadoc/net/minecraftforge/client/IItemRenderer.html @@ -0,0 +1,281 @@ + + + + + +IItemRenderer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client
+

Interface IItemRenderer

+
+
+
+
    +
  • +
    +
    +
    public interface IItemRenderer
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        handleRenderType

        +
        boolean handleRenderType(ItemStack item,
+                       IItemRenderer.ItemRenderType type)
        +
        Checks if this renderer should handle a specific item's render type
        +
        Parameters:
        item - The item we are trying to render
        type - A render type to check if this renderer handles
        +
        Returns:
        true if this renderer should handle the given render type, + otherwise false
        +
        • +
      + + + +
        +
      • +

        shouldUseRenderHelper

        +
        boolean shouldUseRenderHelper(IItemRenderer.ItemRenderType type,
+                            ItemStack item,
+                            IItemRenderer.ItemRendererHelper helper)
        +
        Checks if certain helper functionality should be executed for this renderer. + See ItemRendererHelper for more info
        +
        Parameters:
        type - The render type
        item - The ItemStack being rendered
        helper - The type of helper functionality to be ran
        +
        Returns:
        True to run the helper functionality, false to not.
        +
        • +
      + + + +
        +
      • +

        renderItem

        +
        void renderItem(IItemRenderer.ItemRenderType type,
+              ItemStack item,
+              java.lang.Object... data)
        +
        Called to do the actual rendering, see ItemRenderType for details on when specific + types are run, and what extra data is passed into the data parameter.
        +
        Parameters:
        type - The render type
        item - The ItemStack being rendered
        data - Extra Type specific data
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/IRenderContextHandler.html b/javadoc/net/minecraftforge/client/IRenderContextHandler.html new file mode 100644 index 0000000..eb41100 --- /dev/null +++ b/javadoc/net/minecraftforge/client/IRenderContextHandler.html @@ -0,0 +1,223 @@ + + + + + +IRenderContextHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client
+

Interface IRenderContextHandler

+
+
+
+
    +
  • +
    +
    +
    public interface IRenderContextHandler
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidafterRenderContext() +
      Run after the specified rendering context.
      +
      voidbeforeRenderContext() +
      Run before the specified rendering context.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        beforeRenderContext

        +
        void beforeRenderContext()
        +
        Run before the specified rendering context.
        +
        • +
      + + + +
        +
      • +

        afterRenderContext

        +
        void afterRenderContext()
        +
        Run after the specified rendering context.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/IRenderHandler.html b/javadoc/net/minecraftforge/client/IRenderHandler.html new file mode 100644 index 0000000..6f7d19e --- /dev/null +++ b/javadoc/net/minecraftforge/client/IRenderHandler.html @@ -0,0 +1,258 @@ + + + + + +IRenderHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.client
+

Class IRenderHandler

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class IRenderHandler
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      IRenderHandler() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      abstract voidrender(float partialTicks, + WorldClient world, + Minecraft mc) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IRenderHandler

        +
        public IRenderHandler()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/MinecraftForgeClient.html b/javadoc/net/minecraftforge/client/MinecraftForgeClient.html new file mode 100644 index 0000000..c494598 --- /dev/null +++ b/javadoc/net/minecraftforge/client/MinecraftForgeClient.html @@ -0,0 +1,338 @@ + + + + + +MinecraftForgeClient (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.client
+

Class MinecraftForgeClient

+
+
+ +
+
    +
  • +
    +
    +
    public class MinecraftForgeClient
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MinecraftForgeClient

        +
        public MinecraftForgeClient()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerItemRenderer

        +
        public static void registerItemRenderer(Item item,
+                        IItemRenderer renderer)
        +
        Register a custom renderer for a specific item. This can be used to + render the item in-world as an EntityItem, when the item is equipped, or + when the item is in an inventory slot.
        +
        Parameters:
        itemID - The item ID (shifted index) to handle rendering.
        renderer - The IItemRenderer interface that handles rendering for + this item.
        +
        • +
      + + + + + + + +
        +
      • +

        getRenderPass

        +
        public static int getRenderPass()
        +
        • +
      + + + +
        +
      • +

        getStencilBits

        +
        public static int getStencilBits()
        +
        • +
      + + + +
        +
      • +

        reserveStencilBit

        +
        public static int reserveStencilBit()
        +
        Reserve a stencil bit for use in rendering
        +
        Returns:
        A bit or -1 if no further stencil bits are available
        +
        • +
      + + + +
        +
      • +

        releaseStencilBit

        +
        public static void releaseStencilBit(int bit)
        +
        Release the stencil bit for other use
        +
        Parameters:
        bit - The bit from reserveStencilBit()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/ClientChatReceivedEvent.html b/javadoc/net/minecraftforge/client/event/ClientChatReceivedEvent.html new file mode 100644 index 0000000..1c34bce --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/ClientChatReceivedEvent.html @@ -0,0 +1,289 @@ + + + + + +ClientChatReceivedEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class ClientChatReceivedEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class ClientChatReceivedEvent
+extends Event
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ClientChatReceivedEvent

        +
        public ClientChatReceivedEvent(IChatComponent message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/DrawBlockHighlightEvent.html b/javadoc/net/minecraftforge/client/event/DrawBlockHighlightEvent.html new file mode 100644 index 0000000..92eb00d --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/DrawBlockHighlightEvent.html @@ -0,0 +1,364 @@ + + + + + +DrawBlockHighlightEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class DrawBlockHighlightEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class DrawBlockHighlightEvent
+extends Event
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.FogColors.html b/javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.FogColors.html new file mode 100644 index 0000000..c353d89 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.FogColors.html @@ -0,0 +1,352 @@ + + + + + +EntityViewRenderEvent.FogColors (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class EntityViewRenderEvent.FogColors

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    EntityViewRenderEvent
    +
    +
    +
    +
    public static class EntityViewRenderEvent.FogColors
+extends EntityViewRenderEvent
    +
    Event that allows any feature to customize the color of fog the player sees. + NOTE: Any change made to one of the color variables will affect the result seen in-game.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        red

        +
        public float red
        +
        • +
      + + + +
        +
      • +

        green

        +
        public float green
        +
        • +
      + + + +
        +
      • +

        blue

        +
        public float blue
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntityViewRenderEvent.FogColors

        +
        public EntityViewRenderEvent.FogColors(EntityRenderer renderer,
+                               EntityLivingBase entity,
+                               Block block,
+                               double renderPartialTicks,
+                               float red,
+                               float green,
+                               float blue)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.FogDensity.html b/javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.FogDensity.html new file mode 100644 index 0000000..179535a --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.FogDensity.html @@ -0,0 +1,322 @@ + + + + + +EntityViewRenderEvent.FogDensity (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class EntityViewRenderEvent.FogDensity

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    EntityViewRenderEvent
    +
    +
    +
    +
    public static class EntityViewRenderEvent.FogDensity
+extends EntityViewRenderEvent
    +
    Event that allows any feature to customize the fog density the player sees. + NOTE: In order to make this event have an effect, you must cancel the event
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        density

        +
        public float density
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntityViewRenderEvent.FogDensity

        +
        public EntityViewRenderEvent.FogDensity(EntityRenderer renderer,
+                                EntityLivingBase entity,
+                                Block block,
+                                double renderPartialTicks,
+                                float density)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.RenderFogEvent.html b/javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.RenderFogEvent.html new file mode 100644 index 0000000..2033133 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.RenderFogEvent.html @@ -0,0 +1,336 @@ + + + + + +EntityViewRenderEvent.RenderFogEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class EntityViewRenderEvent.RenderFogEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    EntityViewRenderEvent
    +
    +
    +
    +
    public static class EntityViewRenderEvent.RenderFogEvent
+extends EntityViewRenderEvent
    +
    Event that allows any feature to customize the rendering of fog.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fogMode

        +
        public final int fogMode
        +
        • +
      + + + +
        +
      • +

        farPlaneDistance

        +
        public final float farPlaneDistance
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntityViewRenderEvent.RenderFogEvent

        +
        public EntityViewRenderEvent.RenderFogEvent(EntityRenderer renderer,
+                                    EntityLivingBase entity,
+                                    Block block,
+                                    double renderPartialTicks,
+                                    int fogMode,
+                                    float farPlaneDistance)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.html b/javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.html new file mode 100644 index 0000000..1abddd1 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/EntityViewRenderEvent.html @@ -0,0 +1,365 @@ + + + + + +EntityViewRenderEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class EntityViewRenderEvent

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/FOVUpdateEvent.html b/javadoc/net/minecraftforge/client/event/FOVUpdateEvent.html new file mode 100644 index 0000000..c959d80 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/FOVUpdateEvent.html @@ -0,0 +1,319 @@ + + + + + +FOVUpdateEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class FOVUpdateEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FOVUpdateEvent
+extends Event
    +
    Author: MachineMuse (Claire Semple) + Created: 6:07 PM, 9/5/13
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        fov

        +
        public final float fov
        +
        • +
      + + + +
        +
      • +

        newfov

        +
        public float newfov
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FOVUpdateEvent

        +
        public FOVUpdateEvent(EntityPlayerSP entity,
+              float fov)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/GuiOpenEvent.html b/javadoc/net/minecraftforge/client/event/GuiOpenEvent.html new file mode 100644 index 0000000..f66efab --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/GuiOpenEvent.html @@ -0,0 +1,292 @@ + + + + + +GuiOpenEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class GuiOpenEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiOpenEvent
+extends Event
    +
    This event is called before any Gui will open. + If you don't want this to happen, cancel the event. + If you want to override this Gui, simply set the gui variable to your own Gui.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiOpenEvent

        +
        public GuiOpenEvent(GuiScreen gui)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/GuiScreenEvent.ActionPerformedEvent.Post.html b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.ActionPerformedEvent.Post.html new file mode 100644 index 0000000..c5ccaf8 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.ActionPerformedEvent.Post.html @@ -0,0 +1,309 @@ + + + + + +GuiScreenEvent.ActionPerformedEvent.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class GuiScreenEvent.ActionPerformedEvent.Post

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiScreenEvent.ActionPerformedEvent.Post

        +
        public GuiScreenEvent.ActionPerformedEvent.Post(GuiScreen gui,
+                                        GuiButton button,
+                                        java.util.List buttonList)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/GuiScreenEvent.ActionPerformedEvent.Pre.html b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.ActionPerformedEvent.Pre.html new file mode 100644 index 0000000..7463324 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.ActionPerformedEvent.Pre.html @@ -0,0 +1,310 @@ + + + + + +GuiScreenEvent.ActionPerformedEvent.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class GuiScreenEvent.ActionPerformedEvent.Pre

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    GuiScreenEvent.ActionPerformedEvent
    +
    +
    +
    +
    public static class GuiScreenEvent.ActionPerformedEvent.Pre
+extends GuiScreenEvent.ActionPerformedEvent
    +
    This event fires once it has been determined that a GuiButton object has been clicked. + Cancel this event to bypass GuiScreen.actionPerformed(). + Replace button with a different button from buttonList to have that button's action executed.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiScreenEvent.ActionPerformedEvent.Pre

        +
        public GuiScreenEvent.ActionPerformedEvent.Pre(GuiScreen gui,
+                                       GuiButton button,
+                                       java.util.List buttonList)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/GuiScreenEvent.ActionPerformedEvent.html b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.ActionPerformedEvent.html new file mode 100644 index 0000000..9f9e14f --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.ActionPerformedEvent.html @@ -0,0 +1,359 @@ + + + + + +GuiScreenEvent.ActionPerformedEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class GuiScreenEvent.ActionPerformedEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        button

        +
        public GuiButton button
        +
        The button that was clicked.
        +
        • +
      + + + +
        +
      • +

        buttonList

        +
        public java.util.List buttonList
        +
        A COPY of the buttonList field from the GuiScreen referenced by gui.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiScreenEvent.ActionPerformedEvent

        +
        public GuiScreenEvent.ActionPerformedEvent(GuiScreen gui,
+                                   GuiButton button,
+                                   java.util.List buttonList)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/GuiScreenEvent.DrawScreenEvent.Post.html b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.DrawScreenEvent.Post.html new file mode 100644 index 0000000..36a1ad0 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.DrawScreenEvent.Post.html @@ -0,0 +1,310 @@ + + + + + +GuiScreenEvent.DrawScreenEvent.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class GuiScreenEvent.DrawScreenEvent.Post

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiScreenEvent.DrawScreenEvent.Post

        +
        public GuiScreenEvent.DrawScreenEvent.Post(GuiScreen gui,
+                                   int mouseX,
+                                   int mouseY,
+                                   float renderPartialTicks)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/GuiScreenEvent.DrawScreenEvent.Pre.html b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.DrawScreenEvent.Pre.html new file mode 100644 index 0000000..8cf2e4b --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.DrawScreenEvent.Pre.html @@ -0,0 +1,311 @@ + + + + + +GuiScreenEvent.DrawScreenEvent.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class GuiScreenEvent.DrawScreenEvent.Pre

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiScreenEvent.DrawScreenEvent.Pre

        +
        public GuiScreenEvent.DrawScreenEvent.Pre(GuiScreen gui,
+                                  int mouseX,
+                                  int mouseY,
+                                  float renderPartialTicks)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/GuiScreenEvent.DrawScreenEvent.html b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.DrawScreenEvent.html new file mode 100644 index 0000000..f824820 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.DrawScreenEvent.html @@ -0,0 +1,376 @@ + + + + + +GuiScreenEvent.DrawScreenEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class GuiScreenEvent.DrawScreenEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        mouseX

        +
        public final int mouseX
        +
        The x coordinate of the mouse pointer on the screen.
        +
        • +
      + + + +
        +
      • +

        mouseY

        +
        public final int mouseY
        +
        The y coordinate of the mouse pointer on the screen.
        +
        • +
      + + + +
        +
      • +

        renderPartialTicks

        +
        public final float renderPartialTicks
        +
        Partial render ticks elapsed.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiScreenEvent.DrawScreenEvent

        +
        public GuiScreenEvent.DrawScreenEvent(GuiScreen gui,
+                              int mouseX,
+                              int mouseY,
+                              float renderPartialTicks)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/GuiScreenEvent.InitGuiEvent.Post.html b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.InitGuiEvent.Post.html new file mode 100644 index 0000000..4d7ddd7 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.InitGuiEvent.Post.html @@ -0,0 +1,307 @@ + + + + + +GuiScreenEvent.InitGuiEvent.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class GuiScreenEvent.InitGuiEvent.Post

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    GuiScreenEvent.InitGuiEvent
    +
    +
    +
    +
    public static class GuiScreenEvent.InitGuiEvent.Post
+extends GuiScreenEvent.InitGuiEvent
    +
    This event fires right after GuiScreen.initGui(). + This is a good place to alter a GuiScreen's component layout if desired.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiScreenEvent.InitGuiEvent.Post

        +
        public GuiScreenEvent.InitGuiEvent.Post(GuiScreen gui,
+                                java.util.List buttonList)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/GuiScreenEvent.InitGuiEvent.Pre.html b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.InitGuiEvent.Pre.html new file mode 100644 index 0000000..3f9dcb9 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.InitGuiEvent.Pre.html @@ -0,0 +1,312 @@ + + + + + +GuiScreenEvent.InitGuiEvent.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class GuiScreenEvent.InitGuiEvent.Pre

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    GuiScreenEvent.InitGuiEvent
    +
    +
    +
    +
    public static class GuiScreenEvent.InitGuiEvent.Pre
+extends GuiScreenEvent.InitGuiEvent
    +
    This event fires just after initializing GuiScreen.mc, GuiScreen.fontRendererObj, + GuiScreen.width, and GuiScreen.height, and just before calling GuiScreen.buttonList.clear() + and GuiScreen.initGui(). To skip or override a screen's initGui() method cancel the event.

    + + If canceled the following lines are skipped in GuiScreen.setWorldAndResolution():
    + this.buttonList.clear();
    + this.initGui();
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiScreenEvent.InitGuiEvent.Pre

        +
        public GuiScreenEvent.InitGuiEvent.Pre(GuiScreen gui,
+                               java.util.List buttonList)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/GuiScreenEvent.InitGuiEvent.html b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.InitGuiEvent.html new file mode 100644 index 0000000..643d479 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.InitGuiEvent.html @@ -0,0 +1,342 @@ + + + + + +GuiScreenEvent.InitGuiEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class GuiScreenEvent.InitGuiEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        buttonList

        +
        public java.util.List buttonList
        +
        The buttonList field from the GuiScreen object referenced by gui.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiScreenEvent.InitGuiEvent

        +
        public GuiScreenEvent.InitGuiEvent(GuiScreen gui,
+                           java.util.List buttonList)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/GuiScreenEvent.html b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.html new file mode 100644 index 0000000..8bd3c39 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/GuiScreenEvent.html @@ -0,0 +1,316 @@ + + + + + +GuiScreenEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class GuiScreenEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        gui

        +
        public final GuiScreen gui
        +
        The GuiScreen object generating this event.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiScreenEvent

        +
        public GuiScreenEvent(GuiScreen gui)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/MouseEvent.html b/javadoc/net/minecraftforge/client/event/MouseEvent.html new file mode 100644 index 0000000..465d36c --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/MouseEvent.html @@ -0,0 +1,382 @@ + + + + + +MouseEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class MouseEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class MouseEvent
+extends Event
    +
    Author: MachineMuse (Claire Semple) + Created: 2:46 PM, 9/4/13
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        x

        +
        public final int x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final int y
        +
        • +
      + + + +
        +
      • +

        dx

        +
        public final int dx
        +
        • +
      + + + +
        +
      • +

        dy

        +
        public final int dy
        +
        • +
      + + + +
        +
      • +

        dwheel

        +
        public final int dwheel
        +
        • +
      + + + +
        +
      • +

        button

        +
        public final int button
        +
        • +
      + + + +
        +
      • +

        buttonstate

        +
        public final boolean buttonstate
        +
        • +
      + + + +
        +
      • +

        nanoseconds

        +
        public final long nanoseconds
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MouseEvent

        +
        public MouseEvent()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderBlockOverlayEvent.OverlayType.html b/javadoc/net/minecraftforge/client/event/RenderBlockOverlayEvent.OverlayType.html new file mode 100644 index 0000000..7654019 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderBlockOverlayEvent.OverlayType.html @@ -0,0 +1,333 @@ + + + + + +RenderBlockOverlayEvent.OverlayType (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Enum RenderBlockOverlayEvent.OverlayType

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      BLOCK 
      FIRE 
      WATER 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static RenderBlockOverlayEvent.OverlayTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static RenderBlockOverlayEvent.OverlayType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static RenderBlockOverlayEvent.OverlayType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (RenderBlockOverlayEvent.OverlayType c : RenderBlockOverlayEvent.OverlayType.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static RenderBlockOverlayEvent.OverlayType valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderBlockOverlayEvent.html b/javadoc/net/minecraftforge/client/event/RenderBlockOverlayEvent.html new file mode 100644 index 0000000..4351d88 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderBlockOverlayEvent.html @@ -0,0 +1,400 @@ + + + + + +RenderBlockOverlayEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderBlockOverlayEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class RenderBlockOverlayEvent
+extends Event
    +
    Called when a block's texture is going to be overlaid on the player's HUD. Cancel this event to prevent the overlay.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        player

        +
        public final EntityPlayer player
        +
        The player which the overlay will apply to
        +
        • +
      + + + +
        +
      • +

        renderPartialTicks

        +
        public final float renderPartialTicks
        +
        • +
      + + + + + + + +
        +
      • +

        blockForOverlay

        +
        public final Block blockForOverlay
        +
        If the overlay type is BLOCK, then this is the block which the overlay is getting it's icon from
        +
        • +
      + + + +
        +
      • +

        blockX

        +
        public final int blockX
        +
        • +
      + + + +
        +
      • +

        blockY

        +
        public final int blockY
        +
        • +
      + + + +
        +
      • +

        blockZ

        +
        public final int blockZ
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Chat.html b/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Chat.html new file mode 100644 index 0000000..50042d8 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Chat.html @@ -0,0 +1,334 @@ + + + + + +RenderGameOverlayEvent.Chat (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderGameOverlayEvent.Chat

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        posX

        +
        public int posX
        +
        • +
      + + + +
        +
      • +

        posY

        +
        public int posY
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenderGameOverlayEvent.Chat

        +
        public RenderGameOverlayEvent.Chat(RenderGameOverlayEvent parent,
+                           int posX,
+                           int posY)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.ElementType.html b/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.ElementType.html new file mode 100644 index 0000000..73f60dc --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.ElementType.html @@ -0,0 +1,501 @@ + + + + + +RenderGameOverlayEvent.ElementType (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Enum RenderGameOverlayEvent.ElementType

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Post.html b/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Post.html new file mode 100644 index 0000000..7e32e56 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Post.html @@ -0,0 +1,322 @@ + + + + + +RenderGameOverlayEvent.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderGameOverlayEvent.Post

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isCancelable

        +
        public boolean isCancelable()
        +
        Description copied from class: Event
        +
        Determine if this function is cancelable at all.
        +
        +
        Overrides:
        +
        isCancelable in class Event
        +
        Returns:
        If access to setCanceled should be allowed
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Pre.html b/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Pre.html new file mode 100644 index 0000000..d4441dd --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Pre.html @@ -0,0 +1,290 @@ + + + + + +RenderGameOverlayEvent.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderGameOverlayEvent.Pre

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Text.html b/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Text.html new file mode 100644 index 0000000..74eca85 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.Text.html @@ -0,0 +1,334 @@ + + + + + +RenderGameOverlayEvent.Text (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderGameOverlayEvent.Text

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        left

        +
        public final java.util.ArrayList<java.lang.String> left
        +
        • +
      + + + +
        +
      • +

        right

        +
        public final java.util.ArrayList<java.lang.String> right
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenderGameOverlayEvent.Text

        +
        public RenderGameOverlayEvent.Text(RenderGameOverlayEvent parent,
+                           java.util.ArrayList<java.lang.String> left,
+                           java.util.ArrayList<java.lang.String> right)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.html b/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.html new file mode 100644 index 0000000..7590aa8 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderGameOverlayEvent.html @@ -0,0 +1,378 @@ + + + + + +RenderGameOverlayEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderGameOverlayEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenderGameOverlayEvent

        +
        public RenderGameOverlayEvent(float partialTicks,
+                      ScaledResolution resolution,
+                      int mouseX,
+                      int mouseY)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderHandEvent.html b/javadoc/net/minecraftforge/client/event/RenderHandEvent.html new file mode 100644 index 0000000..a346f4e --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderHandEvent.html @@ -0,0 +1,319 @@ + + + + + +RenderHandEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderHandEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class RenderHandEvent
+extends Event
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        partialTicks

        +
        public final float partialTicks
        +
        • +
      + + + +
        +
      • +

        renderPass

        +
        public final int renderPass
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenderHandEvent

        +
        public RenderHandEvent(RenderGlobal context,
+               float partialTicks,
+               int renderPass)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderItemInFrameEvent.html b/javadoc/net/minecraftforge/client/event/RenderItemInFrameEvent.html new file mode 100644 index 0000000..18d0f2e --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderItemInFrameEvent.html @@ -0,0 +1,320 @@ + + + + + +RenderItemInFrameEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderItemInFrameEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class RenderItemInFrameEvent
+extends Event
    +
    This event is called when an item is rendered in an item frame. + + You can set canceled to do no further vanilla processing.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Post.html b/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Post.html new file mode 100644 index 0000000..e02362a --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Post.html @@ -0,0 +1,292 @@ + + + + + +RenderLivingEvent.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderLivingEvent.Post

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Pre.html b/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Pre.html new file mode 100644 index 0000000..781ed86 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Pre.html @@ -0,0 +1,292 @@ + + + + + +RenderLivingEvent.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderLivingEvent.Pre

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Specials.Post.html b/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Specials.Post.html new file mode 100644 index 0000000..3d988ad --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Specials.Post.html @@ -0,0 +1,304 @@ + + + + + +RenderLivingEvent.Specials.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderLivingEvent.Specials.Post

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Specials.Pre.html b/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Specials.Pre.html new file mode 100644 index 0000000..548388d --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Specials.Pre.html @@ -0,0 +1,304 @@ + + + + + +RenderLivingEvent.Specials.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderLivingEvent.Specials.Pre

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Specials.html b/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Specials.html new file mode 100644 index 0000000..8761e61 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderLivingEvent.Specials.html @@ -0,0 +1,311 @@ + + + + + +RenderLivingEvent.Specials (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderLivingEvent.Specials

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderLivingEvent.html b/javadoc/net/minecraftforge/client/event/RenderLivingEvent.html new file mode 100644 index 0000000..f6b27c7 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderLivingEvent.html @@ -0,0 +1,372 @@ + + + + + +RenderLivingEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderLivingEvent

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Post.html b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Post.html new file mode 100644 index 0000000..294fb8b --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Post.html @@ -0,0 +1,345 @@ + + + + + +RenderPlayerEvent.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderPlayerEvent.Post

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenderPlayerEvent.Post

        +
        public RenderPlayerEvent.Post(EntityPlayer player,
+                      RenderPlayer renderer,
+                      float tick)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Pre.html b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Pre.html new file mode 100644 index 0000000..c09b8af --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Pre.html @@ -0,0 +1,345 @@ + + + + + +RenderPlayerEvent.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderPlayerEvent.Pre

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenderPlayerEvent.Pre

        +
        public RenderPlayerEvent.Pre(EntityPlayer player,
+                     RenderPlayer renderer,
+                     float tick)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.SetArmorModel.html b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.SetArmorModel.html new file mode 100644 index 0000000..5d840c3 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.SetArmorModel.html @@ -0,0 +1,408 @@ + + + + + +RenderPlayerEvent.SetArmorModel (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderPlayerEvent.SetArmorModel

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        result

        +
        public int result
        +
        Setting this to any value besides -1 will result in the function being + Immediately exited with the return value specified.
        +
        • +
      + + + +
        +
      • +

        slot

        +
        public final int slot
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenderPlayerEvent.SetArmorModel

        +
        public RenderPlayerEvent.SetArmorModel(EntityPlayer player,
+                               RenderPlayer renderer,
+                               int slot,
+                               float partialTick,
+                               ItemStack stack)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Specials.Post.html b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Specials.Post.html new file mode 100644 index 0000000..2ee1c06 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Specials.Post.html @@ -0,0 +1,357 @@ + + + + + +RenderPlayerEvent.Specials.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderPlayerEvent.Specials.Post

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenderPlayerEvent.Specials.Post

        +
        public RenderPlayerEvent.Specials.Post(EntityPlayer player,
+                               RenderPlayer renderer,
+                               float partialTicks)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Specials.Pre.html b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Specials.Pre.html new file mode 100644 index 0000000..7b3ba05 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Specials.Pre.html @@ -0,0 +1,411 @@ + + + + + +RenderPlayerEvent.Specials.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderPlayerEvent.Specials.Pre

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        renderHelmet

        +
        public boolean renderHelmet
        +
        • +
      + + + +
        +
      • +

        renderCape

        +
        public boolean renderCape
        +
        • +
      + + + +
        +
      • +

        renderItem

        +
        public boolean renderItem
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenderPlayerEvent.Specials.Pre

        +
        public RenderPlayerEvent.Specials.Pre(EntityPlayer player,
+                              RenderPlayer renderer,
+                              float partialTicks)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Specials.html b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Specials.html new file mode 100644 index 0000000..1f50ec4 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.Specials.html @@ -0,0 +1,364 @@ + + + + + +RenderPlayerEvent.Specials (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderPlayerEvent.Specials

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenderPlayerEvent.Specials

        +
        public RenderPlayerEvent.Specials(EntityPlayer player,
+                          RenderPlayer renderer,
+                          float partialTicks)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.html b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.html new file mode 100644 index 0000000..ff735bd --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderPlayerEvent.html @@ -0,0 +1,390 @@ + + + + + +RenderPlayerEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderPlayerEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        partialRenderTick

        +
        public final float partialRenderTick
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenderPlayerEvent

        +
        public RenderPlayerEvent(EntityPlayer player,
+                 RenderPlayer renderer,
+                 float partialRenderTick)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderWorldEvent.Post.html b/javadoc/net/minecraftforge/client/event/RenderWorldEvent.Post.html new file mode 100644 index 0000000..e54f6cb --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderWorldEvent.Post.html @@ -0,0 +1,291 @@ + + + + + +RenderWorldEvent.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderWorldEvent.Post

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    RenderWorldEvent
    +
    +
    +
    +
    public static class RenderWorldEvent.Post
+extends RenderWorldEvent
    +
    Fired after the tessellator is stopped, before the display list is ended.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderWorldEvent.Pre.html b/javadoc/net/minecraftforge/client/event/RenderWorldEvent.Pre.html new file mode 100644 index 0000000..7fe3d76 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderWorldEvent.Pre.html @@ -0,0 +1,292 @@ + + + + + +RenderWorldEvent.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderWorldEvent.Pre

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    RenderWorldEvent
    +
    +
    +
    +
    public static class RenderWorldEvent.Pre
+extends RenderWorldEvent
    +
    Fired when 16x16x16 chunk area is being redrawn. + Fired after GL state is setup, before tessellator is started.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderWorldEvent.html b/javadoc/net/minecraftforge/client/event/RenderWorldEvent.html new file mode 100644 index 0000000..4a35a7c --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderWorldEvent.html @@ -0,0 +1,357 @@ + + + + + +RenderWorldEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderWorldEvent

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/RenderWorldLastEvent.html b/javadoc/net/minecraftforge/client/event/RenderWorldLastEvent.html new file mode 100644 index 0000000..c333cd0 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/RenderWorldLastEvent.html @@ -0,0 +1,304 @@ + + + + + +RenderWorldLastEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class RenderWorldLastEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class RenderWorldLastEvent
+extends Event
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        partialTicks

        +
        public final float partialTicks
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenderWorldLastEvent

        +
        public RenderWorldLastEvent(RenderGlobal context,
+                    float partialTicks)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/TextureStitchEvent.Post.html b/javadoc/net/minecraftforge/client/event/TextureStitchEvent.Post.html new file mode 100644 index 0000000..541ad64 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/TextureStitchEvent.Post.html @@ -0,0 +1,287 @@ + + + + + +TextureStitchEvent.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class TextureStitchEvent.Post

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TextureStitchEvent
    +
    +
    +
    +
    public static class TextureStitchEvent.Post
+extends TextureStitchEvent
    +
    This event is fired once the texture map has loaded all textures and + stitched them together. All Icons should have there locations defined + by the time this is fired.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TextureStitchEvent.Post

        +
        public TextureStitchEvent.Post(TextureMap map)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/TextureStitchEvent.Pre.html b/javadoc/net/minecraftforge/client/event/TextureStitchEvent.Pre.html new file mode 100644 index 0000000..bc49a5f --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/TextureStitchEvent.Pre.html @@ -0,0 +1,287 @@ + + + + + +TextureStitchEvent.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class TextureStitchEvent.Pre

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TextureStitchEvent
    +
    +
    +
    +
    public static class TextureStitchEvent.Pre
+extends TextureStitchEvent
    +
    Fired when the TextureMap is told to refresh it's stitched texture. + Called after the Stitched list is cleared, but before any blocks or items + add themselves to the list.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TextureStitchEvent.Pre

        +
        public TextureStitchEvent.Pre(TextureMap map)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/TextureStitchEvent.html b/javadoc/net/minecraftforge/client/event/TextureStitchEvent.html new file mode 100644 index 0000000..7556608 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/TextureStitchEvent.html @@ -0,0 +1,313 @@ + + + + + +TextureStitchEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event
+

Class TextureStitchEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TextureStitchEvent

        +
        public TextureStitchEvent(TextureMap map)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/package-frame.html b/javadoc/net/minecraftforge/client/event/package-frame.html new file mode 100644 index 0000000..0a37eaa --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/package-frame.html @@ -0,0 +1,70 @@ + + + + + +net.minecraftforge.client.event (Forge API) + + + + +

net.minecraftforge.client.event

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/net/minecraftforge/client/event/package-summary.html b/javadoc/net/minecraftforge/client/event/package-summary.html new file mode 100644 index 0000000..8d0c666 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/package-summary.html @@ -0,0 +1,381 @@ + + + + + +net.minecraftforge.client.event (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.client.event

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/package-tree.html b/javadoc/net/minecraftforge/client/event/package-tree.html new file mode 100644 index 0000000..5297c77 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/package-tree.html @@ -0,0 +1,240 @@ + + + + + +net.minecraftforge.client.event Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.client.event

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/PlayBackgroundMusicEvent.html b/javadoc/net/minecraftforge/client/event/sound/PlayBackgroundMusicEvent.html new file mode 100644 index 0000000..7917563 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/PlayBackgroundMusicEvent.html @@ -0,0 +1,302 @@ + + + + + +PlayBackgroundMusicEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class PlayBackgroundMusicEvent

+
+
+ +
+
    +
  • +
    +
    Deprecated.
    +
    +
    @Deprecated
+public class PlayBackgroundMusicEvent
+extends SoundResultEvent
    +
    Raised when the SoundManager tries to play a Background Music file, + If you return null from this function it will prevent the sound from being played, + you can return a different entry if you want to change the sound being played.
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/PlaySoundEffectEvent.html b/javadoc/net/minecraftforge/client/event/sound/PlaySoundEffectEvent.html new file mode 100644 index 0000000..0ea3bf9 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/PlaySoundEffectEvent.html @@ -0,0 +1,305 @@ + + + + + +PlaySoundEffectEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class PlaySoundEffectEvent

+
+
+ +
+
    +
  • +
    +
    Deprecated.
    +
    +
    @Deprecated
+public class PlaySoundEffectEvent
+extends SoundResultEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlaySoundEffectEvent

        +
        public PlaySoundEffectEvent(SoundManager manager,
+                    SoundPoolEntry source,
+                    java.lang.String name,
+                    float volume,
+                    float pitch)
        +
        Deprecated. 
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/PlaySoundEffectSourceEvent.html b/javadoc/net/minecraftforge/client/event/sound/PlaySoundEffectSourceEvent.html new file mode 100644 index 0000000..294645a --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/PlaySoundEffectSourceEvent.html @@ -0,0 +1,334 @@ + + + + + +PlaySoundEffectSourceEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class PlaySoundEffectSourceEvent

+
+
+ +
+
    +
  • +
    +
    Deprecated.
    +
    +
    @Deprecated
+public class PlaySoundEffectSourceEvent
+extends SoundEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        manager

        +
        public final SoundManager manager
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        name

        +
        public final java.lang.String name
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlaySoundEffectSourceEvent

        +
        public PlaySoundEffectSourceEvent(SoundManager manager,
+                          java.lang.String name)
        +
        Deprecated. 
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/PlaySoundEvent.html b/javadoc/net/minecraftforge/client/event/sound/PlaySoundEvent.html new file mode 100644 index 0000000..463f07b --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/PlaySoundEvent.html @@ -0,0 +1,378 @@ + + + + + +PlaySoundEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class PlaySoundEvent

+
+
+ +
+
    +
  • +
    +
    Deprecated.
    +
    +
    @Deprecated
+public class PlaySoundEvent
+extends SoundResultEvent
    +
    Raised when the SoundManager tries to play a normal sound. + + If you return null from this function it will prevent the sound from being played, + you can return a different entry if you want to change the sound being played.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        x

        +
        public final float x
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final float y
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final float z
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlaySoundEvent

        +
        public PlaySoundEvent(SoundManager manager,
+              SoundPoolEntry source,
+              java.lang.String name,
+              float x,
+              float y,
+              float z,
+              float volume,
+              float pitch)
        +
        Deprecated. 
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/PlaySoundEvent17.html b/javadoc/net/minecraftforge/client/event/sound/PlaySoundEvent17.html new file mode 100644 index 0000000..91c9cee --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/PlaySoundEvent17.html @@ -0,0 +1,362 @@ + + + + + +PlaySoundEvent17 (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class PlaySoundEvent17

+
+
+ +
+
    +
  • +
    +
    +
    public class PlaySoundEvent17
+extends SoundEvent
    +
    Raised when the SoundManager tries to play a normal sound. + + If you return null from this function it will prevent the sound from being played, + you can return a different entry if you want to change the sound being played.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/PlaySoundSourceEvent.html b/javadoc/net/minecraftforge/client/event/sound/PlaySoundSourceEvent.html new file mode 100644 index 0000000..ee94978 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/PlaySoundSourceEvent.html @@ -0,0 +1,420 @@ + + + + + +PlaySoundSourceEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class PlaySoundSourceEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        manager

        +
        @Deprecated
+public final SoundManager manager
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        name

        +
        @Deprecated
+public final java.lang.String name
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        x

        +
        @Deprecated
+public final float x
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        y

        +
        @Deprecated
+public final float y
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        z

        +
        @Deprecated
+public final float z
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlaySoundSourceEvent

        +
        @Deprecated
+public PlaySoundSourceEvent(SoundManager manager,
+                               java.lang.String name,
+                               float x,
+                               float y,
+                               float z)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        PlaySoundSourceEvent

        +
        public PlaySoundSourceEvent(SoundManager manager,
+                    ISound sound,
+                    java.lang.String uuid)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/PlayStreamingEvent.html b/javadoc/net/minecraftforge/client/event/sound/PlayStreamingEvent.html new file mode 100644 index 0000000..f2472b5 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/PlayStreamingEvent.html @@ -0,0 +1,375 @@ + + + + + +PlayStreamingEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class PlayStreamingEvent

+
+
+ +
+
    +
  • +
    +
    Deprecated.
    +
    +
    @Deprecated
+public class PlayStreamingEvent
+extends SoundResultEvent
    +
    Raised when the SoundManager tries to play a 'Streaming' file, + in vanilla it is only the Jukebox that uses this function. + + If you return null from this function it will prevent the sound from being played, + you can return a different entry if you want to change the sound being played.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        x

        +
        public final float x
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final float y
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final float z
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayStreamingEvent

        +
        public PlayStreamingEvent(SoundManager manager,
+                  SoundPoolEntry source,
+                  java.lang.String name,
+                  float x,
+                  float y,
+                  float z)
        +
        Deprecated. 
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/PlayStreamingSourceEvent.html b/javadoc/net/minecraftforge/client/event/sound/PlayStreamingSourceEvent.html new file mode 100644 index 0000000..06f99a8 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/PlayStreamingSourceEvent.html @@ -0,0 +1,420 @@ + + + + + +PlayStreamingSourceEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class PlayStreamingSourceEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        manager

        +
        @Deprecated
+public final SoundManager manager
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        name

        +
        @Deprecated
+public final java.lang.String name
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        x

        +
        @Deprecated
+public final float x
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        y

        +
        @Deprecated
+public final float y
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        z

        +
        @Deprecated
+public final float z
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayStreamingSourceEvent

        +
        @Deprecated
+public PlayStreamingSourceEvent(SoundManager manager,
+                                   java.lang.String name,
+                                   float x,
+                                   float y,
+                                   float z)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        PlayStreamingSourceEvent

        +
        public PlayStreamingSourceEvent(SoundManager manager,
+                        ISound sound,
+                        java.lang.String uuid)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/SoundEvent.SoundSourceEvent.html b/javadoc/net/minecraftforge/client/event/sound/SoundEvent.SoundSourceEvent.html new file mode 100644 index 0000000..c68b8f9 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/SoundEvent.SoundSourceEvent.html @@ -0,0 +1,353 @@ + + + + + +SoundEvent.SoundSourceEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class SoundEvent.SoundSourceEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        sound

        +
        public final ISound sound
        +
        • +
      + + + +
        +
      • +

        uuid

        +
        public final java.lang.String uuid
        +
        • +
      + + + +
        +
      • +

        name

        +
        public final java.lang.String name
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SoundEvent.SoundSourceEvent

        +
        public SoundEvent.SoundSourceEvent(SoundManager manager,
+                           ISound sound,
+                           java.lang.String uuid)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/SoundEvent.html b/javadoc/net/minecraftforge/client/event/sound/SoundEvent.html new file mode 100644 index 0000000..3b9f385 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/SoundEvent.html @@ -0,0 +1,336 @@ + + + + + +SoundEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class SoundEvent

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/SoundLoadEvent.html b/javadoc/net/minecraftforge/client/event/sound/SoundLoadEvent.html new file mode 100644 index 0000000..563e3e2 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/SoundLoadEvent.html @@ -0,0 +1,314 @@ + + + + + +SoundLoadEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class SoundLoadEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class SoundLoadEvent
+extends SoundEvent
    +
    Raised by the SoundManager.loadSoundSettings, this would be a good place for + adding your custom sounds to the SoundPool.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        manager

        +
        @Deprecated
+public final SoundManager manager
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SoundLoadEvent

        +
        public SoundLoadEvent(SoundManager manager)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/SoundResultEvent.html b/javadoc/net/minecraftforge/client/event/sound/SoundResultEvent.html new file mode 100644 index 0000000..f887d3e --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/SoundResultEvent.html @@ -0,0 +1,408 @@ + + + + + +SoundResultEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class SoundResultEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        manager

        +
        public final SoundManager manager
        +
        Deprecated. 
        +
        • +
      + + + + + + + +
        +
      • +

        name

        +
        public final java.lang.String name
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        volume

        +
        public final float volume
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        pitch

        +
        public final float pitch
        +
        Deprecated. 
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SoundResultEvent

        +
        public SoundResultEvent(SoundManager manager,
+                SoundPoolEntry source,
+                java.lang.String name,
+                float volume,
+                float pitch)
        +
        Deprecated. 
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/SoundSetupEvent.html b/javadoc/net/minecraftforge/client/event/sound/SoundSetupEvent.html new file mode 100644 index 0000000..859b480 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/SoundSetupEvent.html @@ -0,0 +1,314 @@ + + + + + +SoundSetupEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.event.sound
+

Class SoundSetupEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class SoundSetupEvent
+extends SoundEvent
    +
    This event is raised by the SoundManager when it does its first setup of the + SoundSystemConfig's codecs, use this function to add your own codecs.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        manager

        +
        @Deprecated
+public final SoundManager manager
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SoundSetupEvent

        +
        public SoundSetupEvent(SoundManager manager)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/package-frame.html b/javadoc/net/minecraftforge/client/event/sound/package-frame.html new file mode 100644 index 0000000..b9b8442 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/package-frame.html @@ -0,0 +1,31 @@ + + + + + +net.minecraftforge.client.event.sound (Forge API) + + + + +

net.minecraftforge.client.event.sound

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/client/event/sound/package-summary.html b/javadoc/net/minecraftforge/client/event/sound/package-summary.html new file mode 100644 index 0000000..397e458 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/package-summary.html @@ -0,0 +1,187 @@ + + + + + +net.minecraftforge.client.event.sound (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.client.event.sound

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/event/sound/package-tree.html b/javadoc/net/minecraftforge/client/event/sound/package-tree.html new file mode 100644 index 0000000..893d309 --- /dev/null +++ b/javadoc/net/minecraftforge/client/event/sound/package-tree.html @@ -0,0 +1,151 @@ + + + + + +net.minecraftforge.client.event.sound Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.client.event.sound

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.AddModOverrideEntry.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.AddModOverrideEntry.html new file mode 100644 index 0000000..586f8ad --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.AddModOverrideEntry.html @@ -0,0 +1,344 @@ + + + + + +ForgeGuiFactory.ForgeConfigGui.AddModOverrideEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory.ForgeConfigGui.AddModOverrideEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ChunkLoaderEntry.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ChunkLoaderEntry.html new file mode 100644 index 0000000..c0dda24 --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ChunkLoaderEntry.html @@ -0,0 +1,322 @@ + + + + + +ForgeGuiFactory.ForgeConfigGui.ChunkLoaderEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory.ForgeConfigGui.ChunkLoaderEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.GeneralEntry.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.GeneralEntry.html new file mode 100644 index 0000000..d5ffe5c --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.GeneralEntry.html @@ -0,0 +1,322 @@ + + + + + +ForgeGuiFactory.ForgeConfigGui.GeneralEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory.ForgeConfigGui.GeneralEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModIDEntry.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModIDEntry.html new file mode 100644 index 0000000..d5f99b0 --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModIDEntry.html @@ -0,0 +1,344 @@ + + + + + +ForgeGuiFactory.ForgeConfigGui.ModIDEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory.ForgeConfigGui.ModIDEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry.html new file mode 100644 index 0000000..702aa2e --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry.html @@ -0,0 +1,392 @@ + + + + + +ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    GuiConfigEntries.IConfigEntry, GuiListExtended.IGuiListEntry
    +
    +
    +
    Enclosing class:
    +
    ForgeGuiFactory.ForgeConfigGui
    +
    +
    +
    +
    public static class ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry
+extends GuiConfigEntries.CategoryEntry
    +
    This custom list entry provides the Mod Overrides entry on the Forge Chunk Loading config screen. + It extends the base Category entry class and defines the IConfigElement objects that will be used to build the child screen. + In this case it adds the custom entry for adding a new mod override and lists the existing mod overrides.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.html new file mode 100644 index 0000000..fa8ce26 --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.html @@ -0,0 +1,340 @@ + + + + + +ForgeGuiFactory.ForgeConfigGui (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory.ForgeConfigGui

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ForgeGuiFactory
    +
    +
    +
    +
    public static class ForgeGuiFactory.ForgeConfigGui
+extends GuiConfig
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeGuiFactory.ForgeConfigGui

        +
        public ForgeGuiFactory.ForgeConfigGui(GuiScreen parentScreen)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.html new file mode 100644 index 0000000..81054bf --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.html @@ -0,0 +1,429 @@ + + + + + +ForgeGuiFactory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IModGuiFactory
    +
    +
    +
    +
    public class ForgeGuiFactory
+extends java.lang.Object
+implements IModGuiFactory
    +
    This is the base GuiConfig screen class that all the other Forge-specific config screens will be called from. + Since Forge has multiple config files I thought I would use that opportunity to show some of the ways + that the config GUI system can be extended to create custom config GUIs that have additional features + over the base functionality of just displaying Properties and ConfigCategories. + + The concepts implemented here are: + - using custom IConfigEntry objects to define child-screens that have specific Properties listed + - using custom IConfigEntry objects to define a dummy property that can be used to generate new ConfigCategory objects + - defining the configID string for a GuiConfig object so that the config changed events will be posted when that GuiConfig screen is closed + (the configID string is optional; if it is not defined the config changed events will be posted when the top-most GuiConfig screen + is closed, eg when the parent is null or is not an instance of GuiConfig) + - overriding the IConfigEntry.enabled() method to control the enabled state of one list entry based on the value of another entry + - overriding the IConfigEntry.onGuiClosed() method to perform custom actions when the screen that owns the entry is closed (in this + case a new ConfigCategory is added to the Configuration object) + + The config file structure looks like this: + forge.cfg (general settings all in one category) + forgeChunkLoading.cfg + - Forge (category) + - defaults (category) + - [optional mod override categories]... + + The GUI structure is this: + Base Screen + - General Settings (from forge.cfg) + - Chunk Loader Settings (from forgeChunkLoading.cfg) + - Defaults (these elements are listed directly on this screen) + - Mod Overrides + - Add New Mod Override + - Mod1 + - Mod2 + - etc. + + Other things to check out: + ForgeModContainer.syncConfig() + ForgeModContainer.onConfigChanged() + ForgeChunkManager.syncConfigDefaults() + ForgeChunkManager.loadConfiguration()
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeGuiFactory

        +
        public ForgeGuiFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initialize

        +
        public void initialize(Minecraft minecraftInstance)
        +
        Description copied from interface: IModGuiFactory
        +
        Called when instantiated to initialize with the active minecraft instance.
        +
        +
        Specified by:
        +
        initialize in interface IModGuiFactory
        +
        Parameters:
        minecraftInstance - the instance
        +
        • +
      + + + +
        +
      • +

        mainConfigGuiClass

        +
        public java.lang.Class<? extends GuiScreen> mainConfigGuiClass()
        +
        Description copied from interface: IModGuiFactory
        +
        Return the name of a class extending GuiScreen. This class will + be instantiated when the "config" button is pressed in the mod list. It will + have a single argument constructor - the "parent" screen, the same as all + Minecraft GUIs. The expected behaviour is that this screen will replace the + "mod list" screen completely, and will return to the mod list screen through + the parent link, once the appropriate action is taken from the config screen. + + A null from this method indicates that the mod does not provide a "config" + button GUI screen, and the config button will be hidden/disabled. + + This config GUI is anticipated to provide configuration to the mod in a friendly + visual way. It should not be abused to set internals such as IDs (they're gonna + keep disappearing anyway), but rather, interesting behaviours. This config GUI + is never run when a server game is running, and should be used to configure + desired behaviours that affect server state. Costs, mod game modes, stuff like that + can be changed here.
        +
        +
        Specified by:
        +
        mainConfigGuiClass in interface IModGuiFactory
        +
        Returns:
        A class that will be instantiated on clicks on the config button + or null if no GUI is desired.
        +
        • +
      + + + +
        +
      • +

        runtimeGuiCategories

        +
        public java.util.Set<IModGuiFactory.RuntimeOptionCategoryElement> runtimeGuiCategories()
        +
        Description copied from interface: IModGuiFactory
        +
        Return a list of the "runtime" categories this mod wishes to populate with + GUI elements. + + Runtime categories are created on demand and organized in a 'lite' tree format. + The parent represents the parent node in the tree. There is one special parent + 'Help' that will always list first, and is generally meant to provide Help type + content for mods. The remaining parents will sort alphabetically, though + this may change if there is a lot of alphabetic abuse. "AAA" is probably never a valid + category parent. + + Runtime configuration itself falls into two flavours: in-game help, which is + generally non interactive except for the text it wishes to show, and client-only + affecting behaviours. This would include things like toggling minimaps, or cheat modes + or anything NOT affecting the behaviour of the server. Please don't abuse this to + change the state of the server in any way, this is intended to behave identically + when the server is local or remote.
        +
        +
        Specified by:
        +
        runtimeGuiCategories in interface IModGuiFactory
        +
        Returns:
        the set of options this mod wishes to have available, or empty if none
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/package-frame.html b/javadoc/net/minecraftforge/client/gui/package-frame.html new file mode 100644 index 0000000..46ad226 --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/package-frame.html @@ -0,0 +1,25 @@ + + + + + +net.minecraftforge.client.gui (Forge API) + + + + +

net.minecraftforge.client.gui

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/client/gui/package-summary.html b/javadoc/net/minecraftforge/client/gui/package-summary.html new file mode 100644 index 0000000..049b62f --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/package-summary.html @@ -0,0 +1,167 @@ + + + + + +net.minecraftforge.client.gui (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.client.gui

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/package-tree.html b/javadoc/net/minecraftforge/client/gui/package-tree.html new file mode 100644 index 0000000..a5e7078 --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/package-tree.html @@ -0,0 +1,160 @@ + + + + + +net.minecraftforge.client.gui Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.client.gui

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/AdvancedModelLoader.html b/javadoc/net/minecraftforge/client/model/AdvancedModelLoader.html new file mode 100644 index 0000000..f971c6c --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/AdvancedModelLoader.html @@ -0,0 +1,297 @@ + + + + + +AdvancedModelLoader (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.client.model
+

Class AdvancedModelLoader

+
+
+ +
+
    +
  • +
    +
    +
    public class AdvancedModelLoader
+extends java.lang.Object
    +
    Common interface for advanced model loading from files, based on file suffix + Model support can be queried through the getSupportedSuffixes() method. + Instances can be created by calling #loadModel(String) with a class-loadable-path
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static java.util.Collection<java.lang.String>getSupportedSuffixes() 
      static IModelCustomloadModel(ResourceLocation resource) +
      Load the model from the supplied classpath resolvable resource name
      +
      static voidregisterModelHandler(IModelCustomLoader modelHandler) +
      Register a new model handler
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AdvancedModelLoader

        +
        public AdvancedModelLoader()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerModelHandler

        +
        public static void registerModelHandler(IModelCustomLoader modelHandler)
        +
        Register a new model handler
        +
        Parameters:
        modelHandler - The model handler to register
        +
        • +
      + + + +
        +
      • +

        loadModel

        +
        public static IModelCustom loadModel(ResourceLocation resource)
+                              throws java.lang.IllegalArgumentException,
+                                     ModelFormatException
        +
        Load the model from the supplied classpath resolvable resource name
        +
        Parameters:
        resource - The resource name
        +
        Returns:
        A model
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the resource name cannot be understood
        +
        ModelFormatException - if the underlying model handler cannot parse the model format
        +
        • +
      + + + +
        +
      • +

        getSupportedSuffixes

        +
        public static java.util.Collection<java.lang.String> getSupportedSuffixes()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/IModelCustom.html b/javadoc/net/minecraftforge/client/model/IModelCustom.html new file mode 100644 index 0000000..17d6bf6 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/IModelCustom.html @@ -0,0 +1,260 @@ + + + + + +IModelCustom (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.model
+

Interface IModelCustom

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetType() 
      voidrenderAll() 
      voidrenderAllExcept(java.lang.String... excludedGroupNames) 
      voidrenderOnly(java.lang.String... groupNames) 
      voidrenderPart(java.lang.String partName) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getType

        +
        java.lang.String getType()
        +
        • +
      + + + +
        +
      • +

        renderAll

        +
        void renderAll()
        +
        • +
      + + + +
        +
      • +

        renderOnly

        +
        void renderOnly(java.lang.String... groupNames)
        +
        • +
      + + + +
        +
      • +

        renderPart

        +
        void renderPart(java.lang.String partName)
        +
        • +
      + + + +
        +
      • +

        renderAllExcept

        +
        void renderAllExcept(java.lang.String... excludedGroupNames)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/IModelCustomLoader.html b/javadoc/net/minecraftforge/client/model/IModelCustomLoader.html new file mode 100644 index 0000000..efe3ab1 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/IModelCustomLoader.html @@ -0,0 +1,251 @@ + + + + + +IModelCustomLoader (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.model
+

Interface IModelCustomLoader

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    ObjModelLoader, TechneModelLoader
    +
    +
    +
    +
    public interface IModelCustomLoader
    +
    Instances of this class act as factories for their model type
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.String[]getSuffixes() +
      Get resource suffixes this model loader recognizes
      +
      java.lang.StringgetType() +
      Get the main type name for this loader
      +
      IModelCustomloadInstance(ResourceLocation resource) +
      Load a model instance from the supplied path
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getType

        +
        java.lang.String getType()
        +
        Get the main type name for this loader
        +
        Returns:
        the type name
        +
        • +
      + + + +
        +
      • +

        getSuffixes

        +
        java.lang.String[] getSuffixes()
        +
        Get resource suffixes this model loader recognizes
        +
        Returns:
        a list of suffixes
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/ModelFormatException.html b/javadoc/net/minecraftforge/client/model/ModelFormatException.html new file mode 100644 index 0000000..a13a4bc --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/ModelFormatException.html @@ -0,0 +1,292 @@ + + + + + +ModelFormatException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.model
+

Class ModelFormatException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class ModelFormatException
+extends java.lang.RuntimeException
    +
    Thrown if there is a problem parsing the model
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ModelFormatException

        +
        public ModelFormatException()
        +
        • +
      + + + +
        +
      • +

        ModelFormatException

        +
        public ModelFormatException(java.lang.String message,
+                    java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        ModelFormatException

        +
        public ModelFormatException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        ModelFormatException

        +
        public ModelFormatException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/obj/Face.html b/javadoc/net/minecraftforge/client/model/obj/Face.html new file mode 100644 index 0000000..047c87d --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/obj/Face.html @@ -0,0 +1,357 @@ + + + + + +Face (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.model.obj
+

Class Face

+
+
+ +
+
    +
  • +
    +
    +
    public class Face
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Face

        +
        public Face()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addFaceForRender

        +
        public void addFaceForRender(Tessellator tessellator)
        +
        • +
      + + + +
        +
      • +

        addFaceForRender

        +
        public void addFaceForRender(Tessellator tessellator,
+                    float textureOffset)
        +
        • +
      + + + +
        +
      • +

        calculateFaceNormal

        +
        public Vertex calculateFaceNormal()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/obj/GroupObject.html b/javadoc/net/minecraftforge/client/model/obj/GroupObject.html new file mode 100644 index 0000000..c6c4563 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/obj/GroupObject.html @@ -0,0 +1,355 @@ + + + + + +GroupObject (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.model.obj
+

Class GroupObject

+
+
+ +
+
    +
  • +
    +
    +
    public class GroupObject
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      java.util.ArrayList<Face>faces 
      intglDrawingMode 
      java.lang.Stringname 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      GroupObject() 
      GroupObject(java.lang.String name) 
      GroupObject(java.lang.String name, + int glDrawingMode) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidrender() 
      voidrender(Tessellator tessellator) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        name

        +
        public java.lang.String name
        +
        • +
      + + + +
        +
      • +

        faces

        +
        public java.util.ArrayList<Face> faces
        +
        • +
      + + + +
        +
      • +

        glDrawingMode

        +
        public int glDrawingMode
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GroupObject

        +
        public GroupObject()
        +
        • +
      + + + +
        +
      • +

        GroupObject

        +
        public GroupObject(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        GroupObject

        +
        public GroupObject(java.lang.String name,
+           int glDrawingMode)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        render

        +
        public void render()
        +
        • +
      + + + +
        +
      • +

        render

        +
        public void render(Tessellator tessellator)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/obj/ObjModelLoader.html b/javadoc/net/minecraftforge/client/model/obj/ObjModelLoader.html new file mode 100644 index 0000000..abf3007 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/obj/ObjModelLoader.html @@ -0,0 +1,313 @@ + + + + + +ObjModelLoader (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.client.model.obj
+

Class ObjModelLoader

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ObjModelLoader() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.String[]getSuffixes() +
      Get resource suffixes this model loader recognizes
      +
      java.lang.StringgetType() +
      Get the main type name for this loader
      +
      IModelCustomloadInstance(ResourceLocation resource) +
      Load a model instance from the supplied path
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/obj/TextureCoordinate.html b/javadoc/net/minecraftforge/client/model/obj/TextureCoordinate.html new file mode 100644 index 0000000..426c0eb --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/obj/TextureCoordinate.html @@ -0,0 +1,306 @@ + + + + + +TextureCoordinate (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.model.obj
+

Class TextureCoordinate

+
+
+ +
+
    +
  • +
    +
    +
    public class TextureCoordinate
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      floatu 
      floatv 
      floatw 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      TextureCoordinate(float u, + float v) 
      TextureCoordinate(float u, + float v, + float w) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        u

        +
        public float u
        +
        • +
      + + + +
        +
      • +

        v

        +
        public float v
        +
        • +
      + + + +
        +
      • +

        w

        +
        public float w
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TextureCoordinate

        +
        public TextureCoordinate(float u,
+                 float v)
        +
        • +
      + + + +
        +
      • +

        TextureCoordinate

        +
        public TextureCoordinate(float u,
+                 float v,
+                 float w)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/obj/Vertex.html b/javadoc/net/minecraftforge/client/model/obj/Vertex.html new file mode 100644 index 0000000..1538ca5 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/obj/Vertex.html @@ -0,0 +1,306 @@ + + + + + +Vertex (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.model.obj
+

Class Vertex

+
+
+ +
+
    +
  • +
    +
    +
    public class Vertex
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      floatx 
      floaty 
      floatz 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      Vertex(float x, + float y) 
      Vertex(float x, + float y, + float z) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        x

        +
        public float x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public float y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public float z
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Vertex

        +
        public Vertex(float x,
+      float y)
        +
        • +
      + + + +
        +
      • +

        Vertex

        +
        public Vertex(float x,
+      float y,
+      float z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/obj/WavefrontObject.html b/javadoc/net/minecraftforge/client/model/obj/WavefrontObject.html new file mode 100644 index 0000000..009ba05 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/obj/WavefrontObject.html @@ -0,0 +1,486 @@ + + + + + +WavefrontObject (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.model.obj
+

Class WavefrontObject

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IModelCustom
    +
    +
    +
    +
    public class WavefrontObject
+extends java.lang.Object
+implements IModelCustom
    +
    Wavefront Object importer + Based heavily off of the specifications found at http://en.wikipedia.org/wiki/Wavefront_.obj_file
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        vertices

        +
        public java.util.ArrayList<Vertex> vertices
        +
        • +
      + + + +
        +
      • +

        vertexNormals

        +
        public java.util.ArrayList<Vertex> vertexNormals
        +
        • +
      + + + +
        +
      • +

        textureCoordinates

        +
        public java.util.ArrayList<TextureCoordinate> textureCoordinates
        +
        • +
      + + + +
        +
      • +

        groupObjects

        +
        public java.util.ArrayList<GroupObject> groupObjects
        +
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        tessellateAll

        +
        public void tessellateAll(Tessellator tessellator)
        +
        • +
      + + + +
        +
      • +

        renderOnly

        +
        public void renderOnly(java.lang.String... groupNames)
        +
        +
        Specified by:
        +
        renderOnly in interface IModelCustom
        +
        +
        • +
      + + + +
        +
      • +

        tessellateOnly

        +
        public void tessellateOnly(Tessellator tessellator,
+                  java.lang.String... groupNames)
        +
        • +
      + + + +
        +
      • +

        renderPart

        +
        public void renderPart(java.lang.String partName)
        +
        +
        Specified by:
        +
        renderPart in interface IModelCustom
        +
        +
        • +
      + + + +
        +
      • +

        tessellatePart

        +
        public void tessellatePart(Tessellator tessellator,
+                  java.lang.String partName)
        +
        • +
      + + + +
        +
      • +

        renderAllExcept

        +
        public void renderAllExcept(java.lang.String... excludedGroupNames)
        +
        +
        Specified by:
        +
        renderAllExcept in interface IModelCustom
        +
        +
        • +
      + + + +
        +
      • +

        tessellateAllExcept

        +
        public void tessellateAllExcept(Tessellator tessellator,
+                       java.lang.String... excludedGroupNames)
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public java.lang.String getType()
        +
        +
        Specified by:
        +
        getType in interface IModelCustom
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/obj/package-frame.html b/javadoc/net/minecraftforge/client/model/obj/package-frame.html new file mode 100644 index 0000000..b075018 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/obj/package-frame.html @@ -0,0 +1,24 @@ + + + + + +net.minecraftforge.client.model.obj (Forge API) + + + + +

net.minecraftforge.client.model.obj

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/client/model/obj/package-summary.html b/javadoc/net/minecraftforge/client/model/obj/package-summary.html new file mode 100644 index 0000000..752bea6 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/obj/package-summary.html @@ -0,0 +1,154 @@ + + + + + +net.minecraftforge.client.model.obj (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.client.model.obj

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/obj/package-tree.html b/javadoc/net/minecraftforge/client/model/obj/package-tree.html new file mode 100644 index 0000000..7ed9279 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/obj/package-tree.html @@ -0,0 +1,131 @@ + + + + + +net.minecraftforge.client.model.obj Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.client.model.obj

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/package-frame.html b/javadoc/net/minecraftforge/client/model/package-frame.html new file mode 100644 index 0000000..48384b4 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/package-frame.html @@ -0,0 +1,28 @@ + + + + + +net.minecraftforge.client.model (Forge API) + + + + +

net.minecraftforge.client.model

+
+

Interfaces

+ +

Classes

+ +

Exceptions

+ +
+ + diff --git a/javadoc/net/minecraftforge/client/model/package-summary.html b/javadoc/net/minecraftforge/client/model/package-summary.html new file mode 100644 index 0000000..7f2e614 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/package-summary.html @@ -0,0 +1,172 @@ + + + + + +net.minecraftforge.client.model (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.client.model

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/package-tree.html b/javadoc/net/minecraftforge/client/model/package-tree.html new file mode 100644 index 0000000..9fee2f5 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/package-tree.html @@ -0,0 +1,144 @@ + + + + + +net.minecraftforge.client.model Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.client.model

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/techne/TechneModel.html b/javadoc/net/minecraftforge/client/model/techne/TechneModel.html new file mode 100644 index 0000000..c9b3013 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/techne/TechneModel.html @@ -0,0 +1,390 @@ + + + + + +TechneModel (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.model.techne
+

Class TechneModel

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IModelCustom
    +
    +
    +
    +
    public class TechneModel
+extends ModelBase
+implements IModelCustom
    +
    Techne model importer, based on iChun's Hats importer
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/techne/TechneModelLoader.html b/javadoc/net/minecraftforge/client/model/techne/TechneModelLoader.html new file mode 100644 index 0000000..01a28f4 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/techne/TechneModelLoader.html @@ -0,0 +1,313 @@ + + + + + +TechneModelLoader (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.client.model.techne
+

Class TechneModelLoader

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      TechneModelLoader() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.String[]getSuffixes() +
      Get resource suffixes this model loader recognizes
      +
      java.lang.StringgetType() +
      Get the main type name for this loader
      +
      IModelCustomloadInstance(ResourceLocation resource) +
      Load a model instance from the supplied path
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/techne/package-frame.html b/javadoc/net/minecraftforge/client/model/techne/package-frame.html new file mode 100644 index 0000000..bbe30f1 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/techne/package-frame.html @@ -0,0 +1,20 @@ + + + + + +net.minecraftforge.client.model.techne (Forge API) + + + + +

net.minecraftforge.client.model.techne

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/client/model/techne/package-summary.html b/javadoc/net/minecraftforge/client/model/techne/package-summary.html new file mode 100644 index 0000000..c508829 --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/techne/package-summary.html @@ -0,0 +1,137 @@ + + + + + +net.minecraftforge.client.model.techne (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.client.model.techne

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/model/techne/package-tree.html b/javadoc/net/minecraftforge/client/model/techne/package-tree.html new file mode 100644 index 0000000..057a51d --- /dev/null +++ b/javadoc/net/minecraftforge/client/model/techne/package-tree.html @@ -0,0 +1,131 @@ + + + + + +net.minecraftforge.client.model.techne Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.client.model.techne

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/package-frame.html b/javadoc/net/minecraftforge/client/package-frame.html new file mode 100644 index 0000000..263c7ef --- /dev/null +++ b/javadoc/net/minecraftforge/client/package-frame.html @@ -0,0 +1,34 @@ + + + + + +net.minecraftforge.client (Forge API) + + + + +

net.minecraftforge.client

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/net/minecraftforge/client/package-summary.html b/javadoc/net/minecraftforge/client/package-summary.html new file mode 100644 index 0000000..c2fb024 --- /dev/null +++ b/javadoc/net/minecraftforge/client/package-summary.html @@ -0,0 +1,191 @@ + + + + + +net.minecraftforge.client (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.client

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/package-tree.html b/javadoc/net/minecraftforge/client/package-tree.html new file mode 100644 index 0000000..7ca7fb8 --- /dev/null +++ b/javadoc/net/minecraftforge/client/package-tree.html @@ -0,0 +1,165 @@ + + + + + +net.minecraftforge.client Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.client

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/AchievementPage.html b/javadoc/net/minecraftforge/common/AchievementPage.html new file mode 100644 index 0000000..18ab6dc --- /dev/null +++ b/javadoc/net/minecraftforge/common/AchievementPage.html @@ -0,0 +1,369 @@ + + + + + +AchievementPage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common
+

Class AchievementPage

+
+
+ +
+
    +
  • +
    +
    +
    public class AchievementPage
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AchievementPage

        +
        public AchievementPage(java.lang.String name,
+               Achievement... achievements)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        getAchievements

        +
        public java.util.List<Achievement> getAchievements()
        +
        • +
      + + + +
        +
      • +

        registerAchievementPage

        +
        public static void registerAchievementPage(AchievementPage page)
        +
        Registers an achievement page.
        +
        Parameters:
        page - The page.
        +
        • +
      + + + +
        +
      • +

        getAchievementPage

        +
        public static AchievementPage getAchievementPage(int index)
        +
        Will return an achievement page by its index on the list.
        +
        Parameters:
        index - The page's index.
        +
        Returns:
        the achievement page corresponding to the index or null if invalid index
        +
        • +
      + + + +
        +
      • +

        getAchievementPage

        +
        public static AchievementPage getAchievementPage(java.lang.String name)
        +
        Will return an achievement page by its name.
        +
        Parameters:
        name - The page's name.
        +
        Returns:
        the achievement page with the given name or null if no such page
        +
        • +
      + + + +
        +
      • +

        getAchievementPages

        +
        public static java.util.Set<AchievementPage> getAchievementPages()
        +
        Will return the list of achievement pages.
        +
        Returns:
        the list's size
        +
        • +
      + + + +
        +
      • +

        isAchievementInPages

        +
        public static boolean isAchievementInPages(Achievement achievement)
        +
        Will return whether an achievement is in any page or not.
        +
        Parameters:
        achievement - The achievement.
        +
        • +
      + + + +
        +
      • +

        getTitle

        +
        public static java.lang.String getTitle(int index)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/BiomeDictionary.Type.html b/javadoc/net/minecraftforge/common/BiomeDictionary.Type.html new file mode 100644 index 0000000..a0ab768 --- /dev/null +++ b/javadoc/net/minecraftforge/common/BiomeDictionary.Type.html @@ -0,0 +1,712 @@ + + + + + +BiomeDictionary.Type (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Enum BiomeDictionary.Type

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/BiomeDictionary.html b/javadoc/net/minecraftforge/common/BiomeDictionary.html new file mode 100644 index 0000000..9fdfc67 --- /dev/null +++ b/javadoc/net/minecraftforge/common/BiomeDictionary.html @@ -0,0 +1,442 @@ + + + + + +BiomeDictionary (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class BiomeDictionary

+
+
+ +
+
    +
  • +
    +
    +
    public class BiomeDictionary
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BiomeDictionary

        +
        public BiomeDictionary()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerBiomeType

        +
        public static boolean registerBiomeType(BiomeGenBase biome,
+                        BiomeDictionary.Type... types)
        +
        Registers a biome with a specific biome type
        +
        Parameters:
        biome - the biome to be registered
        type - the type to register the biome as
        +
        Returns:
        returns true if the biome was registered successfully
        +
        • +
      + + + +
        +
      • +

        getBiomesForType

        +
        public static BiomeGenBase[] getBiomesForType(BiomeDictionary.Type type)
        +
        Returns a list of biomes registered with a specific type
        +
        Parameters:
        type - the Type to look for
        +
        Returns:
        a list of biomes of the specified type, null if there are none
        +
        • +
      + + + +
        +
      • +

        getTypesForBiome

        +
        public static BiomeDictionary.Type[] getTypesForBiome(BiomeGenBase biome)
        +
        Gets a list of Types that a specific biome is registered with
        +
        Parameters:
        biome - the biome to check
        +
        Returns:
        the list of types, null if there are none
        +
        • +
      + + + +
        +
      • +

        areBiomesEquivalent

        +
        public static boolean areBiomesEquivalent(BiomeGenBase biomeA,
+                          BiomeGenBase biomeB)
        +
        Checks to see if two biomes are registered as having the same type
        +
        Parameters:
        biomeA -
        biomeB -
        +
        Returns:
        returns true if a common type is found, false otherwise
        +
        • +
      + + + +
        +
      • +

        isBiomeOfType

        +
        public static boolean isBiomeOfType(BiomeGenBase biome,
+                    BiomeDictionary.Type type)
        +
        Checks to see if the given biome is registered as being a specific type
        +
        Parameters:
        biome - the biome to be considered
        type - the type to check for
        +
        Returns:
        returns true if the biome is registered as being of type type, false otherwise
        +
        • +
      + + + +
        +
      • +

        isBiomeRegistered

        +
        public static boolean isBiomeRegistered(BiomeGenBase biome)
        +
        Checks to see if the given biome has been registered as being of any type
        +
        Parameters:
        biome - the biome to consider
        +
        Returns:
        returns true if the biome has been registered, false otherwise
        +
        • +
      + + + +
        +
      • +

        isBiomeRegistered

        +
        public static boolean isBiomeRegistered(int biomeID)
        +
        • +
      + + + +
        +
      • +

        registerAllBiomes

        +
        public static void registerAllBiomes()
        +
        • +
      + + + +
        +
      • +

        registerAllBiomesAndGenerateEvents

        +
        public static void registerAllBiomesAndGenerateEvents()
        +
        Loops through the biome list and automatically adds tags to any biome that does not have any + This is called by Forge at postinit time. It will additionally dispatch any deferred decorator + creation events. + + DO NOT call this during world generation
        +
        • +
      + + + +
        +
      • +

        makeBestGuess

        +
        public static void makeBestGuess(BiomeGenBase biome)
        +
        Automatically looks for and registers a given biome with appropriate tags + This method is called automatically if a biome has not been registered with any tags, + And another method requests information about it
        +
        Parameters:
        biome - the biome to be considered
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/BiomeManager.BiomeEntry.html b/javadoc/net/minecraftforge/common/BiomeManager.BiomeEntry.html new file mode 100644 index 0000000..e07bed1 --- /dev/null +++ b/javadoc/net/minecraftforge/common/BiomeManager.BiomeEntry.html @@ -0,0 +1,280 @@ + + + + + +BiomeManager.BiomeEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class BiomeManager.BiomeEntry

+
+
+ +
+ +
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BiomeManager.BiomeEntry

        +
        public BiomeManager.BiomeEntry(BiomeGenBase biome,
+                       int weight)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/BiomeManager.BiomeType.html b/javadoc/net/minecraftforge/common/BiomeManager.BiomeType.html new file mode 100644 index 0000000..5345773 --- /dev/null +++ b/javadoc/net/minecraftforge/common/BiomeManager.BiomeType.html @@ -0,0 +1,358 @@ + + + + + +BiomeManager.BiomeType (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Enum BiomeManager.BiomeType

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      COOL 
      DESERT 
      ICY 
      WARM 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static BiomeManager.BiomeTypegetType(java.lang.String name) 
      static BiomeManager.BiomeTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static BiomeManager.BiomeType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static BiomeManager.BiomeType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (BiomeManager.BiomeType c : BiomeManager.BiomeType.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static BiomeManager.BiomeType valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/BiomeManager.html b/javadoc/net/minecraftforge/common/BiomeManager.html new file mode 100644 index 0000000..cdb41ab --- /dev/null +++ b/javadoc/net/minecraftforge/common/BiomeManager.html @@ -0,0 +1,530 @@ + + + + + +BiomeManager (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class BiomeManager

+
+
+ +
+
    +
  • +
    +
    +
    public class BiomeManager
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ChestGenHooks.html b/javadoc/net/minecraftforge/common/ChestGenHooks.html new file mode 100644 index 0000000..366a209 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ChestGenHooks.html @@ -0,0 +1,683 @@ + + + + + +ChestGenHooks (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class ChestGenHooks

+
+
+ +
+
    +
  • +
    +
    +
    public class ChestGenHooks
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ChestGenHooks

        +
        public ChestGenHooks(java.lang.String category)
        +
        • +
      + + + +
        +
      • +

        ChestGenHooks

        +
        public ChestGenHooks(java.lang.String category,
+             WeightedRandomChestContent[] items,
+             int min,
+             int max)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getInfo

        +
        public static ChestGenHooks getInfo(java.lang.String category)
        +
        Retrieves, or creates the info class for the specified category.
        +
        Parameters:
        category - The category name
        +
        Returns:
        A instance of ChestGenHooks for the specified category.
        +
        • +
      + + + +
        +
      • +

        generateStacks

        +
        public static ItemStack[] generateStacks(java.util.Random rand,
+                         ItemStack source,
+                         int min,
+                         int max)
        +
        Generates an array of items based on the input min/max count. + If the stack can not hold the total amount, it will be split into + stacks of size 1.
        +
        Parameters:
        rand - A random number generator
        source - Source item stack
        min - Minimum number of items
        max - Maximum number of items
        +
        Returns:
        An array containing the generated item stacks
        +
        • +
      + + + + + + + +
        +
      • +

        getCount

        +
        public static int getCount(java.lang.String category,
+           java.util.Random rand)
        +
        • +
      + + + + + + + +
        +
      • +

        removeItem

        +
        public static void removeItem(java.lang.String category,
+              ItemStack item)
        +
        • +
      + + + +
        +
      • +

        getOneItem

        +
        public static ItemStack getOneItem(java.lang.String category,
+                   java.util.Random rand)
        +
        • +
      + + + +
        +
      • +

        addItem

        +
        public void addItem(WeightedRandomChestContent item)
        +
        Adds a new entry into the possible items to generate.
        +
        Parameters:
        item - The item to add.
        +
        • +
      + + + +
        +
      • +

        removeItem

        +
        public void removeItem(ItemStack item)
        +
        Removes all items that match the input item stack, Only metadata and item ID are checked. + If the input item has a metadata of -1, all metadatas will match.
        +
        Parameters:
        item - The item to check
        +
        • +
      + + + +
        +
      • +

        getItems

        +
        public WeightedRandomChestContent[] getItems(java.util.Random rnd)
        +
        Gets an array of all random objects that are associated with this category.
        +
        Returns:
        The random objects
        +
        • +
      + + + +
        +
      • +

        getCount

        +
        public int getCount(java.util.Random rand)
        +
        Gets a random number between countMin and countMax.
        +
        Parameters:
        rand - A RNG
        +
        Returns:
        A random number where countMin <= num <= countMax
        +
        • +
      + + + +
        +
      • +

        getOneItem

        +
        public ItemStack getOneItem(java.util.Random rand)
        +
        Returns a single ItemStack from the possible items in this registry, + Useful if you just want a quick and dirty random Item.
        +
        Parameters:
        rand - A Random Number gen
        +
        Returns:
        A single ItemStack, or null if it could not get one.
        +
        • +
      + + + +
        +
      • +

        getMin

        +
        public int getMin()
        +
        • +
      + + + +
        +
      • +

        getMax

        +
        public int getMax()
        +
        • +
      + + + +
        +
      • +

        setMin

        +
        public void setMin(int value)
        +
        • +
      + + + +
        +
      • +

        setMax

        +
        public void setMax(int value)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/DimensionManager.html b/javadoc/net/minecraftforge/common/DimensionManager.html new file mode 100644 index 0000000..9e54cb5 --- /dev/null +++ b/javadoc/net/minecraftforge/common/DimensionManager.html @@ -0,0 +1,575 @@ + + + + + +DimensionManager (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common
+

Class DimensionManager

+
+
+ +
+
    +
  • +
    +
    +
    public class DimensionManager
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DimensionManager

        +
        public DimensionManager()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerProviderType

        +
        public static boolean registerProviderType(int id,
+                           java.lang.Class<? extends WorldProvider> provider,
+                           boolean keepLoaded)
        +
        • +
      + + + +
        +
      • +

        unregisterProviderType

        +
        public static int[] unregisterProviderType(int id)
        +
        Unregisters a Provider type, and returns a array of all dimensions that are + registered to this provider type. + If the return size is greater then 0, it is required that the caller either + change those dimensions's registered type, or replace this type before the + world is attempted to load, else the loader will throw an exception.
        +
        Parameters:
        id - The provider type ID to unreigster
        +
        Returns:
        An array containing all dimension IDs still registered to this provider type.
        +
        • +
      + + + +
        +
      • +

        init

        +
        public static void init()
        +
        • +
      + + + +
        +
      • +

        registerDimension

        +
        public static void registerDimension(int id,
+                     int providerType)
        +
        • +
      + + + +
        +
      • +

        unregisterDimension

        +
        public static void unregisterDimension(int id)
        +
        For unregistering a dimension when the save is changed (disconnected from a server or loaded a new save
        +
        • +
      + + + +
        +
      • +

        isDimensionRegistered

        +
        public static boolean isDimensionRegistered(int dim)
        +
        • +
      + + + +
        +
      • +

        getProviderType

        +
        public static int getProviderType(int dim)
        +
        • +
      + + + +
        +
      • +

        getProvider

        +
        public static WorldProvider getProvider(int dim)
        +
        • +
      + + + +
        +
      • +

        getIDs

        +
        public static java.lang.Integer[] getIDs(boolean check)
        +
        • +
      + + + +
        +
      • +

        getIDs

        +
        public static java.lang.Integer[] getIDs()
        +
        • +
      + + + +
        +
      • +

        setWorld

        +
        public static void setWorld(int id,
+            WorldServer world)
        +
        • +
      + + + +
        +
      • +

        initDimension

        +
        public static void initDimension(int dim)
        +
        • +
      + + + +
        +
      • +

        getWorld

        +
        public static WorldServer getWorld(int id)
        +
        • +
      + + + +
        +
      • +

        getWorlds

        +
        public static WorldServer[] getWorlds()
        +
        • +
      + + + +
        +
      • +

        shouldLoadSpawn

        +
        public static boolean shouldLoadSpawn(int dim)
        +
        • +
      + + + +
        +
      • +

        getStaticDimensionIDs

        +
        public static java.lang.Integer[] getStaticDimensionIDs()
        +
        Not public API: used internally to get dimensions that should load at + server startup
        +
        • +
      + + + +
        +
      • +

        createProviderFor

        +
        public static WorldProvider createProviderFor(int dim)
        +
        • +
      + + + +
        +
      • +

        unloadWorld

        +
        public static void unloadWorld(int id)
        +
        • +
      + + + +
        +
      • +

        unloadWorlds

        +
        public static void unloadWorlds(java.util.Hashtable<java.lang.Integer,long[]> worldTickTimes)
        +
        • +
      + + + +
        +
      • +

        getNextFreeDimId

        +
        public static int getNextFreeDimId()
        +
        Return the next free dimension ID. Note: you are not guaranteed a contiguous + block of free ids. Always call for each individual ID you wish to get.
        +
        Returns:
        the next free dimension ID
        +
        • +
      + + + +
        +
      • +

        saveDimensionDataMap

        +
        public static NBTTagCompound saveDimensionDataMap()
        +
        • +
      + + + +
        +
      • +

        loadDimensionDataMap

        +
        public static void loadDimensionDataMap(NBTTagCompound compoundTag)
        +
        • +
      + + + +
        +
      • +

        getCurrentSaveRootDirectory

        +
        public static java.io.File getCurrentSaveRootDirectory()
        +
        Return the current root directory for the world save. Accesses getSaveHandler from the overworld
        +
        Returns:
        the root directory of the save
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/DungeonHooks.DungeonMob.html b/javadoc/net/minecraftforge/common/DungeonHooks.DungeonMob.html new file mode 100644 index 0000000..34b645e --- /dev/null +++ b/javadoc/net/minecraftforge/common/DungeonHooks.DungeonMob.html @@ -0,0 +1,312 @@ + + + + + +DungeonHooks.DungeonMob (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class DungeonHooks.DungeonMob

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      java.lang.Stringtype 
      + +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DungeonHooks.DungeonMob(int weight, + java.lang.String type) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object target) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        type

        +
        public java.lang.String type
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DungeonHooks.DungeonMob

        +
        public DungeonHooks.DungeonMob(int weight,
+                       java.lang.String type)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object target)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/DungeonHooks.html b/javadoc/net/minecraftforge/common/DungeonHooks.html new file mode 100644 index 0000000..7786fe8 --- /dev/null +++ b/javadoc/net/minecraftforge/common/DungeonHooks.html @@ -0,0 +1,323 @@ + + + + + +DungeonHooks (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class DungeonHooks

+
+
+ +
+
    +
  • +
    +
    +
    public class DungeonHooks
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class DungeonHooks.DungeonMob 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DungeonHooks() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static floataddDungeonMob(java.lang.String name, + int rarity) +
      Adds a mob to the possible list of creatures the spawner will create.
      +
      static java.lang.StringgetRandomDungeonMob(java.util.Random rand) +
      Gets a random mob name from the list.
      +
      static intremoveDungeonMob(java.lang.String name) +
      Will completely remove a Mob from the dungeon spawn list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DungeonHooks

        +
        public DungeonHooks()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addDungeonMob

        +
        public static float addDungeonMob(java.lang.String name,
+                  int rarity)
        +
        Adds a mob to the possible list of creatures the spawner will create. + If the mob is already in the spawn list, the rarity will be added to the existing one, + causing the mob to be more common.
        +
        Parameters:
        name - The name of the monster, use the same name used when registering the entity.
        rarity - The rarity of selecting this mob over others. Must be greater then 0. + Vanilla Minecraft has the following mobs: + Spider 100 + Skeleton 100 + Zombie 200 + Meaning, Zombies are twice as common as spiders or skeletons.
        +
        Returns:
        The new rarity of the monster,
        +
        • +
      + + + +
        +
      • +

        removeDungeonMob

        +
        public static int removeDungeonMob(java.lang.String name)
        +
        Will completely remove a Mob from the dungeon spawn list.
        +
        Parameters:
        name - The name of the mob to remove
        +
        Returns:
        The rarity of the removed mob, prior to being removed.
        +
        • +
      + + + +
        +
      • +

        getRandomDungeonMob

        +
        public static java.lang.String getRandomDungeonMob(java.util.Random rand)
        +
        Gets a random mob name from the list.
        +
        Parameters:
        rand - World generation random number generator
        +
        Returns:
        The mob name
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/EnumPlantType.html b/javadoc/net/minecraftforge/common/EnumPlantType.html new file mode 100644 index 0000000..5ea8691 --- /dev/null +++ b/javadoc/net/minecraftforge/common/EnumPlantType.html @@ -0,0 +1,377 @@ + + + + + +EnumPlantType (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Enum EnumPlantType

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<EnumPlantType>
    +
    +
    +
    +
    public enum EnumPlantType
+extends java.lang.Enum<EnumPlantType>
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static EnumPlantTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static EnumPlantType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static EnumPlantType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (EnumPlantType c : EnumPlantType.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static EnumPlantType valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/FishingHooks.FishableCategory.html b/javadoc/net/minecraftforge/common/FishingHooks.FishableCategory.html new file mode 100644 index 0000000..a11e3c9 --- /dev/null +++ b/javadoc/net/minecraftforge/common/FishingHooks.FishableCategory.html @@ -0,0 +1,369 @@ + + + + + +FishingHooks.FishableCategory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Enum FishingHooks.FishableCategory

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      FISH 
      JUNK 
      TREASURE 
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      StatBasestat 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static FishingHooks.FishableCategoryvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static FishingHooks.FishableCategory[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static FishingHooks.FishableCategory[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (FishingHooks.FishableCategory c : FishingHooks.FishableCategory.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static FishingHooks.FishableCategory valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/FishingHooks.html b/javadoc/net/minecraftforge/common/FishingHooks.html new file mode 100644 index 0000000..1ba6df5 --- /dev/null +++ b/javadoc/net/minecraftforge/common/FishingHooks.html @@ -0,0 +1,389 @@ + + + + + +FishingHooks (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class FishingHooks

+
+
+ +
+
    +
  • +
    +
    +
    public class FishingHooks
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FishingHooks

        +
        public FishingHooks()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html new file mode 100644 index 0000000..1995c7f --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html @@ -0,0 +1,308 @@ + + + + + +ForgeChunkManager.ForceChunkEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class ForgeChunkManager.ForceChunkEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ForgeChunkManager
    +
    +
    +
    +
    public static class ForgeChunkManager.ForceChunkEvent
+extends Event
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html new file mode 100644 index 0000000..8c8a6a1 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html @@ -0,0 +1,225 @@ + + + + + +ForgeChunkManager.LoadingCallback (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common
+

Interface ForgeChunkManager.LoadingCallback

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidticketsLoaded(java.util.List<ForgeChunkManager.Ticket> tickets, + World world) +
      Called back when tickets are loaded from the world to allow the + mod to re-register the chunks associated with those tickets.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        ticketsLoaded

        +
        void ticketsLoaded(java.util.List<ForgeChunkManager.Ticket> tickets,
+                 World world)
        +
        Called back when tickets are loaded from the world to allow the + mod to re-register the chunks associated with those tickets. The list supplied + here is truncated to length prior to use. Tickets unwanted by the + mod must be disposed of manually unless the mod is an OrderedLoadingCallback instance + in which case, they will have been disposed of by the earlier callback.
        +
        Parameters:
        tickets - The tickets to re-register. The list is immutable and cannot be manipulated directly. Copy it first.
        world - the world
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html new file mode 100644 index 0000000..9a4eff4 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html @@ -0,0 +1,244 @@ + + + + + +ForgeChunkManager.OrderedLoadingCallback (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common
+

Interface ForgeChunkManager.OrderedLoadingCallback

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    ForgeChunkManager.LoadingCallback
    +
    +
    +
    Enclosing class:
    +
    ForgeChunkManager
    +
    +
    +
    +
    public static interface ForgeChunkManager.OrderedLoadingCallback
+extends ForgeChunkManager.LoadingCallback
    +
    This is a special LoadingCallback that can be implemented as well as the + LoadingCallback to provide access to additional behaviour. + Specifically, this callback will fire prior to Forge dropping excess + tickets. Tickets in the returned list are presumed ordered and excess will + be truncated from the returned list. + This allows the mod to control not only if they actually want a ticket but + also their preferred ticket ordering.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        ticketsLoaded

        +
        java.util.List<ForgeChunkManager.Ticket> ticketsLoaded(java.util.List<ForgeChunkManager.Ticket> tickets,
+                                                     World world,
+                                                     int maxTicketCount)
        +
        Called back when tickets are loaded from the world to allow the + mod to decide if it wants the ticket still, and prioritise overflow + based on the ticket count. + WARNING: You cannot force chunks in this callback, it is strictly for allowing the mod + to be more selective in which tickets it wishes to preserve in an overflow situation
        +
        Parameters:
        tickets - The tickets that you will want to select from. The list is immutable and cannot be manipulated directly. Copy it first.
        world - The world
        maxTicketCount - The maximum number of tickets that will be allowed.
        +
        Returns:
        A list of the tickets this mod wishes to continue using. This list will be truncated + to "maxTicketCount" size after the call returns and then offered to the other callback + method
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html new file mode 100644 index 0000000..492868e --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html @@ -0,0 +1,235 @@ + + + + + +ForgeChunkManager.PlayerOrderedLoadingCallback (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common
+

Interface ForgeChunkManager.PlayerOrderedLoadingCallback

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        playerTicketsLoaded

        +
        com.google.common.collect.ListMultimap<java.lang.String,ForgeChunkManager.Ticket> playerTicketsLoaded(com.google.common.collect.ListMultimap<java.lang.String,ForgeChunkManager.Ticket> tickets,
+                                                                                                    World world)
        +
        Called back when tickets are loaded from the world to allow the + mod to decide if it wants the ticket still. + This is for player bound tickets rather than mod bound tickets. It is here so mods can + decide they want to dump all player tickets + + WARNING: You cannot force chunks in this callback, it is strictly for allowing the mod + to be more selective in which tickets it wishes to preserve
        +
        Parameters:
        tickets - The tickets that you will want to select from. The list is immutable and cannot be manipulated directly. Copy it first.
        world - The world
        +
        Returns:
        A list of the tickets this mod wishes to use. This list will subsequently be offered + to the main callback for action
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html new file mode 100644 index 0000000..181e4eb --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html @@ -0,0 +1,435 @@ + + + + + +ForgeChunkManager.Ticket (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common
+

Class ForgeChunkManager.Ticket

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ForgeChunkManager
    +
    +
    +
    +
    public static class ForgeChunkManager.Ticket
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setChunkListDepth

        +
        public void setChunkListDepth(int depth)
        +
        The chunk list depth can be manipulated up to the maximal grant allowed for the mod. This value is configurable. Once the maximum is reached, + the least recently forced chunk, by original registration time, is removed from the forced chunk list.
        +
        Parameters:
        depth - The new depth to set
        +
        • +
      + + + +
        +
      • +

        getChunkListDepth

        +
        public int getChunkListDepth()
        +
        Gets the current max depth for this ticket. + Should be the same as getMaxChunkListDepth() + unless setChunkListDepth has been called.
        +
        Returns:
        Current max depth
        +
        • +
      + + + +
        +
      • +

        getMaxChunkListDepth

        +
        public int getMaxChunkListDepth()
        +
        Get the maximum chunk depth size
        +
        Returns:
        The maximum chunk depth size
        +
        • +
      + + + +
        +
      • +

        bindEntity

        +
        public void bindEntity(Entity entity)
        +
        Bind the entity to the ticket for ForgeChunkManager.Type.ENTITY type tickets. Other types will throw a runtime exception.
        +
        Parameters:
        entity - The entity to bind
        +
        • +
      + + + +
        +
      • +

        getModData

        +
        public NBTTagCompound getModData()
        +
        Retrieve the NBTTagCompound that stores mod specific data for the chunk ticket. + Example data to store would be a TileEntity or Block location. This is persisted with the ticket and + provided to the ForgeChunkManager.LoadingCallback for the mod. It is recommended to use this to recover + useful state information for the forced chunks.
        +
        Returns:
        The custom compound tag for mods to store additional chunkloading data
        +
        • +
      + + + + + + + +
        +
      • +

        isPlayerTicket

        +
        public boolean isPlayerTicket()
        +
        Is this a player associated ticket rather than a mod associated ticket?
        +
        • +
      + + + +
        +
      • +

        getPlayerName

        +
        public java.lang.String getPlayerName()
        +
        Get the player associated with this ticket
        +
        • +
      + + + +
        +
      • +

        getModId

        +
        public java.lang.String getModId()
        +
        Get the associated mod id
        +
        • +
      + + + + + + + +
        +
      • +

        getChunkList

        +
        public com.google.common.collect.ImmutableSet<ChunkCoordIntPair> getChunkList()
        +
        Gets a list of requested chunks for this ticket.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.Type.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.Type.html new file mode 100644 index 0000000..a92ba7b --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.Type.html @@ -0,0 +1,327 @@ + + + + + +ForgeChunkManager.Type (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Enum ForgeChunkManager.Type

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      ENTITY +
      For entity registrations
      +
      NORMAL +
      For non-entity registrations
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static ForgeChunkManager.TypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ForgeChunkManager.Type[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ForgeChunkManager.Type[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ForgeChunkManager.Type c : ForgeChunkManager.Type.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ForgeChunkManager.Type valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html new file mode 100644 index 0000000..3adfe41 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html @@ -0,0 +1,308 @@ + + + + + +ForgeChunkManager.UnforceChunkEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class ForgeChunkManager.UnforceChunkEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ForgeChunkManager
    +
    +
    +
    +
    public static class ForgeChunkManager.UnforceChunkEvent
+extends Event
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.html new file mode 100644 index 0000000..0550c95 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.html @@ -0,0 +1,694 @@ + + + + + +ForgeChunkManager (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class ForgeChunkManager

+
+
+ +
+
    +
  • +
    +
    +
    public class ForgeChunkManager
+extends java.lang.Object
    +
    Manages chunkloading for mods. + + The basic principle is a ticket based system. + 1. Mods register a callback setForcedChunkLoadingCallback(Object, LoadingCallback) + 2. Mods ask for a ticket requestTicket(Object, World, Type) and then hold on to that ticket. + 3. Mods request chunks to stay loaded forceChunk(Ticket, ChunkCoordIntPair) or remove chunks from force loading unforceChunk(Ticket, ChunkCoordIntPair). + 4. When a world unloads, the tickets associated with that world are saved by the chunk manager. + 5. When a world loads, saved tickets are offered to the mods associated with the tickets. The ForgeChunkManager.Ticket.getModData() that is set by the mod should be used to re-register + chunks to stay loaded (and maybe take other actions). + + The chunkloading is configurable at runtime. The file "config/forgeChunkLoading.cfg" contains both default configuration for chunkloading, and a sample individual mod + specific override section.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        MOD_PROP_ORDER

        +
        public static final java.util.List<java.lang.String> MOD_PROP_ORDER
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeChunkManager

        +
        public ForgeChunkManager()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        savedWorldHasForcedChunkTickets

        +
        public static boolean savedWorldHasForcedChunkTickets(java.io.File chunkDir)
        +
        Allows dynamically loading world mods to test if there are chunk tickets in the world + Mods that add dynamically generated worlds (like Mystcraft) should call this method + to determine if the world should be loaded during server starting.
        +
        Parameters:
        chunkDir - The chunk directory to test: should be equivalent to WorldServer.getChunkSaveLocation()
        +
        Returns:
        if there are tickets outstanding for this world or not
        +
        • +
      + + + +
        +
      • +

        setForcedChunkLoadingCallback

        +
        public static void setForcedChunkLoadingCallback(java.lang.Object mod,
+                                 ForgeChunkManager.LoadingCallback callback)
        +
        Set a chunkloading callback for the supplied mod object
        +
        Parameters:
        mod - The mod instance registering the callback
        callback - The code to call back when forced chunks are loaded
        +
        • +
      + + + +
        +
      • +

        ticketCountAvailableFor

        +
        public static int ticketCountAvailableFor(java.lang.Object mod,
+                          World world)
        +
        Discover the available tickets for the mod in the world
        +
        Parameters:
        mod - The mod that will own the tickets
        world - The world
        +
        Returns:
        The count of tickets left for the mod in the supplied world
        +
        • +
      + + + +
        +
      • +

        getMaxTicketLengthFor

        +
        public static int getMaxTicketLengthFor(java.lang.String modId)
        +
        • +
      + + + +
        +
      • +

        getMaxChunkDepthFor

        +
        public static int getMaxChunkDepthFor(java.lang.String modId)
        +
        • +
      + + + +
        +
      • +

        ticketCountAvailableFor

        +
        public static int ticketCountAvailableFor(java.lang.String username)
        +
        • +
      + + + + + + + +
        +
      • +

        requestTicket

        +
        public static ForgeChunkManager.Ticket requestTicket(java.lang.Object mod,
+                                     World world,
+                                     ForgeChunkManager.Type type)
        +
        Request a chunkloading ticket of the appropriate type for the supplied mod
        +
        Parameters:
        mod - The mod requesting a ticket
        world - The world in which it is requesting the ticket
        type - The type of ticket
        +
        Returns:
        A ticket with which to register chunks for loading, or null if no further tickets are available
        +
        • +
      + + + +
        +
      • +

        releaseTicket

        +
        public static void releaseTicket(ForgeChunkManager.Ticket ticket)
        +
        Release the ticket back to the system. This will also unforce any chunks held by the ticket so that they can be unloaded and/or stop ticking.
        +
        Parameters:
        ticket - The ticket to release
        +
        • +
      + + + +
        +
      • +

        forceChunk

        +
        public static void forceChunk(ForgeChunkManager.Ticket ticket,
+              ChunkCoordIntPair chunk)
        +
        Force the supplied chunk coordinate to be loaded by the supplied ticket. If the ticket's ForgeChunkManager.Ticket.maxDepth is exceeded, the least + recently registered chunk is unforced and may be unloaded. + It is safe to force the chunk several times for a ticket, it will not generate duplication or change the ordering.
        +
        Parameters:
        ticket - The ticket registering the chunk
        chunk - The chunk to force
        +
        • +
      + + + +
        +
      • +

        reorderChunk

        +
        public static void reorderChunk(ForgeChunkManager.Ticket ticket,
+                ChunkCoordIntPair chunk)
        +
        Reorganize the internal chunk list so that the chunk supplied is at the *end* of the list + This helps if you wish to guarantee a certain "automatic unload ordering" for the chunks + in the ticket list
        +
        Parameters:
        ticket - The ticket holding the chunk list
        chunk - The chunk you wish to push to the end (so that it would be unloaded last)
        +
        • +
      + + + +
        +
      • +

        unforceChunk

        +
        public static void unforceChunk(ForgeChunkManager.Ticket ticket,
+                ChunkCoordIntPair chunk)
        +
        Unforce the supplied chunk, allowing it to be unloaded and stop ticking.
        +
        Parameters:
        ticket - The ticket holding the chunk
        chunk - The chunk to unforce
        +
        • +
      + + + +
        +
      • +

        getPersistentChunksFor

        +
        public static com.google.common.collect.ImmutableSetMultimap<ChunkCoordIntPair,ForgeChunkManager.Ticket> getPersistentChunksFor(World world)
        +
        The list of persistent chunks in the world. This set is immutable.
        +
        Parameters:
        world -
        +
        Returns:
        the list of persistent chunks in the world
        +
        • +
      + + + +
        +
      • +

        putDormantChunk

        +
        public static void putDormantChunk(long coords,
+                   Chunk chunk)
        +
        • +
      + + + +
        +
      • +

        fetchDormantChunk

        +
        public static Chunk fetchDormantChunk(long coords,
+                      World world)
        +
        • +
      + + + +
        +
      • +

        syncConfigDefaults

        +
        public static void syncConfigDefaults()
        +
        Synchronizes the local fields with the values in the Configuration object.
        +
        • +
      + + + + + + + +
        +
      • +

        getDefaultsCategory

        +
        public static ConfigCategory getDefaultsCategory()
        +
        • +
      + + + +
        +
      • +

        getModCategories

        +
        public static java.util.List<ConfigCategory> getModCategories()
        +
        • +
      + + + +
        +
      • +

        getConfigFor

        +
        public static ConfigCategory getConfigFor(java.lang.Object mod)
        +
        • +
      + + + +
        +
      • +

        addConfigProperty

        +
        public static void addConfigProperty(java.lang.Object mod,
+                     java.lang.String propertyName,
+                     java.lang.String value,
+                     Property.Type type)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeHooks.html b/javadoc/net/minecraftforge/common/ForgeHooks.html new file mode 100644 index 0000000..c94810b --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeHooks.html @@ -0,0 +1,704 @@ + + + + + +ForgeHooks (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common
+

Class ForgeHooks

+
+
+ +
+
    +
  • +
    +
    +
    public class ForgeHooks
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeInternalHandler.html b/javadoc/net/minecraftforge/common/ForgeInternalHandler.html new file mode 100644 index 0000000..8f38de5 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeInternalHandler.html @@ -0,0 +1,293 @@ + + + + + +ForgeInternalHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common
+

Class ForgeInternalHandler

+
+
+ +
+
    +
  • +
    +
    +
    public class ForgeInternalHandler
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeInternalHandler

        +
        public ForgeInternalHandler()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeModContainer.html b/javadoc/net/minecraftforge/common/ForgeModContainer.html new file mode 100644 index 0000000..eafdcdd --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeModContainer.html @@ -0,0 +1,733 @@ + + + + + +ForgeModContainer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class ForgeModContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeVersion.Status.html b/javadoc/net/minecraftforge/common/ForgeVersion.Status.html new file mode 100644 index 0000000..b7f1714 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeVersion.Status.html @@ -0,0 +1,381 @@ + + + + + +ForgeVersion.Status (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Enum ForgeVersion.Status

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static ForgeVersion.StatusvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ForgeVersion.Status[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ForgeVersion.Status[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ForgeVersion.Status c : ForgeVersion.Status.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ForgeVersion.Status valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ForgeVersion.html b/javadoc/net/minecraftforge/common/ForgeVersion.html new file mode 100644 index 0000000..be1e4f8 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeVersion.html @@ -0,0 +1,443 @@ + + + + + +ForgeVersion (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class ForgeVersion

+
+
+ +
+
    +
  • +
    +
    +
    public class ForgeVersion
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeVersion

        +
        public ForgeVersion()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMajorVersion

        +
        public static int getMajorVersion()
        +
        • +
      + + + +
        +
      • +

        getMinorVersion

        +
        public static int getMinorVersion()
        +
        • +
      + + + +
        +
      • +

        getRevisionVersion

        +
        public static int getRevisionVersion()
        +
        • +
      + + + +
        +
      • +

        getBuildVersion

        +
        public static int getBuildVersion()
        +
        • +
      + + + + + + + +
        +
      • +

        getTarget

        +
        public static java.lang.String getTarget()
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public static java.lang.String getVersion()
        +
        • +
      + + + +
        +
      • +

        startVersionCheck

        +
        public static void startVersionCheck()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/IExtendedEntityProperties.html b/javadoc/net/minecraftforge/common/IExtendedEntityProperties.html new file mode 100644 index 0000000..efb8871 --- /dev/null +++ b/javadoc/net/minecraftforge/common/IExtendedEntityProperties.html @@ -0,0 +1,253 @@ + + + + + +IExtendedEntityProperties (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common
+

Interface IExtendedEntityProperties

+
+
+
+
    +
  • +
    +
    +
    public interface IExtendedEntityProperties
    +
    Allows for custom entity data and logic to be hooked to existing entity classes.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidinit(Entity entity, + World world) +
      Used to initialize the extended properties with the entity that this is attached to, as well + as the world object.
      +
      voidloadNBTData(NBTTagCompound compound) +
      Called when the entity that this class is attached to is loaded.
      +
      voidsaveNBTData(NBTTagCompound compound) +
      Called when the entity that this class is attached to is saved.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        saveNBTData

        +
        void saveNBTData(NBTTagCompound compound)
        +
        Called when the entity that this class is attached to is saved. + Any custom entity data that needs saving should be saved here.
        +
        Parameters:
        compound - The compound to save to.
        +
        • +
      + + + +
        +
      • +

        loadNBTData

        +
        void loadNBTData(NBTTagCompound compound)
        +
        Called when the entity that this class is attached to is loaded. + In order to hook into this, you will need to subscribe to the EntityConstructing event. + Otherwise, you will need to initialize manually.
        +
        Parameters:
        compound - The compound to load from.
        +
        • +
      + + + +
        +
      • +

        init

        +
        void init(Entity entity,
+        World world)
        +
        Used to initialize the extended properties with the entity that this is attached to, as well + as the world object. + Called automatically if you register with the EntityConstructing event. + May be called multiple times if the extended properties is moved over to a new entity. + Such as when a player switches dimension {Minecraft re-creates the player entity}
        +
        Parameters:
        entity - The entity that this extended properties is attached to
        world - The world in which the entity exists
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/IMinecartCollisionHandler.html b/javadoc/net/minecraftforge/common/IMinecartCollisionHandler.html new file mode 100644 index 0000000..cdc7fd7 --- /dev/null +++ b/javadoc/net/minecraftforge/common/IMinecartCollisionHandler.html @@ -0,0 +1,274 @@ + + + + + +IMinecartCollisionHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common
+

Interface IMinecartCollisionHandler

+
+
+
+
    +
  • +
    +
    +
    public interface IMinecartCollisionHandler
    +
    This class defines a replacement for the default minecart collision code. + Only one handler can be registered at a time. It it registered with EntityMinecart.registerCollisionHandler(). + If you use this, make it a configuration option.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onEntityCollision

        +
        void onEntityCollision(EntityMinecart cart,
+                     Entity other)
        +
        This basically replaces the function of the same name in EnityMinecart. + Code in IMinecartHooks.applyEntityCollisionHook is still run.
        +
        Parameters:
        cart - The cart that called the collision.
        other - The object it collided with.
        +
        • +
      + + + +
        +
      • +

        getCollisionBox

        +
        AxisAlignedBB getCollisionBox(EntityMinecart cart,
+                            Entity other)
        +
        This function replaced the function of the same name in EntityMinecart. + It is used to define whether minecarts collide with specific entities, + for example items.
        +
        Parameters:
        cart - The cart for which the collision box was requested.
        other - The entity requesting the collision box.
        +
        Returns:
        The collision box or null.
        +
        • +
      + + + +
        +
      • +

        getMinecartCollisionBox

        +
        AxisAlignedBB getMinecartCollisionBox(EntityMinecart cart)
        +
        This function is used to define the box used for detecting minecart collisions. + It is generally bigger that the normal collision box.
        +
        Parameters:
        cart - The cart for which the collision box was requested.
        +
        Returns:
        The collision box, cannot be null.
        +
        • +
      + + + +
        +
      • +

        getBoundingBox

        +
        AxisAlignedBB getBoundingBox(EntityMinecart cart)
        +
        This function replaces the function of the same name in EntityMinecart. + It defines whether minecarts are solid to the player.
        +
        Parameters:
        cart - The cart for which the bounding box was requested.
        +
        Returns:
        The bounding box or null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/IPlantable.html b/javadoc/net/minecraftforge/common/IPlantable.html new file mode 100644 index 0000000..879c444 --- /dev/null +++ b/javadoc/net/minecraftforge/common/IPlantable.html @@ -0,0 +1,252 @@ + + + + + +IPlantable (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common
+

Interface IPlantable

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/IShearable.html b/javadoc/net/minecraftforge/common/IShearable.html new file mode 100644 index 0000000..4c316d5 --- /dev/null +++ b/javadoc/net/minecraftforge/common/IShearable.html @@ -0,0 +1,264 @@ + + + + + +IShearable (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common
+

Interface IShearable

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanisShearable(ItemStack item, + IBlockAccess world, + int x, + int y, + int z) +
      Checks if the object is currently shearable + Example: Sheep return false when they have no wool
      +
      java.util.ArrayList<ItemStack>onSheared(ItemStack item, + IBlockAccess world, + int x, + int y, + int z, + int fortune) +
      Performs the shear function on this object.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isShearable

        +
        boolean isShearable(ItemStack item,
+                  IBlockAccess world,
+                  int x,
+                  int y,
+                  int z)
        +
        Checks if the object is currently shearable + Example: Sheep return false when they have no wool
        +
        Parameters:
        item - The itemstack that is being used, Possible to be null
        world - The current world
        x - The X Position
        y - The Y Position
        z - The Z Position
        +
        Returns:
        If this is shearable, and onSheared should be called.
        +
        • +
      + + + +
        +
      • +

        onSheared

        +
        java.util.ArrayList<ItemStack> onSheared(ItemStack item,
+                                       IBlockAccess world,
+                                       int x,
+                                       int y,
+                                       int z,
+                                       int fortune)
        +
        Performs the shear function on this object. + This is called for both client, and server. + The object should perform all actions related to being sheared, + except for dropping of the items, and removal of the block. + As those are handled by ItemShears itself. + + Returns a list of items that resulted from the shearing process. + + For entities, they should trust there internal location information + over the values passed into this function.
        +
        Parameters:
        item - The itemstack that is being used, Possible to be null
        world - The current world
        x - The X Position
        y - The Y Position
        z - The Z Position
        fortune - The fortune level of the shears being used
        +
        Returns:
        A ArrayList containing all items from this shearing. Possible to be null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ISpecialArmor.ArmorProperties.html b/javadoc/net/minecraftforge/common/ISpecialArmor.ArmorProperties.html new file mode 100644 index 0000000..57b3f9a --- /dev/null +++ b/javadoc/net/minecraftforge/common/ISpecialArmor.ArmorProperties.html @@ -0,0 +1,400 @@ + + + + + +ISpecialArmor.ArmorProperties (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class ISpecialArmor.ArmorProperties

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        Priority

        +
        public int Priority
        +
        • +
      + + + +
        +
      • +

        AbsorbMax

        +
        public int AbsorbMax
        +
        • +
      + + + +
        +
      • +

        AbsorbRatio

        +
        public double AbsorbRatio
        +
        • +
      + + + +
        +
      • +

        Slot

        +
        public int Slot
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ISpecialArmor.ArmorProperties

        +
        public ISpecialArmor.ArmorProperties(int priority,
+                             double ratio,
+                             int max)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        ApplyArmor

        +
        public static float ApplyArmor(EntityLivingBase entity,
+               ItemStack[] inventory,
+               DamageSource source,
+               double damage)
        +
        Gathers and applies armor reduction to damage being dealt to a entity.
        +
        Parameters:
        entity - The Entity being damage
        inventory - An array of armor items
        source - The damage source type
        damage - The total damage being done
        +
        Returns:
        The left over damage that has not been absorbed by the armor
        +
        • +
      + + + + + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/ISpecialArmor.html b/javadoc/net/minecraftforge/common/ISpecialArmor.html new file mode 100644 index 0000000..dbf967a --- /dev/null +++ b/javadoc/net/minecraftforge/common/ISpecialArmor.html @@ -0,0 +1,296 @@ + + + + + +ISpecialArmor (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common
+

Interface ISpecialArmor

+
+
+
+
    +
  • +
    +
    +
    public interface ISpecialArmor
    +
    This interface is to be implemented by ItemArmor classes. It will allow to + modify computation of damage and health loss. Computation will be called + before the actual armor computation, which can then be cancelled.
    +
    See Also:
    ItemArmor
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getProperties

        +
        ISpecialArmor.ArmorProperties getProperties(EntityLivingBase player,
+                                          ItemStack armor,
+                                          DamageSource source,
+                                          double damage,
+                                          int slot)
        +
        Retrieves the modifiers to be used when calculating armor damage. + + Armor will higher priority will have damage applied to them before + lower priority ones. If there are multiple pieces of armor with the + same priority, damage will be distributed between them based on there + absorption ratio.
        +
        Parameters:
        player - The entity wearing the armor.
        armor - The ItemStack of the armor item itself.
        source - The source of the damage, which can be used to alter armor + properties based on the type or source of damage.
        damage - The total damage being applied to the entity
        slot - The armor slot the item is in.
        +
        Returns:
        A ArmorProperties instance holding information about how the armor effects damage.
        +
        • +
      + + + +
        +
      • +

        getArmorDisplay

        +
        int getArmorDisplay(EntityPlayer player,
+                  ItemStack armor,
+                  int slot)
        +
        Get the displayed effective armor.
        +
        Parameters:
        player - The player wearing the armor.
        armor - The ItemStack of the armor item itself.
        slot - The armor slot the item is in.
        +
        Returns:
        The number of armor points for display, 2 per shield.
        +
        • +
      + + + +
        +
      • +

        damageArmor

        +
        void damageArmor(EntityLivingBase entity,
+               ItemStack stack,
+               DamageSource source,
+               int damage,
+               int slot)
        +
        Applies damage to the ItemStack. The mod is responsible for reducing the + item durability and stack size. If the stack is depleted it will be cleaned + up automatically.
        +
        Parameters:
        entity - The entity wearing the armor
        stack - The ItemStack of the armor item itself.
        source - The source of the damage, which can be used to alter armor + properties based on the type or source of damage.
        damage - The amount of damage being applied to the armor
        slot - The armor slot the item is in.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/MinecraftForge.html b/javadoc/net/minecraftforge/common/MinecraftForge.html new file mode 100644 index 0000000..f304d82 --- /dev/null +++ b/javadoc/net/minecraftforge/common/MinecraftForge.html @@ -0,0 +1,375 @@ + + + + + +MinecraftForge (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class MinecraftForge

+
+
+ +
+
    +
  • +
    +
    +
    public class MinecraftForge
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static EventBusEVENT_BUS +
      The core Forge EventBusses, all events for Forge will be fired on these, + you should use this to register all your listeners.
      +
      static java.lang.StringMC_VERSION 
      static EventBusORE_GEN_BUS 
      static EventBusTERRAIN_GEN_BUS 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MinecraftForge() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidaddGrassSeed(ItemStack seed, + int weight) +
      Register a new seed to be dropped when breaking tall grass.
      +
      static java.lang.StringgetBrandingVersion() 
      static voidinitialize() +
      Method invoked by FML before any other mods are loaded.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        EVENT_BUS

        +
        public static final EventBus EVENT_BUS
        +
        The core Forge EventBusses, all events for Forge will be fired on these, + you should use this to register all your listeners. + This replaces every register*Handler() function in the old version of Forge. + TERRAIN_GEN_BUS for terrain gen events + ORE_GEN_BUS for ore gen events + EVENT_BUS for everything else
        +
        • +
      + + + +
        +
      • +

        TERRAIN_GEN_BUS

        +
        public static final EventBus TERRAIN_GEN_BUS
        +
        • +
      + + + +
        +
      • +

        ORE_GEN_BUS

        +
        public static final EventBus ORE_GEN_BUS
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MinecraftForge

        +
        public MinecraftForge()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addGrassSeed

        +
        public static void addGrassSeed(ItemStack seed,
+                int weight)
        +
        Register a new seed to be dropped when breaking tall grass.
        +
        Parameters:
        seed - The item to drop as a seed.
        weight - The relative probability of the seeds, + where wheat seeds are 10.
        +
        • +
      + + + +
        +
      • +

        initialize

        +
        public static void initialize()
        +
        Method invoked by FML before any other mods are loaded.
        +
        • +
      + + + +
        +
      • +

        getBrandingVersion

        +
        public static java.lang.String getBrandingVersion()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/UsernameCache.html b/javadoc/net/minecraftforge/common/UsernameCache.html new file mode 100644 index 0000000..055d13a --- /dev/null +++ b/javadoc/net/minecraftforge/common/UsernameCache.html @@ -0,0 +1,339 @@ + + + + + +UsernameCache (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common
+

Class UsernameCache

+
+
+ +
+
    +
  • +
    +
    +
    public final class UsernameCache
+extends java.lang.Object
    +
    Caches player's last known usernames +

    + Modders should use getLastKnownUsername(UUID) to determine a players + last known username.
    + For convenience, getMap() is provided to get an immutable copy of + the caches underlying map.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static booleancontainsUUID(java.util.UUID uuid) +
      Check if the cache contains the given player's username
      +
      static java.lang.StringgetLastKnownUsername(java.util.UUID uuid) +
      Get the player's last known username
      +
      static java.util.Map<java.util.UUID,java.lang.String>getMap() +
      Get an immutable copy of the cache's underlying map
      +
      protected static voidload() +
      Load the cache from file
      +
      protected static booleanremoveUsername(java.util.UUID uuid) +
      Remove a player's username from the cache
      +
      protected static voidsave() +
      Save the cache to file
      +
      protected static voidsetUsername(java.util.UUID uuid, + java.lang.String username) +
      Set a player's current username
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setUsername

        +
        protected static void setUsername(java.util.UUID uuid,
+               java.lang.String username)
        +
        Set a player's current username
        +
        Parameters:
        uuid - the player's UUID
        username - the player's username
        +
        • +
      + + + +
        +
      • +

        removeUsername

        +
        protected static boolean removeUsername(java.util.UUID uuid)
        +
        Remove a player's username from the cache
        +
        Parameters:
        uuid - the player's UUID
        +
        Returns:
        if the cache contained the user
        +
        • +
      + + + +
        +
      • +

        getLastKnownUsername

        +
        @Nullable
+public static java.lang.String getLastKnownUsername(java.util.UUID uuid)
        +
        Get the player's last known username +

        + May be null

        +
        Parameters:
        uuid - the player's UUID
        +
        Returns:
        the player's last known username, or null if the + cache doesn't have a record of the last username
        +
        • +
      + + + +
        +
      • +

        containsUUID

        +
        public static boolean containsUUID(java.util.UUID uuid)
        +
        Check if the cache contains the given player's username
        +
        Parameters:
        uuid - the player's UUID
        +
        Returns:
        if the cache contains a username for the given player
        +
        • +
      + + + +
        +
      • +

        getMap

        +
        public static java.util.Map<java.util.UUID,java.lang.String> getMap()
        +
        Get an immutable copy of the cache's underlying map
        +
        Returns:
        the map
        +
        • +
      + + + +
        +
      • +

        save

        +
        protected static void save()
        +
        Save the cache to file
        +
        • +
      + + + +
        +
      • +

        load

        +
        protected static void load()
        +
        Load the cache from file
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/WorldSpecificSaveHandler.html b/javadoc/net/minecraftforge/common/WorldSpecificSaveHandler.html new file mode 100644 index 0000000..3036b89 --- /dev/null +++ b/javadoc/net/minecraftforge/common/WorldSpecificSaveHandler.html @@ -0,0 +1,422 @@ + + + + + +WorldSpecificSaveHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common
+

Class WorldSpecificSaveHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    ISaveHandler
    +
    +
    +
    +
    public class WorldSpecificSaveHandler
+extends java.lang.Object
+implements ISaveHandler
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/chunkio/ChunkIOExecutor.html b/javadoc/net/minecraftforge/common/chunkio/ChunkIOExecutor.html new file mode 100644 index 0000000..079f2fb --- /dev/null +++ b/javadoc/net/minecraftforge/common/chunkio/ChunkIOExecutor.html @@ -0,0 +1,330 @@ + + + + + +ChunkIOExecutor (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common.chunkio
+

Class ChunkIOExecutor

+
+
+ +
+
    +
  • +
    +
    +
    public class ChunkIOExecutor
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ChunkIOExecutor

        +
        public ChunkIOExecutor()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        dropQueuedChunkLoad

        +
        public static void dropQueuedChunkLoad(World world,
+                       int x,
+                       int z,
+                       java.lang.Runnable runnable)
        +
        • +
      + + + +
        +
      • +

        adjustPoolSize

        +
        public static void adjustPoolSize(int players)
        +
        • +
      + + + +
        +
      • +

        tick

        +
        public static void tick()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/chunkio/package-frame.html b/javadoc/net/minecraftforge/common/chunkio/package-frame.html new file mode 100644 index 0000000..a6b0808 --- /dev/null +++ b/javadoc/net/minecraftforge/common/chunkio/package-frame.html @@ -0,0 +1,19 @@ + + + + + +net.minecraftforge.common.chunkio (Forge API) + + + + +

net.minecraftforge.common.chunkio

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/common/chunkio/package-summary.html b/javadoc/net/minecraftforge/common/chunkio/package-summary.html new file mode 100644 index 0000000..f969902 --- /dev/null +++ b/javadoc/net/minecraftforge/common/chunkio/package-summary.html @@ -0,0 +1,131 @@ + + + + + +net.minecraftforge.common.chunkio (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.common.chunkio

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/chunkio/package-tree.html b/javadoc/net/minecraftforge/common/chunkio/package-tree.html new file mode 100644 index 0000000..81d78b4 --- /dev/null +++ b/javadoc/net/minecraftforge/common/chunkio/package-tree.html @@ -0,0 +1,126 @@ + + + + + +net.minecraftforge.common.chunkio Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.common.chunkio

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/config/ConfigCategory.html b/javadoc/net/minecraftforge/common/config/ConfigCategory.html new file mode 100644 index 0000000..f9c0e7d --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/ConfigCategory.html @@ -0,0 +1,929 @@ + + + + + +ConfigCategory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common.config
+

Class ConfigCategory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Map<java.lang.String,Property>
    +
    +
    +
    +
    public class ConfigCategory
+extends java.lang.Object
+implements java.util.Map<java.lang.String,Property>
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConfigCategory

        +
        public ConfigCategory(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        ConfigCategory

        +
        public ConfigCategory(java.lang.String name,
+              ConfigCategory parent)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Specified by:
        +
        equals in interface java.util.Map<java.lang.String,Property>
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        getQualifiedName

        +
        public java.lang.String getQualifiedName()
        +
        • +
      + + + +
        +
      • +

        getQualifiedName

        +
        public static java.lang.String getQualifiedName(java.lang.String name,
+                                ConfigCategory parent)
        +
        • +
      + + + + + + + +
        +
      • +

        isChild

        +
        public boolean isChild()
        +
        • +
      + + + +
        +
      • +

        getValues

        +
        public java.util.Map<java.lang.String,Property> getValues()
        +
        • +
      + + + +
        +
      • +

        getOrderedValues

        +
        public java.util.List<Property> getOrderedValues()
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        setLanguageKey

        +
        public ConfigCategory setLanguageKey(java.lang.String languagekey)
        +
        • +
      + + + +
        +
      • +

        getLanguagekey

        +
        public java.lang.String getLanguagekey()
        +
        • +
      + + + +
        +
      • +

        setComment

        +
        public void setComment(java.lang.String comment)
        +
        • +
      + + + +
        +
      • +

        getComment

        +
        public java.lang.String getComment()
        +
        • +
      + + + +
        +
      • +

        setRequiresWorldRestart

        +
        public ConfigCategory setRequiresWorldRestart(boolean requiresWorldRestart)
        +
        Sets the flag for whether or not this category can be edited while a world is running. Care should be taken to ensure + that only properties that are truly dynamic can be changed from the in-game options menu. Only set this flag to + true if all child properties/categories are unable to be modified while a world is running.
        +
        • +
      + + + +
        +
      • +

        requiresWorldRestart

        +
        public boolean requiresWorldRestart()
        +
        Returns whether or not this category is able to be edited while a world is running using the in-game Mod Options screen + as well as the Mods list screen, or only from the Mods list screen.
        +
        • +
      + + + +
        +
      • +

        setShowInGui

        +
        public ConfigCategory setShowInGui(boolean showInGui)
        +
        Sets whether or not this ConfigCategory should be allowed to show on config GUIs. + Defaults to true.
        +
        • +
      + + + +
        +
      • +

        showInGui

        +
        public boolean showInGui()
        +
        Gets whether or not this ConfigCategory should be allowed to show on config GUIs. + Defaults to true unless set to false.
        +
        • +
      + + + +
        +
      • +

        setRequiresMcRestart

        +
        public ConfigCategory setRequiresMcRestart(boolean requiresMcRestart)
        +
        Sets whether or not this ConfigCategory requires Minecraft to be restarted when changed. + Defaults to false. Only set this flag to true if ALL child properties/categories require + Minecraft to be restarted when changed. Setting this flag will also prevent modification + of the child properties/categories while a world is running.
        +
        • +
      + + + +
        +
      • +

        requiresMcRestart

        +
        public boolean requiresMcRestart()
        +
        Gets whether or not this ConfigCategory requires Minecraft to be restarted when changed. + Defaults to false unless set to true.
        +
        • +
      + + + +
        +
      • +

        setPropertyOrder

        +
        public ConfigCategory setPropertyOrder(java.util.List<java.lang.String> propertyOrder)
        +
        • +
      + + + +
        +
      • +

        getPropertyOrder

        +
        public java.util.List<java.lang.String> getPropertyOrder()
        +
        • +
      + + + +
        +
      • +

        containsKey

        +
        public boolean containsKey(java.lang.String key)
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String key)
        +
        • +
      + + + +
        +
      • +

        write

        +
        public void write(java.io.BufferedWriter out,
+         int indent)
+           throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        hasChanged

        +
        public boolean hasChanged()
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Map<java.lang.String,Property>
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        +
        Specified by:
        +
        isEmpty in interface java.util.Map<java.lang.String,Property>
        +
        +
        • +
      + + + +
        +
      • +

        containsKey

        +
        public boolean containsKey(java.lang.Object key)
        +
        +
        Specified by:
        +
        containsKey in interface java.util.Map<java.lang.String,Property>
        +
        +
        • +
      + + + +
        +
      • +

        containsValue

        +
        public boolean containsValue(java.lang.Object value)
        +
        +
        Specified by:
        +
        containsValue in interface java.util.Map<java.lang.String,Property>
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.Object key)
        +
        +
        Specified by:
        +
        get in interface java.util.Map<java.lang.String,Property>
        +
        +
        • +
      + + + +
        +
      • +

        put

        +
        public Property put(java.lang.String key,
+           Property value)
        +
        +
        Specified by:
        +
        put in interface java.util.Map<java.lang.String,Property>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public Property remove(java.lang.Object key)
        +
        +
        Specified by:
        +
        remove in interface java.util.Map<java.lang.String,Property>
        +
        +
        • +
      + + + +
        +
      • +

        putAll

        +
        public void putAll(java.util.Map<? extends java.lang.String,? extends Property> m)
        +
        +
        Specified by:
        +
        putAll in interface java.util.Map<java.lang.String,Property>
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        +
        Specified by:
        +
        clear in interface java.util.Map<java.lang.String,Property>
        +
        +
        • +
      + + + +
        +
      • +

        keySet

        +
        public java.util.Set<java.lang.String> keySet()
        +
        +
        Specified by:
        +
        keySet in interface java.util.Map<java.lang.String,Property>
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public java.util.Collection<Property> values()
        +
        +
        Specified by:
        +
        values in interface java.util.Map<java.lang.String,Property>
        +
        +
        • +
      + + + +
        +
      • +

        entrySet

        +
        public java.util.Set<java.util.Map.Entry<java.lang.String,Property>> entrySet()
        +
        +
        Specified by:
        +
        entrySet in interface java.util.Map<java.lang.String,Property>
        +
        +
        • +
      + + + +
        +
      • +

        getChildren

        +
        public java.util.Set<ConfigCategory> getChildren()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/config/ConfigElement.html b/javadoc/net/minecraftforge/common/config/ConfigElement.html new file mode 100644 index 0000000..886c8a6 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/ConfigElement.html @@ -0,0 +1,919 @@ + + + + + +ConfigElement (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common.config
+

Class ConfigElement<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IConfigElement<T>
    +
    +
    +
    +
    public class ConfigElement<T>
+extends java.lang.Object
+implements IConfigElement<T>
    +
    This class bridges the gap between the FML config GUI classes and the Forge Configuration classes.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Property Summary

      + + + + + + + + + + +
      Properties 
      TypeProperty and Description
      booleanis +
      [Property, Category] Is this object a property object?
      +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Objectget() +
      [Property] Gets this property value.
      +
      java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry>getArrayEntryClass() +
      This method returns a class that implements IArrayEntry.
      +
      java.util.List<IConfigElement>getChildElements() +
      [Category] Gets this category's child categories/properties.
      +
      java.lang.StringgetComment() +
      [Property, Category] Gets the comment for this object.
      +
      java.lang.Class<? extends GuiConfigEntries.IConfigEntry>getConfigEntryClass() +
      This method returns a class that implements IConfigEntry or null.
      +
      java.lang.ObjectgetDefault() +
      [Property] Gets this property's default value.
      +
      java.lang.Object[]getDefaults() +
      [Property] Gets this property's default values.
      +
      java.lang.StringgetLanguageKey() +
      [Property, Category] Gets a language key for localization of config GUI entry names.
      +
      java.lang.Object[]getList() +
      [Property] Gets this property value as a list.
      +
      intgetMaxListLength() +
      [Property] Gets the max length of this list property, or -1 if the length is unlimited.
      +
      TgetMaxValue() +
      [Property] Gets this property's maximum value.
      +
      TgetMinValue() +
      [Property] Gets this property's minimum value.
      +
      java.lang.StringgetName() +
      [Property, Category] Gets the name of this object.
      +
      java.lang.StringgetQualifiedName() +
      [Category] Gets the qualified name of this object.
      +
      ConfigGuiTypegetType() +
      [Property, Category] Gets the ConfigGuiType value corresponding to the type of this property object, or CONFIG_CATEGORY if this is a + category object.
      +
      static ConfigGuiTypegetType(Property prop) 
      static ConfigElement<?>getTypedElement(Property prop) 
      java.util.regex.PatterngetValidationPattern() +
      [Property] Gets a Pattern object used in String property input validation.
      +
      java.lang.String[]getValidValues() +
      [Property] Gets a String array of valid values for this property.
      +
      booleanisDefault() +
      [Property] Is this property value equal to the default value?
      +
      booleanisList() +
      [Property] Is this property object a list?
      +
      booleanisListLengthFixed() +
      [Property] Does this list property have to remain a fixed length?
      +
      booleanisProperty() +
      [Property, Category] Is this object a property object?
      +
      ConfigElement<T>listCategoriesFirst(boolean categoriesFirst) 
      booleanrequiresMcRestart() +
      [Property, Category] Whether or not this element requires Minecraft to be restarted when changed.
      +
      booleanrequiresWorldRestart() +
      [Property, Category] Whether or not this element is safe to modify while a world is running.
      +
      voidset(T value) +
      [Property] Sets this property's value.
      +
      voidset(T[] aVal) +
      [Property] Sets this property's value to the specified array.
      +
      voidsetToDefault() +
      [Property] Sets this property's value to the default value.
      +
      booleanshowInGui() +
      [Property, Category] Whether or not this element should be allowed to show on config GUIs.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + + + + + +
        +
      • +

        ConfigElement

        +
        public ConfigElement(Property prop)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        listCategoriesFirst

        +
        public ConfigElement<T> listCategoriesFirst(boolean categoriesFirst)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: IConfigElement
        +
        [Property, Category] Gets the name of this object.
        +
        +
        Specified by:
        +
        getName in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        isProperty

        +
        public boolean isProperty()
        +
        Description copied from interface: IConfigElement
        +
        [Property, Category] Is this object a property object?
        +
        +
        Specified by:
        +
        isProperty in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getConfigEntryClass

        +
        public java.lang.Class<? extends GuiConfigEntries.IConfigEntry> getConfigEntryClass()
        +
        Description copied from interface: IConfigElement
        +
        This method returns a class that implements IConfigEntry or null. This class MUST + provide a constructor with the following parameter types: GuiConfig, GuiConfigEntries, IConfigElement
        +
        +
        Specified by:
        +
        getConfigEntryClass in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getArrayEntryClass

        +
        public java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> getArrayEntryClass()
        +
        Description copied from interface: IConfigElement
        +
        This method returns a class that implements IArrayEntry. This class MUST provide a constructor with the + following parameter types: GuiEditArray, GuiEditArrayEntries, IConfigElement, Object
        +
        +
        Specified by:
        +
        getArrayEntryClass in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getQualifiedName

        +
        public java.lang.String getQualifiedName()
        +
        Description copied from interface: IConfigElement
        +
        [Category] Gets the qualified name of this object. This is typically only used for category objects.
        +
        +
        Specified by:
        +
        getQualifiedName in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public ConfigGuiType getType()
        +
        Description copied from interface: IConfigElement
        +
        [Property, Category] Gets the ConfigGuiType value corresponding to the type of this property object, or CONFIG_CATEGORY if this is a + category object.
        +
        +
        Specified by:
        +
        getType in interface IConfigElement<T>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isList

        +
        public boolean isList()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Is this property object a list?
        +
        +
        Specified by:
        +
        isList in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        isListLengthFixed

        +
        public boolean isListLengthFixed()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Does this list property have to remain a fixed length?
        +
        +
        Specified by:
        +
        isListLengthFixed in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getMaxListLength

        +
        public int getMaxListLength()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Gets the max length of this list property, or -1 if the length is unlimited.
        +
        +
        Specified by:
        +
        getMaxListLength in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getComment

        +
        public java.lang.String getComment()
        +
        Description copied from interface: IConfigElement
        +
        [Property, Category] Gets the comment for this object. Used for the tooltip if getLanguageKey() + ".tooltip" is not defined in the + .lang file.
        +
        +
        Specified by:
        +
        getComment in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        isDefault

        +
        public boolean isDefault()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Is this property value equal to the default value?
        +
        +
        Specified by:
        +
        isDefault in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        setToDefault

        +
        public void setToDefault()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Sets this property's value to the default value.
        +
        +
        Specified by:
        +
        setToDefault in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        requiresWorldRestart

        +
        public boolean requiresWorldRestart()
        +
        Description copied from interface: IConfigElement
        +
        [Property, Category] Whether or not this element is safe to modify while a world is running. For Categories return false if ANY properties + in the category are modifiable while a world is running, true if all are not.
        +
        +
        Specified by:
        +
        requiresWorldRestart in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        showInGui

        +
        public boolean showInGui()
        +
        Description copied from interface: IConfigElement
        +
        [Property, Category] Whether or not this element should be allowed to show on config GUIs.
        +
        +
        Specified by:
        +
        showInGui in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        requiresMcRestart

        +
        public boolean requiresMcRestart()
        +
        Description copied from interface: IConfigElement
        +
        [Property, Category] Whether or not this element requires Minecraft to be restarted when changed.
        +
        +
        Specified by:
        +
        requiresMcRestart in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getValidValues

        +
        public java.lang.String[] getValidValues()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Gets a String array of valid values for this property. This is generally used for String properties to allow the user to + select a value from a list of valid values.
        +
        +
        Specified by:
        +
        getValidValues in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getLanguageKey

        +
        public java.lang.String getLanguageKey()
        +
        Description copied from interface: IConfigElement
        +
        [Property, Category] Gets a language key for localization of config GUI entry names. If the same key is specified with .tooltip + appended to the end, that key will return a localized tooltip when the mouse hovers over the property label/category button.
        +
        +
        Specified by:
        +
        getLanguageKey in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getDefault

        +
        public java.lang.Object getDefault()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Gets this property's default value. If this element is an array, this method should return a String + representation of that array using Arrays.toString()
        +
        +
        Specified by:
        +
        getDefault in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getDefaults

        +
        public java.lang.Object[] getDefaults()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Gets this property's default values.
        +
        +
        Specified by:
        +
        getDefaults in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getValidationPattern

        +
        public java.util.regex.Pattern getValidationPattern()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Gets a Pattern object used in String property input validation.
        +
        +
        Specified by:
        +
        getValidationPattern in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public java.lang.Object get()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Gets this property value.
        +
        +
        Specified by:
        +
        get in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getList

        +
        public java.lang.Object[] getList()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Gets this property value as a list. Generally you should be sure of whether the property is a list before calling this.
        +
        +
        Specified by:
        +
        getList in interface IConfigElement<T>
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public void set(T value)
        +
        Description copied from interface: IConfigElement
        +
        [Property] Sets this property's value.
        +
        +
        Specified by:
        +
        set in interface IConfigElement<T>
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public void set(T[] aVal)
        +
        Description copied from interface: IConfigElement
        +
        [Property] Sets this property's value to the specified array.
        +
        +
        Specified by:
        +
        set in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getMinValue

        +
        public T getMinValue()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Gets this property's minimum value.
        +
        +
        Specified by:
        +
        getMinValue in interface IConfigElement<T>
        +
        +
        • +
      + + + +
        +
      • +

        getMaxValue

        +
        public T getMaxValue()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Gets this property's maximum value.
        +
        +
        Specified by:
        +
        getMaxValue in interface IConfigElement<T>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html b/javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html new file mode 100644 index 0000000..d1e0522 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html @@ -0,0 +1,340 @@ + + + + + +Configuration.UnicodeInputStreamReader (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common.config
+

Class Configuration.UnicodeInputStreamReader

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable
    +
    +
    +
    Enclosing class:
    +
    Configuration
    +
    +
    +
    +
    public static class Configuration.UnicodeInputStreamReader
+extends java.io.Reader
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class java.io.Reader

        +lock
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      java.lang.StringgetEncoding() 
      intread(char[] cbuf, + int off, + int len) 
      +
        +
      • + + +

        Methods inherited from class java.io.Reader

        +mark, markSupported, read, read, read, ready, reset, skip
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Configuration.UnicodeInputStreamReader

        +
        public Configuration.UnicodeInputStreamReader(java.io.InputStream source,
+                                      java.lang.String encoding)
+                                       throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getEncoding

        +
        public java.lang.String getEncoding()
        +
        • +
      + + + +
        +
      • +

        read

        +
        public int read(char[] cbuf,
+       int off,
+       int len)
+         throws java.io.IOException
        +
        +
        Specified by:
        +
        read in class java.io.Reader
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws java.io.IOException
        +
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in class java.io.Reader
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/config/Configuration.html b/javadoc/net/minecraftforge/common/config/Configuration.html new file mode 100644 index 0000000..0b955f3 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/Configuration.html @@ -0,0 +1,1988 @@ + + + + + +Configuration (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common.config
+

Class Configuration

+
+
+ +
+
    +
  • +
    +
    +
    public class Configuration
+extends java.lang.Object
    +
    This class offers advanced configurations capabilities, allowing to provide + various categories for configuration variables.
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      Configuration() 
      Configuration(java.io.File file) +
      Create a configuration file for the file given in parameter.
      +
      Configuration(java.io.File file, + boolean caseSensitiveCustomCategories) 
      Configuration(java.io.File file, + java.lang.String configVersion) +
      Create a configuration file for the file given in parameter with the provided config version number.
      +
      Configuration(java.io.File file, + java.lang.String configVersion, + boolean caseSensitiveCustomCategories) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddCustomCategoryComment(java.lang.String category, + java.lang.String comment) 
      voidcopyCategoryProps(Configuration fromConfig, + java.lang.String[] ctgys) +
      Copies property objects from another Configuration object to this one using the list of category names.
      +
      static voidenableGlobalConfig() 
      Propertyget(java.lang.String category, + java.lang.String key, + boolean defaultValue) +
      Gets a boolean Property object without a comment using the default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + boolean[] defaultValues) +
      Gets a boolean array Property without a comment using the default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + boolean[] defaultValues, + java.lang.String comment) +
      Gets a boolean array Property with a comment using the default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + boolean[] defaultValues, + java.lang.String comment, + boolean isListLengthFixed, + int maxListLength) +
      Gets a boolean array Property with all settings defined.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + boolean defaultValue, + java.lang.String comment) +
      Gets a boolean Property object with a comment using the default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + double defaultValue) +
      Gets a double Property object without a comment using default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + double[] defaultValues) +
      Gets a double array Property object without a comment using default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + double[] defaultValues, + java.lang.String comment) +
      Gets a double array Property object without a comment using default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + double[] defaultValues, + java.lang.String comment, + double minValue, + double maxValue) +
      Gets a double array Property object with the defined comment, minimum and maximum bounds.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + double[] defaultValues, + java.lang.String comment, + double minValue, + double maxValue, + boolean isListLengthFixed, + int maxListLength) +
      Gets a double array Property object with all settings defined.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + double defaultValue, + java.lang.String comment) +
      Gets a double Property object with a comment using default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + double defaultValue, + java.lang.String comment, + double minValue, + double maxValue) +
      Gets a double Property object with the defined comment, minimum and maximum bounds
      +
      Propertyget(java.lang.String category, + java.lang.String key, + int defaultValue) +
      Gets an integer Property object without a comment using default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + int[] defaultValues) +
      Gets an integer array Property object without a comment using default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + int[] defaultValues, + java.lang.String comment) +
      Gets an integer array Property object with a comment using default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + int[] defaultValues, + java.lang.String comment, + int minValue, + int maxValue) +
      Gets an integer array Property object with the defined comment, minimum and maximum bounds.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + int[] defaultValues, + java.lang.String comment, + int minValue, + int maxValue, + boolean isListLengthFixed, + int maxListLength) +
      Gets an integer array Property object with all settings defined.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + int defaultValue, + java.lang.String comment) +
      Gets an integer Property object with a comment using default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + int defaultValue, + java.lang.String comment, + int minValue, + int maxValue) +
      Gets an integer Property object with the defined comment, minimum and maximum bounds.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue) +
      Gets a string Property without a comment using the default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues) +
      Gets a string array Property without a comment using the default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment) +
      Gets a string array Property with a comment using the default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment, + boolean isListLengthFixed, + int maxListLength, + java.util.regex.Pattern validationPattern) +
      Gets a string array Property with a comment with all settings defined.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment, + java.util.regex.Pattern validationPattern) +
      Gets a string array Property with a comment using the defined validationPattern and otherwise default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment, + Property.Type type) +
      Gets a list (array) Property object of the specified type using default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment) +
      Gets a string Property with a comment using the default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment, + java.util.regex.Pattern validationPattern) +
      Gets a string Property with a comment using the defined validationPattern and otherwise default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment, + Property.Type type) +
      Gets a Property object of the specified type using default settings.
      +
      Propertyget(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String[] validValues) +
      Gets a string Property with a comment using the defined validValues array and otherwise default settings.
      +
      booleangetBoolean(java.lang.String name, + java.lang.String category, + boolean defaultValue, + java.lang.String comment) +
      Creates a boolean property.
      +
      booleangetBoolean(java.lang.String name, + java.lang.String category, + boolean defaultValue, + java.lang.String comment, + java.lang.String langKey) +
      Creates a boolean property.
      +
      ConfigCategorygetCategory(java.lang.String category) 
      java.util.Set<java.lang.String>getCategoryNames() 
      java.io.FilegetConfigFile() 
      java.lang.StringgetDefinedConfigVersion() 
      floatgetFloat(java.lang.String name, + java.lang.String category, + float defaultValue, + float minValue, + float maxValue, + java.lang.String comment) +
      Creates a float property.
      +
      floatgetFloat(java.lang.String name, + java.lang.String category, + float defaultValue, + float minValue, + float maxValue, + java.lang.String comment, + java.lang.String langKey) +
      Creates a float property.
      +
      intgetInt(java.lang.String name, + java.lang.String category, + int defaultValue, + int minValue, + int maxValue, + java.lang.String comment) +
      Creates a integer property.
      +
      intgetInt(java.lang.String name, + java.lang.String category, + int defaultValue, + int minValue, + int maxValue, + java.lang.String comment, + java.lang.String langKey) +
      Creates a integer property.
      +
      java.lang.StringgetLoadedConfigVersion() 
      java.lang.StringgetString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment) +
      Creates a string property.
      +
      java.lang.StringgetString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.util.regex.Pattern pattern) +
      Creates a string property.
      +
      java.lang.StringgetString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String langKey) +
      Creates a string property.
      +
      java.lang.StringgetString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String[] validValues) +
      Creates a string property.
      +
      java.lang.StringgetString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String[] validValues, + java.lang.String langKey) +
      Creates a string property.
      +
      java.lang.StringgetString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String langKey, + java.util.regex.Pattern pattern) +
      Creates a string property.
      +
      java.lang.String[]getStringList(java.lang.String name, + java.lang.String category, + java.lang.String[] defaultValues, + java.lang.String comment) +
      Creates a string list property.
      +
      java.lang.String[]getStringList(java.lang.String name, + java.lang.String category, + java.lang.String[] defaultValue, + java.lang.String comment, + java.lang.String[] validValues) +
      Creates a string list property.
      +
      java.lang.String[]getStringList(java.lang.String name, + java.lang.String category, + java.lang.String[] defaultValue, + java.lang.String comment, + java.lang.String[] validValues, + java.lang.String langKey) +
      Creates a string list property.
      +
      booleanhasCategory(java.lang.String category) 
      booleanhasChanged() 
      booleanhasKey(java.lang.String category, + java.lang.String key) 
      voidload() 
      booleanmoveProperty(java.lang.String oldCategory, + java.lang.String propName, + java.lang.String newCategory) +
      Moves a property from one category to another.
      +
      voidremoveCategory(ConfigCategory category) 
      booleanrenameProperty(java.lang.String category, + java.lang.String oldPropName, + java.lang.String newPropName) +
      Renames a property in a given category.
      +
      voidsave() 
      ConfigurationsetCategoryComment(java.lang.String category, + java.lang.String comment) +
      Adds a comment to the specified ConfigCategory object
      +
      ConfigurationsetCategoryConfigEntryClass(java.lang.String category, + java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz) +
      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).
      +
      ConfigurationsetCategoryLanguageKey(java.lang.String category, + java.lang.String langKey) +
      Adds a language key to the specified ConfigCategory object
      +
      ConfigurationsetCategoryPropertyOrder(java.lang.String category, + java.util.List<java.lang.String> propOrder) +
      Sets the order that direct child properties of this config category will be written to the config file and will be displayed in + config GUIs.
      +
      ConfigurationsetCategoryRequiresMcRestart(java.lang.String category, + boolean requiresMcRestart) +
      Sets whether or not this ConfigCategory requires Minecraft to be restarted when changed.
      +
      ConfigurationsetCategoryRequiresWorldRestart(java.lang.String category, + boolean requiresWorldRestart) +
      Sets the flag for whether or not this category can be edited while a world is running.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        CATEGORY_GENERAL

        +
        public static final java.lang.String CATEGORY_GENERAL
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        ALLOWED_CHARS

        +
        public static final java.lang.String ALLOWED_CHARS
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DEFAULT_ENCODING

        +
        public static final java.lang.String DEFAULT_ENCODING
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        CATEGORY_SPLITTER

        +
        public static final java.lang.String CATEGORY_SPLITTER
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        NEW_LINE

        +
        public static final java.lang.String NEW_LINE
        +
        • +
      + + + +
        +
      • +

        COMMENT_SEPARATOR

        +
        public static final java.lang.String COMMENT_SEPARATOR
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        allowedProperties

        +
        public static final com.google.common.base.CharMatcher allowedProperties
        +
        • +
      + + + +
        +
      • +

        defaultEncoding

        +
        public java.lang.String defaultEncoding
        +
        • +
      + + + +
        +
      • +

        isChild

        +
        public boolean isChild
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Configuration

        +
        public Configuration()
        +
        • +
      + + + +
        +
      • +

        Configuration

        +
        public Configuration(java.io.File file)
        +
        Create a configuration file for the file given in parameter.
        +
        • +
      + + + +
        +
      • +

        Configuration

        +
        public Configuration(java.io.File file,
+             java.lang.String configVersion)
        +
        Create a configuration file for the file given in parameter with the provided config version number.
        +
        • +
      + + + +
        +
      • +

        Configuration

        +
        public Configuration(java.io.File file,
+             java.lang.String configVersion,
+             boolean caseSensitiveCustomCategories)
        +
        • +
      + + + +
        +
      • +

        Configuration

        +
        public Configuration(java.io.File file,
+             boolean caseSensitiveCustomCategories)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        getDefinedConfigVersion

        +
        public java.lang.String getDefinedConfigVersion()
        +
        • +
      + + + +
        +
      • +

        getLoadedConfigVersion

        +
        public java.lang.String getLoadedConfigVersion()
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           boolean defaultValue)
        +
        Gets a boolean Property object without a comment using the default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        +
        Returns:
        a boolean Property object without a comment
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           boolean defaultValue,
+           java.lang.String comment)
        +
        Gets a boolean Property object with a comment using the default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        +
        Returns:
        a boolean Property object without a comment
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           boolean[] defaultValues)
        +
        Gets a boolean array Property without a comment using the default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        +
        Returns:
        a boolean array Property without a comment using these defaults: isListLengthFixed = false, maxListLength = -1
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           boolean[] defaultValues,
+           java.lang.String comment)
        +
        Gets a boolean array Property with a comment using the default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        +
        Returns:
        a boolean array Property with a comment using these defaults: isListLengthFixed = false, maxListLength = -1
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           boolean[] defaultValues,
+           java.lang.String comment,
+           boolean isListLengthFixed,
+           int maxListLength)
        +
        Gets a boolean array Property with all settings defined.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        isListLengthFixed - boolean for whether this array is required to be a specific length (defined by the default value array + length or maxListLength)
        maxListLength - the maximum length of this array, use -1 for no max length
        +
        Returns:
        a boolean array Property with all settings defined
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           int defaultValue)
        +
        Gets an integer Property object without a comment using default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        +
        Returns:
        an integer Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           int defaultValue,
+           java.lang.String comment)
        +
        Gets an integer Property object with a comment using default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        +
        Returns:
        an integer Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           int defaultValue,
+           java.lang.String comment,
+           int minValue,
+           int maxValue)
        +
        Gets an integer Property object with the defined comment, minimum and maximum bounds.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        minValue - minimum boundary
        maxValue - maximum boundary
        +
        Returns:
        an integer Property object with the defined comment, minimum and maximum bounds
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           int[] defaultValues)
        +
        Gets an integer array Property object without a comment using default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        +
        Returns:
        an integer array Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE, isListLengthFixed = false, + maxListLength = -1
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           int[] defaultValues,
+           java.lang.String comment)
        +
        Gets an integer array Property object with a comment using default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        +
        Returns:
        an integer array Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE, isListLengthFixed = false, + maxListLength = -1
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           int[] defaultValues,
+           java.lang.String comment,
+           int minValue,
+           int maxValue)
        +
        Gets an integer array Property object with the defined comment, minimum and maximum bounds.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        minValue - minimum boundary
        maxValue - maximum boundary
        +
        Returns:
        an integer array Property object with the defined comment, minimum and maximum bounds, isListLengthFixed + = false, maxListLength = -1
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           int[] defaultValues,
+           java.lang.String comment,
+           int minValue,
+           int maxValue,
+           boolean isListLengthFixed,
+           int maxListLength)
        +
        Gets an integer array Property object with all settings defined.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        minValue - minimum boundary
        maxValue - maximum boundary
        isListLengthFixed - boolean for whether this array is required to be a specific length (defined by the default value array + length or maxListLength)
        maxListLength - the maximum length of this array, use -1 for no max length
        +
        Returns:
        an integer array Property object with all settings defined
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           double defaultValue)
        +
        Gets a double Property object without a comment using default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        +
        Returns:
        a double Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           double defaultValue,
+           java.lang.String comment)
        +
        Gets a double Property object with a comment using default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        +
        Returns:
        a double Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           double defaultValue,
+           java.lang.String comment,
+           double minValue,
+           double maxValue)
        +
        Gets a double Property object with the defined comment, minimum and maximum bounds
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        minValue - minimum boundary
        maxValue - maximum boundary
        +
        Returns:
        a double Property object with the defined comment, minimum and maximum bounds
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           double[] defaultValues)
        +
        Gets a double array Property object without a comment using default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        +
        Returns:
        a double array Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE, isListLengthFixed = false, + maxListLength = -1
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           double[] defaultValues,
+           java.lang.String comment)
        +
        Gets a double array Property object without a comment using default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        +
        Returns:
        a double array Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE, isListLengthFixed = false, + maxListLength = -1
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           double[] defaultValues,
+           java.lang.String comment,
+           double minValue,
+           double maxValue)
        +
        Gets a double array Property object with the defined comment, minimum and maximum bounds.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        minValue - minimum boundary
        maxValue - maximum boundary
        +
        Returns:
        a double array Property object with the defined comment, minimum and maximum bounds, isListLengthFixed = + false, maxListLength = -1
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           double[] defaultValues,
+           java.lang.String comment,
+           double minValue,
+           double maxValue,
+           boolean isListLengthFixed,
+           int maxListLength)
        +
        Gets a double array Property object with all settings defined.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        minValue - minimum boundary
        maxValue - maximum boundary
        isListLengthFixed - boolean for whether this array is required to be a specific length (defined by the default value array + length or maxListLength)
        maxListLength - the maximum length of this array, use -1 for no max length
        +
        Returns:
        a double array Property object with all settings defined
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String defaultValue)
        +
        Gets a string Property without a comment using the default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        +
        Returns:
        a string Property with validationPattern = null, validValues = null
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String defaultValue,
+           java.lang.String comment)
        +
        Gets a string Property with a comment using the default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        +
        Returns:
        a string Property with validationPattern = null, validValues = null
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String defaultValue,
+           java.lang.String comment,
+           java.util.regex.Pattern validationPattern)
        +
        Gets a string Property with a comment using the defined validationPattern and otherwise default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        validationPattern - a Pattern object for input validation
        +
        Returns:
        a string Property with the defined validationPattern, validValues = null
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String defaultValue,
+           java.lang.String comment,
+           java.lang.String[] validValues)
        +
        Gets a string Property with a comment using the defined validValues array and otherwise default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        validValues - an array of valid values that this Property can be set to. If an array is provided the Config GUI control will be + a value cycle button.
        +
        Returns:
        a string Property with the defined validValues array, validationPattern = null
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String[] defaultValues)
        +
        Gets a string array Property without a comment using the default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        +
        Returns:
        a string array Property with validationPattern = null, isListLengthFixed = false, maxListLength = -1
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String[] defaultValues,
+           java.lang.String comment)
        +
        Gets a string array Property with a comment using the default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        +
        Returns:
        a string array Property with validationPattern = null, isListLengthFixed = false, maxListLength = -1
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String[] defaultValues,
+           java.lang.String comment,
+           java.util.regex.Pattern validationPattern)
        +
        Gets a string array Property with a comment using the defined validationPattern and otherwise default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        validationPattern - a Pattern object for input validation
        +
        Returns:
        a string array Property with the defined validationPattern, isListLengthFixed = false, maxListLength = -1
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String[] defaultValues,
+           java.lang.String comment,
+           boolean isListLengthFixed,
+           int maxListLength,
+           java.util.regex.Pattern validationPattern)
        +
        Gets a string array Property with a comment with all settings defined.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        isListLengthFixed - boolean for whether this array is required to be a specific length (defined by the default value array + length or maxListLength)
        maxListLength - the maximum length of this array, use -1 for no max length
        validationPattern - a Pattern object for input validation
        +
        Returns:
        a string array Property with a comment with all settings defined
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String defaultValue,
+           java.lang.String comment,
+           Property.Type type)
        +
        Gets a Property object of the specified type using default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        type - a Property.Type enum value
        +
        Returns:
        a Property object of the specified type using default settings
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String[] defaultValues,
+           java.lang.String comment,
+           Property.Type type)
        +
        Gets a list (array) Property object of the specified type using default settings.
        +
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        type - a Property.Type enum value
        +
        Returns:
        a list (array) Property object of the specified type using default settings
        +
        • +
      + + + +
        +
      • +

        hasCategory

        +
        public boolean hasCategory(java.lang.String category)
        +
        • +
      + + + +
        +
      • +

        hasKey

        +
        public boolean hasKey(java.lang.String category,
+             java.lang.String key)
        +
        • +
      + + + +
        +
      • +

        load

        +
        public void load()
        +
        • +
      + + + +
        +
      • +

        save

        +
        public void save()
        +
        • +
      + + + +
        +
      • +

        getCategory

        +
        public ConfigCategory getCategory(java.lang.String category)
        +
        • +
      + + + +
        +
      • +

        removeCategory

        +
        public void removeCategory(ConfigCategory category)
        +
        • +
      + + + +
        +
      • +

        setCategoryComment

        +
        public Configuration setCategoryComment(java.lang.String category,
+                               java.lang.String comment)
        +
        Adds a comment to the specified ConfigCategory object
        +
        Parameters:
        category - the config category
        comment - a String comment
        +
        • +
      + + + +
        +
      • +

        addCustomCategoryComment

        +
        public void addCustomCategoryComment(java.lang.String category,
+                            java.lang.String comment)
        +
        • +
      + + + +
        +
      • +

        setCategoryLanguageKey

        +
        public Configuration setCategoryLanguageKey(java.lang.String category,
+                                   java.lang.String langKey)
        +
        Adds a language key to the specified ConfigCategory object
        +
        Parameters:
        category - the config category
        langKey - a language key string such as configcategory.general
        +
        • +
      + + + +
        +
      • +

        setCategoryConfigEntryClass

        +
        public Configuration setCategoryConfigEntryClass(java.lang.String category,
+                                        java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz)
        +
        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: GuiConfig (the parent + GuiConfig screen will be provided), GuiPropertyList (the parent GuiPropertyList will be provided), IConfigElement + (the IConfigElement for this Property will be provided).
        +
        • +
      + + + +
        +
      • +

        setCategoryRequiresWorldRestart

        +
        public Configuration setCategoryRequiresWorldRestart(java.lang.String category,
+                                            boolean requiresWorldRestart)
        +
        Sets the flag for whether or not this category can be edited while a world is running. Care should be taken to ensure + that only properties that are truly dynamic can be changed from the in-game options menu. Only set this flag to + true if all child properties/categories are unable to be modified while a world is running.
        +
        • +
      + + + +
        +
      • +

        setCategoryRequiresMcRestart

        +
        public Configuration setCategoryRequiresMcRestart(java.lang.String category,
+                                         boolean requiresMcRestart)
        +
        Sets whether or not this ConfigCategory requires Minecraft to be restarted when changed. + Defaults to false. Only set this flag to true if ALL child properties/categories require + Minecraft to be restarted when changed. Setting this flag will also prevent modification + of the child properties/categories while a world is running.
        +
        • +
      + + + +
        +
      • +

        setCategoryPropertyOrder

        +
        public Configuration setCategoryPropertyOrder(java.lang.String category,
+                                     java.util.List<java.lang.String> propOrder)
        +
        Sets the order that direct child properties of this config category will be written to the config file and will be displayed in + config GUIs.
        +
        • +
      + + + +
        +
      • +

        enableGlobalConfig

        +
        public static void enableGlobalConfig()
        +
        • +
      + + + +
        +
      • +

        hasChanged

        +
        public boolean hasChanged()
        +
        • +
      + + + +
        +
      • +

        getCategoryNames

        +
        public java.util.Set<java.lang.String> getCategoryNames()
        +
        • +
      + + + +
        +
      • +

        renameProperty

        +
        public boolean renameProperty(java.lang.String category,
+                     java.lang.String oldPropName,
+                     java.lang.String newPropName)
        +
        Renames a property in a given category.
        +
        Parameters:
        category - the category in which the property resides
        oldPropName - the existing property name
        newPropName - the new property name
        +
        Returns:
        true if the category and property exist, false otherwise
        +
        • +
      + + + +
        +
      • +

        moveProperty

        +
        public boolean moveProperty(java.lang.String oldCategory,
+                   java.lang.String propName,
+                   java.lang.String newCategory)
        +
        Moves a property from one category to another.
        +
        Parameters:
        oldCategory - the category the property currently resides in
        propName - the name of the property to move
        newCategory - the category the property should be moved to
        +
        Returns:
        true if the old category and property exist, false otherwise
        +
        • +
      + + + +
        +
      • +

        copyCategoryProps

        +
        public void copyCategoryProps(Configuration fromConfig,
+                     java.lang.String[] ctgys)
        +
        Copies property objects from another Configuration object to this one using the list of category names. Properties that only exist in the + "from" object are ignored. Pass null for the ctgys array to include all categories.
        +
        • +
      + + + +
        +
      • +

        getString

        +
        public java.lang.String getString(java.lang.String name,
+                         java.lang.String category,
+                         java.lang.String defaultValue,
+                         java.lang.String comment)
        +
        Creates a string property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        +
        Returns:
        The value of the new string property.
        +
        • +
      + + + +
        +
      • +

        getString

        +
        public java.lang.String getString(java.lang.String name,
+                         java.lang.String category,
+                         java.lang.String defaultValue,
+                         java.lang.String comment,
+                         java.lang.String langKey)
        +
        Creates a string property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        langKey - A language key used for localization of GUIs
        +
        Returns:
        The value of the new string property.
        +
        • +
      + + + +
        +
      • +

        getString

        +
        public java.lang.String getString(java.lang.String name,
+                         java.lang.String category,
+                         java.lang.String defaultValue,
+                         java.lang.String comment,
+                         java.util.regex.Pattern pattern)
        +
        Creates a string property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        +
        Returns:
        The value of the new string property.
        +
        • +
      + + + +
        +
      • +

        getString

        +
        public java.lang.String getString(java.lang.String name,
+                         java.lang.String category,
+                         java.lang.String defaultValue,
+                         java.lang.String comment,
+                         java.lang.String langKey,
+                         java.util.regex.Pattern pattern)
        +
        Creates a string property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        langKey - A language key used for localization of GUIs
        +
        Returns:
        The value of the new string property.
        +
        • +
      + + + +
        +
      • +

        getString

        +
        public java.lang.String getString(java.lang.String name,
+                         java.lang.String category,
+                         java.lang.String defaultValue,
+                         java.lang.String comment,
+                         java.lang.String[] validValues)
        +
        Creates a string property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        validValues - A list of valid values that this property can be set to.
        +
        Returns:
        The value of the new string property.
        +
        • +
      + + + +
        +
      • +

        getString

        +
        public java.lang.String getString(java.lang.String name,
+                         java.lang.String category,
+                         java.lang.String defaultValue,
+                         java.lang.String comment,
+                         java.lang.String[] validValues,
+                         java.lang.String langKey)
        +
        Creates a string property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        validValues - A list of valid values that this property can be set to.
        langKey - A language key used for localization of GUIs
        +
        Returns:
        The value of the new string property.
        +
        • +
      + + + +
        +
      • +

        getStringList

        +
        public java.lang.String[] getStringList(java.lang.String name,
+                               java.lang.String category,
+                               java.lang.String[] defaultValues,
+                               java.lang.String comment)
        +
        Creates a string list property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        +
        Returns:
        The value of the new string property.
        +
        • +
      + + + +
        +
      • +

        getStringList

        +
        public java.lang.String[] getStringList(java.lang.String name,
+                               java.lang.String category,
+                               java.lang.String[] defaultValue,
+                               java.lang.String comment,
+                               java.lang.String[] validValues)
        +
        Creates a string list property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        +
        Returns:
        The value of the new string property.
        +
        • +
      + + + +
        +
      • +

        getStringList

        +
        public java.lang.String[] getStringList(java.lang.String name,
+                               java.lang.String category,
+                               java.lang.String[] defaultValue,
+                               java.lang.String comment,
+                               java.lang.String[] validValues,
+                               java.lang.String langKey)
        +
        Creates a string list property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        +
        Returns:
        The value of the new string property.
        +
        • +
      + + + +
        +
      • +

        getBoolean

        +
        public boolean getBoolean(java.lang.String name,
+                 java.lang.String category,
+                 boolean defaultValue,
+                 java.lang.String comment)
        +
        Creates a boolean property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        +
        Returns:
        The value of the new boolean property.
        +
        • +
      + + + +
        +
      • +

        getBoolean

        +
        public boolean getBoolean(java.lang.String name,
+                 java.lang.String category,
+                 boolean defaultValue,
+                 java.lang.String comment,
+                 java.lang.String langKey)
        +
        Creates a boolean property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        langKey - A language key used for localization of GUIs
        +
        Returns:
        The value of the new boolean property.
        +
        • +
      + + + +
        +
      • +

        getInt

        +
        public int getInt(java.lang.String name,
+         java.lang.String category,
+         int defaultValue,
+         int minValue,
+         int maxValue,
+         java.lang.String comment)
        +
        Creates a integer property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        minValue - Minimum value of the property.
        maxValue - Maximum value of the property.
        comment - A brief description what the property does.
        +
        Returns:
        The value of the new integer property.
        +
        • +
      + + + +
        +
      • +

        getInt

        +
        public int getInt(java.lang.String name,
+         java.lang.String category,
+         int defaultValue,
+         int minValue,
+         int maxValue,
+         java.lang.String comment,
+         java.lang.String langKey)
        +
        Creates a integer property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        minValue - Minimum value of the property.
        maxValue - Maximum value of the property.
        comment - A brief description what the property does.
        langKey - A language key used for localization of GUIs
        +
        Returns:
        The value of the new integer property.
        +
        • +
      + + + +
        +
      • +

        getFloat

        +
        public float getFloat(java.lang.String name,
+             java.lang.String category,
+             float defaultValue,
+             float minValue,
+             float maxValue,
+             java.lang.String comment)
        +
        Creates a float property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        minValue - Minimum value of the property.
        maxValue - Maximum value of the property.
        comment - A brief description what the property does.
        +
        Returns:
        The value of the new float property.
        +
        • +
      + + + +
        +
      • +

        getFloat

        +
        public float getFloat(java.lang.String name,
+             java.lang.String category,
+             float defaultValue,
+             float minValue,
+             float maxValue,
+             java.lang.String comment,
+             java.lang.String langKey)
        +
        Creates a float property.
        +
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        minValue - Minimum value of the property.
        maxValue - Maximum value of the property.
        comment - A brief description what the property does.
        langKey - A language key used for localization of GUIs
        +
        Returns:
        The value of the new float property.
        +
        • +
      + + + +
        +
      • +

        getConfigFile

        +
        public java.io.File getConfigFile()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/config/Property.Type.html b/javadoc/net/minecraftforge/common/config/Property.Type.html new file mode 100644 index 0000000..10d5191 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/Property.Type.html @@ -0,0 +1,395 @@ + + + + + +Property.Type (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common.config
+

Enum Property.Type

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Property.Type>
    +
    +
    +
    Enclosing class:
    +
    Property
    +
    +
    +
    +
    public static enum Property.Type
+extends java.lang.Enum<Property.Type>
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      chargetID() 
      static Property.TypetryParse(char id) 
      static Property.TypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Property.Type[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Property.Type[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Property.Type c : Property.Type.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Property.Type valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      + + + +
        +
      • +

        tryParse

        +
        public static Property.Type tryParse(char id)
        +
        • +
      + + + +
        +
      • +

        getID

        +
        public char getID()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/config/Property.html b/javadoc/net/minecraftforge/common/config/Property.html new file mode 100644 index 0000000..3c842c9 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/Property.html @@ -0,0 +1,1733 @@ + + + + + +Property (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common.config
+

Class Property

+
+
+ +
+
    +
  • +
    +
    +
    public class Property
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Property.Type 
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      java.lang.Stringcomment 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      Property(java.lang.String name, + java.lang.String[] values, + Property.Type type) 
      Property(java.lang.String name, + java.lang.String[] values, + Property.Type type, + java.lang.String langKey) 
      Property(java.lang.String name, + java.lang.String value, + Property.Type type) 
      Property(java.lang.String name, + java.lang.String value, + Property.Type type, + boolean read) 
      Property(java.lang.String name, + java.lang.String value, + Property.Type type, + boolean read, + java.lang.String langKey) 
      Property(java.lang.String name, + java.lang.String value, + Property.Type type, + java.lang.String langKey) 
      Property(java.lang.String name, + java.lang.String value, + Property.Type type, + java.lang.String[] validValues) 
      Property(java.lang.String name, + java.lang.String value, + Property.Type type, + java.lang.String[] validValues, + java.lang.String langKey) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry>getArrayEntryClass() +
      Gets the custom IArrayEntry class that should be used in place of the standard entry class for this Property type, or null if + none has been set.
      +
      booleangetBoolean() +
      Returns the value in this property as a boolean, if the value is not a valid boolean, it will return the provided default.
      +
      booleangetBoolean(boolean _default) +
      Returns the value in this property as a boolean, + if the value is not a valid boolean, it will return the + provided default.
      +
      boolean[]getBooleanList() +
      Returns the boolean value of all values that can + be parsed in the list.
      +
      java.lang.Class<? extends GuiConfigEntries.IConfigEntry>getConfigEntryClass() +
      Gets the custom IConfigEntry class that should be used in place of the standard entry class for this Property type, or null if + none has been set.
      +
      java.lang.StringgetDefault() +
      Gets the raw String default value of this Property.
      +
      java.lang.String[]getDefaults() +
      Gets the raw String[] default values of this Property.
      +
      doublegetDouble() +
      Returns the value in this property as a double, if the value is not a valid double, it will return the provided default.
      +
      doublegetDouble(double _default) +
      Returns the value in this property as a double, + if the value is not a valid double, it will return the + provided default.
      +
      double[]getDoubleList() +
      Returns the double value of all values that can + be parsed in the list.
      +
      intgetInt() +
      Returns the value in this property as an integer, + if the value is not a valid integer, it will return the initially provided default.
      +
      intgetInt(int _default) +
      Returns the value in this property as an integer, + if the value is not a valid integer, it will return the + provided default.
      +
      int[]getIntList() +
      Returns the integer value of all values that can + be parsed in the list.
      +
      java.lang.StringgetLanguageKey() +
      Gets the language key string for this Property.
      +
      intgetMaxListLength() +
      Gets the maximum length of this list/array Property.
      +
      java.lang.StringgetMaxValue() +
      Gets the maximum value.
      +
      java.lang.StringgetMinValue() +
      Gets the minimum value.
      +
      java.lang.StringgetName() +
      Gets the name/key for this Property.
      +
      java.lang.StringgetString() +
      Returns the value in this property as it's raw string.
      +
      java.lang.String[]getStringList() 
      Property.TypegetType() +
      Gets the Property.Type enum value for this Property.
      +
      java.util.regex.PatterngetValidationPattern() +
      Gets the Pattern object used to validate user input for this Property.
      +
      java.lang.String[]getValidValues() +
      Gets the array of valid values that this String Property can be set to, or null if not defined.
      +
      booleanhasChanged() +
      Gets the changed status of this Property.
      +
      booleanisBooleanList() +
      Checks if all of current values stored in this property can be converted to a boolean.
      +
      booleanisBooleanValue() +
      Checks if the current value held by this property is a valid boolean value.
      +
      booleanisDefault() +
      Returns whether or not this Property is defaulted.
      +
      booleanisDoubleList() +
      Checks if all of the current values stored in this property can be converted to a double.
      +
      booleanisDoubleValue() +
      Checks if the current value held by this property is a valid double value.
      +
      booleanisIntList() +
      Checks if all of the current values stored in this property can be converted to an integer.
      +
      booleanisIntValue() +
      Checks if the current value stored in this property can be converted to an integer.
      +
      booleanisList() +
      Returns whether or not this Property is a list/array.
      +
      booleanisListLengthFixed() +
      Returns whether or not this list/array has a fixed length.
      +
      booleanrequiresMcRestart() +
      Gets whether or not this Property requires Minecraft to be restarted when changed.
      +
      booleanrequiresWorldRestart() +
      Returns whether or not this Property is able to be edited while a world is running using the in-game Mod Options screen + as well as the Mods list screen, or only from the Mods list screen.
      +
      voidset(boolean value) 
      voidset(boolean[] values) 
      voidset(double value) 
      voidset(double[] values) 
      voidset(int value) 
      voidset(int[] values) 
      voidset(java.lang.String value) 
      voidset(java.lang.String[] values) 
      PropertysetArrayEntryClass(java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> clazz) +
      Sets a custom IGuiEditListEntry class that should be used in place of the standard entry class for this Property type.
      +
      PropertysetConfigEntryClass(java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz) +
      Sets a custom IConfigEntry class that should be used in place of the standard entry class for this Property type.
      +
      PropertysetDefaultValue(boolean defaultValue) +
      Sets the default boolean value of this Property.
      +
      PropertysetDefaultValue(double defaultValue) +
      Sets the default double value of this Property.
      +
      PropertysetDefaultValue(int defaultValue) +
      Sets the default int value of this Property.
      +
      PropertysetDefaultValue(java.lang.String defaultValue) +
      Sets the default string value of this Property.
      +
      PropertysetDefaultValues(boolean[] defaultValues) +
      Sets the default boolean[] values of this Property.
      +
      PropertysetDefaultValues(double[] defaultValues) +
      Sets the default double[] values of this Property
      +
      PropertysetDefaultValues(int[] defaultValues) +
      Sets the default int[] values of this Property.
      +
      PropertysetDefaultValues(java.lang.String[] defaultValues) +
      Sets the default String[] values of this Property.
      +
      PropertysetIsListLengthFixed(boolean isListLengthFixed) +
      Sets the flag for whether this list/array Property has a fixed length.
      +
      PropertysetLanguageKey(java.lang.String langKey) +
      Sets the localization language key for this Property so that the config GUI screens are nice and pretty <3.
      +
      PropertysetMaxListLength(int max) +
      Sets the maximum length of this list/array Property.
      +
      PropertysetMaxValue(double maxValue) +
      Sets the maximum double value of this Property.
      +
      PropertysetMaxValue(int maxValue) +
      Sets the maximum int value of this Property.
      +
      PropertysetMinValue(double minValue) +
      Sets the minimum double value of this Property.
      +
      PropertysetMinValue(int minValue) +
      Sets the minimum int value of this Property.
      +
      voidsetName(java.lang.String name) +
      Sets the name/key for this Property.
      +
      PropertysetRequiresMcRestart(boolean requiresMcRestart) +
      Sets whether or not this Property requires Minecraft to be restarted when changed.
      +
      PropertysetRequiresWorldRestart(boolean requiresWorldRestart) +
      Sets the flag for whether or not this Property can be edited while a world is running.
      +
      PropertysetShowInGui(boolean showInGui) +
      Sets whether or not this Property should be allowed to show on config GUIs.
      +
      PropertysetToDefault() +
      Sets the current value(s) of this Property to the default value(s).
      +
      PropertysetValidationPattern(java.util.regex.Pattern validationPattern) +
      Sets a regex Pattern object used to validate user input for formatted String or String[] properties.
      +
      PropertysetValidValues(java.lang.String[] validValues) +
      Sets the array of valid values that this String Property can be set to.
      +
      PropertysetValue(boolean value) +
      Sets the value of this Property to the provided boolean value.
      +
      PropertysetValue(double value) +
      Sets the value of this Property to the provided double value.
      +
      PropertysetValue(int value) +
      Sets the value of this Property to the provided int value.
      +
      PropertysetValue(java.lang.String value) +
      Sets the value of this Property to the provided String value.
      +
      PropertysetValues(boolean[] values) +
      Sets the values of this Property to the provided boolean[] values.
      +
      PropertysetValues(double[] values) +
      Sets the values of this Property to the provided double[] values.
      +
      PropertysetValues(int[] values) +
      Sets the values of this Property to the provided int[] values.
      +
      PropertysetValues(java.lang.String[] values) +
      Sets the values of this Property to the provided String[] values.
      +
      booleanshowInGui() +
      Gets whether or not this Property should be allowed to show on config GUIs.
      +
      booleanwasRead() +
      Determines if this config value was just created, or if it was read from the config file.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        comment

        +
        public java.lang.String comment
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Property

        +
        public Property(java.lang.String name,
+        java.lang.String value,
+        Property.Type type)
        +
        • +
      + + + +
        +
      • +

        Property

        +
        public Property(java.lang.String name,
+        java.lang.String value,
+        Property.Type type,
+        boolean read)
        +
        • +
      + + + +
        +
      • +

        Property

        +
        public Property(java.lang.String name,
+        java.lang.String value,
+        Property.Type type,
+        java.lang.String[] validValues)
        +
        • +
      + + + +
        +
      • +

        Property

        +
        public Property(java.lang.String name,
+        java.lang.String value,
+        Property.Type type,
+        java.lang.String langKey)
        +
        • +
      + + + +
        +
      • +

        Property

        +
        public Property(java.lang.String name,
+        java.lang.String value,
+        Property.Type type,
+        boolean read,
+        java.lang.String langKey)
        +
        • +
      + + + +
        +
      • +

        Property

        +
        public Property(java.lang.String name,
+        java.lang.String value,
+        Property.Type type,
+        java.lang.String[] validValues,
+        java.lang.String langKey)
        +
        • +
      + + + +
        +
      • +

        Property

        +
        public Property(java.lang.String name,
+        java.lang.String[] values,
+        Property.Type type)
        +
        • +
      + + + +
        +
      • +

        Property

        +
        public Property(java.lang.String name,
+        java.lang.String[] values,
+        Property.Type type,
+        java.lang.String langKey)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isDefault

        +
        public boolean isDefault()
        +
        Returns whether or not this Property is defaulted.
        +
        Returns:
        true if the current value(s) is(are) deeply equal to the default value(s)
        +
        • +
      + + + +
        +
      • +

        setToDefault

        +
        public Property setToDefault()
        +
        Sets the current value(s) of this Property to the default value(s).
        +
        • +
      + + + +
        +
      • +

        getDefault

        +
        public java.lang.String getDefault()
        +
        Gets the raw String default value of this Property. Check for isList() == false first.
        +
        Returns:
        the default value String
        +
        • +
      + + + +
        +
      • +

        getDefaults

        +
        public java.lang.String[] getDefaults()
        +
        Gets the raw String[] default values of this Property. Check for isList() == true first.
        +
        Returns:
        the default values String[]
        +
        • +
      + + + +
        +
      • +

        setRequiresWorldRestart

        +
        public Property setRequiresWorldRestart(boolean requiresWorldRestart)
        +
        Sets the flag for whether or not this Property can be edited while a world is running. Care should be taken to ensure + that only properties that are truly dynamic can be changed from the in-game options menu. When set to false the Property will be + editable from both the main menu Mods list config screen and the in-game Mod Options config screen. When set to true the Property + will only be editable from the main menu Mods list config screen.
        +
        • +
      + + + +
        +
      • +

        requiresWorldRestart

        +
        public boolean requiresWorldRestart()
        +
        Returns whether or not this Property is able to be edited while a world is running using the in-game Mod Options screen + as well as the Mods list screen, or only from the Mods list screen. Setting this flag to true will disable editing of + this property while a world is running.
        +
        • +
      + + + +
        +
      • +

        setShowInGui

        +
        public Property setShowInGui(boolean showInGui)
        +
        Sets whether or not this Property should be allowed to show on config GUIs. + Defaults to true.
        +
        • +
      + + + +
        +
      • +

        showInGui

        +
        public boolean showInGui()
        +
        Gets whether or not this Property should be allowed to show on config GUIs. + Defaults to true unless set to false.
        +
        • +
      + + + +
        +
      • +

        setRequiresMcRestart

        +
        public Property setRequiresMcRestart(boolean requiresMcRestart)
        +
        Sets whether or not this Property requires Minecraft to be restarted when changed. + Defaults to false. Setting this flag to true will also disable editing of + this property while a world is running.
        +
        • +
      + + + +
        +
      • +

        requiresMcRestart

        +
        public boolean requiresMcRestart()
        +
        Gets whether or not this Property requires Minecraft to be restarted when changed. + Defaults to false unless set to true.
        +
        • +
      + + + +
        +
      • +

        setMaxListLength

        +
        public Property setMaxListLength(int max)
        +
        Sets the maximum length of this list/array Property. Only important if isList() == true. If the current values array or default + values array is longer than the new maximum it will be resized. If calling both this method and setIsListLengthFixed(true), this + method should be called afterwards (but is not required).
        +
        • +
      + + + +
        +
      • +

        getMaxListLength

        +
        public int getMaxListLength()
        +
        Gets the maximum length of this list/array Property. Only important if isList() == true.
        +
        • +
      + + + +
        +
      • +

        setIsListLengthFixed

        +
        public Property setIsListLengthFixed(boolean isListLengthFixed)
        +
        Sets the flag for whether this list/array Property has a fixed length. Only important if isList() == true. If calling both this + method and setMaxListLength(), this method should be called first (but is not required).
        +
        • +
      + + + +
        +
      • +

        isListLengthFixed

        +
        public boolean isListLengthFixed()
        +
        Returns whether or not this list/array has a fixed length. Only important if isList() == true.
        +
        • +
      + + + +
        +
      • +

        setConfigEntryClass

        +
        public Property setConfigEntryClass(java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz)
        +
        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: GuiConfig (the owning GuiConfig screen will be provided), + GuiConfigEntries (the owning GuiConfigEntries will be provided), IConfigElement (the IConfigElement for this Property + will be provided).
        +
        • +
      + + + +
        +
      • +

        getConfigEntryClass

        +
        public java.lang.Class<? extends GuiConfigEntries.IConfigEntry> getConfigEntryClass()
        +
        Gets the custom IConfigEntry class that should be used in place of the standard entry class for this Property type, or null if + none has been set.
        +
        Returns:
        a class that implements IConfigEntry
        +
        • +
      + + + +
        +
      • +

        setArrayEntryClass

        +
        public Property setArrayEntryClass(java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> clazz)
        +
        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: GuiEditList (the owning GuiEditList screen will be provided), + GuiPropertyList (the parent GuiPropertyList will be provided), IConfigProperty (the IConfigProperty for this Property + will be provided).
        +
        Parameters:
        clazz - a class that implements IConfigEntry
        +
        • +
      + + + +
        +
      • +

        getArrayEntryClass

        +
        public java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> getArrayEntryClass()
        +
        Gets the custom IArrayEntry class that should be used in place of the standard entry class for this Property type, or null if + none has been set.
        +
        Returns:
        a class that implements IArrayEntry
        +
        • +
      + + + +
        +
      • +

        setValidationPattern

        +
        public Property setValidationPattern(java.util.regex.Pattern validationPattern)
        +
        Sets a regex Pattern object used to validate user input for formatted String or String[] properties.
        +
        Parameters:
        validationPattern -
        +
        • +
      + + + +
        +
      • +

        getValidationPattern

        +
        public java.util.regex.Pattern getValidationPattern()
        +
        Gets the Pattern object used to validate user input for this Property.
        +
        Returns:
        the user input validation Pattern object, or null if none is set
        +
        • +
      + + + +
        +
      • +

        setLanguageKey

        +
        public Property setLanguageKey(java.lang.String langKey)
        +
        Sets the localization language key for this Property so that the config GUI screens are nice and pretty <3. The string languageKey + + ".tooltip" is used for tooltips when a user hovers the mouse over a GUI property label.
        +
        Parameters:
        langKey - a string language key such as myawesomemod.config.myPropName
        +
        • +
      + + + +
        +
      • +

        getLanguageKey

        +
        public java.lang.String getLanguageKey()
        +
        Gets the language key string for this Property.
        +
        Returns:
        the language key
        +
        • +
      + + + +
        +
      • +

        setDefaultValue

        +
        public Property setDefaultValue(java.lang.String defaultValue)
        +
        Sets the default string value of this Property.
        +
        Parameters:
        defaultValue - a String value
        +
        • +
      + + + +
        +
      • +

        setDefaultValues

        +
        public Property setDefaultValues(java.lang.String[] defaultValues)
        +
        Sets the default String[] values of this Property.
        +
        Parameters:
        defaultValues - an array of String values
        +
        • +
      + + + +
        +
      • +

        setDefaultValue

        +
        public Property setDefaultValue(int defaultValue)
        +
        Sets the default int value of this Property.
        +
        Parameters:
        defaultValue - an int value
        +
        • +
      + + + +
        +
      • +

        setDefaultValues

        +
        public Property setDefaultValues(int[] defaultValues)
        +
        Sets the default int[] values of this Property.
        +
        Parameters:
        defaultValues - an array of int values
        +
        • +
      + + + +
        +
      • +

        setDefaultValue

        +
        public Property setDefaultValue(double defaultValue)
        +
        Sets the default double value of this Property.
        +
        Parameters:
        defaultValue - a double value
        +
        • +
      + + + +
        +
      • +

        setDefaultValues

        +
        public Property setDefaultValues(double[] defaultValues)
        +
        Sets the default double[] values of this Property
        +
        Parameters:
        defaultValues - an array of double values
        +
        • +
      + + + +
        +
      • +

        setDefaultValue

        +
        public Property setDefaultValue(boolean defaultValue)
        +
        Sets the default boolean value of this Property.
        +
        Parameters:
        defaultValue - a boolean value
        +
        • +
      + + + +
        +
      • +

        setDefaultValues

        +
        public Property setDefaultValues(boolean[] defaultValues)
        +
        Sets the default boolean[] values of this Property.
        +
        Parameters:
        defaultValues - an array of boolean values
        +
        • +
      + + + +
        +
      • +

        setMinValue

        +
        public Property setMinValue(int minValue)
        +
        Sets the minimum int value of this Property.
        +
        Parameters:
        minValue - an int value
        +
        • +
      + + + +
        +
      • +

        setMaxValue

        +
        public Property setMaxValue(int maxValue)
        +
        Sets the maximum int value of this Property.
        +
        Parameters:
        maxValue - an int value
        +
        • +
      + + + +
        +
      • +

        setMinValue

        +
        public Property setMinValue(double minValue)
        +
        Sets the minimum double value of this Property.
        +
        Parameters:
        minValue - a double value
        +
        • +
      + + + +
        +
      • +

        setMaxValue

        +
        public Property setMaxValue(double maxValue)
        +
        Sets the maximum double value of this Property.
        +
        Parameters:
        maxValue - a double value
        +
        • +
      + + + +
        +
      • +

        getMinValue

        +
        public java.lang.String getMinValue()
        +
        Gets the minimum value.
        +
        Returns:
        the minimum value bound
        +
        • +
      + + + +
        +
      • +

        getMaxValue

        +
        public java.lang.String getMaxValue()
        +
        Gets the maximum value.
        +
        Returns:
        the maximum value bound
        +
        • +
      + + + +
        +
      • +

        getString

        +
        public java.lang.String getString()
        +
        Returns the value in this property as it's raw string.
        +
        Returns:
        current value
        +
        • +
      + + + +
        +
      • +

        setValidValues

        +
        public Property setValidValues(java.lang.String[] validValues)
        +
        Sets the array of valid values that this String Property can be set to. When an array of valid values is defined for a Property the + GUI control for that property will be a value cycle button.
        +
        Parameters:
        validValues - a String array of valid values
        +
        • +
      + + + +
        +
      • +

        getValidValues

        +
        public java.lang.String[] getValidValues()
        +
        Gets the array of valid values that this String Property can be set to, or null if not defined.
        +
        Returns:
        a String array of valid values
        +
        • +
      + + + +
        +
      • +

        getInt

        +
        public int getInt()
        +
        Returns the value in this property as an integer, + if the value is not a valid integer, it will return the initially provided default.
        +
        Returns:
        The value
        +
        • +
      + + + +
        +
      • +

        getInt

        +
        public int getInt(int _default)
        +
        Returns the value in this property as an integer, + if the value is not a valid integer, it will return the + provided default.
        +
        Parameters:
        _default - The default to provide if the current value is not a valid integer
        +
        Returns:
        The value
        +
        • +
      + + + +
        +
      • +

        isIntValue

        +
        public boolean isIntValue()
        +
        Checks if the current value stored in this property can be converted to an integer.
        +
        Returns:
        True if the type of the Property is an Integer
        +
        • +
      + + + +
        +
      • +

        getBoolean

        +
        public boolean getBoolean(boolean _default)
        +
        Returns the value in this property as a boolean, + if the value is not a valid boolean, it will return the + provided default.
        +
        Parameters:
        _default - The default to provide
        +
        Returns:
        The value as a boolean, or the default
        +
        • +
      + + + +
        +
      • +

        getBoolean

        +
        public boolean getBoolean()
        +
        Returns the value in this property as a boolean, if the value is not a valid boolean, it will return the provided default.
        +
        Returns:
        The value as a boolean, or the default
        +
        • +
      + + + +
        +
      • +

        isBooleanValue

        +
        public boolean isBooleanValue()
        +
        Checks if the current value held by this property is a valid boolean value.
        +
        Returns:
        True if it is a boolean value
        +
        • +
      + + + +
        +
      • +

        isDoubleValue

        +
        public boolean isDoubleValue()
        +
        Checks if the current value held by this property is a valid double value.
        +
        Returns:
        True if the value can be converted to an double
        +
        • +
      + + + +
        +
      • +

        getDouble

        +
        public double getDouble(double _default)
        +
        Returns the value in this property as a double, + if the value is not a valid double, it will return the + provided default.
        +
        Parameters:
        _default - The default to provide if the current value is not a valid double
        +
        Returns:
        The value
        +
        • +
      + + + +
        +
      • +

        getDouble

        +
        public double getDouble()
        +
        Returns the value in this property as a double, if the value is not a valid double, it will return the provided default.
        +
        Parameters:
        _default - The default to provide if the current value is not a valid double
        +
        Returns:
        The value
        +
        • +
      + + + +
        +
      • +

        getStringList

        +
        public java.lang.String[] getStringList()
        +
        • +
      + + + +
        +
      • +

        getIntList

        +
        public int[] getIntList()
        +
        Returns the integer value of all values that can + be parsed in the list.
        +
        Returns:
        Array of length 0 if none of the values could be parsed.
        +
        • +
      + + + +
        +
      • +

        isIntList

        +
        public boolean isIntList()
        +
        Checks if all of the current values stored in this property can be converted to an integer.
        +
        Returns:
        True if the type of the Property is an Integer List
        +
        • +
      + + + +
        +
      • +

        getBooleanList

        +
        public boolean[] getBooleanList()
        +
        Returns the boolean value of all values that can + be parsed in the list.
        +
        Returns:
        Array of length 0 if none of the values could be parsed.
        +
        • +
      + + + +
        +
      • +

        isBooleanList

        +
        public boolean isBooleanList()
        +
        Checks if all of current values stored in this property can be converted to a boolean.
        +
        Returns:
        True if it is a boolean value
        +
        • +
      + + + +
        +
      • +

        getDoubleList

        +
        public double[] getDoubleList()
        +
        Returns the double value of all values that can + be parsed in the list.
        +
        Returns:
        Array of length 0 if none of the values could be parsed.
        +
        • +
      + + + +
        +
      • +

        isDoubleList

        +
        public boolean isDoubleList()
        +
        Checks if all of the current values stored in this property can be converted to a double.
        +
        Returns:
        True if the type of the Property is a double List
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Gets the name/key for this Property.
        +
        Returns:
        the Property name
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Sets the name/key for this Property.
        +
        Parameters:
        name - a name
        +
        • +
      + + + +
        +
      • +

        wasRead

        +
        public boolean wasRead()
        +
        Determines if this config value was just created, or if it was read from the config file. + This is useful for mods who auto-assign their blocks to determine if the ID returned is + a configured one, or a automatically generated one.
        +
        Returns:
        True if this property was loaded from the config file with a value
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public Property.Type getType()
        +
        Gets the Property.Type enum value for this Property.
        +
        Returns:
        the Property's type
        +
        • +
      + + + +
        +
      • +

        isList

        +
        public boolean isList()
        +
        Returns whether or not this Property is a list/array.
        +
        Returns:
        true if this Property is a list/array, false otherwise
        +
        • +
      + + + +
        +
      • +

        hasChanged

        +
        public boolean hasChanged()
        +
        Gets the changed status of this Property.
        +
        Returns:
        true if this Property has changed, false otherwise
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public Property setValue(java.lang.String value)
        +
        Sets the value of this Property to the provided String value.
        +
        • +
      + + + +
        +
      • +

        set

        +
        public void set(java.lang.String value)
        +
        • +
      + + + +
        +
      • +

        setValues

        +
        public Property setValues(java.lang.String[] values)
        +
        Sets the values of this Property to the provided String[] values.
        +
        • +
      + + + +
        +
      • +

        set

        +
        public void set(java.lang.String[] values)
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public Property setValue(int value)
        +
        Sets the value of this Property to the provided int value.
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public Property setValue(boolean value)
        +
        Sets the value of this Property to the provided boolean value.
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public Property setValue(double value)
        +
        Sets the value of this Property to the provided double value.
        +
        • +
      + + + +
        +
      • +

        setValues

        +
        public Property setValues(boolean[] values)
        +
        Sets the values of this Property to the provided boolean[] values.
        +
        • +
      + + + +
        +
      • +

        set

        +
        public void set(boolean[] values)
        +
        • +
      + + + +
        +
      • +

        setValues

        +
        public Property setValues(int[] values)
        +
        Sets the values of this Property to the provided int[] values.
        +
        • +
      + + + +
        +
      • +

        set

        +
        public void set(int[] values)
        +
        • +
      + + + +
        +
      • +

        setValues

        +
        public Property setValues(double[] values)
        +
        Sets the values of this Property to the provided double[] values.
        +
        • +
      + + + +
        +
      • +

        set

        +
        public void set(double[] values)
        +
        • +
      + + + +
        +
      • +

        set

        +
        public void set(int value)
        +
        • +
      + + + +
        +
      • +

        set

        +
        public void set(boolean value)
        +
        • +
      + + + +
        +
      • +

        set

        +
        public void set(double value)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/config/package-frame.html b/javadoc/net/minecraftforge/common/config/package-frame.html new file mode 100644 index 0000000..cda5878 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/package-frame.html @@ -0,0 +1,27 @@ + + + + + +net.minecraftforge.common.config (Forge API) + + + + +

net.minecraftforge.common.config

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/net/minecraftforge/common/config/package-summary.html b/javadoc/net/minecraftforge/common/config/package-summary.html new file mode 100644 index 0000000..4ff72e5 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/package-summary.html @@ -0,0 +1,167 @@ + + + + + +net.minecraftforge.common.config (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.common.config

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/config/package-tree.html b/javadoc/net/minecraftforge/common/config/package-tree.html new file mode 100644 index 0000000..894fc23 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/package-tree.html @@ -0,0 +1,146 @@ + + + + + +net.minecraftforge.common.config Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.common.config

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/network/DimensionMessageHandler.html b/javadoc/net/minecraftforge/common/network/DimensionMessageHandler.html new file mode 100644 index 0000000..7d79bb3 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/DimensionMessageHandler.html @@ -0,0 +1,349 @@ + + + + + +DimensionMessageHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common.network
+

Class DimensionMessageHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class DimensionMessageHandler
+extends io.netty.channel.SimpleChannelInboundHandler<ForgeMessage.DimensionRegisterMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + ForgeMessage.DimensionRegisterMessage msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerAdded, handlerRemoved, isSharable
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface io.netty.channel.ChannelHandler

        +handlerAdded, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DimensionMessageHandler

        +
        public DimensionMessageHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        exceptionCaught

        +
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
+                   java.lang.Throwable cause)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        exceptionCaught in interface io.netty.channel.ChannelHandler
        +
        Specified by:
        +
        exceptionCaught in interface io.netty.channel.ChannelInboundHandler
        +
        Overrides:
        +
        exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html b/javadoc/net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html new file mode 100644 index 0000000..8471382 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html @@ -0,0 +1,349 @@ + + + + + +FluidIdRegistryMessageHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common.network
+

Class FluidIdRegistryMessageHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class FluidIdRegistryMessageHandler
+extends io.netty.channel.SimpleChannelInboundHandler<ForgeMessage.FluidIdMapMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + ForgeMessage.FluidIdMapMessage msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerAdded, handlerRemoved, isSharable
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface io.netty.channel.ChannelHandler

        +handlerAdded, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidIdRegistryMessageHandler

        +
        public FluidIdRegistryMessageHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                ForgeMessage.FluidIdMapMessage msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<ForgeMessage.FluidIdMapMessage>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        exceptionCaught

        +
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
+                   java.lang.Throwable cause)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        exceptionCaught in interface io.netty.channel.ChannelHandler
        +
        Specified by:
        +
        exceptionCaught in interface io.netty.channel.ChannelInboundHandler
        +
        Overrides:
        +
        exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html b/javadoc/net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html new file mode 100644 index 0000000..2e63a43 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html @@ -0,0 +1,264 @@ + + + + + +ForgeMessage.DimensionRegisterMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common.network
+

Class ForgeMessage.DimensionRegisterMessage

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ForgeMessage
    +
    +
    +
    +
    public static class ForgeMessage.DimensionRegisterMessage
+extends ForgeMessage
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeMessage.DimensionRegisterMessage

        +
        public ForgeMessage.DimensionRegisterMessage()
        +
        • +
      + + + +
        +
      • +

        ForgeMessage.DimensionRegisterMessage

        +
        public ForgeMessage.DimensionRegisterMessage(int dimensionId,
+                                     int providerId)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html b/javadoc/net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html new file mode 100644 index 0000000..30e89b3 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html @@ -0,0 +1,250 @@ + + + + + +ForgeMessage.FluidIdMapMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common.network
+

Class ForgeMessage.FluidIdMapMessage

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ForgeMessage
    +
    +
    +
    +
    public static class ForgeMessage.FluidIdMapMessage
+extends ForgeMessage
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeMessage.FluidIdMapMessage

        +
        public ForgeMessage.FluidIdMapMessage()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/network/ForgeMessage.html b/javadoc/net/minecraftforge/common/network/ForgeMessage.html new file mode 100644 index 0000000..279d7d7 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/ForgeMessage.html @@ -0,0 +1,253 @@ + + + + + +ForgeMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common.network
+

Class ForgeMessage

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ForgeMessage() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeMessage

        +
        public ForgeMessage()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/network/ForgeNetworkHandler.html b/javadoc/net/minecraftforge/common/network/ForgeNetworkHandler.html new file mode 100644 index 0000000..57d9047 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/ForgeNetworkHandler.html @@ -0,0 +1,256 @@ + + + + + +ForgeNetworkHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common.network
+

Class ForgeNetworkHandler

+
+
+ +
+
    +
  • +
    +
    +
    public class ForgeNetworkHandler
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidregisterChannel(ForgeModContainer forgeModContainer, + Side side) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeNetworkHandler

        +
        public ForgeNetworkHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerChannel

        +
        public static void registerChannel(ForgeModContainer forgeModContainer,
+                   Side side)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/network/ForgeRuntimeCodec.html b/javadoc/net/minecraftforge/common/network/ForgeRuntimeCodec.html new file mode 100644 index 0000000..2561969 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/ForgeRuntimeCodec.html @@ -0,0 +1,386 @@ + + + + + +ForgeRuntimeCodec (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common.network
+

Class ForgeRuntimeCodec

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class ForgeRuntimeCodec
+extends FMLIndexedMessageToMessageCodec<ForgeMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ForgeRuntimeCodec() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecodeInto(io.netty.channel.ChannelHandlerContext ctx, + io.netty.buffer.ByteBuf source, + ForgeMessage msg) 
      voidencodeInto(io.netty.channel.ChannelHandlerContext ctx, + ForgeMessage msg, + io.netty.buffer.ByteBuf target) 
      + +
        +
      • + + +

        Methods inherited from class io.netty.handler.codec.MessageToMessageCodec

        +acceptInboundMessage, acceptOutboundMessage, channelRead, write
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelDuplexHandler

        +bind, close, connect, deregister, disconnect, flush, read
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerRemoved, isSharable
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface io.netty.channel.ChannelHandler

        +handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html b/javadoc/net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html new file mode 100644 index 0000000..1e680ad --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html @@ -0,0 +1,314 @@ + + + + + +ServerToClientConnectionEstablishedHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common.network
+

Class ServerToClientConnectionEstablishedHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class ServerToClientConnectionEstablishedHandler
+extends io.netty.channel.ChannelInboundHandlerAdapter
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiduserEventTriggered(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object evt) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerAdded, handlerRemoved, isSharable
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface io.netty.channel.ChannelHandler

        +handlerAdded, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ServerToClientConnectionEstablishedHandler

        +
        public ServerToClientConnectionEstablishedHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        userEventTriggered

        +
        public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx,
+                      java.lang.Object evt)
+                        throws java.lang.Exception
        +
        +
        Specified by:
        +
        userEventTriggered in interface io.netty.channel.ChannelInboundHandler
        +
        Overrides:
        +
        userEventTriggered in class io.netty.channel.ChannelInboundHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/network/package-frame.html b/javadoc/net/minecraftforge/common/network/package-frame.html new file mode 100644 index 0000000..da935c4 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/package-frame.html @@ -0,0 +1,26 @@ + + + + + +net.minecraftforge.common.network (Forge API) + + + + +

net.minecraftforge.common.network

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/common/network/package-summary.html b/javadoc/net/minecraftforge/common/network/package-summary.html new file mode 100644 index 0000000..9e251ff --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/package-summary.html @@ -0,0 +1,159 @@ + + + + + +net.minecraftforge.common.network (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.common.network

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/network/package-tree.html b/javadoc/net/minecraftforge/common/network/package-tree.html new file mode 100644 index 0000000..efe776d --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/package-tree.html @@ -0,0 +1,160 @@ + + + + + +net.minecraftforge.common.network Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.common.network

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/package-frame.html b/javadoc/net/minecraftforge/common/package-frame.html new file mode 100644 index 0000000..fabd683 --- /dev/null +++ b/javadoc/net/minecraftforge/common/package-frame.html @@ -0,0 +1,59 @@ + + + + + +net.minecraftforge.common (Forge API) + + + + +

net.minecraftforge.common

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/net/minecraftforge/common/package-summary.html b/javadoc/net/minecraftforge/common/package-summary.html new file mode 100644 index 0000000..bf0f415 --- /dev/null +++ b/javadoc/net/minecraftforge/common/package-summary.html @@ -0,0 +1,308 @@ + + + + + +net.minecraftforge.common (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.common

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/package-tree.html b/javadoc/net/minecraftforge/common/package-tree.html new file mode 100644 index 0000000..830d987 --- /dev/null +++ b/javadoc/net/minecraftforge/common/package-tree.html @@ -0,0 +1,189 @@ + + + + + +net.minecraftforge.common Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.common

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html b/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html new file mode 100644 index 0000000..d3e4c49 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html @@ -0,0 +1,280 @@ + + + + + +AsynchronousExecutor.CallBackProvider (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common.util
+

Interface AsynchronousExecutor.CallBackProvider<P,T,C,E extends java.lang.Throwable>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.util.concurrent.ThreadFactory
    +
    +
    +
    Enclosing class:
    +
    AsynchronousExecutor<P,T,C,E extends java.lang.Throwable>
    +
    +
    +
    +
    public static interface AsynchronousExecutor.CallBackProvider<P,T,C,E extends java.lang.Throwable>
+extends java.util.concurrent.ThreadFactory
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      TcallStage1(P parameter) +
      Normally an asynchronous call, but can be synchronous
      +
      voidcallStage2(P parameter, + T object) +
      Synchronous call
      +
      voidcallStage3(P parameter, + T object, + C callback) +
      Synchronous call, called multiple times, once per registered callback
      +
      +
        +
      • + + +

        Methods inherited from interface java.util.concurrent.ThreadFactory

        +newThread
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        callStage1

        +
        T callStage1(P parameter)
+             throws E extends java.lang.Throwable
        +
        Normally an asynchronous call, but can be synchronous
        +
        Parameters:
        parameter - parameter object provided
        +
        Returns:
        the created object
        +
        Throws:
        +
        E extends java.lang.Throwable
        +
        • +
      + + + + + +
        +
      • +

        callStage2

        +
        void callStage2(P parameter,
+              T object)
+                throws E extends java.lang.Throwable
        +
        Synchronous call
        +
        Parameters:
        parameter - parameter object provided
        object - the previously created object
        +
        Throws:
        +
        E extends java.lang.Throwable
        +
        • +
      + + + + + +
        +
      • +

        callStage3

        +
        void callStage3(P parameter,
+              T object,
+              C callback)
+                throws E extends java.lang.Throwable
        +
        Synchronous call, called multiple times, once per registered callback
        +
        Parameters:
        parameter - parameter object provided
        object - the previously created object
        callback - the current callback to execute
        +
        Throws:
        +
        E extends java.lang.Throwable
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.html b/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.html new file mode 100644 index 0000000..98f08a3 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.html @@ -0,0 +1,474 @@ + + + + + +AsynchronousExecutor (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common.util
+

Class AsynchronousExecutor<P,T,C,E extends java.lang.Throwable>

+
+
+ +
+
    +
  • +
    Type Parameters:
    P - The type of parameter you provide to make the object that will be created. It should implement Object.hashCode() and Object.equals(Object) if you want to get the value early.
    T - The type of object you provide. This is created in stage 1, and passed to stage 2, 3, and returned if get() is called.
    C - The type of callback you provide. You may register many of these to be passed to the provider in stage 3, one at a time.
    E - A type of exception you may throw and expect to be handled by the main thread
    +
    +
    +
    public final class AsynchronousExecutor<P,T,C,E extends java.lang.Throwable>
+extends java.lang.Object
    +
    Executes tasks using a multi-stage process executor. Synchronous executions are via finishActive() or the get(Object) methods. +
  • Stage 1 creates the object from a parameter, and is usually called asynchronously. +
  • Stage 2 takes the parameter and object from stage 1 and does any synchronous processing to prepare it. +
  • Stage 3 takes the parameter and object from stage 1, as well as a callback that was registered, and performs any synchronous calculations.
+ + +
+
+ +
+
+ +
+ + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/BlockSnapshot.html b/javadoc/net/minecraftforge/common/util/BlockSnapshot.html new file mode 100644 index 0000000..df83bce --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/BlockSnapshot.html @@ -0,0 +1,697 @@ + + + + + +BlockSnapshot (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common.util
+

Class BlockSnapshot

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class BlockSnapshot
+extends java.lang.Object
+implements java.io.Serializable
    +
    Represents a captured snapshot of a block which will not change + automatically. +

    + Unlike Block, which only one object can exist per coordinate, BlockSnapshot + can exist multiple times for any given Block.

    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        x

        +
        public final int x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final int y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final int z
        +
        • +
      + + + +
        +
      • +

        dimId

        +
        public final int dimId
        +
        • +
      + + + +
        +
      • +

        replacedBlock

        +
        public transient Block replacedBlock
        +
        • +
      + + + +
        +
      • +

        meta

        +
        public final int meta
        +
        • +
      + + + +
        +
      • +

        flag

        +
        public int flag
        +
        • +
      + + + +
        +
      • +

        world

        +
        public transient World world
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlockSnapshot

        +
        public BlockSnapshot(World world,
+             int x,
+             int y,
+             int z,
+             Block block,
+             int meta)
        +
        • +
      + + + +
        +
      • +

        BlockSnapshot

        +
        public BlockSnapshot(World world,
+             int x,
+             int y,
+             int z,
+             Block block,
+             int meta,
+             NBTTagCompound nbt)
        +
        • +
      + + + +
        +
      • +

        BlockSnapshot

        +
        public BlockSnapshot(World world,
+             int x,
+             int y,
+             int z,
+             Block block,
+             int meta,
+             int flag)
        +
        • +
      + + + +
        +
      • +

        BlockSnapshot

        +
        public BlockSnapshot(int dimension,
+             int x,
+             int y,
+             int z,
+             java.lang.String modid,
+             java.lang.String blockName,
+             int meta,
+             int flag,
+             NBTTagCompound nbt)
        +
        Raw constructor designed for serialization usages.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBlockSnapshot

        +
        public static BlockSnapshot getBlockSnapshot(World world,
+                             int x,
+                             int y,
+                             int z)
        +
        • +
      + + + +
        +
      • +

        getBlockSnapshot

        +
        public static BlockSnapshot getBlockSnapshot(World world,
+                             int x,
+                             int y,
+                             int z,
+                             int flag)
        +
        • +
      + + + + + + + +
        +
      • +

        getCurrentBlock

        +
        public Block getCurrentBlock()
        +
        • +
      + + + +
        +
      • +

        getWorld

        +
        public World getWorld()
        +
        • +
      + + + +
        +
      • +

        getReplacedBlock

        +
        public Block getReplacedBlock()
        +
        • +
      + + + +
        +
      • +

        getTileEntity

        +
        public TileEntity getTileEntity()
        +
        • +
      + + + +
        +
      • +

        restore

        +
        public boolean restore()
        +
        • +
      + + + +
        +
      • +

        restore

        +
        public boolean restore(boolean force)
        +
        • +
      + + + +
        +
      • +

        restore

        +
        public boolean restore(boolean force,
+              boolean applyPhysics)
        +
        • +
      + + + +
        +
      • +

        restoreToLocation

        +
        public boolean restoreToLocation(World world,
+                        int x,
+                        int y,
+                        int z,
+                        boolean force,
+                        boolean applyPhysics)
        +
        • +
      + + + +
        +
      • +

        writeToNBT

        +
        public void writeToNBT(NBTTagCompound compound)
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/ChunkCoordComparator.html b/javadoc/net/minecraftforge/common/util/ChunkCoordComparator.html new file mode 100644 index 0000000..8ff601c --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/ChunkCoordComparator.html @@ -0,0 +1,272 @@ + + + + + +ChunkCoordComparator (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common.util
+

Class ChunkCoordComparator

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Comparator<ChunkCoordIntPair>
    +
    +
    +
    +
    public class ChunkCoordComparator
+extends java.lang.Object
+implements java.util.Comparator<ChunkCoordIntPair>
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intcompare(ChunkCoordIntPair a, + ChunkCoordIntPair b) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Comparator

        +equals
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/Constants.NBT.html b/javadoc/net/minecraftforge/common/util/Constants.NBT.html new file mode 100644 index 0000000..4cc53fa --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/Constants.NBT.html @@ -0,0 +1,439 @@ + + + + + +Constants.NBT (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common.util
+

Class Constants.NBT

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Constants
    +
    +
    +
    +
    public static class Constants.NBT
+extends java.lang.Object
    +
    NBT Tag type IDS, used when storing the nbt to disc, Should align with NBTBase.getId, + table used in NBTBase.func_150283_g + + Main use is checking tag type in NBTTagCompound.func_150297_b(String, int)
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/Constants.html b/javadoc/net/minecraftforge/common/util/Constants.html new file mode 100644 index 0000000..e1a8cc9 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/Constants.html @@ -0,0 +1,252 @@ + + + + + +Constants (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.common.util
+

Class Constants

+
+
+ +
+
    +
  • +
    +
    +
    public class Constants
+extends java.lang.Object
    +
    A class containing constants for magic numbers used in the minecraft codebase. + Everything here should be checked each update, and have a comment relating to where to check it.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Constants.NBT +
      NBT Tag type IDS, used when storing the nbt to disc, Should align with NBTBase.getId, + table used in NBTBase.func_150283_g + + Main use is checking tag type in NBTTagCompound.func_150297_b(String, int)
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Constants() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Constants

        +
        public Constants()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/EnumHelper.html b/javadoc/net/minecraftforge/common/util/EnumHelper.html new file mode 100644 index 0000000..dff6c7b --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/EnumHelper.html @@ -0,0 +1,544 @@ + + + + + +EnumHelper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common.util
+

Class EnumHelper

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    EnumHelperClient
    +
    +
    +
    +
    public class EnumHelper
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EnumHelper

        +
        public EnumHelper()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addAction

        +
        public static EnumAction addAction(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        addArmorMaterial

        +
        public static ItemArmor.ArmorMaterial addArmorMaterial(java.lang.String name,
+                                       int durability,
+                                       int[] reductionAmounts,
+                                       int enchantability)
        +
        • +
      + + + +
        +
      • +

        addArt

        +
        public static EntityPainting.EnumArt addArt(java.lang.String name,
+                            java.lang.String tile,
+                            int sizeX,
+                            int sizeY,
+                            int offsetX,
+                            int offsetY)
        +
        • +
      + + + +
        +
      • +

        addCreatureAttribute

        +
        public static EnumCreatureAttribute addCreatureAttribute(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        addCreatureType

        +
        public static EnumCreatureType addCreatureType(java.lang.String name,
+                               java.lang.Class typeClass,
+                               int maxNumber,
+                               Material material,
+                               boolean peaceful,
+                               boolean animal)
        +
        • +
      + + + + + + + +
        +
      • +

        addEnchantmentType

        +
        public static EnumEnchantmentType addEnchantmentType(java.lang.String name)
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        addSkyBlock

        +
        public static EnumSkyBlock addSkyBlock(java.lang.String name,
+                       int lightValue)
        +
        • +
      + + + + + + + +
        +
      • +

        addToolMaterial

        +
        public static Item.ToolMaterial addToolMaterial(java.lang.String name,
+                                int harvestLevel,
+                                int maxUses,
+                                float efficiency,
+                                float damage,
+                                int enchantability)
        +
        • +
      + + + +
        +
      • +

        addRarity

        +
        public static EnumRarity addRarity(java.lang.String name,
+                   EnumChatFormatting color,
+                   java.lang.String displayName)
        +
        • +
      + + + +
        +
      • +

        setFailsafeFieldValue

        +
        public static void setFailsafeFieldValue(java.lang.reflect.Field field,
+                         java.lang.Object target,
+                         java.lang.Object value)
+                                  throws java.lang.Exception
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        addEnum

        +
        public static <T extends java.lang.Enum<?>> T addEnum(java.lang.Class<T> enumType,
+                                      java.lang.String enumName,
+                                      java.lang.Object... paramValues)
        +
        • +
      + + + +
        +
      • +

        addEnum

        +
        public static <T extends java.lang.Enum<?>> T addEnum(java.lang.Class[][] map,
+                                      java.lang.Class<T> enumType,
+                                      java.lang.String enumName,
+                                      java.lang.Object... paramValues)
        +
        • +
      + + + +
        +
      • +

        addEnum

        +
        public static <T extends java.lang.Enum<?>> T addEnum(java.lang.Class<T> enumType,
+                                      java.lang.String enumName,
+                                      java.lang.Class<?>[] paramTypes,
+                                      java.lang.Object[] paramValues)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/FakePlayer.html b/javadoc/net/minecraftforge/common/util/FakePlayer.html new file mode 100644 index 0000000..e9da208 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/FakePlayer.html @@ -0,0 +1,558 @@ + + + + + +FakePlayer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common.util
+

Class FakePlayer

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/FakePlayerFactory.html b/javadoc/net/minecraftforge/common/util/FakePlayerFactory.html new file mode 100644 index 0000000..aa30560 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/FakePlayerFactory.html @@ -0,0 +1,289 @@ + + + + + +FakePlayerFactory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common.util
+

Class FakePlayerFactory

+
+
+ +
+
    +
  • +
    +
    +
    public class FakePlayerFactory
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FakePlayerFactory() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static FakePlayerget(WorldServer world, + com.mojang.authlib.GameProfile username) +
      Get a fake player with a given username, + Mods should either hold weak references to the return value, or listen for a + WorldEvent.Unload and kill all references to prevent worlds staying in memory.
      +
      static FakePlayergetMinecraft(WorldServer world) 
      static voidunloadWorld(WorldServer world) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FakePlayerFactory

        +
        public FakePlayerFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        get

        +
        public static FakePlayer get(WorldServer world,
+             com.mojang.authlib.GameProfile username)
        +
        Get a fake player with a given username, + Mods should either hold weak references to the return value, or listen for a + WorldEvent.Unload and kill all references to prevent worlds staying in memory.
        +
        • +
      + + + +
        +
      • +

        unloadWorld

        +
        public static void unloadWorld(WorldServer world)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/ForgeDirection.html b/javadoc/net/minecraftforge/common/util/ForgeDirection.html new file mode 100644 index 0000000..80c84b4 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/ForgeDirection.html @@ -0,0 +1,551 @@ + + + + + +ForgeDirection (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common.util
+

Enum ForgeDirection

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<ForgeDirection>
    +
    +
    +
    +
    public enum ForgeDirection
+extends java.lang.Enum<ForgeDirection>
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        offsetX

        +
        public final int offsetX
        +
        • +
      + + + +
        +
      • +

        offsetY

        +
        public final int offsetY
        +
        • +
      + + + +
        +
      • +

        offsetZ

        +
        public final int offsetZ
        +
        • +
      + + + +
        +
      • +

        flag

        +
        public final int flag
        +
        • +
      + + + +
        +
      • +

        VALID_DIRECTIONS

        +
        public static final ForgeDirection[] VALID_DIRECTIONS
        +
        • +
      + + + +
        +
      • +

        OPPOSITES

        +
        public static final int[] OPPOSITES
        +
        • +
      + + + +
        +
      • +

        ROTATION_MATRIX

        +
        public static final int[][] ROTATION_MATRIX
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ForgeDirection[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ForgeDirection c : ForgeDirection.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ForgeDirection valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      + + + +
        +
      • +

        getOrientation

        +
        public static ForgeDirection getOrientation(int id)
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/RotationHelper.html b/javadoc/net/minecraftforge/common/util/RotationHelper.html new file mode 100644 index 0000000..2676874 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/RotationHelper.html @@ -0,0 +1,279 @@ + + + + + +RotationHelper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common.util
+

Class RotationHelper

+
+
+ +
+
    +
  • +
    +
    +
    public class RotationHelper
+extends java.lang.Object
    +
    This class is a helper function for vanilla blocks, and should not be called by Modders. + Refer to block.rotateBlock and block.getValidRotations instead.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RotationHelper

        +
        public RotationHelper()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getValidVanillaBlockRotations

        +
        public static ForgeDirection[] getValidVanillaBlockRotations(Block block)
        +
        • +
      + + + +
        +
      • +

        rotateVanillaBlock

        +
        public static boolean rotateVanillaBlock(Block block,
+                         World worldObj,
+                         int x,
+                         int y,
+                         int z,
+                         ForgeDirection axis)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/package-frame.html b/javadoc/net/minecraftforge/common/util/package-frame.html new file mode 100644 index 0000000..02ed6d9 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/package-frame.html @@ -0,0 +1,35 @@ + + + + + +net.minecraftforge.common.util (Forge API) + + + + +

net.minecraftforge.common.util

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/net/minecraftforge/common/util/package-summary.html b/javadoc/net/minecraftforge/common/util/package-summary.html new file mode 100644 index 0000000..4f8ebac --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/package-summary.html @@ -0,0 +1,207 @@ + + + + + +net.minecraftforge.common.util (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.common.util

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/common/util/package-tree.html b/javadoc/net/minecraftforge/common/util/package-tree.html new file mode 100644 index 0000000..a714776 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/package-tree.html @@ -0,0 +1,170 @@ + + + + + +net.minecraftforge.common.util Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.common.util

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/AnvilUpdateEvent.html b/javadoc/net/minecraftforge/event/AnvilUpdateEvent.html new file mode 100644 index 0000000..3d868f3 --- /dev/null +++ b/javadoc/net/minecraftforge/event/AnvilUpdateEvent.html @@ -0,0 +1,364 @@ + + + + + +AnvilUpdateEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event
+

Class AnvilUpdateEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class AnvilUpdateEvent
+extends Event
    +
    AnvilUpdateEvent is fired when a player places items in both the left and right slots of a anvil. + If the event is canceled, vanilla behavior will not run, and the output will be set to null. + If the event is not canceled, but the output is not null, it will set the output and not run vanilla behavior. + if the output is null, and the event is not canceled, vanilla behavior will execute.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + + + + + +
        +
      • +

        name

        +
        public final java.lang.String name
        +
        • +
      + + + + + + + +
        +
      • +

        cost

        +
        public int cost
        +
        • +
      + + + +
        +
      • +

        materialCost

        +
        public int materialCost
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AnvilUpdateEvent

        +
        public AnvilUpdateEvent(ItemStack left,
+                ItemStack right,
+                java.lang.String name,
+                int cost)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/CommandEvent.html b/javadoc/net/minecraftforge/event/CommandEvent.html new file mode 100644 index 0000000..76a12e2 --- /dev/null +++ b/javadoc/net/minecraftforge/event/CommandEvent.html @@ -0,0 +1,347 @@ + + + + + +CommandEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event
+

Class CommandEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class CommandEvent
+extends Event
    +
    CommandEvent is fired whenever a command is scheduled to be executed. + This event is fired during the invocation of CommandHandler#executeCommand(ICommandSender, String) + and ClientCommandHandler#executeCommand(ICommandSender, String).
    +
    + command contains the instance of ICommand which is representative of the currently executing command.
    + sender contains the instance of ICommandSender for the given command sender.
    + parameters contains the arguments passed for the command execution.
    + exception begins null, but can be populated with an exception to be thrown within the command.
    +
    + This event is Cancelable.
    + If the event is canceled, the execution of the command does not occur.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        command

        +
        public final ICommand command
        +
        • +
      + + + + + + + +
        +
      • +

        parameters

        +
        public java.lang.String[] parameters
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public java.lang.Throwable exception
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CommandEvent

        +
        public CommandEvent(ICommand command,
+            ICommandSender sender,
+            java.lang.String[] parameters)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/ForgeEventFactory.html b/javadoc/net/minecraftforge/event/ForgeEventFactory.html new file mode 100644 index 0000000..1391d79 --- /dev/null +++ b/javadoc/net/minecraftforge/event/ForgeEventFactory.html @@ -0,0 +1,846 @@ + + + + + +ForgeEventFactory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.event
+

Class ForgeEventFactory

+
+
+ +
+
    +
  • +
    +
    +
    public class ForgeEventFactory
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/ServerChatEvent.html b/javadoc/net/minecraftforge/event/ServerChatEvent.html new file mode 100644 index 0000000..be80819 --- /dev/null +++ b/javadoc/net/minecraftforge/event/ServerChatEvent.html @@ -0,0 +1,347 @@ + + + + + +ServerChatEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event
+

Class ServerChatEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class ServerChatEvent
+extends Event
    +
    ServerChatEvent is fired whenever a C01PacketChatMessage is processed.
    + This event is fired via ForgeHooks#onServerChatEvent(net.minecraft.network.NetHandlerPlayServer, String, ChatComponentTranslation), + which is executed by the NetHandlerPlayServer#processChatMessage(net.minecraft.network.play.client.C01PacketChatMessage)
    +
    + username contains the username of the player sending the chat message.
    + message contains the message being sent.
    + player the instance of EntityPlayerMP for the player sending the chat message.
    + component contains the instance of ChatComponentTranslation for the sent message.
    +
    + This event is Cancelable.
    + If this event is canceled, the chat message is never distributed to all clients.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/brewing/PotionBrewEvent.Post.html b/javadoc/net/minecraftforge/event/brewing/PotionBrewEvent.Post.html new file mode 100644 index 0000000..aaff33a --- /dev/null +++ b/javadoc/net/minecraftforge/event/brewing/PotionBrewEvent.Post.html @@ -0,0 +1,307 @@ + + + + + +PotionBrewEvent.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.brewing
+

Class PotionBrewEvent.Post

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PotionBrewEvent
    +
    +
    +
    +
    public static class PotionBrewEvent.Post
+extends PotionBrewedEvent
    +
    PotionBrewEvent.Post is fired when a potion is brewed in the brewing stand. +
    + The event is fired during the TileEntityBrewingStand#brewPotions() method invocation.
    +
    + PotionBrewedEvent.brewingStacks contains the itemstack array from the TileEntityBrewer holding all items in Brewer.
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. Event.HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PotionBrewEvent.Post

        +
        public PotionBrewEvent.Post(ItemStack[] stacks)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/brewing/PotionBrewEvent.Pre.html b/javadoc/net/minecraftforge/event/brewing/PotionBrewEvent.Pre.html new file mode 100644 index 0000000..238fc80 --- /dev/null +++ b/javadoc/net/minecraftforge/event/brewing/PotionBrewEvent.Pre.html @@ -0,0 +1,291 @@ + + + + + +PotionBrewEvent.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.brewing
+

Class PotionBrewEvent.Pre

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PotionBrewEvent
    +
    +
    +
    +
    public static class PotionBrewEvent.Pre
+extends PotionBrewEvent
    +
    PotionBrewEvent.Pre is fired before vanilla brewing takes place. + All changes made to the event's array will be made to the TileEntity if the event is canceled. +
    + The event is fired during the TileEntityBrewingStand#brewPotions() method invocation.
    +
    + #brewingStacks contains the itemstack array from the TileEntityBrewer holding all items in Brewer.
    +
    + This event is Cancelable.
    + If the event is not canceled, the vanilla brewing will take place instead of modded brewing. +
    + This event does not have a result. Event.HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    + If this event is canceled, and items have been modified, PotionBrewEvent.Post will automatically be fired.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PotionBrewEvent.Pre

        +
        public PotionBrewEvent.Pre(ItemStack[] stacks)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/brewing/PotionBrewEvent.html b/javadoc/net/minecraftforge/event/brewing/PotionBrewEvent.html new file mode 100644 index 0000000..d26e5a4 --- /dev/null +++ b/javadoc/net/minecraftforge/event/brewing/PotionBrewEvent.html @@ -0,0 +1,334 @@ + + + + + +PotionBrewEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.brewing
+

Class PotionBrewEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PotionBrewEvent

        +
        protected PotionBrewEvent(ItemStack[] stacks)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getItem

        +
        public ItemStack getItem(int index)
        +
        • +
      + + + +
        +
      • +

        setItem

        +
        public void setItem(int index,
+           ItemStack stack)
        +
        • +
      + + + +
        +
      • +

        getLength

        +
        public int getLength()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/brewing/PotionBrewedEvent.html b/javadoc/net/minecraftforge/event/brewing/PotionBrewedEvent.html new file mode 100644 index 0000000..9d7cbf0 --- /dev/null +++ b/javadoc/net/minecraftforge/event/brewing/PotionBrewedEvent.html @@ -0,0 +1,334 @@ + + + + + +PotionBrewedEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.brewing
+

Class PotionBrewedEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    PotionBrewEvent.Post
    +
    +
    +
    Deprecated.
    +
    +
    @Deprecated
+public class PotionBrewedEvent
+extends PotionBrewEvent
    +
    PotionBrewedEvent is fired when a potion is brewed in the brewing stand. +
    + The event is fired during the TileEntityBrewingStand#brewPotions() method invocation.
    +
    + brewingStacks contains the itemstack array from the TileEntityBrewer holding all items in Brewer.
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        brewingStacks

        +
        @Deprecated
+public ItemStack[] brewingStacks
        +
        Deprecated. 
        +
        The brewing stacks in the brewing stand. Each index has the possibility to be null, so make sure you check. + Changing this array to another one has no effect.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PotionBrewedEvent

        +
        public PotionBrewedEvent(ItemStack[] brewingStacks)
        +
        Deprecated. 
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/brewing/package-frame.html b/javadoc/net/minecraftforge/event/brewing/package-frame.html new file mode 100644 index 0000000..2d5c33f --- /dev/null +++ b/javadoc/net/minecraftforge/event/brewing/package-frame.html @@ -0,0 +1,22 @@ + + + + + +net.minecraftforge.event.brewing (Forge API) + + + + +

net.minecraftforge.event.brewing

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/event/brewing/package-summary.html b/javadoc/net/minecraftforge/event/brewing/package-summary.html new file mode 100644 index 0000000..b751eb7 --- /dev/null +++ b/javadoc/net/minecraftforge/event/brewing/package-summary.html @@ -0,0 +1,147 @@ + + + + + +net.minecraftforge.event.brewing (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.event.brewing

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/brewing/package-tree.html b/javadoc/net/minecraftforge/event/brewing/package-tree.html new file mode 100644 index 0000000..d8cf751 --- /dev/null +++ b/javadoc/net/minecraftforge/event/brewing/package-tree.html @@ -0,0 +1,139 @@ + + + + + +net.minecraftforge.event.brewing Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.event.brewing

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/EntityEvent.CanUpdate.html b/javadoc/net/minecraftforge/event/entity/EntityEvent.CanUpdate.html new file mode 100644 index 0000000..f132894 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/EntityEvent.CanUpdate.html @@ -0,0 +1,323 @@ + + + + + +EntityEvent.CanUpdate (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity
+

Class EntityEvent.CanUpdate

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    EntityEvent
    +
    +
    +
    +
    public static class EntityEvent.CanUpdate
+extends EntityEvent
    +
    CanUpdate is fired when an Entity is being created.
    + This event is fired whenever vanilla Minecraft determines that an entity
    + cannot update in World#updateEntityWithOptionalForce(net.minecraft.entity.Entity, boolean)
    +
    + canUpdate contains the boolean value of whether this entity can update.
    + If the modder decides that this Entity can be updated, they may change canUpdate to true,
    + and the entity with then be updated.
    +
    + This event is not Cancelable.
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        canUpdate

        +
        public boolean canUpdate
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntityEvent.CanUpdate

        +
        public EntityEvent.CanUpdate(Entity entity)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/EntityEvent.EnteringChunk.html b/javadoc/net/minecraftforge/event/entity/EntityEvent.EnteringChunk.html new file mode 100644 index 0000000..2e6eb06 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/EntityEvent.EnteringChunk.html @@ -0,0 +1,368 @@ + + + + + +EntityEvent.EnteringChunk (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity
+

Class EntityEvent.EnteringChunk

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    EntityEvent
    +
    +
    +
    +
    public static class EntityEvent.EnteringChunk
+extends EntityEvent
    +
    EnteringChunk is fired when an Entity enters a chunk.
    + This event is fired whenever vanilla Minecraft determines that an entity
    + is entering a chunk in Chunk#addEntity(net.minecraft.entity.Entity)
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        newChunkX

        +
        public int newChunkX
        +
        • +
      + + + +
        +
      • +

        newChunkZ

        +
        public int newChunkZ
        +
        • +
      + + + +
        +
      • +

        oldChunkX

        +
        public int oldChunkX
        +
        • +
      + + + +
        +
      • +

        oldChunkZ

        +
        public int oldChunkZ
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntityEvent.EnteringChunk

        +
        public EntityEvent.EnteringChunk(Entity entity,
+                         int newChunkX,
+                         int newChunkZ,
+                         int oldChunkX,
+                         int oldChunkZ)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/EntityEvent.EntityConstructing.html b/javadoc/net/minecraftforge/event/entity/EntityEvent.EntityConstructing.html new file mode 100644 index 0000000..d626cb6 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/EntityEvent.EntityConstructing.html @@ -0,0 +1,292 @@ + + + + + +EntityEvent.EntityConstructing (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.entity
+

Class EntityEvent.EntityConstructing

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    EntityEvent
    +
    +
    +
    +
    public static class EntityEvent.EntityConstructing
+extends EntityEvent
    +
    EntityConstructing is fired when an Entity is being created.
    + This event is fired within the constructor of the Entity.
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntityEvent.EntityConstructing

        +
        public EntityEvent.EntityConstructing(Entity entity)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/EntityEvent.html b/javadoc/net/minecraftforge/event/entity/EntityEvent.html new file mode 100644 index 0000000..ea09d88 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/EntityEvent.html @@ -0,0 +1,325 @@ + + + + + +EntityEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity
+

Class EntityEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        entity

        +
        public final Entity entity
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntityEvent

        +
        public EntityEvent(Entity entity)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/EntityJoinWorldEvent.html b/javadoc/net/minecraftforge/event/entity/EntityJoinWorldEvent.html new file mode 100644 index 0000000..3b87f6b --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/EntityJoinWorldEvent.html @@ -0,0 +1,322 @@ + + + + + +EntityJoinWorldEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity
+

Class EntityJoinWorldEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class EntityJoinWorldEvent
+extends EntityEvent
    +
    EntityJoinWorldEvent is fired when an Entity joins the world.
    + This event is fired whenever an Entity is added to the world in + World#addLoadedEntities(java.util.List), World#joinEntityInSurroundings(Entity), and World#spawnEntityInWorld(Entity).
    +
    + world contains the world in which the entity is to join.
    +
    + This event is Cancelable.
    + If this event is canceled, the Entity is not added to the world.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntityJoinWorldEvent

        +
        public EntityJoinWorldEvent(Entity entity,
+                    World world)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/EntityStruckByLightningEvent.html b/javadoc/net/minecraftforge/event/entity/EntityStruckByLightningEvent.html new file mode 100644 index 0000000..c06e095 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/EntityStruckByLightningEvent.html @@ -0,0 +1,322 @@ + + + + + +EntityStruckByLightningEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity
+

Class EntityStruckByLightningEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class EntityStruckByLightningEvent
+extends EntityEvent
    +
    EntityStruckByLightningEvent is fired when an Entity is about to be struck by lightening.
    + This event is fired whenever an EntityLightningBolt is updated to strike an Entity in + EntityLightningBolt#onUpdate() via ForgeEventFactory#onEntityStruckByLightning(Entity, EntityLightningBolt).
    +
    + lightning contains the instance of EntityLightningBolt attempting to strike an entity.
    +
    + This event is Cancelable.
    + If this event is canceled, the Entity is not struck by the lightening.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html b/javadoc/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html new file mode 100644 index 0000000..53e177f --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html @@ -0,0 +1,356 @@ + + + + + +PlaySoundAtEntityEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity
+

Class PlaySoundAtEntityEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class PlaySoundAtEntityEvent
+extends EntityEvent
    +
    PlaySoundAtEntityEvent is fired a sound is to be played at an Entity
    + This event is fired whenever a sound is set to be played at an Entity such as in + EntityPlayerSP#playSound(String, float, float), World#playSoundAtEntity(Entity, String, float, float), + and World#playerSoundToNearExcept(EntityPlayer, String, float, float).
    +
    + name contains the name of the sound to be played at the Entity.
    + volume contains the volume at which the sound is to be played.
    + pitch contains the pitch at which the sound is to be played.
    + Changing the name field will cause the sound of this name to be played instead of the originally intended sound.
    +
    + This event is Cancelable.
    + If this event is canceled, the sound is not played.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        name

        +
        public java.lang.String name
        +
        • +
      + + + +
        +
      • +

        volume

        +
        public final float volume
        +
        • +
      + + + +
        +
      • +

        pitch

        +
        public final float pitch
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlaySoundAtEntityEvent

        +
        public PlaySoundAtEntityEvent(Entity entity,
+                      java.lang.String name,
+                      float volume,
+                      float pitch)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/item/ItemEvent.html b/javadoc/net/minecraftforge/event/entity/item/ItemEvent.html new file mode 100644 index 0000000..9b38458 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/item/ItemEvent.html @@ -0,0 +1,323 @@ + + + + + +ItemEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.item
+

Class ItemEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    ItemExpireEvent, ItemTossEvent
    +
    +
    +
    +
    public class ItemEvent
+extends EntityEvent
    +
    Base class for all EntityItem events. Contains a reference to the + EntityItem of interest. For most EntityItem events, there's little to no + additional useful data from the firing method that isn't already contained + within the EntityItem instance.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        entityItem

        +
        public final EntityItem entityItem
        +
        The relevant EntityItem for this event, already cast for you.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ItemEvent

        +
        public ItemEvent(EntityItem itemEntity)
        +
        Creates a new event for an EntityItem.
        +
        Parameters:
        itemEntity - The EntityItem for this event
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/item/ItemExpireEvent.html b/javadoc/net/minecraftforge/event/entity/item/ItemExpireEvent.html new file mode 100644 index 0000000..4107d81 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/item/ItemExpireEvent.html @@ -0,0 +1,330 @@ + + + + + +ItemExpireEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.item
+

Class ItemExpireEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class ItemExpireEvent
+extends ItemEvent
    +
    Event that is fired when an EntityItem's age has reached its maximum + lifespan. Canceling this event will prevent the EntityItem from being + flagged as dead, thus staying it's removal from the world. If canceled + it will add more time to the entitie's life equal to extraLife.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        extraLife

        +
        public int extraLife
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ItemExpireEvent

        +
        public ItemExpireEvent(EntityItem entityItem,
+               int extraLife)
        +
        Creates a new event for an expiring EntityItem.
        +
        Parameters:
        entityItem - The EntityItem being deleted.
        extraLife - The amount of time to be added to this entities lifespan if the event is canceled.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/item/ItemTossEvent.html b/javadoc/net/minecraftforge/event/entity/item/ItemTossEvent.html new file mode 100644 index 0000000..8cc0926 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/item/ItemTossEvent.html @@ -0,0 +1,333 @@ + + + + + +ItemTossEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.item
+

Class ItemTossEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class ItemTossEvent
+extends ItemEvent
    +
    Event that is fired whenever a player tosses (Q) an item or drag-n-drops a + stack of items outside the inventory GUI screens. Canceling the event will + stop the items from entering the world, but will not prevent them being + removed from the inventory - and thus removed from the system.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        player

        +
        public final EntityPlayer player
        +
        The player tossing the item.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ItemTossEvent

        +
        public ItemTossEvent(EntityItem entityItem,
+             EntityPlayer player)
        +
        Creates a new event for EntityItems tossed by a player.
        +
        Parameters:
        entityItem - The EntityItem being tossed.
        player - The player tossing the item.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/item/package-frame.html b/javadoc/net/minecraftforge/event/entity/item/package-frame.html new file mode 100644 index 0000000..5ef0d76 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/item/package-frame.html @@ -0,0 +1,21 @@ + + + + + +net.minecraftforge.event.entity.item (Forge API) + + + + +

net.minecraftforge.event.entity.item

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/event/entity/item/package-summary.html b/javadoc/net/minecraftforge/event/entity/item/package-summary.html new file mode 100644 index 0000000..2302a08 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/item/package-summary.html @@ -0,0 +1,147 @@ + + + + + +net.minecraftforge.event.entity.item (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.event.entity.item

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/item/package-tree.html b/javadoc/net/minecraftforge/event/entity/item/package-tree.html new file mode 100644 index 0000000..4a2bf1f --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/item/package-tree.html @@ -0,0 +1,139 @@ + + + + + +net.minecraftforge.event.entity.item Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.event.entity.item

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/EnderTeleportEvent.html b/javadoc/net/minecraftforge/event/entity/living/EnderTeleportEvent.html new file mode 100644 index 0000000..d45d71a --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/EnderTeleportEvent.html @@ -0,0 +1,375 @@ + + + + + +EnderTeleportEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class EnderTeleportEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class EnderTeleportEvent
+extends LivingEvent
    +
    Event for when an Enderman teleports or an ender pearl is used. Can be used to either modify the target position, or cancel the teleport outright.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        targetX

        +
        public double targetX
        +
        • +
      + + + +
        +
      • +

        targetY

        +
        public double targetY
        +
        • +
      + + + +
        +
      • +

        targetZ

        +
        public double targetZ
        +
        • +
      + + + +
        +
      • +

        attackDamage

        +
        public float attackDamage
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EnderTeleportEvent

        +
        public EnderTeleportEvent(EntityLivingBase entity,
+                  double targetX,
+                  double targetY,
+                  double targetZ,
+                  float attackDamage)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingAttackEvent.html b/javadoc/net/minecraftforge/event/entity/living/LivingAttackEvent.html new file mode 100644 index 0000000..d904ac2 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingAttackEvent.html @@ -0,0 +1,360 @@ + + + + + +LivingAttackEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingAttackEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class LivingAttackEvent
+extends LivingEvent
    +
    LivingAttackEvent is fired when a living Entity is attacked.
    + This event is fired whenever an Entity is attacked in + EntityLivingBase#attackEntityFrom(DamageSource, float) and + EntityPlayer#attackEntityFrom(DamageSource, float).
    +
    + This event is fired via the ForgeHooks#onLivingAttack(EntityLivingBase, DamageSource, float).
    +
    + source contains the DamageSource of the attack.
    + #amount contains the amount of damage dealt to the entity.
    +
    + This event is Cancelable.
    + If this event is canceled, the Entity does not take attack damage.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        ammount

        +
        public final float ammount
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingDeathEvent.html b/javadoc/net/minecraftforge/event/entity/living/LivingDeathEvent.html new file mode 100644 index 0000000..821f522 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingDeathEvent.html @@ -0,0 +1,345 @@ + + + + + +LivingDeathEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingDeathEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class LivingDeathEvent
+extends LivingEvent
    +
    LivingDeathEvent is fired when an Entity dies.
    + This event is fired whenever an Entity dies in + EntityLivingBase#onDeath(DamageSource), + EntityPlayer#onDeath(DamageSource), and + EntityPlayerMP#onDeath(DamageSource).
    +
    + This event is fired via the ForgeHooks#onLivingDeath(EntityLivingBase, DamageSource).
    +
    + source contains the DamageSource that caused the entity to die.
    +
    + This event is Cancelable.
    + If this event is canceled, the Entity does not die.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingDropsEvent.html b/javadoc/net/minecraftforge/event/entity/living/LivingDropsEvent.html new file mode 100644 index 0000000..69b3880 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingDropsEvent.html @@ -0,0 +1,411 @@ + + + + + +LivingDropsEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingDropsEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    PlayerDropsEvent
    +
    +
    +
    +
    public class LivingDropsEvent
+extends LivingEvent
    +
    LivingDropsEvent is fired when an Entity's death causes dropped items to appear.
    + This event is fired whenever an Entity dies and drops items in + EntityLivingBase#onDeath(DamageSource).
    +
    + This event is fired via the ForgeHooks#onLivingDrops(EntityLivingBase, DamageSource, ArrayList, int, boolean, int).
    +
    + source contains the DamageSource that caused the drop to occur.
    + drops contains the ArrayList of EntityItems that will be dropped.
    + lootingLevel contains the amount of loot that will be dropped.
    + recentlyHit determines whether the Entity doing the drop has recently been damaged.
    + specialDropValue contains the special drop value for this even.
    +
    + This event is Cancelable.
    + If this event is canceled, the Entity does not drop anything.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        drops

        +
        public final java.util.ArrayList<EntityItem> drops
        +
        • +
      + + + +
        +
      • +

        lootingLevel

        +
        public final int lootingLevel
        +
        • +
      + + + +
        +
      • +

        recentlyHit

        +
        public final boolean recentlyHit
        +
        • +
      + + + +
        +
      • +

        specialDropValue

        +
        public final int specialDropValue
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LivingDropsEvent

        +
        public LivingDropsEvent(EntityLivingBase entity,
+                DamageSource source,
+                java.util.ArrayList<EntityItem> drops,
+                int lootingLevel,
+                boolean recentlyHit,
+                int specialDropValue)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingEvent.LivingJumpEvent.html b/javadoc/net/minecraftforge/event/entity/living/LivingEvent.LivingJumpEvent.html new file mode 100644 index 0000000..70e92e5 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingEvent.LivingJumpEvent.html @@ -0,0 +1,315 @@ + + + + + +LivingEvent.LivingJumpEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingEvent.LivingJumpEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    LivingEvent
    +
    +
    +
    +
    public static class LivingEvent.LivingJumpEvent
+extends LivingEvent
    +
    LivingJumpEvent is fired when an Entity jumps.
    + This event is fired whenever an Entity jumps in + EntityLivingBase#jump(), EntityMagmaCube#jump(), + and EntityHorse#jump().
    +
    + This event is fired via the ForgeHooks#onLivingJump(EntityLivingBase).
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LivingEvent.LivingJumpEvent

        +
        public LivingEvent.LivingJumpEvent(EntityLivingBase e)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingEvent.LivingUpdateEvent.html b/javadoc/net/minecraftforge/event/entity/living/LivingEvent.LivingUpdateEvent.html new file mode 100644 index 0000000..a730bf7 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingEvent.LivingUpdateEvent.html @@ -0,0 +1,315 @@ + + + + + +LivingEvent.LivingUpdateEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingEvent.LivingUpdateEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    LivingEvent
    +
    +
    +
    +
    public static class LivingEvent.LivingUpdateEvent
+extends LivingEvent
    +
    LivingUpdateEvent is fired when an Entity is updated.
    + This event is fired whenever an Entity is updated in + EntityLivingBase#onUpdate().
    +
    + This event is fired via the ForgeHooks#onLivingUpdate(EntityLivingBase).
    +
    + This event is Cancelable.
    + If this event is canceled, the Entity does not update.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LivingEvent.LivingUpdateEvent

        +
        public LivingEvent.LivingUpdateEvent(EntityLivingBase e)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingEvent.html b/javadoc/net/minecraftforge/event/entity/living/LivingEvent.html new file mode 100644 index 0000000..361a44c --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingEvent.html @@ -0,0 +1,345 @@ + + + + + +LivingEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingEvent

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingFallEvent.html b/javadoc/net/minecraftforge/event/entity/living/LivingFallEvent.html new file mode 100644 index 0000000..813601a --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingFallEvent.html @@ -0,0 +1,343 @@ + + + + + +LivingFallEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingFallEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class LivingFallEvent
+extends LivingEvent
    +
    LivingFallEvent is fired when an Entity is set to be falling.
    + This event is fired whenever an Entity is set to fall in + EntityLivingBase#fall(float).
    +
    + This event is fired via the ForgeHooks#onLivingFall(EntityLivingBase, float).
    +
    + distance contains the distance the Entity is to fall. If this event is canceled, this value is set to 0.0F. +
    + This event is Cancelable.
    + If this event is canceled, the Entity does not fall.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        distance

        +
        public float distance
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LivingFallEvent

        +
        public LivingFallEvent(EntityLivingBase entity,
+               float distance)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingHealEvent.html b/javadoc/net/minecraftforge/event/entity/living/LivingHealEvent.html new file mode 100644 index 0000000..47c1b19 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingHealEvent.html @@ -0,0 +1,342 @@ + + + + + +LivingHealEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingHealEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class LivingHealEvent
+extends LivingEvent
    +
    LivingHealEvent is fired when an Entity is set to be healed.
    + This event is fired whenever an Entity is healed in EntityLivingBase#heal(float)
    +
    + This event is fired via the ForgeHooks#onLivingHeal(EntityLivingBase, float).
    +
    + amount contains the amount of healing done to the Entity that was healed.
    +
    + This event is Cancelable.
    + If this event is canceled, the Entity is not healed.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        amount

        +
        public float amount
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LivingHealEvent

        +
        public LivingHealEvent(EntityLivingBase entity,
+               float amount)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingHurtEvent.html b/javadoc/net/minecraftforge/event/entity/living/LivingHurtEvent.html new file mode 100644 index 0000000..8548353 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingHurtEvent.html @@ -0,0 +1,360 @@ + + + + + +LivingHurtEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingHurtEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class LivingHurtEvent
+extends LivingEvent
    +
    LivingHurtEvent is fired when an Entity is set to be hurt.
    + This event is fired whenever an Entity is hurt in + EntityLivingBase#damageEntity(DamageSource, float) and + EntityPlayer#damageEntity(DamageSource, float).
    +
    + This event is fired via the ForgeHooks#onLivingHurt(EntityLivingBase, DamageSource, float).
    +
    + source contains the DamageSource that caused this Entity to be hurt.
    + #amount contains the amount of damage dealt to the Entity that was hurt.
    +
    + This event is Cancelable.
    + If this event is canceled, the Entity is not hurt.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingPackSizeEvent.html b/javadoc/net/minecraftforge/event/entity/living/LivingPackSizeEvent.html new file mode 100644 index 0000000..3cc040c --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingPackSizeEvent.html @@ -0,0 +1,337 @@ + + + + + +LivingPackSizeEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingPackSizeEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class LivingPackSizeEvent
+extends LivingEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        maxPackSize

        +
        public int maxPackSize
        +
        This event is fired when the spawning system determines the + maximum amount of the selected entity that can spawn at the same + time. + + If you set the result to 'ALLOW', it means that you want to return + the value of maxPackSize as the maximum pack size for current entity.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LivingPackSizeEvent

        +
        public LivingPackSizeEvent(EntityLiving entity)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingSetAttackTargetEvent.html b/javadoc/net/minecraftforge/event/entity/living/LivingSetAttackTargetEvent.html new file mode 100644 index 0000000..02279bb --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingSetAttackTargetEvent.html @@ -0,0 +1,343 @@ + + + + + +LivingSetAttackTargetEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingSetAttackTargetEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class LivingSetAttackTargetEvent
+extends LivingEvent
    +
    LivingSetAttackTargetEvent is fired when an Entity sets a target to attack.
    + This event is fired whenever an Entity sets a target to attack in + EntityLiving#setAttackTarget(EntityLivingBase) and + EntityLivingBase#setRevengeTarget(EntityLivingBase).
    +
    + This event is fired via the ForgeHooks#onLivingSetAttackTarget(EntityLivingBase, EntityLivingBase).
    +
    + target contains the newly targeted Entity.
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.AllowDespawn.html b/javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.AllowDespawn.html new file mode 100644 index 0000000..a0ac847 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.AllowDespawn.html @@ -0,0 +1,330 @@ + + + + + +LivingSpawnEvent.AllowDespawn (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingSpawnEvent.AllowDespawn

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    LivingSpawnEvent
    +
    +
    +
    +
    public static class LivingSpawnEvent.AllowDespawn
+extends LivingSpawnEvent
    +
    Fired each tick for despawnable mobs to allow control over despawning. + Result#DEFAULT will pass the mob on to vanilla despawn mechanics. + Result#ALLOW will force the mob to despawn. + Result#DENY will force the mob to remain. + This is fired every tick for every despawnable entity. Be efficient in your handlers. + + Note: this is not fired if the mob is definitely going to otherwise despawn. It is fired to check if + the mob can be allowed to despawn. See EntityLiving.despawnEntity()
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LivingSpawnEvent.AllowDespawn

        +
        public LivingSpawnEvent.AllowDespawn(EntityLiving entity)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.CheckSpawn.html b/javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.CheckSpawn.html new file mode 100644 index 0000000..ec0c98c --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.CheckSpawn.html @@ -0,0 +1,336 @@ + + + + + +LivingSpawnEvent.CheckSpawn (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingSpawnEvent.CheckSpawn

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    LivingSpawnEvent
    +
    +
    +
    +
    public static class LivingSpawnEvent.CheckSpawn
+extends LivingSpawnEvent
    +
    Fires before mob spawn events. + + Result is significant: + DEFAULT: use vanilla spawn rules + ALLOW: allow the spawn + DENY: deny the spawn
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LivingSpawnEvent.CheckSpawn

        +
        public LivingSpawnEvent.CheckSpawn(EntityLiving entity,
+                           World world,
+                           float x,
+                           float y,
+                           float z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.SpecialSpawn.html b/javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.SpecialSpawn.html new file mode 100644 index 0000000..890e224 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.SpecialSpawn.html @@ -0,0 +1,342 @@ + + + + + +LivingSpawnEvent.SpecialSpawn (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingSpawnEvent.SpecialSpawn

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    LivingSpawnEvent
    +
    +
    +
    +
    public static class LivingSpawnEvent.SpecialSpawn
+extends LivingSpawnEvent
    +
    SpecialSpawn is fired when an Entity is to be spawned from a mob spawner.
    + This event is fired whenever an Entity is spawned in a mob spawner in
    + SpawnerAnimals#findChunksForSpawning(WorldServer, boolean, boolean, boolean).
    +
    + This event is fired via the ForgeHooks#doSpecialSpawn(EntityLiving, World, float, float, float).
    +
    + This event is Cancelable.
    + If this event is canceled, the Entity is not spawned.
    +
    + This event does not have a result. Event.HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LivingSpawnEvent.SpecialSpawn

        +
        public LivingSpawnEvent.SpecialSpawn(EntityLiving entity,
+                             World world,
+                             float x,
+                             float y,
+                             float z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.html b/javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.html new file mode 100644 index 0000000..a8ee2a7 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/LivingSpawnEvent.html @@ -0,0 +1,422 @@ + + + + + +LivingSpawnEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class LivingSpawnEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    LivingSpawnEvent.AllowDespawn, LivingSpawnEvent.CheckSpawn, LivingSpawnEvent.SpecialSpawn
    +
    +
    +
    +
    public class LivingSpawnEvent
+extends LivingEvent
    +
    LivingSpawnEvent is fired whenever a living Entity is spawned.
    + If a method utilizes this Event as its parameter, the method will + receive every child event of this class.
    +
    + world contains the world in which this living Entity is being spawned.
    + x contains the x-coordinate this entity is being spawned at.
    + y contains the y-coordinate this entity is being spawned at.
    + z contains the z-coordinate this entity is being spawned at.
    +
    + All children of this event are fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      + + + +
        +
      • +

        x

        +
        public final float x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final float y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final float z
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LivingSpawnEvent

        +
        public LivingSpawnEvent(EntityLiving entity,
+                World world,
+                float x,
+                float y,
+                float z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/ZombieEvent.SummonAidEvent.html b/javadoc/net/minecraftforge/event/entity/living/ZombieEvent.SummonAidEvent.html new file mode 100644 index 0000000..02f7d0f --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/ZombieEvent.SummonAidEvent.html @@ -0,0 +1,445 @@ + + + + + +ZombieEvent.SummonAidEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class ZombieEvent.SummonAidEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ZombieEvent
    +
    +
    +
    +
    public static class ZombieEvent.SummonAidEvent
+extends ZombieEvent
    +
    SummonAidEvent is fired when a Zombie Entity is summoned. + This event is fired whenever a Zombie Entity is summoned in + EntityZombie#attackEntityFrom(DamageSource, float). + + This event is fired via the ForgeHooks#fireZombieSummonAid(EntityZombie, World, int, int, int, EntityLivingBase, double). + + customSummonedAid remains null, but can be populated with a custom EntityZombie which will be spawned. + world contains the world that this summoning is occurring in. + x contains the x-coordinate at which this summoning event is occurring. + y contains the y-coordinate at which this summoning event is occurring. + z contains the z-coordinate at which this summoning event is occurring. + attacker contains the living Entity that attacked and caused this event to fire. + summonChance contains the likelihood that a Zombie would successfully be summoned. + + This event is not Cancelable. + + This event has a result. Event.HasResult + Result#ALLOW Zombie is summoned. + Result#DENY Zombie is not summoned. + + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        customSummonedAid

        +
        public EntityZombie customSummonedAid
        +
        Populate this field to have a custom zombie instead of a normal zombie summoned
        +
        • +
      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      + + + +
        +
      • +

        x

        +
        public final int x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final int y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final int z
        +
        • +
      + + + + + + + +
        +
      • +

        summonChance

        +
        public final double summonChance
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ZombieEvent.SummonAidEvent

        +
        public ZombieEvent.SummonAidEvent(EntityZombie entity,
+                          World world,
+                          int x,
+                          int y,
+                          int z,
+                          EntityLivingBase attacker,
+                          double summonChance)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/ZombieEvent.html b/javadoc/net/minecraftforge/event/entity/living/ZombieEvent.html new file mode 100644 index 0000000..4683105 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/ZombieEvent.html @@ -0,0 +1,330 @@ + + + + + +ZombieEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.living
+

Class ZombieEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    ZombieEvent.SummonAidEvent
    +
    +
    +
    +
    public class ZombieEvent
+extends EntityEvent
    +
    ZombieEvent is fired whenever a zombie is spawned for aid. + If a method utilizes this Event as its parameter, the method will + receive every child event of this class. + + All children of this event are fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ZombieEvent

        +
        public ZombieEvent(EntityZombie entity)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/package-frame.html b/javadoc/net/minecraftforge/event/entity/living/package-frame.html new file mode 100644 index 0000000..af8e23a --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/package-frame.html @@ -0,0 +1,36 @@ + + + + + +net.minecraftforge.event.entity.living (Forge API) + + + + +

net.minecraftforge.event.entity.living

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/event/entity/living/package-summary.html b/javadoc/net/minecraftforge/event/entity/living/package-summary.html new file mode 100644 index 0000000..2015b7c --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/package-summary.html @@ -0,0 +1,287 @@ + + + + + +net.minecraftforge.event.entity.living (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.event.entity.living

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/living/package-tree.html b/javadoc/net/minecraftforge/event/entity/living/package-tree.html new file mode 100644 index 0000000..5af11bc --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/living/package-tree.html @@ -0,0 +1,160 @@ + + + + + +net.minecraftforge.event.entity.living Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.event.entity.living

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/minecart/MinecartCollisionEvent.html b/javadoc/net/minecraftforge/event/entity/minecart/MinecartCollisionEvent.html new file mode 100644 index 0000000..7fc7626 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/minecart/MinecartCollisionEvent.html @@ -0,0 +1,333 @@ + + + + + +MinecartCollisionEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.minecart
+

Class MinecartCollisionEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class MinecartCollisionEvent
+extends MinecartEvent
    +
    MinecartCollisionEvent is fired when a minecart collides with an Entity. + This event is fired whenever a minecraft collides in + EntityMinecart#applyEntityCollision(Entity). + + collider contains the Entity the Minecart collided with. + + This event is not Cancelable. + + This event does not have a result. HasResult + + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        collider

        +
        public final Entity collider
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MinecartCollisionEvent

        +
        public MinecartCollisionEvent(EntityMinecart minecart,
+                      Entity collider)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/minecart/MinecartEvent.html b/javadoc/net/minecraftforge/event/entity/minecart/MinecartEvent.html new file mode 100644 index 0000000..cbcd449 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/minecart/MinecartEvent.html @@ -0,0 +1,319 @@ + + + + + +MinecartEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.minecart
+

Class MinecartEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    MinecartCollisionEvent, MinecartInteractEvent, MinecartUpdateEvent
    +
    +
    +
    +
    public class MinecartEvent
+extends EntityEvent
    +
    MinecartEvent is fired whenever an event involving minecart entities occurs.
    + If a method utilizes this Event as its parameter, the method will
    + receive every child event of this class.
    +
    + minecart contains the minecart entity involved with this event.
    +
    + All children of this event are fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/minecart/MinecartInteractEvent.html b/javadoc/net/minecraftforge/event/entity/minecart/MinecartInteractEvent.html new file mode 100644 index 0000000..8223f1d --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/minecart/MinecartInteractEvent.html @@ -0,0 +1,337 @@ + + + + + +MinecartInteractEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.minecart
+

Class MinecartInteractEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class MinecartInteractEvent
+extends MinecartEvent
    +
    MinecartInteractEvent is fired when a player interacts with a minecart.
    + This event is fired whenever a player interacts with a minecart in + EntityMinecartContainer#interactFirst(EntityPlayer), + EntityMinecartEmpty#interactFirst(EntityPlayer) + EntityMinecartFurnace#interactFirst(EntityPlayer) + EntityMinecartHopper#interactFirst(EntityPlayer).
    +
    + player contains the EntityPlayer that is involved with this minecart interaction.
    +
    + This event is Cancelable.
    + If this event is canceled, the player does not interact with the minecart.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/minecart/MinecartUpdateEvent.html b/javadoc/net/minecraftforge/event/entity/minecart/MinecartUpdateEvent.html new file mode 100644 index 0000000..6d97d04 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/minecart/MinecartUpdateEvent.html @@ -0,0 +1,365 @@ + + + + + +MinecartUpdateEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.minecart
+

Class MinecartUpdateEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class MinecartUpdateEvent
+extends MinecartEvent
    +
    MinecartUpdateEvent is fired when a minecart is updated.
    + This event is fired whenever a minecart is updated in + EntityMinecart#onUpdate().
    +
    + x contains the x-coordinate of the minecart Entity.
    + y contains the y-coordinate of the minecart Entity.
    + z contains the z-coordinate of the minecart Entity.
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        x

        +
        public final float x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final float y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final float z
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MinecartUpdateEvent

        +
        public MinecartUpdateEvent(EntityMinecart minecart,
+                   float x,
+                   float y,
+                   float z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/minecart/package-frame.html b/javadoc/net/minecraftforge/event/entity/minecart/package-frame.html new file mode 100644 index 0000000..4a44d37 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/minecart/package-frame.html @@ -0,0 +1,22 @@ + + + + + +net.minecraftforge.event.entity.minecart (Forge API) + + + + +

net.minecraftforge.event.entity.minecart

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/event/entity/minecart/package-summary.html b/javadoc/net/minecraftforge/event/entity/minecart/package-summary.html new file mode 100644 index 0000000..97ce34c --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/minecart/package-summary.html @@ -0,0 +1,161 @@ + + + + + +net.minecraftforge.event.entity.minecart (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.event.entity.minecart

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/minecart/package-tree.html b/javadoc/net/minecraftforge/event/entity/minecart/package-tree.html new file mode 100644 index 0000000..3b7184f --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/minecart/package-tree.html @@ -0,0 +1,140 @@ + + + + + +net.minecraftforge.event.entity.minecart Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.event.entity.minecart

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/package-frame.html b/javadoc/net/minecraftforge/event/entity/package-frame.html new file mode 100644 index 0000000..44f40d4 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/package-frame.html @@ -0,0 +1,25 @@ + + + + + +net.minecraftforge.event.entity (Forge API) + + + + +

net.minecraftforge.event.entity

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/event/entity/package-summary.html b/javadoc/net/minecraftforge/event/entity/package-summary.html new file mode 100644 index 0000000..dbc8b27 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/package-summary.html @@ -0,0 +1,197 @@ + + + + + +net.minecraftforge.event.entity (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.event.entity

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/package-tree.html b/javadoc/net/minecraftforge/event/entity/package-tree.html new file mode 100644 index 0000000..d1335b1 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/package-tree.html @@ -0,0 +1,139 @@ + + + + + +net.minecraftforge.event.entity Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.event.entity

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/AchievementEvent.html b/javadoc/net/minecraftforge/event/entity/player/AchievementEvent.html new file mode 100644 index 0000000..52ac9b9 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/AchievementEvent.html @@ -0,0 +1,349 @@ + + + + + +AchievementEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class AchievementEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class AchievementEvent
+extends PlayerEvent
    +
    When the player receives an achievement. If canceled the player will not receive anything.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/AnvilRepairEvent.html b/javadoc/net/minecraftforge/event/entity/player/AnvilRepairEvent.html new file mode 100644 index 0000000..afbe482 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/AnvilRepairEvent.html @@ -0,0 +1,398 @@ + + + + + +AnvilRepairEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class AnvilRepairEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class AnvilRepairEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        left

        +
        public final ItemStack left
        +
        Fired when the player removes a "repaired" item from the Anvil's Output slot. + + breakChance specifies as a percentage the chance that the anvil will be "damaged" when used. + + ItemStacks are the inputs/output from the anvil. They cannot be edited.
        +
        • +
      + + + + + + + +
        +
      • +

        output

        +
        public final ItemStack output
        +
        • +
      + + + +
        +
      • +

        breakChance

        +
        public float breakChance
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/ArrowLooseEvent.html b/javadoc/net/minecraftforge/event/entity/player/ArrowLooseEvent.html new file mode 100644 index 0000000..0d26679 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/ArrowLooseEvent.html @@ -0,0 +1,376 @@ + + + + + +ArrowLooseEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class ArrowLooseEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class ArrowLooseEvent
+extends PlayerEvent
    +
    ArrowLooseEvent is fired when a player stops using a bow.
    + This event is fired whenever a player stops using a bow in + ItemBow#onPlayerStoppedUsing(ItemStack, World, EntityPlayer, int).
    +
    + bow contains the ItemBow ItemStack that was used in this event.
    + charge contains the value for how much the player had charged before stopping the shot.
    +
    + This event is Cancelable.
    + If this event is canceled, the player does not stop using the bow.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        charge

        +
        public int charge
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/ArrowNockEvent.html b/javadoc/net/minecraftforge/event/entity/player/ArrowNockEvent.html new file mode 100644 index 0000000..dc5a7e0 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/ArrowNockEvent.html @@ -0,0 +1,360 @@ + + + + + +ArrowNockEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class ArrowNockEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class ArrowNockEvent
+extends PlayerEvent
    +
    ArrowNockEvent is fired when a player begins using a bow.
    + This event is fired whenever a player begins using a bow in + ItemBow#onItemRightClick(ItemStack, World, EntityPlayer).
    +
    + result contains the resulting ItemStack due to the use of the bow.
    +
    + This event is Cancelable.
    + If this event is canceled, the player does not begin using the bow.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/AttackEntityEvent.html b/javadoc/net/minecraftforge/event/entity/player/AttackEntityEvent.html new file mode 100644 index 0000000..c3f62b8 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/AttackEntityEvent.html @@ -0,0 +1,360 @@ + + + + + +AttackEntityEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class AttackEntityEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class AttackEntityEvent
+extends PlayerEvent
    +
    AttackEntityEvent is fired when a player attacks an Entity.
    + This event is fired whenever a player attacks an Entity in + EntityPlayer#attackTargetEntityWithCurrentItem(Entity).
    +
    + target contains the Entity that was damaged by the player.
    +
    + This event is Cancelable.
    + If this event is canceled, the player does not attack the Entity.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        target

        +
        public final Entity target
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AttackEntityEvent

        +
        public AttackEntityEvent(EntityPlayer player,
+                 Entity target)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/BonemealEvent.html b/javadoc/net/minecraftforge/event/entity/player/BonemealEvent.html new file mode 100644 index 0000000..5068e1c --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/BonemealEvent.html @@ -0,0 +1,417 @@ + + + + + +BonemealEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class BonemealEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class BonemealEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        world

        +
        public final World world
        +
        This event is called when a player attempts to use Bonemeal on a block. + It can be canceled to completely prevent any further processing. + + You can also set the result to ALLOW to mark the event as processed + and use up a bonemeal from the stack but do no further processing. + + setResult(ALLOW) is the same as the old setHandeled()
        +
        • +
      + + + +
        +
      • +

        block

        +
        public final Block block
        +
        • +
      + + + +
        +
      • +

        x

        +
        public final int x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final int y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final int z
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BonemealEvent

        +
        public BonemealEvent(EntityPlayer player,
+             World world,
+             Block block,
+             int x,
+             int y,
+             int z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/EntityInteractEvent.html b/javadoc/net/minecraftforge/event/entity/player/EntityInteractEvent.html new file mode 100644 index 0000000..f702da3 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/EntityInteractEvent.html @@ -0,0 +1,360 @@ + + + + + +EntityInteractEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class EntityInteractEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class EntityInteractEvent
+extends PlayerEvent
    +
    EntityInteractEvent is fired when a player interacts with an Entity.
    + This event is fired whenever a player interacts with an Entity in + EntityPlayer#interactWith(Entity).
    +
    + target contains the Entity the player interacted with.
    +
    + This event is Cancelable.
    + If this event is canceled, the player does not interact with the Entity.
    +
    + This event does not have a result. Event.HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        target

        +
        public final Entity target
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntityInteractEvent

        +
        public EntityInteractEvent(EntityPlayer player,
+                   Entity target)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/EntityItemPickupEvent.html b/javadoc/net/minecraftforge/event/entity/player/EntityItemPickupEvent.html new file mode 100644 index 0000000..efee2a0 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/EntityItemPickupEvent.html @@ -0,0 +1,358 @@ + + + + + +EntityItemPickupEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class EntityItemPickupEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class EntityItemPickupEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        item

        +
        public final EntityItem item
        +
        This event is called when a player collides with a EntityItem on the ground. + The event can be canceled, and no further processing will be done. + + You can set the result of this event to ALLOW which will trigger the + processing of achievements, FML's event, play the sound, and kill the + entity if all the items are picked up. + + setResult(ALLOW) is the same as the old setHandled()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/FillBucketEvent.html b/javadoc/net/minecraftforge/event/entity/player/FillBucketEvent.html new file mode 100644 index 0000000..f221ff3 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/FillBucketEvent.html @@ -0,0 +1,401 @@ + + + + + +FillBucketEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class FillBucketEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FillBucketEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        current

        +
        public final ItemStack current
        +
        This event is fired when a player attempts to use a Empty bucket, it + can be canceled to completely prevent any further processing. + + If you set the result to 'ALLOW', it means that you have processed + the event and wants the basic functionality of adding the new + ItemStack to your inventory and reducing the stack size to process. + setResult(ALLOW) is the same as the old setHandeled();
        +
        • +
      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      + + + + + + + + +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/ItemTooltipEvent.html b/javadoc/net/minecraftforge/event/entity/player/ItemTooltipEvent.html new file mode 100644 index 0000000..a0e3880 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/ItemTooltipEvent.html @@ -0,0 +1,390 @@ + + + + + +ItemTooltipEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class ItemTooltipEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class ItemTooltipEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        showAdvancedItemTooltips

        +
        public final boolean showAdvancedItemTooltips
        +
        Whether the advanced information on item tooltips is being shown, toggled by F3+H.
        +
        • +
      + + + + + + + +
        +
      • +

        toolTip

        +
        public final java.util.List<java.lang.String> toolTip
        +
        The ItemStack tooltip.
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerDestroyItemEvent.html b/javadoc/net/minecraftforge/event/entity/player/PlayerDestroyItemEvent.html new file mode 100644 index 0000000..7712211 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerDestroyItemEvent.html @@ -0,0 +1,364 @@ + + + + + +PlayerDestroyItemEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerDestroyItemEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class PlayerDestroyItemEvent
+extends PlayerEvent
    +
    PlayerDestroyItemEvent is fired when a player destroys an item.
    + This event is fired whenever a player destroys an item in + PlayerControllerMP#onPlayerRightClick(EntityPlayer, World, ItemStack, int, int, int, int, Vec3), + PlayerControllerMP#sendUseItem(EntityPlayer, World, ItemStack), + EntityPlayer#destroyCurrentEquippedItem(), + SlotCrafting#onPickupFromSlot(EntityPlayer, ItemStack), + ItemInWorldManager#tryUseItem(EntityPlayer, World, ItemStack), + and ItemInWorldManager#activateBlockOrUseItem(EntityPlayer, World, ItemStack, int, int, int, int, float, float, float).
    +
    + original contains the original ItemStack before the item was destroyed.
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerDestroyItemEvent

        +
        public PlayerDestroyItemEvent(EntityPlayer player,
+                      ItemStack original)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerDropsEvent.html b/javadoc/net/minecraftforge/event/entity/player/PlayerDropsEvent.html new file mode 100644 index 0000000..ed14e38 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerDropsEvent.html @@ -0,0 +1,354 @@ + + + + + +PlayerDropsEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerDropsEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class PlayerDropsEvent
+extends LivingDropsEvent
    +
    Child class of LivingDropEvent that is fired specifically when a + player dies. Canceling the event will prevent ALL drops from entering the + world.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerDropsEvent

        +
        public PlayerDropsEvent(EntityPlayer entity,
+                DamageSource source,
+                java.util.ArrayList<EntityItem> drops,
+                boolean recentlyHit)
        +
        Creates a new event containing all the items that will drop into the + world when a player dies.
        +
        Parameters:
        entity - The dying player.
        source - The source of the damage which is killing the player.
        drops - List of all drops entering the world.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.BreakSpeed.html b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.BreakSpeed.html new file mode 100644 index 0000000..78dc901 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.BreakSpeed.html @@ -0,0 +1,482 @@ + + + + + +PlayerEvent.BreakSpeed (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerEvent.BreakSpeed

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.BreakSpeed
+extends PlayerEvent
    +
    BreakSpeed is fired when a player attempts to harvest a block.
    + This event is fired whenever a player attempts to harvest a block in + EntityPlayer#canHarvestBlock(Block).
    +
    + This event is fired via the ForgeEventFactory#getBreakSpeed(EntityPlayer, Block, int, float, int, int, int).
    +
    + block contains the block being broken.
    + metadata contains the metadata of the block being broken.
    + originalSpeed contains the original speed at which the player broke the block.
    + newSpeed contains the newSpeed at which the player will break the block.
    + x contains the x-coordinate at which this event is occurring.
    + y contains the y-coordinate at which this event is occurring.
    + z contains the z-coordinate at which this event is occurring.
    +
    + This event is Cancelable.
    + If it is canceled, the player is unable to break the block.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        block

        +
        public final Block block
        +
        • +
      + + + +
        +
      • +

        metadata

        +
        public final int metadata
        +
        • +
      + + + +
        +
      • +

        originalSpeed

        +
        public final float originalSpeed
        +
        • +
      + + + +
        +
      • +

        newSpeed

        +
        public float newSpeed
        +
        • +
      + + + +
        +
      • +

        x

        +
        public final int x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final int y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final int z
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.BreakSpeed

        +
        @Deprecated
+public PlayerEvent.BreakSpeed(EntityPlayer player,
+                                 Block block,
+                                 int metadata,
+                                 float original)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        PlayerEvent.BreakSpeed

        +
        public PlayerEvent.BreakSpeed(EntityPlayer player,
+                      Block block,
+                      int metadata,
+                      float original,
+                      int x,
+                      int y,
+                      int z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.Clone.html b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.Clone.html new file mode 100644 index 0000000..53e84e5 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.Clone.html @@ -0,0 +1,376 @@ + + + + + +PlayerEvent.Clone (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerEvent.Clone

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.Clone
+extends PlayerEvent
    +
    Fired when the EntityPlayer is cloned, typically caused by the network sending a RESPAWN_PLAYER event. + Either caused by death, or by traveling from the End to the overworld.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        original

        +
        public final EntityPlayer original
        +
        The old EntityPlayer that this new entity is a clone of.
        +
        • +
      + + + +
        +
      • +

        wasDeath

        +
        public final boolean wasDeath
        +
        True if this event was fired because the player died. + False if it was fired because the entity switched dimensions.
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.HarvestCheck.html b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.HarvestCheck.html new file mode 100644 index 0000000..9b888b1 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.HarvestCheck.html @@ -0,0 +1,381 @@ + + + + + +PlayerEvent.HarvestCheck (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerEvent.HarvestCheck

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.HarvestCheck
+extends PlayerEvent
    +
    HarvestCheck is fired when a player attempts to harvest a block.
    + This event is fired whenever a player attempts to harvest a block in + EntityPlayer#canHarvestBlock(Block).
    +
    + This event is fired via the ForgeEventFactory#doPlayerHarvestCheck(EntityPlayer, Block, boolean).
    +
    + block contains the Block that is being checked for harvesting.
    + success contains the boolean value for whether the Block will be successfully harvested.
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        block

        +
        public final Block block
        +
        • +
      + + + +
        +
      • +

        success

        +
        public boolean success
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.HarvestCheck

        +
        public PlayerEvent.HarvestCheck(EntityPlayer player,
+                        Block block,
+                        boolean success)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.LoadFromFile.html b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.LoadFromFile.html new file mode 100644 index 0000000..eabb734 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.LoadFromFile.html @@ -0,0 +1,412 @@ + + + + + +PlayerEvent.LoadFromFile (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerEvent.LoadFromFile

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.LoadFromFile
+extends PlayerEvent
    +
    The player is being loaded from the world save. Note that the + player won't have been added to the world yet. Intended to + allow mods to load an additional file from the players directory + containing additional mod related player data.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        playerDirectory

        +
        public final java.io.File playerDirectory
        +
        The directory where player data is being stored. Use this + to locate your mod additional file.
        +
        • +
      + + + +
        +
      • +

        playerUUID

        +
        public final java.lang.String playerUUID
        +
        The UUID is the standard for player related file storage. + It is broken out here for convenience for quick file generation.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.LoadFromFile

        +
        public PlayerEvent.LoadFromFile(EntityPlayer player,
+                        java.io.File originDirectory,
+                        java.lang.String playerUUID)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPlayerFile

        +
        public java.io.File getPlayerFile(java.lang.String suffix)
        +
        Construct and return a recommended file for the supplied suffix
        +
        Parameters:
        suffix - The suffix to use.
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.NameFormat.html b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.NameFormat.html new file mode 100644 index 0000000..eb1e832 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.NameFormat.html @@ -0,0 +1,379 @@ + + + + + +PlayerEvent.NameFormat (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerEvent.NameFormat

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.NameFormat
+extends PlayerEvent
    +
    NameFormat is fired when a player's display name is retrieved.
    + This event is fired whenever a player's name is retrieved in + EntityPlayer#getDisplayName() or EntityPlayer#refreshDisplayName().
    +
    + This event is fired via the ForgeEventFactory#getPlayerDisplayName(EntityPlayer, String).
    +
    + username contains the username of the player. + displayname contains the display name of the player. +
    + This event is not Cancelable. +
    + This event does not have a result. HasResult +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        username

        +
        public final java.lang.String username
        +
        • +
      + + + +
        +
      • +

        displayname

        +
        public java.lang.String displayname
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.NameFormat

        +
        public PlayerEvent.NameFormat(EntityPlayer player,
+                      java.lang.String username)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.SaveToFile.html b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.SaveToFile.html new file mode 100644 index 0000000..5cbe13f --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.SaveToFile.html @@ -0,0 +1,419 @@ + + + + + +PlayerEvent.SaveToFile (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerEvent.SaveToFile

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.SaveToFile
+extends PlayerEvent
    +
    The player is being saved to the world store. Note that the + player may be in the process of logging out or otherwise departing + from the world. Don't assume it's association with the world. + This allows mods to load an additional file from the players directory + containing additional mod related player data. +
    + Use this event to save the additional mod related player data to the world. + +
    + WARNING: Do not overwrite the player's .dat file here. You will + corrupt the world state.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        playerDirectory

        +
        public final java.io.File playerDirectory
        +
        The directory where player data is being stored. Use this + to locate your mod additional file.
        +
        • +
      + + + +
        +
      • +

        playerUUID

        +
        public final java.lang.String playerUUID
        +
        The UUID is the standard for player related file storage. + It is broken out here for convenience for quick file generation.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.SaveToFile

        +
        public PlayerEvent.SaveToFile(EntityPlayer player,
+                      java.io.File originDirectory,
+                      java.lang.String playerUUID)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPlayerFile

        +
        public java.io.File getPlayerFile(java.lang.String suffix)
        +
        Construct and return a recommended file for the supplied suffix
        +
        Parameters:
        suffix - The suffix to use.
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.StartTracking.html b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.StartTracking.html new file mode 100644 index 0000000..64b6a8b --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.StartTracking.html @@ -0,0 +1,356 @@ + + + + + +PlayerEvent.StartTracking (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerEvent.StartTracking

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.StartTracking
+extends PlayerEvent
    +
    Fired when an Entity is started to be "tracked" by this player (the player receives updates about this entity, e.g. motion).
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        target

        +
        public final Entity target
        +
        The Entity now being tracked.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.StartTracking

        +
        public PlayerEvent.StartTracking(EntityPlayer player,
+                         Entity target)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.StopTracking.html b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.StopTracking.html new file mode 100644 index 0000000..074b098 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.StopTracking.html @@ -0,0 +1,356 @@ + + + + + +PlayerEvent.StopTracking (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerEvent.StopTracking

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.StopTracking
+extends PlayerEvent
    +
    Fired when an Entity is stopped to be "tracked" by this player (the player no longer receives updates about this entity, e.g. motion).
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        target

        +
        public final Entity target
        +
        The Entity no longer being tracked.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.StopTracking

        +
        public PlayerEvent.StopTracking(EntityPlayer player,
+                        Entity target)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.html b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.html new file mode 100644 index 0000000..3cfabc3 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerEvent.html @@ -0,0 +1,409 @@ + + + + + +PlayerEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent

        +
        public PlayerEvent(EntityPlayer player)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerFlyableFallEvent.html b/javadoc/net/minecraftforge/event/entity/player/PlayerFlyableFallEvent.html new file mode 100644 index 0000000..4590687 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerFlyableFallEvent.html @@ -0,0 +1,349 @@ + + + + + +PlayerFlyableFallEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerFlyableFallEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class PlayerFlyableFallEvent
+extends PlayerEvent
    +
    Occurs when a player falls, but is able to fly. Doesn't need to be cancelable, this is mainly for notification purposes.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        distance

        +
        public float distance
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerFlyableFallEvent

        +
        public PlayerFlyableFallEvent(EntityPlayer player,
+                      float f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerInteractEvent.Action.html b/javadoc/net/minecraftforge/event/entity/player/PlayerInteractEvent.Action.html new file mode 100644 index 0000000..9e4373c --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerInteractEvent.Action.html @@ -0,0 +1,333 @@ + + + + + +PlayerInteractEvent.Action (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Enum PlayerInteractEvent.Action

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static PlayerInteractEvent.ActionvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static PlayerInteractEvent.Action[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static PlayerInteractEvent.Action[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (PlayerInteractEvent.Action c : PlayerInteractEvent.Action.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static PlayerInteractEvent.Action valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerInteractEvent.html b/javadoc/net/minecraftforge/event/entity/player/PlayerInteractEvent.html new file mode 100644 index 0000000..b34659c --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerInteractEvent.html @@ -0,0 +1,549 @@ + + + + + +PlayerInteractEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerInteractEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class PlayerInteractEvent
+extends PlayerEvent
    +
    PlayerInteractEvent is fired when a player interacts in some way. +
    + This event is fired whenever a player interacts in + Minecraft#func_147121_ag(), + NetHandlerPlayServer#processPlayerBlockPlacement(C08PacketPlayerBlockPlacement), + ItemInWorldManager#activateBlockOrUseItem(EntityPlayer, World, ItemStack, int, int, int, int, float, float, float), + ItemInWorldManager#onBlockClicked(int, int, int, int).
    +
    + This event is fired via the ForgeEventFactory#onPlayerInteract(EntityPlayer, Action, int, int, int, int). +
    + action contains the Action the player performed durin this interaction.
    + x contains the x-coordinate of where this event occurred.
    + y contains the y-coordinate of where this event occurred.
    + z contains the z-coordinate of where this event occurred.
    + face contains the face of the block that was interacted with.
    + world contains the world in which this event is occurring.
    +
    + This event is Cancelable.
    + If this event is canceled, the player does not interact.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setCanceled

        +
        public void setCanceled(boolean cancel)
        +
        Description copied from class: Event
        +
        Sets the state of this event, not all events are cancelable, and any attempt to + cancel a event that can't be will result in a IllegalArgumentException. + + The functionality of setting the canceled state is defined on a per-event bases.
        +
        +
        Overrides:
        +
        setCanceled in class Event
        +
        Parameters:
        cancel - The new canceled value
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerOpenContainerEvent.html b/javadoc/net/minecraftforge/event/entity/player/PlayerOpenContainerEvent.html new file mode 100644 index 0000000..d4feffc --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerOpenContainerEvent.html @@ -0,0 +1,358 @@ + + + + + +PlayerOpenContainerEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerOpenContainerEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class PlayerOpenContainerEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        canInteractWith

        +
        public final boolean canInteractWith
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerOpenContainerEvent

        +
        public PlayerOpenContainerEvent(EntityPlayer player,
+                        Container openContainer)
        +
        This event is fired when a player attempts to view a container during + player tick. + + setResult ALLOW to allow the container to stay open + setResult DENY to force close the container (denying access) + + DEFAULT is vanilla behaviour
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerPickupXpEvent.html b/javadoc/net/minecraftforge/event/entity/player/PlayerPickupXpEvent.html new file mode 100644 index 0000000..6474b38 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerPickupXpEvent.html @@ -0,0 +1,350 @@ + + + + + +PlayerPickupXpEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerPickupXpEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class PlayerPickupXpEvent
+extends PlayerEvent
    +
    This event is called when a player collides with a EntityXPOrb on the ground. + The event can be canceled, and no further processing will be done.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerSleepInBedEvent.html b/javadoc/net/minecraftforge/event/entity/player/PlayerSleepInBedEvent.html new file mode 100644 index 0000000..7cc0b43 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerSleepInBedEvent.html @@ -0,0 +1,403 @@ + + + + + +PlayerSleepInBedEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerSleepInBedEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class PlayerSleepInBedEvent
+extends PlayerEvent
    +
    PlayerSleepInBedEvent is fired when a player sleeps in a bed. +
    + This event is fired whenever a player sleeps in a bed in + EntityPlayer#sleepInBedAt(int, int, int).
    +
    + result contains whether the player is able to sleep.
    +
    + This event is not Cancelable. +
    + This event does not have a result. HasResult +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerSleepInBedEvent

        +
        public PlayerSleepInBedEvent(EntityPlayer player,
+                     int x,
+                     int y,
+                     int z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Finish.html b/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Finish.html new file mode 100644 index 0000000..e364322 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Finish.html @@ -0,0 +1,382 @@ + + + + + +PlayerUseItemEvent.Finish (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerUseItemEvent.Finish

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerUseItemEvent
    +
    +
    +
    +
    public static class PlayerUseItemEvent.Finish
+extends PlayerUseItemEvent
    +
    Fired after an item has fully finished being used. + The item has been notified that it was used, and the item/result stacks reflect after that state. + This means that when this is fired for a Potion, the potion effect has already been applied. + + If you wish to cancel those effects, you should cancel one of the above events. + + The result item stack is the stack that is placed in the player's inventory in replacement of the stack that is currently being used.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Start.html b/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Start.html new file mode 100644 index 0000000..4d21a3b --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Start.html @@ -0,0 +1,353 @@ + + + + + +PlayerUseItemEvent.Start (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerUseItemEvent.Start

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerUseItemEvent
    +
    +
    +
    +
    public static class PlayerUseItemEvent.Start
+extends PlayerUseItemEvent
    +
    Fired when a player starts 'using' an item, typically when they hold right mouse. + Examples: + Drawing a bow + Eating Food + Drinking Potions/Milk + Guarding with a sword + + Cancel the event, or set the duration or <= 0 to prevent it from processing.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerUseItemEvent.Start

        +
        public PlayerUseItemEvent.Start(EntityPlayer player,
+                        ItemStack item,
+                        int duration)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Stop.html b/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Stop.html new file mode 100644 index 0000000..b454986 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Stop.html @@ -0,0 +1,355 @@ + + + + + +PlayerUseItemEvent.Stop (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerUseItemEvent.Stop

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerUseItemEvent
    +
    +
    +
    +
    public static class PlayerUseItemEvent.Stop
+extends PlayerUseItemEvent
    +
    Fired when a player stops using an item without the use duration timing out. + Example: + Stop eating 1/2 way through + Stop defending with sword + Stop drawing bow. This case would fire the arrow + + Duration on this event is how long the item had left in it's count down before 'finishing' + + Canceling this event will prevent the Item from being notified that it has stopped being used, + The only vanilla item this would effect are bows, and it would cause them NOT to fire there arrow.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerUseItemEvent.Stop

        +
        public PlayerUseItemEvent.Stop(EntityPlayer player,
+                       ItemStack item,
+                       int duration)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Tick.html b/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Tick.html new file mode 100644 index 0000000..8e453d6 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.Tick.html @@ -0,0 +1,348 @@ + + + + + +PlayerUseItemEvent.Tick (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerUseItemEvent.Tick

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerUseItemEvent
    +
    +
    +
    +
    public static class PlayerUseItemEvent.Tick
+extends PlayerUseItemEvent
    +
    Fired every tick that a player is 'using' an item, see Start for info. + + Cancel the event, or set the duration or <= 0 to cause the player to stop using the item.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerUseItemEvent.Tick

        +
        public PlayerUseItemEvent.Tick(EntityPlayer player,
+                       ItemStack item,
+                       int duration)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.html b/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.html new file mode 100644 index 0000000..e4113fe --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerUseItemEvent.html @@ -0,0 +1,360 @@ + + + + + +PlayerUseItemEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerUseItemEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        duration

        +
        public int duration
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/PlayerWakeUpEvent.html b/javadoc/net/minecraftforge/event/entity/player/PlayerWakeUpEvent.html new file mode 100644 index 0000000..bf33a56 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/PlayerWakeUpEvent.html @@ -0,0 +1,409 @@ + + + + + +PlayerWakeUpEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class PlayerWakeUpEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class PlayerWakeUpEvent
+extends PlayerEvent
    +
    This event is fired when the player is waking up.
    + This is merely for purposes of listening for this to happen.
    + There is nothing that can be manipulated with this event.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        wakeImmediatly

        +
        public final boolean wakeImmediatly
        +
        Used for the 'wake up animation'. + This is false if the player is considered 'sleepy' and the overlay should slowly fade away.
        +
        • +
      + + + +
        +
      • +

        updateWorld

        +
        public final boolean updateWorld
        +
        Indicates if the server should be notified of sleeping changes. + This will only be false if the server is considered 'up to date' already, because, for example, it initiated the call.
        +
        • +
      + + + +
        +
      • +

        setSpawn

        +
        public final boolean setSpawn
        +
        Indicates if the player's sleep was considered successful. + In vanilla, this is used to determine if the spawn chunk is to be set to the bed's position.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerWakeUpEvent

        +
        @Deprecated
+public PlayerWakeUpEvent(EntityPlayer player)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        PlayerWakeUpEvent

        +
        public PlayerWakeUpEvent(EntityPlayer player,
+                 boolean wakeImmediatly,
+                 boolean updateWorld,
+                 boolean setSpawn)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/UseHoeEvent.html b/javadoc/net/minecraftforge/event/entity/player/UseHoeEvent.html new file mode 100644 index 0000000..e5d1da1 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/UseHoeEvent.html @@ -0,0 +1,418 @@ + + + + + +UseHoeEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.entity.player
+

Class UseHoeEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class UseHoeEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        current

        +
        public final ItemStack current
        +
        This event is fired when a player attempts to use a Hoe on a block, it + can be canceled to completely prevent any further processing. + + You can also set the result to ALLOW to mark the event as processed + and damage the hoe. + + setResult(ALLOW) is the same as the old setHandeled();
        +
        • +
      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      + + + +
        +
      • +

        x

        +
        public final int x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final int y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final int z
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/package-frame.html b/javadoc/net/minecraftforge/event/entity/player/package-frame.html new file mode 100644 index 0000000..9c5d369 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/package-frame.html @@ -0,0 +1,55 @@ + + + + + +net.minecraftforge.event.entity.player (Forge API) + + + + +

net.minecraftforge.event.entity.player

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/net/minecraftforge/event/entity/player/package-summary.html b/javadoc/net/minecraftforge/event/entity/player/package-summary.html new file mode 100644 index 0000000..02e6777 --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/package-summary.html @@ -0,0 +1,376 @@ + + + + + +net.minecraftforge.event.entity.player (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.event.entity.player

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/entity/player/package-tree.html b/javadoc/net/minecraftforge/event/entity/player/package-tree.html new file mode 100644 index 0000000..0f9634f --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/player/package-tree.html @@ -0,0 +1,192 @@ + + + + + +net.minecraftforge.event.entity.player Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.event.entity.player

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/package-frame.html b/javadoc/net/minecraftforge/event/package-frame.html new file mode 100644 index 0000000..1b9865b --- /dev/null +++ b/javadoc/net/minecraftforge/event/package-frame.html @@ -0,0 +1,22 @@ + + + + + +net.minecraftforge.event (Forge API) + + + + +

net.minecraftforge.event

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/event/package-summary.html b/javadoc/net/minecraftforge/event/package-summary.html new file mode 100644 index 0000000..53886a7 --- /dev/null +++ b/javadoc/net/minecraftforge/event/package-summary.html @@ -0,0 +1,149 @@ + + + + + +net.minecraftforge.event (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.event

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/package-tree.html b/javadoc/net/minecraftforge/event/package-tree.html new file mode 100644 index 0000000..0fec81c --- /dev/null +++ b/javadoc/net/minecraftforge/event/package-tree.html @@ -0,0 +1,133 @@ + + + + + +net.minecraftforge.event Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.event

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.BiomeColor.html b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.BiomeColor.html new file mode 100644 index 0000000..13e62af --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.BiomeColor.html @@ -0,0 +1,336 @@ + + + + + +BiomeEvent.BiomeColor (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class BiomeEvent.BiomeColor

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        originalColor

        +
        public final int originalColor
        +
        • +
      + + + +
        +
      • +

        newColor

        +
        public int newColor
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BiomeEvent.BiomeColor

        +
        public BiomeEvent.BiomeColor(BiomeGenBase biome,
+                     int original)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.CreateDecorator.html b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.CreateDecorator.html new file mode 100644 index 0000000..2aa2e91 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.CreateDecorator.html @@ -0,0 +1,339 @@ + + + + + +BiomeEvent.CreateDecorator (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class BiomeEvent.CreateDecorator

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BiomeEvent
    +
    +
    +
    +
    public static class BiomeEvent.CreateDecorator
+extends BiomeEvent
    +
    CreateDecorator is fired when a BiomeDecorator is created.
    + This event is fired whenever a BiomeDecorator is created in + DeferredBiomeDecorator#fireCreateEventAndReplace(BiomeGenBase).
    +
    + originalBiomeDecorator contains the original BiomeDecorator that would be used in vanilla. + newBiomeDecorator contains the new BiomeDecoration to be used by Minecraft. +
    + This event is not Cancelable. +
    + This event does not have a result. Event.HasResult +
    + This event is fired on the MinecraftForge#TERRAIN_GEN_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetFoliageColor.html b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetFoliageColor.html new file mode 100644 index 0000000..c63dcf6 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetFoliageColor.html @@ -0,0 +1,299 @@ + + + + + +BiomeEvent.GetFoliageColor (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class BiomeEvent.GetFoliageColor

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BiomeEvent
    +
    +
    +
    +
    public static class BiomeEvent.GetFoliageColor
+extends BiomeEvent.BiomeColor
    +
    This event is fired when a biome is queried for its grass color.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BiomeEvent.GetFoliageColor

        +
        public BiomeEvent.GetFoliageColor(BiomeGenBase biome,
+                          int original)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetGrassColor.html b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetGrassColor.html new file mode 100644 index 0000000..e5459db --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetGrassColor.html @@ -0,0 +1,299 @@ + + + + + +BiomeEvent.GetGrassColor (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class BiomeEvent.GetGrassColor

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BiomeEvent
    +
    +
    +
    +
    public static class BiomeEvent.GetGrassColor
+extends BiomeEvent.BiomeColor
    +
    This event is fired when a biome is queried for its grass color.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BiomeEvent.GetGrassColor

        +
        public BiomeEvent.GetGrassColor(BiomeGenBase biome,
+                        int original)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetVillageBlockID.html b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetVillageBlockID.html new file mode 100644 index 0000000..c412133 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetVillageBlockID.html @@ -0,0 +1,346 @@ + + + + + +BiomeEvent.GetVillageBlockID (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class BiomeEvent.GetVillageBlockID

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BiomeEvent
    +
    +
    +
    +
    public static class BiomeEvent.GetVillageBlockID
+extends BiomeEvent
    +
    This event is fired when the village generator attempts to choose a block ID + based on the village's biome. + + You can cancel the event to override default values
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        original

        +
        public final Block original
        +
        • +
      + + + +
        +
      • +

        type

        +
        public final int type
        +
        • +
      + + + +
        +
      • +

        replacement

        +
        public Block replacement
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BiomeEvent.GetVillageBlockID

        +
        public BiomeEvent.GetVillageBlockID(BiomeGenBase biome,
+                            Block original,
+                            int type)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetVillageBlockMeta.html b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetVillageBlockMeta.html new file mode 100644 index 0000000..a12c681 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetVillageBlockMeta.html @@ -0,0 +1,346 @@ + + + + + +BiomeEvent.GetVillageBlockMeta (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class BiomeEvent.GetVillageBlockMeta

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BiomeEvent
    +
    +
    +
    +
    public static class BiomeEvent.GetVillageBlockMeta
+extends BiomeEvent
    +
    This event is fired when the village generator attempts to choose a block + metadata based on the village's biome. + + You can set the result to DENY to prevent the default block metadata selection.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        original

        +
        public final Block original
        +
        • +
      + + + +
        +
      • +

        type

        +
        public final int type
        +
        • +
      + + + +
        +
      • +

        replacement

        +
        public int replacement
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BiomeEvent.GetVillageBlockMeta

        +
        public BiomeEvent.GetVillageBlockMeta(BiomeGenBase biome,
+                              Block original,
+                              int type)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetWaterColor.html b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetWaterColor.html new file mode 100644 index 0000000..0097695 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.GetWaterColor.html @@ -0,0 +1,299 @@ + + + + + +BiomeEvent.GetWaterColor (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class BiomeEvent.GetWaterColor

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BiomeEvent
    +
    +
    +
    +
    public static class BiomeEvent.GetWaterColor
+extends BiomeEvent.BiomeColor
    +
    This event is fired when a biome is queried for its water color.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BiomeEvent.GetWaterColor

        +
        public BiomeEvent.GetWaterColor(BiomeGenBase biome,
+                        int original)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.html b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.html new file mode 100644 index 0000000..e09fa79 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/BiomeEvent.html @@ -0,0 +1,353 @@ + + + + + +BiomeEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class BiomeEvent

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/ChunkProviderEvent.InitNoiseField.html b/javadoc/net/minecraftforge/event/terraingen/ChunkProviderEvent.InitNoiseField.html new file mode 100644 index 0000000..70fd73b --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/ChunkProviderEvent.InitNoiseField.html @@ -0,0 +1,407 @@ + + + + + +ChunkProviderEvent.InitNoiseField (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class ChunkProviderEvent.InitNoiseField

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ChunkProviderEvent
    +
    +
    +
    +
    public static class ChunkProviderEvent.InitNoiseField
+extends ChunkProviderEvent
    +
    This event is fired before a chunks terrain noise field is initialized. + + You can set the result to DENY to substitute your own noise field.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        noisefield

        +
        public double[] noisefield
        +
        • +
      + + + +
        +
      • +

        posX

        +
        public final int posX
        +
        • +
      + + + +
        +
      • +

        posY

        +
        public final int posY
        +
        • +
      + + + +
        +
      • +

        posZ

        +
        public final int posZ
        +
        • +
      + + + +
        +
      • +

        sizeX

        +
        public final int sizeX
        +
        • +
      + + + +
        +
      • +

        sizeY

        +
        public final int sizeY
        +
        • +
      + + + +
        +
      • +

        sizeZ

        +
        public final int sizeZ
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ChunkProviderEvent.InitNoiseField

        +
        public ChunkProviderEvent.InitNoiseField(IChunkProvider chunkProvider,
+                                 double[] noisefield,
+                                 int posX,
+                                 int posY,
+                                 int posZ,
+                                 int sizeX,
+                                 int sizeY,
+                                 int sizeZ)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/ChunkProviderEvent.ReplaceBiomeBlocks.html b/javadoc/net/minecraftforge/event/terraingen/ChunkProviderEvent.ReplaceBiomeBlocks.html new file mode 100644 index 0000000..49bbc22 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/ChunkProviderEvent.ReplaceBiomeBlocks.html @@ -0,0 +1,443 @@ + + + + + +ChunkProviderEvent.ReplaceBiomeBlocks (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class ChunkProviderEvent.ReplaceBiomeBlocks

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ChunkProviderEvent
    +
    +
    +
    +
    public static class ChunkProviderEvent.ReplaceBiomeBlocks
+extends ChunkProviderEvent
    +
    This event is fired when a chunks blocks are replaced by a biomes top and + filler blocks. + + You can set the result to DENY to prevent the default replacement.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        chunkX

        +
        public final int chunkX
        +
        • +
      + + + +
        +
      • +

        chunkZ

        +
        public final int chunkZ
        +
        • +
      + + + +
        +
      • +

        blockArray

        +
        public final Block[] blockArray
        +
        • +
      + + + +
        +
      • +

        metaArray

        +
        public final byte[] metaArray
        +
        • +
      + + + + + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ChunkProviderEvent.ReplaceBiomeBlocks

        +
        @Deprecated
+public ChunkProviderEvent.ReplaceBiomeBlocks(IChunkProvider chunkProvider,
+                                                int chunkX,
+                                                int chunkZ,
+                                                Block[] blockArray,
+                                                BiomeGenBase[] biomeArray)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        ChunkProviderEvent.ReplaceBiomeBlocks

        +
        @Deprecated
+public ChunkProviderEvent.ReplaceBiomeBlocks(IChunkProvider chunkProvider,
+                                                int chunkX,
+                                                int chunkZ,
+                                                Block[] blockArray,
+                                                byte[] metaArray,
+                                                BiomeGenBase[] biomeArray)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        ChunkProviderEvent.ReplaceBiomeBlocks

        +
        public ChunkProviderEvent.ReplaceBiomeBlocks(IChunkProvider chunkProvider,
+                                     int chunkX,
+                                     int chunkZ,
+                                     Block[] blockArray,
+                                     byte[] metaArray,
+                                     BiomeGenBase[] biomeArray,
+                                     World world)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/ChunkProviderEvent.html b/javadoc/net/minecraftforge/event/terraingen/ChunkProviderEvent.html new file mode 100644 index 0000000..166ffa7 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/ChunkProviderEvent.html @@ -0,0 +1,313 @@ + + + + + +ChunkProviderEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class ChunkProviderEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ChunkProviderEvent

        +
        public ChunkProviderEvent(IChunkProvider chunkProvider)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Decorate.EventType.html b/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Decorate.EventType.html new file mode 100644 index 0000000..b2e44a5 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Decorate.EventType.html @@ -0,0 +1,478 @@ + + + + + +DecorateBiomeEvent.Decorate.EventType (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Enum DecorateBiomeEvent.Decorate.EventType

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Decorate.html b/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Decorate.html new file mode 100644 index 0000000..fe8b32b --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Decorate.html @@ -0,0 +1,336 @@ + + + + + +DecorateBiomeEvent.Decorate (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class DecorateBiomeEvent.Decorate

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    DecorateBiomeEvent
    +
    +
    +
    +
    public static class DecorateBiomeEvent.Decorate
+extends DecorateBiomeEvent
    +
    This event is fired when a chunk is decorated with a biome feature. + + You can set the result to DENY to prevent the default biome decoration.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Post.html b/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Post.html new file mode 100644 index 0000000..390dc81 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Post.html @@ -0,0 +1,291 @@ + + + + + +DecorateBiomeEvent.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class DecorateBiomeEvent.Post

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    DecorateBiomeEvent
    +
    +
    +
    +
    public static class DecorateBiomeEvent.Post
+extends DecorateBiomeEvent
    +
    This event is fired after a chunk is decorated with a biome feature.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DecorateBiomeEvent.Post

        +
        public DecorateBiomeEvent.Post(World world,
+                       java.util.Random rand,
+                       int worldX,
+                       int worldZ)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Pre.html b/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Pre.html new file mode 100644 index 0000000..16fe477 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.Pre.html @@ -0,0 +1,291 @@ + + + + + +DecorateBiomeEvent.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class DecorateBiomeEvent.Pre

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    DecorateBiomeEvent
    +
    +
    +
    +
    public static class DecorateBiomeEvent.Pre
+extends DecorateBiomeEvent
    +
    This event is fired before a chunk is decorated with a biome feature.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DecorateBiomeEvent.Pre

        +
        public DecorateBiomeEvent.Pre(World world,
+                      java.util.Random rand,
+                      int worldX,
+                      int worldZ)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.html b/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.html new file mode 100644 index 0000000..d084fe7 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/DecorateBiomeEvent.html @@ -0,0 +1,378 @@ + + + + + +DecorateBiomeEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class DecorateBiomeEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    DecorateBiomeEvent.Decorate, DecorateBiomeEvent.Post, DecorateBiomeEvent.Pre
    +
    +
    +
    +
    public class DecorateBiomeEvent
+extends Event
    +
    DecorateBiomeEvent is fired when a BiomeDecorator is created. +
    + This event is fired whenever a BiomeDecorator is created in + DeferredBiomeDecorator#fireCreateEventAndReplace(BiomeGenBase).
    +
    + world contains the world that is being decorated.
    + rand contains an instane of Random to be used.
    + chunkX contains the x-coordinate of the Chunk being decorated.
    + chunkZ contains the z-coordinate of the Chunk being decorated.
    +
    + This event is not Cancelable. +
    + This event does not have a result. Event.HasResult +
    + This event is fired on the MinecraftForge#TERRAIN_GEN_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      + + + +
        +
      • +

        rand

        +
        public final java.util.Random rand
        +
        • +
      + + + +
        +
      • +

        chunkX

        +
        public final int chunkX
        +
        • +
      + + + +
        +
      • +

        chunkZ

        +
        public final int chunkZ
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DecorateBiomeEvent

        +
        public DecorateBiomeEvent(World world,
+                  java.util.Random rand,
+                  int worldX,
+                  int worldZ)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/DeferredBiomeDecorator.html b/javadoc/net/minecraftforge/event/terraingen/DeferredBiomeDecorator.html new file mode 100644 index 0000000..d37b528 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/DeferredBiomeDecorator.html @@ -0,0 +1,306 @@ + + + + + +DeferredBiomeDecorator (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class DeferredBiomeDecorator

+
+
+ +
+
    +
  • +
    +
    +
    public class DeferredBiomeDecorator
+extends BiomeDecorator
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DeferredBiomeDecorator

        +
        public DeferredBiomeDecorator(BiomeDecorator wrappedOriginal)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        fireCreateEventAndReplace

        +
        public void fireCreateEventAndReplace(BiomeGenBase biome)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/InitMapGenEvent.EventType.html b/javadoc/net/minecraftforge/event/terraingen/InitMapGenEvent.EventType.html new file mode 100644 index 0000000..c937412 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/InitMapGenEvent.EventType.html @@ -0,0 +1,406 @@ + + + + + +InitMapGenEvent.EventType (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Enum InitMapGenEvent.EventType

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static InitMapGenEvent.EventTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static InitMapGenEvent.EventType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static InitMapGenEvent.EventType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (InitMapGenEvent.EventType c : InitMapGenEvent.EventType.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static InitMapGenEvent.EventType valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/InitMapGenEvent.html b/javadoc/net/minecraftforge/event/terraingen/InitMapGenEvent.html new file mode 100644 index 0000000..dd65b80 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/InitMapGenEvent.html @@ -0,0 +1,294 @@ + + + + + +InitMapGenEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class InitMapGenEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class InitMapGenEvent
+extends Event
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/InitNoiseGensEvent.html b/javadoc/net/minecraftforge/event/terraingen/InitNoiseGensEvent.html new file mode 100644 index 0000000..92aeb77 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/InitNoiseGensEvent.html @@ -0,0 +1,338 @@ + + + + + +InitNoiseGensEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class InitNoiseGensEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class InitNoiseGensEvent
+extends WorldEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        rand

        +
        public final java.util.Random rand
        +
        • +
      + + + +
        +
      • +

        originalNoiseGens

        +
        public final NoiseGenerator[] originalNoiseGens
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InitNoiseGensEvent

        +
        public InitNoiseGensEvent(World world,
+                  java.util.Random rand,
+                  NoiseGenerator[] original)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.GenerateMinable.EventType.html b/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.GenerateMinable.EventType.html new file mode 100644 index 0000000..6a58d08 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.GenerateMinable.EventType.html @@ -0,0 +1,417 @@ + + + + + +OreGenEvent.GenerateMinable.EventType (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Enum OreGenEvent.GenerateMinable.EventType

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static OreGenEvent.GenerateMinable.EventTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static OreGenEvent.GenerateMinable.EventType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.GenerateMinable.html b/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.GenerateMinable.html new file mode 100644 index 0000000..d5c53a4 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.GenerateMinable.html @@ -0,0 +1,359 @@ + + + + + +OreGenEvent.GenerateMinable (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class OreGenEvent.GenerateMinable

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    OreGenEvent
    +
    +
    +
    +
    public static class OreGenEvent.GenerateMinable
+extends OreGenEvent
    +
    GenerateMinable is fired when a mineable block is generated in a chunk.
    + This event is fired just after ore generation in + BiomeDecorator#generateOres().
    +
    + type contains the enum value for the Ore attempting to be generated.
    + generator contains the WorldGenerator generating this ore.
    +
    + This event is not Cancelable.
    +
    + This event has a result. Event.HasResult
    + This result determines whether the ore is allowed to be generated.
    +
    + This event is fired on the MinecraftForge#ORE_GEN_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.Post.html b/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.Post.html new file mode 100644 index 0000000..d7ed393 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.Post.html @@ -0,0 +1,299 @@ + + + + + +OreGenEvent.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class OreGenEvent.Post

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    OreGenEvent
    +
    +
    +
    +
    public static class OreGenEvent.Post
+extends OreGenEvent
    +
    OreGenEvent.Post is fired just after a chunk is populated with ores.
    + This event is fired just after ore generation in + BiomeDecorator#generateOres().
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. Event.HasResult
    +
    + This event is fired on the MinecraftForge#ORE_GEN_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OreGenEvent.Post

        +
        public OreGenEvent.Post(World world,
+                java.util.Random rand,
+                int worldX,
+                int worldZ)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.Pre.html b/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.Pre.html new file mode 100644 index 0000000..c4288c0 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.Pre.html @@ -0,0 +1,299 @@ + + + + + +OreGenEvent.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class OreGenEvent.Pre

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    OreGenEvent
    +
    +
    +
    +
    public static class OreGenEvent.Pre
+extends OreGenEvent
    +
    OreGenEvent.Pre is fired just before a chunk is populated with ores.
    + This event is fired just before ore generation in + BiomeDecorator#generateOres().
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. Event.HasResult
    +
    + This event is fired on the MinecraftForge#ORE_GEN_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OreGenEvent.Pre

        +
        public OreGenEvent.Pre(World world,
+               java.util.Random rand,
+               int worldX,
+               int worldZ)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.html b/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.html new file mode 100644 index 0000000..847584b --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/OreGenEvent.html @@ -0,0 +1,390 @@ + + + + + +OreGenEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class OreGenEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    OreGenEvent.GenerateMinable, OreGenEvent.Post, OreGenEvent.Pre
    +
    +
    +
    +
    public class OreGenEvent
+extends Event
    +
    OreGenEvent is fired when an event involving ore generation occurs.
    + If a method utilizes this Event as its parameter, the method will + receive every child event of this class.
    +
    + world contains the world this event is occurring in.
    + rand contains an instance of random that can be used in this event.
    + worldX contains the x-coordinate of the block position currently being populated with ores.
    + worldZ contains the z-coordinate of the block position currently being populated with ores.
    +
    + All children of this event are fired on the MinecraftForge#ORE_GEN_BUS.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class OreGenEvent.GenerateMinable +
      GenerateMinable is fired when a mineable block is generated in a chunk.
      + This event is fired just after ore generation in + BiomeDecorator#generateOres().
      +
      + OreGenEvent.GenerateMinable.type contains the enum value for the Ore attempting to be generated.
      + OreGenEvent.GenerateMinable.generator contains the WorldGenerator generating this ore.
      +
      static class OreGenEvent.Post +
      OreGenEvent.Post is fired just after a chunk is populated with ores.
      + This event is fired just after ore generation in + BiomeDecorator#generateOres().
      +
      + This event is not Cancelable.
      +
      + This event does not have a result.
      +
      static class OreGenEvent.Pre +
      OreGenEvent.Pre is fired just before a chunk is populated with ores.
      + This event is fired just before ore generation in + BiomeDecorator#generateOres().
      +
      + This event is not Cancelable.
      +
      + This event does not have a result.
      +
      + +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      java.util.Randomrand 
      Worldworld 
      intworldX 
      intworldZ 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      OreGenEvent(World world, + java.util.Random rand, + int worldX, + int worldZ) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      + + + +
        +
      • +

        rand

        +
        public final java.util.Random rand
        +
        • +
      + + + +
        +
      • +

        worldX

        +
        public final int worldX
        +
        • +
      + + + +
        +
      • +

        worldZ

        +
        public final int worldZ
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OreGenEvent

        +
        public OreGenEvent(World world,
+           java.util.Random rand,
+           int worldX,
+           int worldZ)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Populate.EventType.html b/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Populate.EventType.html new file mode 100644 index 0000000..73aedbb --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Populate.EventType.html @@ -0,0 +1,406 @@ + + + + + +PopulateChunkEvent.Populate.EventType (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Enum PopulateChunkEvent.Populate.EventType

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static PopulateChunkEvent.Populate.EventTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static PopulateChunkEvent.Populate.EventType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Populate.html b/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Populate.html new file mode 100644 index 0000000..3a93c56 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Populate.html @@ -0,0 +1,370 @@ + + + + + +PopulateChunkEvent.Populate (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class PopulateChunkEvent.Populate

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PopulateChunkEvent
    +
    +
    +
    +
    public static class PopulateChunkEvent.Populate
+extends PopulateChunkEvent
    +
    PopulateChunkEvent.Populate is fired when a chunk is populated with a terrain feature.
    + This event is fired during terrain feature generation in + ChunkProviderEnd#populate(IChunkProvider, int, int), + ChunkProviderGenerate#populate(IChunkProvider, int, int), + and ChunkProviderHell#populate(IChunkProvider, int, int).
    +
    + type contains the enum value for the terrain feature being generated.
    +
    + This event is not Cancelable.
    +
    + This event has a result. Event.HasResult
    + This result determines if the chunk is populated with the terrain feature.
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Post.html b/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Post.html new file mode 100644 index 0000000..e33fdf6 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Post.html @@ -0,0 +1,324 @@ + + + + + +PopulateChunkEvent.Post (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class PopulateChunkEvent.Post

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PopulateChunkEvent
    +
    +
    +
    +
    public static class PopulateChunkEvent.Post
+extends PopulateChunkEvent
    +
    PopulateChunkEvent.Post is fired just after a chunk is populated with a terrain feature.
    + This event is fired just after terrain feature generation in + ChunkProviderEnd#populate(IChunkProvider, int, int), + ChunkProviderGenerate#populate(IChunkProvider, int, int), + and ChunkProviderHell#populate(IChunkProvider, int, int).
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. Event.HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PopulateChunkEvent.Post

        +
        public PopulateChunkEvent.Post(IChunkProvider chunkProvider,
+                       World world,
+                       java.util.Random rand,
+                       int chunkX,
+                       int chunkZ,
+                       boolean hasVillageGenerated)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Pre.html b/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Pre.html new file mode 100644 index 0000000..ec91d3e --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.Pre.html @@ -0,0 +1,324 @@ + + + + + +PopulateChunkEvent.Pre (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class PopulateChunkEvent.Pre

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PopulateChunkEvent
    +
    +
    +
    +
    public static class PopulateChunkEvent.Pre
+extends PopulateChunkEvent
    +
    PopulateChunkEvent.Pre is fired just before a chunk is populated a terrain feature.
    + This event is fired just before terrain feature generation in + ChunkProviderEnd#populate(IChunkProvider, int, int), + ChunkProviderGenerate#populate(IChunkProvider, int, int), + and ChunkProviderHell#populate(IChunkProvider, int, int).
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. Event.HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PopulateChunkEvent.Pre

        +
        public PopulateChunkEvent.Pre(IChunkProvider chunkProvider,
+                      World world,
+                      java.util.Random rand,
+                      int chunkX,
+                      int chunkZ,
+                      boolean hasVillageGenerated)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.html b/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.html new file mode 100644 index 0000000..c8fc9b6 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/PopulateChunkEvent.html @@ -0,0 +1,422 @@ + + + + + +PopulateChunkEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class PopulateChunkEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    PopulateChunkEvent.Populate, PopulateChunkEvent.Post, PopulateChunkEvent.Pre
    +
    +
    +
    +
    public class PopulateChunkEvent
+extends ChunkProviderEvent
    +
    PopulateChunkEvent is fired when an event involving chunk terrain feature population occurs.
    + If a method utilizes this Event as its parameter, the method will + receive every child event of this class.
    +
    + world contains the world this event is occurring in.
    + rand contains an instance of random that can be used in this event.
    + chunkX contains the x-coordinate of the chunk currently being populated with a terrain feature.
    + chunkZ contains the z-coordinate of the chunk currently being populated with ores.
    + hasVillageGenerated contains the boolean value stating if the chunk already has a village spawned in it.
    +
    + All children of this event are fired on the MinecraftForge#EVENT_BUS, except PopulateChunkEvent.Populate, which fires on the MinecraftForge#TERRAIN_GEN_BUS.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class PopulateChunkEvent.Populate +
      PopulateChunkEvent.Populate is fired when a chunk is populated with a terrain feature.
      + This event is fired during terrain feature generation in + ChunkProviderEnd#populate(IChunkProvider, int, int), + ChunkProviderGenerate#populate(IChunkProvider, int, int), + and ChunkProviderHell#populate(IChunkProvider, int, int).
      +
      static class PopulateChunkEvent.Post +
      PopulateChunkEvent.Post is fired just after a chunk is populated with a terrain feature.
      + This event is fired just after terrain feature generation in + ChunkProviderEnd#populate(IChunkProvider, int, int), + ChunkProviderGenerate#populate(IChunkProvider, int, int), + and ChunkProviderHell#populate(IChunkProvider, int, int).
      +
      static class PopulateChunkEvent.Pre +
      PopulateChunkEvent.Pre is fired just before a chunk is populated a terrain feature.
      + This event is fired just before terrain feature generation in + ChunkProviderEnd#populate(IChunkProvider, int, int), + ChunkProviderGenerate#populate(IChunkProvider, int, int), + and ChunkProviderHell#populate(IChunkProvider, int, int).
      +
      + + +
      • +
    + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PopulateChunkEvent(IChunkProvider chunkProvider, + World world, + java.util.Random rand, + int chunkX, + int chunkZ, + boolean hasVillageGenerated) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      + + + +
        +
      • +

        rand

        +
        public final java.util.Random rand
        +
        • +
      + + + +
        +
      • +

        chunkX

        +
        public final int chunkX
        +
        • +
      + + + +
        +
      • +

        chunkZ

        +
        public final int chunkZ
        +
        • +
      + + + +
        +
      • +

        hasVillageGenerated

        +
        public final boolean hasVillageGenerated
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PopulateChunkEvent

        +
        public PopulateChunkEvent(IChunkProvider chunkProvider,
+                  World world,
+                  java.util.Random rand,
+                  int chunkX,
+                  int chunkZ,
+                  boolean hasVillageGenerated)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/SaplingGrowTreeEvent.html b/javadoc/net/minecraftforge/event/terraingen/SaplingGrowTreeEvent.html new file mode 100644 index 0000000..bb05a5a --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/SaplingGrowTreeEvent.html @@ -0,0 +1,370 @@ + + + + + +SaplingGrowTreeEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class SaplingGrowTreeEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class SaplingGrowTreeEvent
+extends WorldEvent
    +
    SaplingGrowTreeEvent is fired when a spling grows into a tree.
    + This event is fired during sapling growth in + BlockSapling#func_149878_d(World, int, int, int, Random).
    +
    + x contains the x-coordinate of the growing sapling.
    + y contains the y-coordinate of the growing sapling.
    + z contains the z-coordinate of the growing sapling.
    + rand contains an instance of Random for use.
    +
    + This event is not Cancelable.
    +
    + This event has a result. Event.HasResult
    + This result determines if the sapling is allowed to grow.
    +
    + This event is fired on the MinecraftForge#TERRAIN_GEN_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        x

        +
        public final int x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final int y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final int z
        +
        • +
      + + + +
        +
      • +

        rand

        +
        public final java.util.Random rand
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SaplingGrowTreeEvent

        +
        public SaplingGrowTreeEvent(World world,
+                    java.util.Random rand,
+                    int x,
+                    int y,
+                    int z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/TerrainGen.html b/javadoc/net/minecraftforge/event/terraingen/TerrainGen.html new file mode 100644 index 0000000..fc64d96 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/TerrainGen.html @@ -0,0 +1,363 @@ + + + + + +TerrainGen (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class TerrainGen

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class TerrainGen
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/WorldTypeEvent.BiomeSize.html b/javadoc/net/minecraftforge/event/terraingen/WorldTypeEvent.BiomeSize.html new file mode 100644 index 0000000..e4c4214 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/WorldTypeEvent.BiomeSize.html @@ -0,0 +1,340 @@ + + + + + +WorldTypeEvent.BiomeSize (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class WorldTypeEvent.BiomeSize

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    WorldTypeEvent
    +
    +
    +
    +
    public static class WorldTypeEvent.BiomeSize
+extends WorldTypeEvent
    +
    BiomeSize is fired when vanilla Minecraft attempts to generate biomes.
    + This event is fired during biome generation in + GenLayer#initializeAllBiomeGenerators(long, WorldType).
    +
    + originalSize the original size of the Biome.
    + newSize the new size of the biome. Initially set to the originalSize.
    + If newSize is set to a new value, that value will be used for the Biome size.
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#TERRAIN_GEN_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        originalSize

        +
        public final byte originalSize
        +
        • +
      + + + +
        +
      • +

        newSize

        +
        public byte newSize
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WorldTypeEvent.BiomeSize

        +
        public WorldTypeEvent.BiomeSize(WorldType worldType,
+                        byte original)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/WorldTypeEvent.InitBiomeGens.html b/javadoc/net/minecraftforge/event/terraingen/WorldTypeEvent.InitBiomeGens.html new file mode 100644 index 0000000..f3685cd --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/WorldTypeEvent.InitBiomeGens.html @@ -0,0 +1,356 @@ + + + + + +WorldTypeEvent.InitBiomeGens (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class WorldTypeEvent.InitBiomeGens

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    WorldTypeEvent
    +
    +
    +
    +
    public static class WorldTypeEvent.InitBiomeGens
+extends WorldTypeEvent
    +
    InitBiomeGens is fired when vanilla Minecraft attempts to initialize the biome generators.
    + This event is fired just during biome generator initialization in + WorldChunkManager#WorldChunkManager(long, WorldType).
    +
    + seed the seed of the world.
    + originalBiomeGens the array of GenLayers original intended for this Biome generation.
    + newBiomeGens the array of GenLayers that will now be used for this Biome generation.
    + If newBiomeGens is set to a new value, that value will be used for the Biome generator.
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#TERRAIN_GEN_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        seed

        +
        public final long seed
        +
        • +
      + + + +
        +
      • +

        originalBiomeGens

        +
        public final GenLayer[] originalBiomeGens
        +
        • +
      + + + +
        +
      • +

        newBiomeGens

        +
        public GenLayer[] newBiomeGens
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WorldTypeEvent.InitBiomeGens

        +
        public WorldTypeEvent.InitBiomeGens(WorldType worldType,
+                            long seed,
+                            GenLayer[] original)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/WorldTypeEvent.html b/javadoc/net/minecraftforge/event/terraingen/WorldTypeEvent.html new file mode 100644 index 0000000..58e40f8 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/WorldTypeEvent.html @@ -0,0 +1,323 @@ + + + + + +WorldTypeEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.terraingen
+

Class WorldTypeEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    WorldTypeEvent.BiomeSize, WorldTypeEvent.InitBiomeGens
    +
    +
    +
    +
    public class WorldTypeEvent
+extends Event
    +
    WorldTypeEvent is fired when an event involving the world occurs.
    + If a method utilizes this Event as its parameter, the method will + receive every child event of this class.
    +
    + worldType contains the WorldType of the world this event is occurring in.
    +
    + All children of this event are fired on the MinecraftForge#TERRAIN_GEN_BUS.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class WorldTypeEvent.BiomeSize +
      BiomeSize is fired when vanilla Minecraft attempts to generate biomes.
      + This event is fired during biome generation in + GenLayer#initializeAllBiomeGenerators(long, WorldType).
      +
      static class WorldTypeEvent.InitBiomeGens +
      InitBiomeGens is fired when vanilla Minecraft attempts to initialize the biome generators.
      + This event is fired just during biome generator initialization in + WorldChunkManager#WorldChunkManager(long, WorldType).
      +
      + +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      WorldTypeworldType 
      +
      • +
    + + + + +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WorldTypeEvent

        +
        public WorldTypeEvent(WorldType worldType)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/package-frame.html b/javadoc/net/minecraftforge/event/terraingen/package-frame.html new file mode 100644 index 0000000..9c1acba --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/package-frame.html @@ -0,0 +1,56 @@ + + + + + +net.minecraftforge.event.terraingen (Forge API) + + + + +

net.minecraftforge.event.terraingen

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/net/minecraftforge/event/terraingen/package-summary.html b/javadoc/net/minecraftforge/event/terraingen/package-summary.html new file mode 100644 index 0000000..fc90be1 --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/package-summary.html @@ -0,0 +1,409 @@ + + + + + +net.minecraftforge.event.terraingen (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.event.terraingen

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/terraingen/package-tree.html b/javadoc/net/minecraftforge/event/terraingen/package-tree.html new file mode 100644 index 0000000..c35bf3d --- /dev/null +++ b/javadoc/net/minecraftforge/event/terraingen/package-tree.html @@ -0,0 +1,204 @@ + + + + + +net.minecraftforge.event.terraingen Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.event.terraingen

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/BlockEvent.BreakEvent.html b/javadoc/net/minecraftforge/event/world/BlockEvent.BreakEvent.html new file mode 100644 index 0000000..585d227 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/BlockEvent.BreakEvent.html @@ -0,0 +1,360 @@ + + + + + +BlockEvent.BreakEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class BlockEvent.BreakEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BlockEvent
    +
    +
    +
    +
    public static class BlockEvent.BreakEvent
+extends BlockEvent
    +
    Event that is fired when an Block is about to be broken by a player + Canceling this event will prevent the Block from being broken.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlockEvent.BreakEvent

        +
        public BlockEvent.BreakEvent(int x,
+                     int y,
+                     int z,
+                     World world,
+                     Block block,
+                     int blockMetadata,
+                     EntityPlayer player)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getExpToDrop

        +
        public int getExpToDrop()
        +
        Get the experience dropped by the block after the event has processed
        +
        Returns:
        The experience to drop or 0 if the event was canceled
        +
        • +
      + + + +
        +
      • +

        setExpToDrop

        +
        public void setExpToDrop(int exp)
        +
        Set the amount of experience dropped by the block after the event has processed
        +
        Parameters:
        exp - 1 or higher to drop experience, else nothing will drop
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/BlockEvent.HarvestDropsEvent.html b/javadoc/net/minecraftforge/event/world/BlockEvent.HarvestDropsEvent.html new file mode 100644 index 0000000..9269a28 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/BlockEvent.HarvestDropsEvent.html @@ -0,0 +1,391 @@ + + + + + +BlockEvent.HarvestDropsEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class BlockEvent.HarvestDropsEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BlockEvent
    +
    +
    +
    +
    public static class BlockEvent.HarvestDropsEvent
+extends BlockEvent
    +
    Fired when a block is about to drop it's harvested items. The drops array can be amended, as can the dropChance. + Note well: the harvester player field is null in a variety of scenarios. Code expecting null. + + The dropChance is used to determine which items in this array will actually drop, compared to a random number. If you wish, you + can pre-filter yourself, and set dropChance to 1.0f to always drop the contents of the drops array. + + isSilkTouching is set if this is considered a silk touch harvesting operation, vs a normal harvesting operation. Act accordingly.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fortuneLevel

        +
        public final int fortuneLevel
        +
        • +
      + + + +
        +
      • +

        drops

        +
        public final java.util.ArrayList<ItemStack> drops
        +
        • +
      + + + +
        +
      • +

        isSilkTouching

        +
        public final boolean isSilkTouching
        +
        • +
      + + + +
        +
      • +

        dropChance

        +
        public float dropChance
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlockEvent.HarvestDropsEvent

        +
        public BlockEvent.HarvestDropsEvent(int x,
+                            int y,
+                            int z,
+                            World world,
+                            Block block,
+                            int blockMetadata,
+                            int fortuneLevel,
+                            float dropChance,
+                            java.util.ArrayList<ItemStack> drops,
+                            EntityPlayer harvester,
+                            boolean isSilkTouching)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/BlockEvent.MultiPlaceEvent.html b/javadoc/net/minecraftforge/event/world/BlockEvent.MultiPlaceEvent.html new file mode 100644 index 0000000..ac888eb --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/BlockEvent.MultiPlaceEvent.html @@ -0,0 +1,339 @@ + + + + + +BlockEvent.MultiPlaceEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class BlockEvent.MultiPlaceEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BlockEvent
    +
    +
    +
    +
    public static class BlockEvent.MultiPlaceEvent
+extends BlockEvent.PlaceEvent
    +
    Fired when a single block placement action of a player triggers the + creation of multiple blocks(e.g. placing a bed block). The block returned + by BlockEvent.block and its related methods is the block where + the placed block would exist if the placement only affected a single + block.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlockEvent.MultiPlaceEvent

        +
        public BlockEvent.MultiPlaceEvent(java.util.List<BlockSnapshot> blockSnapshots,
+                          Block placedAgainst,
+                          EntityPlayer player)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getReplacedBlockSnapshots

        +
        public java.util.List<BlockSnapshot> getReplacedBlockSnapshots()
        +
        Gets a list of blocksnapshots for all blocks which were replaced by the + placement of the new blocks. Most of these blocks will just be of type AIR.
        +
        Returns:
        immutable list of replaced BlockSnapshots
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/BlockEvent.PlaceEvent.html b/javadoc/net/minecraftforge/event/world/BlockEvent.PlaceEvent.html new file mode 100644 index 0000000..31feefc --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/BlockEvent.PlaceEvent.html @@ -0,0 +1,375 @@ + + + + + +BlockEvent.PlaceEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class BlockEvent.PlaceEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    BlockEvent.MultiPlaceEvent
    +
    +
    +
    Enclosing class:
    +
    BlockEvent
    +
    +
    +
    +
    public static class BlockEvent.PlaceEvent
+extends BlockEvent
    +
    Called when a block is placed by a player. + + If a Block Place event is cancelled, the block will not be placed.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/BlockEvent.html b/javadoc/net/minecraftforge/event/world/BlockEvent.html new file mode 100644 index 0000000..959fb2d --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/BlockEvent.html @@ -0,0 +1,401 @@ + + + + + +BlockEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class BlockEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        x

        +
        public final int x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final int y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final int z
        +
        • +
      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      + + + +
        +
      • +

        block

        +
        public final Block block
        +
        • +
      + + + +
        +
      • +

        blockMetadata

        +
        public final int blockMetadata
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlockEvent

        +
        public BlockEvent(int x,
+          int y,
+          int z,
+          World world,
+          Block block,
+          int blockMetadata)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/ChunkDataEvent.Load.html b/javadoc/net/minecraftforge/event/world/ChunkDataEvent.Load.html new file mode 100644 index 0000000..f572c40 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/ChunkDataEvent.Load.html @@ -0,0 +1,333 @@ + + + + + +ChunkDataEvent.Load (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class ChunkDataEvent.Load

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ChunkDataEvent
    +
    +
    +
    +
    public static class ChunkDataEvent.Load
+extends ChunkDataEvent
    +
    ChunkDataEvent.Load is fired when vanilla Minecraft attempts to load Chunk data.
    + This event is fired during chunk loading in + ChunkIOProvider#callStage2(QueuedChunk, Chunk).
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/ChunkDataEvent.Save.html b/javadoc/net/minecraftforge/event/world/ChunkDataEvent.Save.html new file mode 100644 index 0000000..3108fd7 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/ChunkDataEvent.Save.html @@ -0,0 +1,333 @@ + + + + + +ChunkDataEvent.Save (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class ChunkDataEvent.Save

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ChunkDataEvent
    +
    +
    +
    +
    public static class ChunkDataEvent.Save
+extends ChunkDataEvent
    +
    ChunkDataEvent.Save is fired when vanilla Minecraft attempts to save Chunk data.
    + This event is fired during chunk saving in + AnvilChunkLoader#saveChunk(World, Chunk).
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/ChunkDataEvent.html b/javadoc/net/minecraftforge/event/world/ChunkDataEvent.html new file mode 100644 index 0000000..9530bfd --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/ChunkDataEvent.html @@ -0,0 +1,363 @@ + + + + + +ChunkDataEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class ChunkDataEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    ChunkDataEvent.Load, ChunkDataEvent.Save
    +
    +
    +
    +
    public class ChunkDataEvent
+extends ChunkEvent
    +
    ChunkDataEvent is fired when an event involving chunk data occurs.
    + If a method utilizes this Event as its parameter, the method will + receive every child event of this class.
    +
    + data contains the NBTTagCompound containing the chunk data for this event.
    +
    + All children of this event are fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/ChunkEvent.Load.html b/javadoc/net/minecraftforge/event/world/ChunkEvent.Load.html new file mode 100644 index 0000000..dd72c41 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/ChunkEvent.Load.html @@ -0,0 +1,313 @@ + + + + + +ChunkEvent.Load (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class ChunkEvent.Load

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ChunkEvent
    +
    +
    +
    +
    public static class ChunkEvent.Load
+extends ChunkEvent
    +
    ChunkEvent.Load is fired when vanilla Minecraft attempts to load a Chunk into the world.
    + This event is fired during chunk loading in
    + ChunkProviderClient#loadChunk(int, int),
    + Chunk.onChunkLoad().
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ChunkEvent.Load

        +
        public ChunkEvent.Load(Chunk chunk)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/ChunkEvent.Unload.html b/javadoc/net/minecraftforge/event/world/ChunkEvent.Unload.html new file mode 100644 index 0000000..9aad4bf --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/ChunkEvent.Unload.html @@ -0,0 +1,312 @@ + + + + + +ChunkEvent.Unload (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class ChunkEvent.Unload

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ChunkEvent
    +
    +
    +
    +
    public static class ChunkEvent.Unload
+extends ChunkEvent
    +
    ChunkEvent.Unload is fired when vanilla Minecraft attempts to unload a Chunk from the world.
    + This event is fired during chunk unloading in
    + Chunk.onChunkUnload().
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ChunkEvent.Unload

        +
        public ChunkEvent.Unload(Chunk chunk)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/ChunkEvent.html b/javadoc/net/minecraftforge/event/world/ChunkEvent.html new file mode 100644 index 0000000..cf836b5 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/ChunkEvent.html @@ -0,0 +1,343 @@ + + + + + +ChunkEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class ChunkEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    ChunkDataEvent, ChunkEvent.Load, ChunkEvent.Unload
    +
    +
    +
    +
    public class ChunkEvent
+extends WorldEvent
    +
    ChunkEvent is fired when an event involving a chunk occurs.
    + If a method utilizes this Event as its parameter, the method will + receive every child event of this class.
    +
    + chunk contains the Chunk this event is affecting.
    +
    + All children of this event are fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ChunkEvent

        +
        public ChunkEvent(Chunk chunk)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getChunk

        +
        public Chunk getChunk()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/ChunkWatchEvent.UnWatch.html b/javadoc/net/minecraftforge/event/world/ChunkWatchEvent.UnWatch.html new file mode 100644 index 0000000..1db8c1e --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/ChunkWatchEvent.UnWatch.html @@ -0,0 +1,295 @@ + + + + + +ChunkWatchEvent.UnWatch (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class ChunkWatchEvent.UnWatch

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ChunkWatchEvent
    +
    +
    +
    +
    public static class ChunkWatchEvent.UnWatch
+extends ChunkWatchEvent
    +
    ChunkWatchEvent.UnWatch is fired when an EntityPlayer stops watching a chunk.
    + This event is fired when a chunk is removed from the watched chunks of an EntityPlayer in + PlayerInstance#removePlayer(EntityPlayerMP).
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/ChunkWatchEvent.Watch.html b/javadoc/net/minecraftforge/event/world/ChunkWatchEvent.Watch.html new file mode 100644 index 0000000..8919931 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/ChunkWatchEvent.Watch.html @@ -0,0 +1,295 @@ + + + + + +ChunkWatchEvent.Watch (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class ChunkWatchEvent.Watch

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ChunkWatchEvent
    +
    +
    +
    +
    public static class ChunkWatchEvent.Watch
+extends ChunkWatchEvent
    +
    ChunkWatchEvent.Watch is fired when an EntityPlayer begins watching a chunk.
    + This event is fired when a chunk is added to the watched chunks of an EntityPlayer in + EntityPlayerMP#onUpdate().
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/ChunkWatchEvent.html b/javadoc/net/minecraftforge/event/world/ChunkWatchEvent.html new file mode 100644 index 0000000..374418d --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/ChunkWatchEvent.html @@ -0,0 +1,339 @@ + + + + + +ChunkWatchEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class ChunkWatchEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    ChunkWatchEvent.UnWatch, ChunkWatchEvent.Watch
    +
    +
    +
    +
    public class ChunkWatchEvent
+extends Event
    +
    ChunkWatchEvent is fired when an event involving a chunk being watched occurs.
    + If a method utilizes this Event as its parameter, the method will + receive every child event of this class.
    +
    + chunk contains the ChunkCoordIntPair of the Chunk this event is affecting.
    + player contains the EntityPlayer that is involved with this chunk being watched.
    +
    + All children of this event are fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/ExplosionEvent.Detonate.html b/javadoc/net/minecraftforge/event/world/ExplosionEvent.Detonate.html new file mode 100644 index 0000000..560bf6e --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/ExplosionEvent.Detonate.html @@ -0,0 +1,340 @@ + + + + + +ExplosionEvent.Detonate (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class ExplosionEvent.Detonate

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ExplosionEvent
    +
    +
    +
    +
    public static class ExplosionEvent.Detonate
+extends ExplosionEvent
    +
    ExplosionEvent.Detonate is fired once the explosion has a list of affected blocks and entities. These lists can be modified to change the outcome.
    +
    + This event is not Cancelable.
    + This event does not use HasResult.
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ExplosionEvent.Detonate

        +
        public ExplosionEvent.Detonate(World world,
+                       Explosion explosion,
+                       java.util.List<Entity> entityList)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAffectedBlocks

        +
        public java.util.List<ChunkPosition> getAffectedBlocks()
        +
        return the list of blocks affected by the explosion.
        +
        • +
      + + + +
        +
      • +

        getAffectedEntities

        +
        public java.util.List<Entity> getAffectedEntities()
        +
        return the list of entities affected by the explosion.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/ExplosionEvent.Start.html b/javadoc/net/minecraftforge/event/world/ExplosionEvent.Start.html new file mode 100644 index 0000000..44050ce --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/ExplosionEvent.Start.html @@ -0,0 +1,291 @@ + + + + + +ExplosionEvent.Start (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class ExplosionEvent.Start

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ExplosionEvent
    +
    +
    +
    +
    public static class ExplosionEvent.Start
+extends ExplosionEvent
    +
    ExplosionEvent.Start is fired before the explosion actually occurs. Canceling this event will stop the explosion.
    +
    + This event is Cancelable.
    + This event does not use HasResult.
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ExplosionEvent.Start

        +
        public ExplosionEvent.Start(World world,
+                    Explosion explosion)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/ExplosionEvent.html b/javadoc/net/minecraftforge/event/world/ExplosionEvent.html new file mode 100644 index 0000000..16606c3 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/ExplosionEvent.html @@ -0,0 +1,336 @@ + + + + + +ExplosionEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class ExplosionEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    ExplosionEvent.Detonate, ExplosionEvent.Start
    +
    +
    +
    +
    public class ExplosionEvent
+extends Event
    +
    ExplosionEvent triggers when an explosion happens in the world.
    +
    + ExplosionEvent.Start is fired before the explosion actually occurs.
    + ExplosionEvent.Detonate is fired once the explosion has a list of affected blocks and entities.
    +
    + ExplosionEvent.Start is Cancelable.
    + ExplosionEvent.Detonate can modify the affected blocks and entities.
    + Children do not use HasResult.
    + Children of this event are fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      + + + +
        +
      • +

        explosion

        +
        public final Explosion explosion
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ExplosionEvent

        +
        public ExplosionEvent(World world,
+              Explosion explosion)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Change.html b/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Change.html new file mode 100644 index 0000000..2a26fc2 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Change.html @@ -0,0 +1,358 @@ + + + + + +NoteBlockEvent.Change (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class NoteBlockEvent.Change

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    NoteBlockEvent
    +
    +
    +
    +
    public static class NoteBlockEvent.Change
+extends NoteBlockEvent
    +
    Fired when a Noteblock is changed. You can adjust the note it will change to via NoteBlockEvent.setNote(Note, Octave). + Canceling this event will not change the note and also stop the Noteblock from playing it's note.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NoteBlockEvent.Change

        +
        public NoteBlockEvent.Change(World world,
+                     int x,
+                     int y,
+                     int z,
+                     int meta,
+                     int oldNote,
+                     int newNote)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Instrument.html b/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Instrument.html new file mode 100644 index 0000000..0a42093 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Instrument.html @@ -0,0 +1,359 @@ + + + + + +NoteBlockEvent.Instrument (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Enum NoteBlockEvent.Instrument

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<NoteBlockEvent.Instrument>
    +
    +
    +
    Enclosing class:
    +
    NoteBlockEvent
    +
    +
    +
    +
    public static enum NoteBlockEvent.Instrument
+extends java.lang.Enum<NoteBlockEvent.Instrument>
    +
    Describes the types of musical Instruments that can be played by a Noteblock. + The Instrument being played can be overridden with NoteBlockEvent.Play#setInstrument(Instrument)
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static NoteBlockEvent.InstrumentvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static NoteBlockEvent.Instrument[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static NoteBlockEvent.Instrument[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (NoteBlockEvent.Instrument c : NoteBlockEvent.Instrument.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static NoteBlockEvent.Instrument valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Note.html b/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Note.html new file mode 100644 index 0000000..bab1688 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Note.html @@ -0,0 +1,443 @@ + + + + + +NoteBlockEvent.Note (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Enum NoteBlockEvent.Note

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<NoteBlockEvent.Note>
    +
    +
    +
    Enclosing class:
    +
    NoteBlockEvent
    +
    +
    +
    +
    public static enum NoteBlockEvent.Note
+extends java.lang.Enum<NoteBlockEvent.Note>
    +
    Information about the pitch of a Noteblock note. + For altered notes such as G-Sharp / A-Flat the Sharp variant is used here.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static NoteBlockEvent.NotevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static NoteBlockEvent.Note[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static NoteBlockEvent.Note[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (NoteBlockEvent.Note c : NoteBlockEvent.Note.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static NoteBlockEvent.Note valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Octave.html b/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Octave.html new file mode 100644 index 0000000..5948455 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Octave.html @@ -0,0 +1,335 @@ + + + + + +NoteBlockEvent.Octave (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Enum NoteBlockEvent.Octave

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      HIGH 
      LOW 
      MID 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static NoteBlockEvent.OctavevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static NoteBlockEvent.Octave[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static NoteBlockEvent.Octave[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (NoteBlockEvent.Octave c : NoteBlockEvent.Octave.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static NoteBlockEvent.Octave valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Play.html b/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Play.html new file mode 100644 index 0000000..1d9763c --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/NoteBlockEvent.Play.html @@ -0,0 +1,345 @@ + + + + + +NoteBlockEvent.Play (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class NoteBlockEvent.Play

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    NoteBlockEvent
    +
    +
    +
    +
    public static class NoteBlockEvent.Play
+extends NoteBlockEvent
    +
    Fired when a Noteblock plays it's note. You can override the note and instrument + Canceling this event will stop the note from playing.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NoteBlockEvent.Play

        +
        public NoteBlockEvent.Play(World world,
+                   int x,
+                   int y,
+                   int z,
+                   int meta,
+                   int note,
+                   int instrument)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/NoteBlockEvent.html b/javadoc/net/minecraftforge/event/world/NoteBlockEvent.html new file mode 100644 index 0000000..5ed3211 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/NoteBlockEvent.html @@ -0,0 +1,375 @@ + + + + + +NoteBlockEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class NoteBlockEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getNote

        +
        public NoteBlockEvent.Note getNote()
        +
        Get the Note the Noteblock is tuned to
        +
        Returns:
        the Note
        +
        • +
      + + + +
        +
      • +

        getOctave

        +
        public NoteBlockEvent.Octave getOctave()
        +
        Get the Octave of the note this Noteblock is tuned to
        +
        Returns:
        the Octave
        +
        • +
      + + + +
        +
      • +

        getVanillaNoteId

        +
        public int getVanillaNoteId()
        +
        get the vanilla note-id, which contains information about both Note and Octave. Most modders should not need this.
        +
        Returns:
        an ID for the note
        +
        • +
      + + + +
        +
      • +

        setNote

        +
        public void setNote(NoteBlockEvent.Note note,
+           NoteBlockEvent.Octave octave)
        +
        Set Note and Octave for this event.
        + If octave is Octave.HIGH, note may only be Note.F_SHARP
        +
        Parameters:
        note - the Note
        octave - the Octave
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/WorldEvent.CreateSpawnPosition.html b/javadoc/net/minecraftforge/event/world/WorldEvent.CreateSpawnPosition.html new file mode 100644 index 0000000..b70db12 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/WorldEvent.CreateSpawnPosition.html @@ -0,0 +1,316 @@ + + + + + +WorldEvent.CreateSpawnPosition (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class WorldEvent.CreateSpawnPosition

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    WorldEvent
    +
    +
    +
    +
    public static class WorldEvent.CreateSpawnPosition
+extends WorldEvent
    +
    Called by WorldServer when it attempts to create a spawnpoint for a dimension. + Canceling the event will prevent the vanilla code from running.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WorldEvent.CreateSpawnPosition

        +
        public WorldEvent.CreateSpawnPosition(World world,
+                              WorldSettings ws)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/WorldEvent.Load.html b/javadoc/net/minecraftforge/event/world/WorldEvent.Load.html new file mode 100644 index 0000000..d19fabc --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/WorldEvent.Load.html @@ -0,0 +1,296 @@ + + + + + +WorldEvent.Load (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class WorldEvent.Load

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    WorldEvent
    +
    +
    +
    +
    public static class WorldEvent.Load
+extends WorldEvent
    +
    WorldEvent.Load is fired when Minecraft loads a world.
    + This event is fired when a world is loaded in + WorldClient#WorldClient(NetHandlerPlayClient, WorldSettings, int, EnumDifficulty, Profiler), + MinecraftServer#loadAllWorlds(String, String, long, WorldType, String), + DimensionManager#initDimension(int), + and ForgeInternalHandler#onDimensionLoad(Load).
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WorldEvent.Load

        +
        public WorldEvent.Load(World world)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/WorldEvent.PotentialSpawns.html b/javadoc/net/minecraftforge/event/world/WorldEvent.PotentialSpawns.html new file mode 100644 index 0000000..b6029fb --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/WorldEvent.PotentialSpawns.html @@ -0,0 +1,376 @@ + + + + + +WorldEvent.PotentialSpawns (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class WorldEvent.PotentialSpawns

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    WorldEvent
    +
    +
    +
    +
    public static class WorldEvent.PotentialSpawns
+extends WorldEvent
    +
    Called by WorldServer to gather a list of all possible entities that can spawn at the specified location. + Canceling the event will result in a empty list, meaning no entity will be spawned.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/WorldEvent.Save.html b/javadoc/net/minecraftforge/event/world/WorldEvent.Save.html new file mode 100644 index 0000000..8e14e30 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/WorldEvent.Save.html @@ -0,0 +1,294 @@ + + + + + +WorldEvent.Save (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class WorldEvent.Save

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    WorldEvent
    +
    +
    +
    +
    public static class WorldEvent.Save
+extends WorldEvent
    +
    WorldEvent.Save is fired when Minecraft saves a world.
    + This event is fired when a world is saved in + WorldServer#saveAllChunks(boolean, IProgressUpdate), + ForgeInternalHandler#onDimensionSave(Save).
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WorldEvent.Save

        +
        public WorldEvent.Save(World world)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/WorldEvent.Unload.html b/javadoc/net/minecraftforge/event/world/WorldEvent.Unload.html new file mode 100644 index 0000000..fed8915 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/WorldEvent.Unload.html @@ -0,0 +1,297 @@ + + + + + +WorldEvent.Unload (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class WorldEvent.Unload

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    WorldEvent
    +
    +
    +
    +
    public static class WorldEvent.Unload
+extends WorldEvent
    +
    WorldEvent.Unload is fired when Minecraft unloads a world.
    + This event is fired when a world is unloaded in + Minecraft#loadWorld(WorldClient, String), + MinecraftServer#deleteWorldAndStopServer(), + MinecraftServer#stopServer(), + DimensionManager#unloadWorlds(Hashtable), + ForgeInternalHandler#onDimensionUnload(Unload).
    +
    + This event is not Cancelable.
    +
    + This event does not have a result. HasResult
    +
    + This event is fired on the MinecraftForge#EVENT_BUS.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WorldEvent.Unload

        +
        public WorldEvent.Unload(World world)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/WorldEvent.html b/javadoc/net/minecraftforge/event/world/WorldEvent.html new file mode 100644 index 0000000..c743626 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/WorldEvent.html @@ -0,0 +1,351 @@ + + + + + +WorldEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.event.world
+

Class WorldEvent

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class WorldEvent.CreateSpawnPosition +
      Called by WorldServer when it attempts to create a spawnpoint for a dimension.
      +
      static class WorldEvent.Load +
      WorldEvent.Load is fired when Minecraft loads a world.
      + This event is fired when a world is loaded in + WorldClient#WorldClient(NetHandlerPlayClient, WorldSettings, int, EnumDifficulty, Profiler), + MinecraftServer#loadAllWorlds(String, String, long, WorldType, String), + DimensionManager#initDimension(int), + and ForgeInternalHandler#onDimensionLoad(Load).
      +
      static class WorldEvent.PotentialSpawns +
      Called by WorldServer to gather a list of all possible entities that can spawn at the specified location.
      +
      static class WorldEvent.Save +
      WorldEvent.Save is fired when Minecraft saves a world.
      + This event is fired when a world is saved in + WorldServer#saveAllChunks(boolean, IProgressUpdate), + ForgeInternalHandler#onDimensionSave(Save).
      +
      static class WorldEvent.Unload +
      WorldEvent.Unload is fired when Minecraft unloads a world.
      + This event is fired when a world is unloaded in + Minecraft#loadWorld(WorldClient, String), + MinecraftServer#deleteWorldAndStopServer(), + MinecraftServer#stopServer(), + DimensionManager#unloadWorlds(Hashtable), + ForgeInternalHandler#onDimensionUnload(Unload).
      +
      + +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      Worldworld 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      WorldEvent(World world) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WorldEvent

        +
        public WorldEvent(World world)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/package-frame.html b/javadoc/net/minecraftforge/event/world/package-frame.html new file mode 100644 index 0000000..fd70c8e --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/package-frame.html @@ -0,0 +1,50 @@ + + + + + +net.minecraftforge.event.world (Forge API) + + + + +

net.minecraftforge.event.world

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/net/minecraftforge/event/world/package-summary.html b/javadoc/net/minecraftforge/event/world/package-summary.html new file mode 100644 index 0000000..ada7f19 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/package-summary.html @@ -0,0 +1,370 @@ + + + + + +net.minecraftforge.event.world (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.event.world

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/event/world/package-tree.html b/javadoc/net/minecraftforge/event/world/package-tree.html new file mode 100644 index 0000000..9d482e9 --- /dev/null +++ b/javadoc/net/minecraftforge/event/world/package-tree.html @@ -0,0 +1,193 @@ + + + + + +net.minecraftforge.event.world Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.event.world

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/BlockFluidBase.html b/javadoc/net/minecraftforge/fluids/BlockFluidBase.html new file mode 100644 index 0000000..0bc06ce --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/BlockFluidBase.html @@ -0,0 +1,1161 @@ + + + + + +BlockFluidBase (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class BlockFluidBase

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IFluidBlock
    +
    +
    +
    Direct Known Subclasses:
    +
    BlockFluidClassic, BlockFluidFinite
    +
    +
    +
    +
    public abstract class BlockFluidBase
+extends Block
+implements IFluidBlock
    +
    This is a base implementation for Fluid blocks. + + It is highly recommended that you extend this class or one of the Forge-provided child classes.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        defaultDisplacements

        +
        protected static final java.util.Map<Block,java.lang.Boolean> defaultDisplacements
        +
        • +
      + + + +
        +
      • +

        displacements

        +
        protected java.util.Map<Block,java.lang.Boolean> displacements
        +
        • +
      + + + +
        +
      • +

        quantaPerBlock

        +
        protected int quantaPerBlock
        +
        • +
      + + + +
        +
      • +

        quantaPerBlockFloat

        +
        protected float quantaPerBlockFloat
        +
        • +
      + + + +
        +
      • +

        density

        +
        protected int density
        +
        • +
      + + + +
        +
      • +

        densityDir

        +
        protected int densityDir
        +
        • +
      + + + +
        +
      • +

        temperature

        +
        protected int temperature
        +
        • +
      + + + +
        +
      • +

        tickRate

        +
        protected int tickRate
        +
        • +
      + + + +
        +
      • +

        renderPass

        +
        protected int renderPass
        +
        • +
      + + + +
        +
      • +

        maxScaledLight

        +
        protected int maxScaledLight
        +
        • +
      + + + +
        +
      • +

        fluidName

        +
        protected final java.lang.String fluidName
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlockFluidBase

        +
        public BlockFluidBase(Fluid fluid,
+              Material material)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setQuantaPerBlock

        +
        public BlockFluidBase setQuantaPerBlock(int quantaPerBlock)
        +
        • +
      + + + + + + + +
        +
      • +

        setTemperature

        +
        public BlockFluidBase setTemperature(int temperature)
        +
        • +
      + + + +
        +
      • +

        setTickRate

        +
        public BlockFluidBase setTickRate(int tickRate)
        +
        • +
      + + + +
        +
      • +

        setRenderPass

        +
        public BlockFluidBase setRenderPass(int renderPass)
        +
        • +
      + + + +
        +
      • +

        setMaxScaledLight

        +
        public BlockFluidBase setMaxScaledLight(int maxScaledLight)
        +
        • +
      + + + +
        +
      • +

        canDisplace

        +
        public boolean canDisplace(IBlockAccess world,
+                  int x,
+                  int y,
+                  int z)
        +
        Returns true if the block at (x, y, z) is displaceable. Does not displace the block.
        +
        • +
      + + + +
        +
      • +

        displaceIfPossible

        +
        public boolean displaceIfPossible(World world,
+                         int x,
+                         int y,
+                         int z)
        +
        Attempt to displace the block at (x, y, z), return true if it was displaced.
        +
        • +
      + + + +
        +
      • +

        getQuantaValue

        +
        public abstract int getQuantaValue(IBlockAccess world,
+                 int x,
+                 int y,
+                 int z)
        +
        • +
      + + + +
        +
      • +

        canCollideCheck

        +
        public abstract boolean canCollideCheck(int meta,
+                      boolean fullHit)
        +
        +
        Overrides:
        +
        canCollideCheck in class Block
        +
        +
        • +
      + + + +
        +
      • +

        getMaxRenderHeightMeta

        +
        public abstract int getMaxRenderHeightMeta()
        +
        • +
      + + + +
        +
      • +

        onBlockAdded

        +
        public void onBlockAdded(World world,
+                int x,
+                int y,
+                int z)
        +
        +
        Overrides:
        +
        onBlockAdded in class Block
        +
        +
        • +
      + + + +
        +
      • +

        onNeighborBlockChange

        +
        public void onNeighborBlockChange(World world,
+                         int x,
+                         int y,
+                         int z,
+                         Block block)
        +
        +
        Overrides:
        +
        onNeighborBlockChange in class Block
        +
        +
        • +
      + + + +
        +
      • +

        func_149698_L

        +
        public boolean func_149698_L()
        +
        +
        Overrides:
        +
        func_149698_L in class Block
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getItemDropped

        +
        public Item getItemDropped(int par1,
+                  java.util.Random par2Random,
+                  int par3)
        +
        +
        Overrides:
        +
        getItemDropped in class Block
        +
        +
        • +
      + + + +
        +
      • +

        quantityDropped

        +
        public int quantityDropped(java.util.Random par1Random)
        +
        +
        Overrides:
        +
        quantityDropped in class Block
        +
        +
        • +
      + + + +
        +
      • +

        tickRate

        +
        public int tickRate(World world)
        +
        +
        Overrides:
        +
        tickRate in class Block
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getLightValue

        +
        public int getLightValue(IBlockAccess world,
+                int x,
+                int y,
+                int z)
        +
        Description copied from class: Block
        +
        Get a light value for the block at the specified coordinates, normal ranges are between 0 and 15
        +
        +
        Overrides:
        +
        getLightValue in class Block
        +
        Parameters:
        world - The current world
        x - X Position
        y - Y position
        z - Z position
        +
        Returns:
        The light value
        +
        • +
      + + + +
        +
      • +

        getRenderType

        +
        public int getRenderType()
        +
        +
        Overrides:
        +
        getRenderType in class Block
        +
        +
        • +
      + + + +
        +
      • +

        isOpaqueCube

        +
        public boolean isOpaqueCube()
        +
        +
        Overrides:
        +
        isOpaqueCube in class Block
        +
        +
        • +
      + + + +
        +
      • +

        renderAsNormalBlock

        +
        public boolean renderAsNormalBlock()
        +
        +
        Overrides:
        +
        renderAsNormalBlock in class Block
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        shouldSideBeRendered

        +
        public boolean shouldSideBeRendered(IBlockAccess world,
+                           int x,
+                           int y,
+                           int z,
+                           int side)
        +
        +
        Overrides:
        +
        shouldSideBeRendered in class Block
        +
        +
        • +
      + + + +
        +
      • +

        getDensity

        +
        public static final int getDensity(IBlockAccess world,
+             int x,
+             int y,
+             int z)
        +
        • +
      + + + +
        +
      • +

        getTemperature

        +
        public static final int getTemperature(IBlockAccess world,
+                 int x,
+                 int y,
+                 int z)
        +
        • +
      + + + +
        +
      • +

        getFlowDirection

        +
        public static double getFlowDirection(IBlockAccess world,
+                      int x,
+                      int y,
+                      int z)
        +
        • +
      + + + +
        +
      • +

        getQuantaValueBelow

        +
        public final int getQuantaValueBelow(IBlockAccess world,
+                      int x,
+                      int y,
+                      int z,
+                      int belowThis)
        +
        • +
      + + + +
        +
      • +

        getQuantaValueAbove

        +
        public final int getQuantaValueAbove(IBlockAccess world,
+                      int x,
+                      int y,
+                      int z,
+                      int aboveThis)
        +
        • +
      + + + +
        +
      • +

        getQuantaPercentage

        +
        public final float getQuantaPercentage(IBlockAccess world,
+                        int x,
+                        int y,
+                        int z)
        +
        • +
      + + + +
        +
      • +

        getFlowVector

        +
        public Vec3 getFlowVector(IBlockAccess world,
+                 int x,
+                 int y,
+                 int z)
        +
        • +
      + + + +
        +
      • +

        getFluid

        +
        public Fluid getFluid()
        +
        Description copied from interface: IFluidBlock
        +
        Returns the Fluid associated with this Block.
        +
        +
        Specified by:
        +
        getFluid in interface IFluidBlock
        +
        +
        • +
      + + + +
        +
      • +

        getFilledPercentage

        +
        public float getFilledPercentage(World world,
+                        int x,
+                        int y,
+                        int z)
        +
        Description copied from interface: IFluidBlock
        +
        Returns the amount of a single block is filled. Value between 0 and 1. + 1 meaning the entire 1x1x1 cube is full, 0 meaning completely empty. + + If the return value is negative. It will be treated as filling the block + from the top down instead of bottom up.
        +
        +
        Specified by:
        +
        getFilledPercentage in interface IFluidBlock
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/BlockFluidClassic.html b/javadoc/net/minecraftforge/fluids/BlockFluidClassic.html new file mode 100644 index 0000000..aabb44e --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/BlockFluidClassic.html @@ -0,0 +1,698 @@ + + + + + +BlockFluidClassic (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class BlockFluidClassic

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IFluidBlock
    +
    +
    +
    +
    public class BlockFluidClassic
+extends BlockFluidBase
    +
    This is a fluid block implementation which emulates vanilla Minecraft fluid behavior. + + It is highly recommended that you use/extend this class for "classic" fluid blocks.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        isOptimalFlowDirection

        +
        protected boolean[] isOptimalFlowDirection
        +
        • +
      + + + +
        +
      • +

        flowCost

        +
        protected int[] flowCost
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlockFluidClassic

        +
        public BlockFluidClassic(Fluid fluid,
+                 Material material)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        setFluidStackAmount

        +
        public BlockFluidClassic setFluidStackAmount(int amount)
        +
        • +
      + + + + + + + +
        +
      • +

        canCollideCheck

        +
        public boolean canCollideCheck(int meta,
+                      boolean fullHit)
        +
        +
        Specified by:
        +
        canCollideCheck in class BlockFluidBase
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getLightValue

        +
        public int getLightValue(IBlockAccess world,
+                int x,
+                int y,
+                int z)
        +
        Description copied from class: Block
        +
        Get a light value for the block at the specified coordinates, normal ranges are between 0 and 15
        +
        +
        Overrides:
        +
        getLightValue in class BlockFluidBase
        +
        Parameters:
        world - The current world
        x - X Position
        y - Y position
        z - Z position
        +
        Returns:
        The light value
        +
        • +
      + + + +
        +
      • +

        updateTick

        +
        public void updateTick(World world,
+              int x,
+              int y,
+              int z,
+              java.util.Random rand)
        +
        +
        Overrides:
        +
        updateTick in class Block
        +
        +
        • +
      + + + +
        +
      • +

        isFlowingVertically

        +
        public boolean isFlowingVertically(IBlockAccess world,
+                          int x,
+                          int y,
+                          int z)
        +
        • +
      + + + +
        +
      • +

        isSourceBlock

        +
        public boolean isSourceBlock(IBlockAccess world,
+                    int x,
+                    int y,
+                    int z)
        +
        • +
      + + + +
        +
      • +

        getOptimalFlowDirections

        +
        protected boolean[] getOptimalFlowDirections(World world,
+                                 int x,
+                                 int y,
+                                 int z)
        +
        • +
      + + + +
        +
      • +

        calculateFlowCost

        +
        protected int calculateFlowCost(World world,
+                    int x,
+                    int y,
+                    int z,
+                    int recurseDepth,
+                    int side)
        +
        • +
      + + + +
        +
      • +

        flowIntoBlock

        +
        protected void flowIntoBlock(World world,
+                 int x,
+                 int y,
+                 int z,
+                 int meta)
        +
        • +
      + + + +
        +
      • +

        canFlowInto

        +
        protected boolean canFlowInto(IBlockAccess world,
+                  int x,
+                  int y,
+                  int z)
        +
        • +
      + + + +
        +
      • +

        getLargerQuanta

        +
        protected int getLargerQuanta(IBlockAccess world,
+                  int x,
+                  int y,
+                  int z,
+                  int compare)
        +
        • +
      + + + +
        +
      • +

        drain

        +
        public FluidStack drain(World world,
+               int x,
+               int y,
+               int z,
+               boolean doDrain)
        +
        Description copied from interface: IFluidBlock
        +
        Attempt to drain the block. This method should be called by devices such as pumps. + + NOTE: The block is intended to handle its own state changes.
        +
        doDrain - If false, the drain will only be simulated.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        canDrain

        +
        public boolean canDrain(World world,
+               int x,
+               int y,
+               int z)
        +
        Description copied from interface: IFluidBlock
        +
        Check to see if a block can be drained. This method should be called by devices such as + pumps.
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/BlockFluidFinite.html b/javadoc/net/minecraftforge/fluids/BlockFluidFinite.html new file mode 100644 index 0000000..aa1e059 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/BlockFluidFinite.html @@ -0,0 +1,470 @@ + + + + + +BlockFluidFinite (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class BlockFluidFinite

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IFluidBlock
    +
    +
    +
    +
    public class BlockFluidFinite
+extends BlockFluidBase
    +
    This is a cellular-automata based finite fluid block implementation. + + It is highly recommended that you use/extend this class for finite fluid blocks.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlockFluidFinite

        +
        public BlockFluidFinite(Fluid fluid,
+                Material material)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        canCollideCheck

        +
        public boolean canCollideCheck(int meta,
+                      boolean fullHit)
        +
        +
        Specified by:
        +
        canCollideCheck in class BlockFluidBase
        +
        +
        • +
      + + + + + + + +
        +
      • +

        updateTick

        +
        public void updateTick(World world,
+              int x,
+              int y,
+              int z,
+              java.util.Random rand)
        +
        +
        Overrides:
        +
        updateTick in class Block
        +
        +
        • +
      + + + +
        +
      • +

        tryToFlowVerticallyInto

        +
        public int tryToFlowVerticallyInto(World world,
+                          int x,
+                          int y,
+                          int z,
+                          int amtToInput)
        +
        • +
      + + + +
        +
      • +

        drain

        +
        public FluidStack drain(World world,
+               int x,
+               int y,
+               int z,
+               boolean doDrain)
        +
        Description copied from interface: IFluidBlock
        +
        Attempt to drain the block. This method should be called by devices such as pumps. + + NOTE: The block is intended to handle its own state changes.
        +
        doDrain - If false, the drain will only be simulated.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        canDrain

        +
        public boolean canDrain(World world,
+               int x,
+               int y,
+               int z)
        +
        Description copied from interface: IFluidBlock
        +
        Check to see if a block can be drained. This method should be called by devices such as + pumps.
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/Fluid.html b/javadoc/net/minecraftforge/fluids/Fluid.html new file mode 100644 index 0000000..0b91ec0 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/Fluid.html @@ -0,0 +1,1169 @@ + + + + + +Fluid (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class Fluid

+
+
+ +
+
    +
  • +
    +
    +
    public class Fluid
+extends java.lang.Object
    +
    Minecraft Forge Fluid Implementation + + This class is a fluid (liquid or gas) equivalent to "Item." It describes the nature of a fluid + and contains its general properties. + + These properties do not have inherent gameplay mechanics - they are provided so that mods may + choose to take advantage of them. + + Fluid implementations are not required to actively use these properties, nor are objects + interfacing with fluids required to make use of them, but it is encouraged. + + The default values can be used as a reference point for mods adding fluids such as oil or heavy + water.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fluidName

        +
        protected final java.lang.String fluidName
        +
        The unique identification name for this fluid.
        +
        • +
      + + + +
        +
      • +

        unlocalizedName

        +
        protected java.lang.String unlocalizedName
        +
        The unlocalized name of this fluid.
        +
        • +
      + + + +
        +
      • +

        stillIcon

        +
        protected IIcon stillIcon
        +
        The Icons for this fluid.
        +
        • +
      + + + +
        +
      • +

        flowingIcon

        +
        protected IIcon flowingIcon
        +
        • +
      + + + +
        +
      • +

        luminosity

        +
        protected int luminosity
        +
        The light level emitted by this fluid. + + Default value is 0, as most fluids do not actively emit light.
        +
        • +
      + + + +
        +
      • +

        density

        +
        protected int density
        +
        Density of the fluid - completely arbitrary; negative density indicates that the fluid is + lighter than air. + + Default value is approximately the real-life density of water in kg/m^3.
        +
        • +
      + + + +
        +
      • +

        temperature

        +
        protected int temperature
        +
        Temperature of the fluid - completely arbitrary; higher temperature indicates that the fluid is + hotter than air. + + Default value is approximately the real-life room temperature of water in degrees Kelvin.
        +
        • +
      + + + +
        +
      • +

        viscosity

        +
        protected int viscosity
        +
        Viscosity ("thickness") of the fluid - completely arbitrary; negative values are not + permissible. + + Default value is approximately the real-life density of water in m/s^2 (x10^-3).
        +
        • +
      + + + +
        +
      • +

        isGaseous

        +
        protected boolean isGaseous
        +
        This indicates if the fluid is gaseous. + + Useful for rendering the fluid in containers and the world. + + Generally this is associated with negative density fluids.
        +
        • +
      + + + +
        +
      • +

        rarity

        +
        protected EnumRarity rarity
        +
        The rarity of the fluid. + + Used primarily in tool tips.
        +
        • +
      + + + +
        +
      • +

        block

        +
        protected Block block
        +
        If there is a Block implementation of the Fluid, the Block is linked here. + + The default value of null should remain for any Fluid without a Block implementation.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Fluid

        +
        public Fluid(java.lang.String fluidName)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setUnlocalizedName

        +
        public Fluid setUnlocalizedName(java.lang.String unlocalizedName)
        +
        • +
      + + + +
        +
      • +

        setBlock

        +
        public Fluid setBlock(Block block)
        +
        • +
      + + + +
        +
      • +

        setLuminosity

        +
        public Fluid setLuminosity(int luminosity)
        +
        • +
      + + + +
        +
      • +

        setDensity

        +
        public Fluid setDensity(int density)
        +
        • +
      + + + +
        +
      • +

        setTemperature

        +
        public Fluid setTemperature(int temperature)
        +
        • +
      + + + +
        +
      • +

        setViscosity

        +
        public Fluid setViscosity(int viscosity)
        +
        • +
      + + + +
        +
      • +

        setGaseous

        +
        public Fluid setGaseous(boolean isGaseous)
        +
        • +
      + + + + + + + +
        +
      • +

        getName

        +
        public final java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        getID

        +
        public final int getID()
        +
        • +
      + + + +
        +
      • +

        getBlock

        +
        public final Block getBlock()
        +
        • +
      + + + +
        +
      • +

        canBePlacedInWorld

        +
        public final boolean canBePlacedInWorld()
        +
        • +
      + + + +
        +
      • +

        getLocalizedName

        +
        public java.lang.String getLocalizedName(FluidStack stack)
        +
        Returns the localized name of this fluid.
        +
        • +
      + + + +
        +
      • +

        getLocalizedName

        +
        @Deprecated
+public java.lang.String getLocalizedName()
        +
        Deprecated. 
        +
        Use the FluidStack sensitive version above
        +
        • +
      + + + +
        +
      • +

        getUnlocalizedName

        +
        public java.lang.String getUnlocalizedName(FluidStack stack)
        +
        A FluidStack sensitive version of getUnlocalizedName
        +
        • +
      + + + +
        +
      • +

        getUnlocalizedName

        +
        public java.lang.String getUnlocalizedName()
        +
        Returns the unlocalized name of this fluid.
        +
        • +
      + + + +
        +
      • +

        getSpriteNumber

        +
        public final int getSpriteNumber()
        +
        Returns 0 for "/terrain.png". ALL FLUID TEXTURES MUST BE ON THIS SHEET.
        +
        • +
      + + + +
        +
      • +

        getLuminosity

        +
        public final int getLuminosity()
        +
        • +
      + + + +
        +
      • +

        getDensity

        +
        public final int getDensity()
        +
        • +
      + + + +
        +
      • +

        getTemperature

        +
        public final int getTemperature()
        +
        • +
      + + + +
        +
      • +

        getViscosity

        +
        public final int getViscosity()
        +
        • +
      + + + +
        +
      • +

        isGaseous

        +
        public final boolean isGaseous()
        +
        • +
      + + + +
        +
      • +

        getRarity

        +
        public EnumRarity getRarity()
        +
        • +
      + + + +
        +
      • +

        getColor

        +
        public int getColor()
        +
        • +
      + + + +
        +
      • +

        setStillIcon

        +
        public final Fluid setStillIcon(IIcon stillIcon)
        +
        • +
      + + + +
        +
      • +

        setFlowingIcon

        +
        public final Fluid setFlowingIcon(IIcon flowingIcon)
        +
        • +
      + + + +
        +
      • +

        setIcons

        +
        public final Fluid setIcons(IIcon stillIcon,
+             IIcon flowingIcon)
        +
        • +
      + + + +
        +
      • +

        setIcons

        +
        public final Fluid setIcons(IIcon commonIcon)
        +
        • +
      + + + +
        +
      • +

        getIcon

        +
        public IIcon getIcon()
        +
        • +
      + + + +
        +
      • +

        getStillIcon

        +
        public IIcon getStillIcon()
        +
        • +
      + + + +
        +
      • +

        getFlowingIcon

        +
        public IIcon getFlowingIcon()
        +
        • +
      + + + +
        +
      • +

        getLuminosity

        +
        public int getLuminosity(FluidStack stack)
        +
        • +
      + + + +
        +
      • +

        getDensity

        +
        public int getDensity(FluidStack stack)
        +
        • +
      + + + +
        +
      • +

        getTemperature

        +
        public int getTemperature(FluidStack stack)
        +
        • +
      + + + +
        +
      • +

        getViscosity

        +
        public int getViscosity(FluidStack stack)
        +
        • +
      + + + +
        +
      • +

        isGaseous

        +
        public boolean isGaseous(FluidStack stack)
        +
        • +
      + + + + + + + +
        +
      • +

        getColor

        +
        public int getColor(FluidStack stack)
        +
        • +
      + + + + + + + +
        +
      • +

        getLuminosity

        +
        public int getLuminosity(World world,
+                int x,
+                int y,
+                int z)
        +
        • +
      + + + +
        +
      • +

        getDensity

        +
        public int getDensity(World world,
+             int x,
+             int y,
+             int z)
        +
        • +
      + + + +
        +
      • +

        getTemperature

        +
        public int getTemperature(World world,
+                 int x,
+                 int y,
+                 int z)
        +
        • +
      + + + +
        +
      • +

        getViscosity

        +
        public int getViscosity(World world,
+               int x,
+               int y,
+               int z)
        +
        • +
      + + + +
        +
      • +

        isGaseous

        +
        public boolean isGaseous(World world,
+                int x,
+                int y,
+                int z)
        +
        • +
      + + + +
        +
      • +

        getRarity

        +
        public EnumRarity getRarity(World world,
+                   int x,
+                   int y,
+                   int z)
        +
        • +
      + + + +
        +
      • +

        getColor

        +
        public int getColor(World world,
+           int x,
+           int y,
+           int z)
        +
        • +
      + + + +
        +
      • +

        getIcon

        +
        public IIcon getIcon(World world,
+            int x,
+            int y,
+            int z)
        +
        • +
      + + + +
        +
      • +

        registerLegacyName

        +
        public static void registerLegacyName(java.lang.String legacyName,
+                      java.lang.String canonicalName)
        +
        Register a legacy liquid name with the Fluids system
        +
        Parameters:
        legacyName - The legacy name to recognize
        canonicalName - The canonical fluid name it will become
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerData.html b/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerData.html new file mode 100644 index 0000000..033bc06 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerData.html @@ -0,0 +1,344 @@ + + + + + +FluidContainerRegistry.FluidContainerData (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidContainerRegistry.FluidContainerData

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FluidContainerRegistry
    +
    +
    +
    +
    public static class FluidContainerRegistry.FluidContainerData
+extends java.lang.Object
    +
    Wrapper class for the registry entries. Ensures that none of the attempted registrations + contain null references unless permitted.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerRegisterEvent.html b/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerRegisterEvent.html new file mode 100644 index 0000000..9af3599 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerRegisterEvent.html @@ -0,0 +1,293 @@ + + + + + +FluidContainerRegistry.FluidContainerRegisterEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidContainerRegistry.FluidContainerRegisterEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FluidContainerRegistry
    +
    +
    +
    +
    public static class FluidContainerRegistry.FluidContainerRegisterEvent
+extends Event
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.html b/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.html new file mode 100644 index 0000000..2b5be34 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.html @@ -0,0 +1,586 @@ + + + + + +FluidContainerRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidContainerRegistry

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class FluidContainerRegistry
+extends java.lang.Object
    +
    Register simple items that contain fluids here. Useful for buckets, bottles, and things that have + ID/metadata mappings. + + For more complex items, use IFluidContainerItem instead.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerFluidContainer

        +
        public static boolean registerFluidContainer(FluidStack stack,
+                             ItemStack filledContainer,
+                             ItemStack emptyContainer)
        +
        Register a new fluid containing item.
        +
        Parameters:
        stack - FluidStack containing the type and amount of the fluid stored in the item.
        filledContainer - ItemStack representing the container when it is full.
        emptyContainer - ItemStack representing the container when it is empty.
        +
        Returns:
        True if container was successfully registered; false if it already is.
        +
        • +
      + + + +
        +
      • +

        registerFluidContainer

        +
        public static boolean registerFluidContainer(Fluid fluid,
+                             ItemStack filledContainer,
+                             ItemStack emptyContainer)
        +
        Register a new fluid containing item. The item is assumed to hold 1000 mB of fluid. Also + registers the Fluid if possible.
        +
        Parameters:
        fluid - Fluid type that is stored in the item.
        filledContainer - ItemStack representing the container when it is full.
        emptyContainer - ItemStack representing the container when it is empty.
        +
        Returns:
        True if container was successfully registered; false if it already is.
        +
        • +
      + + + +
        +
      • +

        registerFluidContainer

        +
        public static boolean registerFluidContainer(FluidStack stack,
+                             ItemStack filledContainer)
        +
        Register a new fluid containing item that does not have an empty container.
        +
        Parameters:
        stack - FluidStack containing the type and amount of the fluid stored in the item.
        filledContainer - ItemStack representing the container when it is full.
        +
        Returns:
        True if container was successfully registered; false if it already is.
        +
        • +
      + + + +
        +
      • +

        registerFluidContainer

        +
        public static boolean registerFluidContainer(Fluid fluid,
+                             ItemStack filledContainer)
        +
        Register a new fluid containing item that does not have an empty container. The item is + assumed to hold 1000 mB of fluid. Also registers the Fluid if possible.
        +
        Parameters:
        fluid - Fluid type that is stored in the item.
        filledContainer - ItemStack representing the container when it is full.
        +
        Returns:
        True if container was successfully registered; false if it already is.
        +
        • +
      + + + + + + + +
        +
      • +

        getFluidForFilledItem

        +
        public static FluidStack getFluidForFilledItem(ItemStack container)
        +
        Determines the fluid type and amount inside a container.
        +
        Parameters:
        container - The fluid container.
        +
        Returns:
        FluidStack representing stored fluid.
        +
        • +
      + + + +
        +
      • +

        fillFluidContainer

        +
        public static ItemStack fillFluidContainer(FluidStack fluid,
+                           ItemStack container)
        +
        Attempts to fill an empty container with a fluid. + + NOTE: Returns null on fail, NOT the empty container.
        +
        Parameters:
        fluid - FluidStack containing the type and amount of fluid to fill.
        container - ItemStack representing the empty container.
        +
        Returns:
        Filled container if successful, otherwise null.
        +
        • +
      + + + +
        +
      • +

        drainFluidContainer

        +
        public static ItemStack drainFluidContainer(ItemStack container)
        +
        Attempts to empty a full container.
        +
        Parameters:
        container - ItemStack representing the full container.
        +
        Returns:
        Empty container if successful, otherwise null.
        +
        • +
      + + + +
        +
      • +

        getContainerCapacity

        +
        public static int getContainerCapacity(ItemStack container)
        +
        Determines the capacity of a full container.
        +
        Parameters:
        container - The full container.
        +
        Returns:
        The containers capacity, or 0 if the ItemStack does not represent + a registered container.
        +
        • +
      + + + +
        +
      • +

        getContainerCapacity

        +
        public static int getContainerCapacity(FluidStack fluid,
+                       ItemStack container)
        +
        Determines the capacity of a container.
        +
        Parameters:
        fluid - FluidStack containing the type of fluid the capacity should be + determined for (ignored for full containers).
        container - The container (full or empty).
        +
        Returns:
        The containers capacity, or 0 if the ItemStack does not represent + a registered container or the FluidStack is not registered with + the empty container.
        +
        • +
      + + + +
        +
      • +

        containsFluid

        +
        public static boolean containsFluid(ItemStack container,
+                    FluidStack fluid)
        +
        Determines if a container holds a specific fluid.
        +
        • +
      + + + +
        +
      • +

        isBucket

        +
        public static boolean isBucket(ItemStack container)
        +
        • +
      + + + +
        +
      • +

        isContainer

        +
        public static boolean isContainer(ItemStack container)
        +
        • +
      + + + +
        +
      • +

        isEmptyContainer

        +
        public static boolean isEmptyContainer(ItemStack container)
        +
        • +
      + + + +
        +
      • +

        isFilledContainer

        +
        public static boolean isFilledContainer(ItemStack container)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidEvent.FluidDrainingEvent.html b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidDrainingEvent.html new file mode 100644 index 0000000..403acca --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidDrainingEvent.html @@ -0,0 +1,374 @@ + + + + + +FluidEvent.FluidDrainingEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidEvent.FluidDrainingEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        amount

        +
        public final int amount
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidEvent.FluidDrainingEvent

        +
        @Deprecated
+public FluidEvent.FluidDrainingEvent(FluidStack fluid,
+                                        World world,
+                                        int x,
+                                        int y,
+                                        int z,
+                                        IFluidTank tank)
        +
        Deprecated. Will be removed in 1.8
        +
        • +
      + + + +
        +
      • +

        FluidEvent.FluidDrainingEvent

        +
        public FluidEvent.FluidDrainingEvent(FluidStack fluid,
+                             World world,
+                             int x,
+                             int y,
+                             int z,
+                             IFluidTank tank,
+                             int amount)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidEvent.FluidFillingEvent.html b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidFillingEvent.html new file mode 100644 index 0000000..0e121a0 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidFillingEvent.html @@ -0,0 +1,374 @@ + + + + + +FluidEvent.FluidFillingEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidEvent.FluidFillingEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        amount

        +
        public final int amount
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidEvent.FluidFillingEvent

        +
        @Deprecated
+public FluidEvent.FluidFillingEvent(FluidStack fluid,
+                                       World world,
+                                       int x,
+                                       int y,
+                                       int z,
+                                       IFluidTank tank)
        +
        Deprecated. Will be removed in 1.8
        +
        • +
      + + + +
        +
      • +

        FluidEvent.FluidFillingEvent

        +
        public FluidEvent.FluidFillingEvent(FluidStack fluid,
+                            World world,
+                            int x,
+                            int y,
+                            int z,
+                            IFluidTank tank,
+                            int amount)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidEvent.FluidMotionEvent.html b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidMotionEvent.html new file mode 100644 index 0000000..fc7f16a --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidMotionEvent.html @@ -0,0 +1,300 @@ + + + + + +FluidEvent.FluidMotionEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidEvent.FluidMotionEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FluidEvent
    +
    +
    +
    +
    public static class FluidEvent.FluidMotionEvent
+extends FluidEvent
    +
    Mods should fire this event when they move fluids around.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidEvent.FluidMotionEvent

        +
        public FluidEvent.FluidMotionEvent(FluidStack fluid,
+                           World world,
+                           int x,
+                           int y,
+                           int z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidEvent.FluidSpilledEvent.html b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidSpilledEvent.html new file mode 100644 index 0000000..b3e6f83 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidSpilledEvent.html @@ -0,0 +1,301 @@ + + + + + +FluidEvent.FluidSpilledEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidEvent.FluidSpilledEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FluidEvent
    +
    +
    +
    +
    public static class FluidEvent.FluidSpilledEvent
+extends FluidEvent
    +
    Mods should fire this event when a fluid "spills", for example, if a block containing fluid + is broken.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidEvent.FluidSpilledEvent

        +
        public FluidEvent.FluidSpilledEvent(FluidStack fluid,
+                            World world,
+                            int x,
+                            int y,
+                            int z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidEvent.html b/javadoc/net/minecraftforge/fluids/FluidEvent.html new file mode 100644 index 0000000..bf39397 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidEvent.html @@ -0,0 +1,419 @@ + + + + + +FluidEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        x

        +
        public final int x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final int y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final int z
        +
        • +
      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidEvent

        +
        public FluidEvent(FluidStack fluid,
+          World world,
+          int x,
+          int y,
+          int z)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fireEvent

        +
        public static final void fireEvent(FluidEvent event)
        +
        A handy shortcut for firing the various fluid events.
        +
        Parameters:
        event -
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidRegistry.FluidRegisterEvent.html b/javadoc/net/minecraftforge/fluids/FluidRegistry.FluidRegisterEvent.html new file mode 100644 index 0000000..d72b7bc --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidRegistry.FluidRegisterEvent.html @@ -0,0 +1,308 @@ + + + + + +FluidRegistry.FluidRegisterEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidRegistry.FluidRegisterEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FluidRegistry
    +
    +
    +
    +
    public static class FluidRegistry.FluidRegisterEvent
+extends Event
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fluidName

        +
        public final java.lang.String fluidName
        +
        • +
      + + + +
        +
      • +

        fluidID

        +
        public final int fluidID
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidRegistry.FluidRegisterEvent

        +
        public FluidRegistry.FluidRegisterEvent(java.lang.String fluidName,
+                                int fluidID)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidRegistry.html b/javadoc/net/minecraftforge/fluids/FluidRegistry.html new file mode 100644 index 0000000..ae3c6bf --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidRegistry.html @@ -0,0 +1,488 @@ + + + + + +FluidRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidRegistry

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class FluidRegistry
+extends java.lang.Object
    +
    Handles Fluid registrations. Fluids MUST be registered in order to function.
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static FluidgetFluid(int fluidID) 
      static FluidgetFluid(java.lang.String fluidName) 
      static intgetFluidID(java.lang.String fluidName) 
      static java.lang.StringgetFluidName(FluidStack stack) 
      static java.lang.StringgetFluidName(int fluidID) 
      static FluidStackgetFluidStack(java.lang.String fluidName, + int amount) 
      static intgetMaxID() 
      static java.util.Map<java.lang.String,java.lang.Integer>getRegisteredFluidIDs() +
      Returns a read-only map containing Fluid Names and their associated IDs.
      +
      static java.util.Map<java.lang.String,Fluid>getRegisteredFluids() +
      Returns a read-only map containing Fluid Names and their associated Fluids.
      +
      static voidinitFluidIDs(com.google.common.collect.BiMap<java.lang.String,java.lang.Integer> newfluidIDs) +
      Called by Forge to prepare the ID map for server -> client sync.
      +
      static booleanisFluidRegistered(Fluid fluid) 
      static booleanisFluidRegistered(java.lang.String fluidName) 
      static FluidlookupFluidForBlock(Block block) 
      static booleanregisterFluid(Fluid fluid) +
      Register a new Fluid.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        WATER

        +
        public static final Fluid WATER
        +
        • +
      + + + +
        +
      • +

        LAVA

        +
        public static final Fluid LAVA
        +
        • +
      + + + +
        +
      • +

        renderIdFluid

        +
        public static int renderIdFluid
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initFluidIDs

        +
        public static void initFluidIDs(com.google.common.collect.BiMap<java.lang.String,java.lang.Integer> newfluidIDs)
        +
        Called by Forge to prepare the ID map for server -> client sync. + Modders, DO NOT call this.
        +
        • +
      + + + +
        +
      • +

        registerFluid

        +
        public static boolean registerFluid(Fluid fluid)
        +
        Register a new Fluid. If a fluid with the same name already exists, registration is denied.
        +
        Parameters:
        fluid - The fluid to register.
        +
        Returns:
        True if the fluid was successfully registered; false if there is a name clash.
        +
        • +
      + + + +
        +
      • +

        isFluidRegistered

        +
        public static boolean isFluidRegistered(Fluid fluid)
        +
        • +
      + + + +
        +
      • +

        isFluidRegistered

        +
        public static boolean isFluidRegistered(java.lang.String fluidName)
        +
        • +
      + + + +
        +
      • +

        getFluid

        +
        public static Fluid getFluid(java.lang.String fluidName)
        +
        • +
      + + + +
        +
      • +

        getFluid

        +
        public static Fluid getFluid(int fluidID)
        +
        • +
      + + + +
        +
      • +

        getFluidName

        +
        public static java.lang.String getFluidName(int fluidID)
        +
        • +
      + + + +
        +
      • +

        getFluidName

        +
        public static java.lang.String getFluidName(FluidStack stack)
        +
        • +
      + + + +
        +
      • +

        getFluidID

        +
        public static int getFluidID(java.lang.String fluidName)
        +
        • +
      + + + +
        +
      • +

        getFluidStack

        +
        public static FluidStack getFluidStack(java.lang.String fluidName,
+                       int amount)
        +
        • +
      + + + +
        +
      • +

        getRegisteredFluids

        +
        public static java.util.Map<java.lang.String,Fluid> getRegisteredFluids()
        +
        Returns a read-only map containing Fluid Names and their associated Fluids.
        +
        • +
      + + + +
        +
      • +

        getRegisteredFluidIDs

        +
        public static java.util.Map<java.lang.String,java.lang.Integer> getRegisteredFluidIDs()
        +
        Returns a read-only map containing Fluid Names and their associated IDs.
        +
        • +
      + + + +
        +
      • +

        lookupFluidForBlock

        +
        public static Fluid lookupFluidForBlock(Block block)
        +
        • +
      + + + +
        +
      • +

        getMaxID

        +
        public static int getMaxID()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidStack.html b/javadoc/net/minecraftforge/fluids/FluidStack.html new file mode 100644 index 0000000..ec97065 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidStack.html @@ -0,0 +1,569 @@ + + + + + +FluidStack (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidStack

+
+
+ +
+
    +
  • +
    +
    +
    public class FluidStack
+extends java.lang.Object
    +
    ItemStack substitute for Fluids. + + NOTE: Equality is based on the Fluid, not the amount. Use + isFluidStackIdentical(FluidStack) to determine if FluidID, Amount and NBT Tag are all + equal.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fluidID

        +
        public int fluidID
        +
        • +
      + + + +
        +
      • +

        amount

        +
        public int amount
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidStack

        +
        public FluidStack(Fluid fluid,
+          int amount)
        +
        • +
      + + + +
        +
      • +

        FluidStack

        +
        public FluidStack(int fluidID,
+          int amount)
        +
        • +
      + + + +
        +
      • +

        FluidStack

        +
        public FluidStack(int fluidID,
+          int amount,
+          NBTTagCompound nbt)
        +
        • +
      + + + +
        +
      • +

        FluidStack

        +
        public FluidStack(FluidStack stack,
+          int amount)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        loadFluidStackFromNBT

        +
        public static FluidStack loadFluidStackFromNBT(NBTTagCompound nbt)
        +
        This provides a safe method for retrieving a FluidStack - if the Fluid is invalid, the stack + will return as null.
        +
        • +
      + + + + + + + +
        +
      • +

        getFluid

        +
        public final Fluid getFluid()
        +
        • +
      + + + +
        +
      • +

        getLocalizedName

        +
        public java.lang.String getLocalizedName()
        +
        • +
      + + + +
        +
      • +

        getUnlocalizedName

        +
        public java.lang.String getUnlocalizedName()
        +
        • +
      + + + +
        +
      • +

        copy

        +
        public FluidStack copy()
        +
        Returns:
        A copy of this FluidStack
        +
        • +
      + + + +
        +
      • +

        isFluidEqual

        +
        public boolean isFluidEqual(FluidStack other)
        +
        Determines if the FluidIDs and NBT Tags are equal. This does not check amounts.
        +
        Parameters:
        other - The FluidStack for comparison
        +
        Returns:
        true if the Fluids (IDs and NBT Tags) are the same
        +
        • +
      + + + +
        +
      • +

        areFluidStackTagsEqual

        +
        public static boolean areFluidStackTagsEqual(FluidStack stack1,
+                             FluidStack stack2)
        +
        Determines if the NBT Tags are equal. Useful if the FluidIDs are known to be equal.
        +
        • +
      + + + +
        +
      • +

        containsFluid

        +
        public boolean containsFluid(FluidStack other)
        +
        Determines if the Fluids are equal and this stack is larger.
        +
        Parameters:
        other -
        +
        Returns:
        true if this FluidStack contains the other FluidStack (same fluid and >= amount)
        +
        • +
      + + + +
        +
      • +

        isFluidStackIdentical

        +
        public boolean isFluidStackIdentical(FluidStack other)
        +
        Determines if the FluidIDs, Amounts, and NBT Tags are all equal.
        +
        Parameters:
        other - - the FluidStack for comparison
        +
        Returns:
        true if the two FluidStacks are exactly the same
        +
        • +
      + + + +
        +
      • +

        isFluidEqual

        +
        public boolean isFluidEqual(ItemStack other)
        +
        Determines if the FluidIDs and NBT Tags are equal compared to a registered container + ItemStack. This does not check amounts.
        +
        Parameters:
        other - The ItemStack for comparison
        +
        Returns:
        true if the Fluids (IDs and NBT Tags) are the same
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object o)
        +
        Default equality comparison for a FluidStack. Same functionality as isFluidEqual(). + + This is included for use in data structures.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidTank.html b/javadoc/net/minecraftforge/fluids/FluidTank.html new file mode 100644 index 0000000..bd7c390 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidTank.html @@ -0,0 +1,507 @@ + + + + + +FluidTank (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidTank

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IFluidTank
    +
    +
    +
    +
    public class FluidTank
+extends java.lang.Object
+implements IFluidTank
    +
    Reference implementation of IFluidTank. Use/extend this or implement your own.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidTank

        +
        public FluidTank(int capacity)
        +
        • +
      + + + +
        +
      • +

        FluidTank

        +
        public FluidTank(FluidStack stack,
+         int capacity)
        +
        • +
      + + + +
        +
      • +

        FluidTank

        +
        public FluidTank(Fluid fluid,
+         int amount,
+         int capacity)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        setFluid

        +
        public void setFluid(FluidStack fluid)
        +
        • +
      + + + +
        +
      • +

        setCapacity

        +
        public void setCapacity(int capacity)
        +
        • +
      + + + +
        +
      • +

        getFluid

        +
        public FluidStack getFluid()
        +
        +
        Specified by:
        +
        getFluid in interface IFluidTank
        +
        Returns:
        FluidStack representing the fluid in the tank, null if the tank is empty.
        +
        • +
      + + + +
        +
      • +

        getFluidAmount

        +
        public int getFluidAmount()
        +
        +
        Specified by:
        +
        getFluidAmount in interface IFluidTank
        +
        Returns:
        Current amount of fluid in the tank.
        +
        • +
      + + + +
        +
      • +

        getCapacity

        +
        public int getCapacity()
        +
        +
        Specified by:
        +
        getCapacity in interface IFluidTank
        +
        Returns:
        Capacity of this fluid tank.
        +
        • +
      + + + +
        +
      • +

        getInfo

        +
        public FluidTankInfo getInfo()
        +
        Description copied from interface: IFluidTank
        +
        Returns a wrapper object FluidTankInfo containing the capacity of the tank and the + FluidStack it holds. + + Should prevent manipulation of the IFluidTank. See FluidTank.
        +
        +
        Specified by:
        +
        getInfo in interface IFluidTank
        +
        Returns:
        State information for the IFluidTank.
        +
        • +
      + + + +
        +
      • +

        fill

        +
        public int fill(FluidStack resource,
+       boolean doFill)
        +
        +
        Specified by:
        +
        fill in interface IFluidTank
        +
        Parameters:
        resource - FluidStack attempting to fill the tank.
        doFill - If false, the fill will only be simulated.
        +
        Returns:
        Amount of fluid that was accepted by the tank.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        public FluidStack drain(int maxDrain,
+               boolean doDrain)
        +
        +
        Specified by:
        +
        drain in interface IFluidTank
        +
        Parameters:
        maxDrain - Maximum amount of fluid to be removed from the container.
        +
        Returns:
        Amount of fluid that was removed from the tank.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidTankInfo.html b/javadoc/net/minecraftforge/fluids/FluidTankInfo.html new file mode 100644 index 0000000..62788dd --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidTankInfo.html @@ -0,0 +1,290 @@ + + + + + +FluidTankInfo (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidTankInfo

+
+
+ +
+
    +
  • +
    +
    +
    public final class FluidTankInfo
+extends java.lang.Object
    +
    Wrapper class used to encapsulate information about an IFluidTank.
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        capacity

        +
        public final int capacity
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidTankInfo

        +
        public FluidTankInfo(FluidStack fluid,
+             int capacity)
        +
        • +
      + + + +
        +
      • +

        FluidTankInfo

        +
        public FluidTankInfo(IFluidTank tank)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/IFluidBlock.html b/javadoc/net/minecraftforge/fluids/IFluidBlock.html new file mode 100644 index 0000000..6d3ebea --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/IFluidBlock.html @@ -0,0 +1,294 @@ + + + + + +IFluidBlock (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.fluids
+

Interface IFluidBlock

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleancanDrain(World world, + int x, + int y, + int z) +
      Check to see if a block can be drained.
      +
      FluidStackdrain(World world, + int x, + int y, + int z, + boolean doDrain) +
      Attempt to drain the block.
      +
      floatgetFilledPercentage(World world, + int x, + int y, + int z) +
      Returns the amount of a single block is filled.
      +
      FluidgetFluid() +
      Returns the Fluid associated with this Block.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFluid

        +
        Fluid getFluid()
        +
        Returns the Fluid associated with this Block.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        FluidStack drain(World world,
+               int x,
+               int y,
+               int z,
+               boolean doDrain)
        +
        Attempt to drain the block. This method should be called by devices such as pumps. + + NOTE: The block is intended to handle its own state changes.
        +
        Parameters:
        doDrain - If false, the drain will only be simulated.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        canDrain

        +
        boolean canDrain(World world,
+               int x,
+               int y,
+               int z)
        +
        Check to see if a block can be drained. This method should be called by devices such as + pumps.
        +
        Parameters:
        doDrain - If false, the drain will only be simulated.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        getFilledPercentage

        +
        float getFilledPercentage(World world,
+                        int x,
+                        int y,
+                        int z)
        +
        Returns the amount of a single block is filled. Value between 0 and 1. + 1 meaning the entire 1x1x1 cube is full, 0 meaning completely empty. + + If the return value is negative. It will be treated as filling the block + from the top down instead of bottom up.
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/IFluidContainerItem.html b/javadoc/net/minecraftforge/fluids/IFluidContainerItem.html new file mode 100644 index 0000000..247bdc1 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/IFluidContainerItem.html @@ -0,0 +1,271 @@ + + + + + +IFluidContainerItem (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.fluids
+

Interface IFluidContainerItem

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    ItemFluidContainer
    +
    +
    +
    +
    public interface IFluidContainerItem
    +
    Implement this interface on Item classes that support external manipulation of their internal + fluid storage. + + A reference implementation is provided ItemFluidContainer. + + NOTE: Use of NBT data on the containing ItemStack is encouraged.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFluid

        +
        FluidStack getFluid(ItemStack container)
        +
        Parameters:
        container - ItemStack which is the fluid container.
        +
        Returns:
        FluidStack representing the fluid in the container, null if the container is empty.
        +
        • +
      + + + +
        +
      • +

        getCapacity

        +
        int getCapacity(ItemStack container)
        +
        Parameters:
        container - ItemStack which is the fluid container.
        +
        Returns:
        Capacity of this fluid container.
        +
        • +
      + + + +
        +
      • +

        fill

        +
        int fill(ItemStack container,
+       FluidStack resource,
+       boolean doFill)
        +
        Parameters:
        container - ItemStack which is the fluid container.
        resource - FluidStack attempting to fill the container.
        doFill - If false, the fill will only be simulated.
        +
        Returns:
        Amount of fluid that was (or would have been, if simulated) filled into the + container.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        FluidStack drain(ItemStack container,
+               int maxDrain,
+               boolean doDrain)
        +
        Parameters:
        container - ItemStack which is the fluid container.
        maxDrain - Maximum amount of fluid to be removed from the container.
        doFill - If false, the drain will only be simulated.
        +
        Returns:
        Amount of fluid that was (or would have been, if simulated) drained from the + container.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/IFluidHandler.html b/javadoc/net/minecraftforge/fluids/IFluidHandler.html new file mode 100644 index 0000000..a3ee123 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/IFluidHandler.html @@ -0,0 +1,328 @@ + + + + + +IFluidHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.fluids
+

Interface IFluidHandler

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    TileFluidHandler
    +
    +
    +
    +
    public interface IFluidHandler
    +
    Implement this interface on TileEntities which should handle fluids, generally storing them in + one or more internal IFluidTank objects. + + A reference implementation is provided TileFluidHandler.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleancanDrain(ForgeDirection from, + Fluid fluid) +
      Returns true if the given fluid can be extracted from the given direction.
      +
      booleancanFill(ForgeDirection from, + Fluid fluid) +
      Returns true if the given fluid can be inserted into the given direction.
      +
      FluidStackdrain(ForgeDirection from, + FluidStack resource, + boolean doDrain) +
      Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
      +
      FluidStackdrain(ForgeDirection from, + int maxDrain, + boolean doDrain) +
      Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
      +
      intfill(ForgeDirection from, + FluidStack resource, + boolean doFill) +
      Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
      +
      FluidTankInfo[]getTankInfo(ForgeDirection from) +
      Returns an array of objects which represent the internal tanks.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fill

        +
        int fill(ForgeDirection from,
+       FluidStack resource,
+       boolean doFill)
        +
        Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
        +
        Parameters:
        from - Orientation the Fluid is pumped in from.
        resource - FluidStack representing the Fluid and maximum amount of fluid to be filled.
        doFill - If false, fill will only be simulated.
        +
        Returns:
        Amount of resource that was (or would have been, if simulated) filled.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        FluidStack drain(ForgeDirection from,
+               FluidStack resource,
+               boolean doDrain)
        +
        Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
        +
        Parameters:
        from - Orientation the Fluid is drained to.
        resource - FluidStack representing the Fluid and maximum amount of fluid to be drained.
        doDrain - If false, drain will only be simulated.
        +
        Returns:
        FluidStack representing the Fluid and amount that was (or would have been, if + simulated) drained.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        FluidStack drain(ForgeDirection from,
+               int maxDrain,
+               boolean doDrain)
        +
        Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler. + + This method is not Fluid-sensitive.
        +
        Parameters:
        from - Orientation the fluid is drained to.
        maxDrain - Maximum amount of fluid to drain.
        doDrain - If false, drain will only be simulated.
        +
        Returns:
        FluidStack representing the Fluid and amount that was (or would have been, if + simulated) drained.
        +
        • +
      + + + +
        +
      • +

        canFill

        +
        boolean canFill(ForgeDirection from,
+              Fluid fluid)
        +
        Returns true if the given fluid can be inserted into the given direction. + + More formally, this should return true if fluid is able to enter from the given direction.
        +
        • +
      + + + +
        +
      • +

        canDrain

        +
        boolean canDrain(ForgeDirection from,
+               Fluid fluid)
        +
        Returns true if the given fluid can be extracted from the given direction. + + More formally, this should return true if fluid is able to leave from the given direction.
        +
        • +
      + + + +
        +
      • +

        getTankInfo

        +
        FluidTankInfo[] getTankInfo(ForgeDirection from)
        +
        Returns an array of objects which represent the internal tanks. These objects cannot be used + to manipulate the internal tanks. See FluidTankInfo.
        +
        Parameters:
        from - Orientation determining which tanks should be queried.
        +
        Returns:
        Info for the relevant internal tanks.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/IFluidTank.html b/javadoc/net/minecraftforge/fluids/IFluidTank.html new file mode 100644 index 0000000..9e87672 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/IFluidTank.html @@ -0,0 +1,295 @@ + + + + + +IFluidTank (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.fluids
+

Interface IFluidTank

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    FluidTank
    +
    +
    +
    +
    public interface IFluidTank
    +
    A tank is the unit of interaction with Fluid inventories. + + A reference implementation can be found at FluidTank.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFluid

        +
        FluidStack getFluid()
        +
        Returns:
        FluidStack representing the fluid in the tank, null if the tank is empty.
        +
        • +
      + + + +
        +
      • +

        getFluidAmount

        +
        int getFluidAmount()
        +
        Returns:
        Current amount of fluid in the tank.
        +
        • +
      + + + +
        +
      • +

        getCapacity

        +
        int getCapacity()
        +
        Returns:
        Capacity of this fluid tank.
        +
        • +
      + + + +
        +
      • +

        getInfo

        +
        FluidTankInfo getInfo()
        +
        Returns a wrapper object FluidTankInfo containing the capacity of the tank and the + FluidStack it holds. + + Should prevent manipulation of the IFluidTank. See FluidTank.
        +
        Returns:
        State information for the IFluidTank.
        +
        • +
      + + + +
        +
      • +

        fill

        +
        int fill(FluidStack resource,
+       boolean doFill)
        +
        Parameters:
        resource - FluidStack attempting to fill the tank.
        doFill - If false, the fill will only be simulated.
        +
        Returns:
        Amount of fluid that was accepted by the tank.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        FluidStack drain(int maxDrain,
+               boolean doDrain)
        +
        Parameters:
        maxDrain - Maximum amount of fluid to be removed from the container.
        doFill - If false, the fill will only be simulated.
        +
        Returns:
        Amount of fluid that was removed from the tank.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/ItemFluidContainer.html b/javadoc/net/minecraftforge/fluids/ItemFluidContainer.html new file mode 100644 index 0000000..f9e01a3 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/ItemFluidContainer.html @@ -0,0 +1,426 @@ + + + + + +ItemFluidContainer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class ItemFluidContainer

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        capacity

        +
        protected int capacity
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ItemFluidContainer

        +
        public ItemFluidContainer(int itemID)
        +
        • +
      + + + +
        +
      • +

        ItemFluidContainer

        +
        public ItemFluidContainer(int itemID,
+                  int capacity)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getFluid

        +
        public FluidStack getFluid(ItemStack container)
        +
        +
        Specified by:
        +
        getFluid in interface IFluidContainerItem
        +
        Parameters:
        container - ItemStack which is the fluid container.
        +
        Returns:
        FluidStack representing the fluid in the container, null if the container is empty.
        +
        • +
      + + + +
        +
      • +

        getCapacity

        +
        public int getCapacity(ItemStack container)
        +
        +
        Specified by:
        +
        getCapacity in interface IFluidContainerItem
        +
        Parameters:
        container - ItemStack which is the fluid container.
        +
        Returns:
        Capacity of this fluid container.
        +
        • +
      + + + +
        +
      • +

        fill

        +
        public int fill(ItemStack container,
+       FluidStack resource,
+       boolean doFill)
        +
        +
        Specified by:
        +
        fill in interface IFluidContainerItem
        +
        Parameters:
        container - ItemStack which is the fluid container.
        resource - FluidStack attempting to fill the container.
        doFill - If false, the fill will only be simulated.
        +
        Returns:
        Amount of fluid that was (or would have been, if simulated) filled into the + container.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        public FluidStack drain(ItemStack container,
+               int maxDrain,
+               boolean doDrain)
        +
        +
        Specified by:
        +
        drain in interface IFluidContainerItem
        +
        Parameters:
        container - ItemStack which is the fluid container.
        maxDrain - Maximum amount of fluid to be removed from the container.
        +
        Returns:
        Amount of fluid that was (or would have been, if simulated) drained from the + container.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/RenderBlockFluid.html b/javadoc/net/minecraftforge/fluids/RenderBlockFluid.html new file mode 100644 index 0000000..e4dae0f --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/RenderBlockFluid.html @@ -0,0 +1,403 @@ + + + + + +RenderBlockFluid (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class RenderBlockFluid

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/TileFluidHandler.html b/javadoc/net/minecraftforge/fluids/TileFluidHandler.html new file mode 100644 index 0000000..50a53aa --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/TileFluidHandler.html @@ -0,0 +1,491 @@ + + + + + +TileFluidHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class TileFluidHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TileFluidHandler

        +
        public TileFluidHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        fill

        +
        public int fill(ForgeDirection from,
+       FluidStack resource,
+       boolean doFill)
        +
        Description copied from interface: IFluidHandler
        +
        Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
        +
        +
        Specified by:
        +
        fill in interface IFluidHandler
        +
        Parameters:
        from - Orientation the Fluid is pumped in from.
        resource - FluidStack representing the Fluid and maximum amount of fluid to be filled.
        doFill - If false, fill will only be simulated.
        +
        Returns:
        Amount of resource that was (or would have been, if simulated) filled.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        public FluidStack drain(ForgeDirection from,
+               FluidStack resource,
+               boolean doDrain)
        +
        Description copied from interface: IFluidHandler
        +
        Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
        +
        +
        Specified by:
        +
        drain in interface IFluidHandler
        +
        Parameters:
        from - Orientation the Fluid is drained to.
        resource - FluidStack representing the Fluid and maximum amount of fluid to be drained.
        doDrain - If false, drain will only be simulated.
        +
        Returns:
        FluidStack representing the Fluid and amount that was (or would have been, if + simulated) drained.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        public FluidStack drain(ForgeDirection from,
+               int maxDrain,
+               boolean doDrain)
        +
        Description copied from interface: IFluidHandler
        +
        Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler. + + This method is not Fluid-sensitive.
        +
        +
        Specified by:
        +
        drain in interface IFluidHandler
        +
        Parameters:
        from - Orientation the fluid is drained to.
        maxDrain - Maximum amount of fluid to drain.
        doDrain - If false, drain will only be simulated.
        +
        Returns:
        FluidStack representing the Fluid and amount that was (or would have been, if + simulated) drained.
        +
        • +
      + + + +
        +
      • +

        canFill

        +
        public boolean canFill(ForgeDirection from,
+              Fluid fluid)
        +
        Description copied from interface: IFluidHandler
        +
        Returns true if the given fluid can be inserted into the given direction. + + More formally, this should return true if fluid is able to enter from the given direction.
        +
        +
        Specified by:
        +
        canFill in interface IFluidHandler
        +
        +
        • +
      + + + +
        +
      • +

        canDrain

        +
        public boolean canDrain(ForgeDirection from,
+               Fluid fluid)
        +
        Description copied from interface: IFluidHandler
        +
        Returns true if the given fluid can be extracted from the given direction. + + More formally, this should return true if fluid is able to leave from the given direction.
        +
        +
        Specified by:
        +
        canDrain in interface IFluidHandler
        +
        +
        • +
      + + + +
        +
      • +

        getTankInfo

        +
        public FluidTankInfo[] getTankInfo(ForgeDirection from)
        +
        Description copied from interface: IFluidHandler
        +
        Returns an array of objects which represent the internal tanks. These objects cannot be used + to manipulate the internal tanks. See FluidTankInfo.
        +
        +
        Specified by:
        +
        getTankInfo in interface IFluidHandler
        +
        Parameters:
        from - Orientation determining which tanks should be queried.
        +
        Returns:
        Info for the relevant internal tanks.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/package-frame.html b/javadoc/net/minecraftforge/fluids/package-frame.html new file mode 100644 index 0000000..a060527 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/package-frame.html @@ -0,0 +1,45 @@ + + + + + +net.minecraftforge.fluids (Forge API) + + + + +

net.minecraftforge.fluids

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/fluids/package-summary.html b/javadoc/net/minecraftforge/fluids/package-summary.html new file mode 100644 index 0000000..cbefdef --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/package-summary.html @@ -0,0 +1,284 @@ + + + + + +net.minecraftforge.fluids (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.fluids

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/package-tree.html b/javadoc/net/minecraftforge/fluids/package-tree.html new file mode 100644 index 0000000..0313551 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/package-tree.html @@ -0,0 +1,174 @@ + + + + + +net.minecraftforge.fluids Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.fluids

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/oredict/OreDictionary.OreRegisterEvent.html b/javadoc/net/minecraftforge/oredict/OreDictionary.OreRegisterEvent.html new file mode 100644 index 0000000..86c9735 --- /dev/null +++ b/javadoc/net/minecraftforge/oredict/OreDictionary.OreRegisterEvent.html @@ -0,0 +1,308 @@ + + + + + +OreDictionary.OreRegisterEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.oredict
+

Class OreDictionary.OreRegisterEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    OreDictionary
    +
    +
    +
    +
    public static class OreDictionary.OreRegisterEvent
+extends Event
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        Name

        +
        public final java.lang.String Name
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OreDictionary.OreRegisterEvent

        +
        public OreDictionary.OreRegisterEvent(java.lang.String name,
+                              ItemStack ore)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/oredict/OreDictionary.html b/javadoc/net/minecraftforge/oredict/OreDictionary.html new file mode 100644 index 0000000..36b420a --- /dev/null +++ b/javadoc/net/minecraftforge/oredict/OreDictionary.html @@ -0,0 +1,601 @@ + + + + + +OreDictionary (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.oredict
+

Class OreDictionary

+
+
+ +
+
    +
  • +
    +
    +
    public class OreDictionary
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.util.ArrayList<ItemStack>EMPTY_LIST 
      static intWILDCARD_VALUE +
      Minecraft changed from -1 to Short.MAX_VALUE in 1.5 release for the "block wildcard".
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      OreDictionary() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static intgetOreID(ItemStack stack) +
      Deprecated. 
      +
      static intgetOreID(java.lang.String name) +
      Gets the integer ID for the specified ore name.
      +
      static int[]getOreIDs(ItemStack stack) +
      Gets all the integer ID for the ores that the specified item stakc is registered to.
      +
      static java.lang.StringgetOreName(int id) +
      Reverse of getOreID, will not create new entries.
      +
      static java.lang.String[]getOreNames() +
      Retrieves a list of all unique ore names that are already registered.
      +
      static java.util.ArrayList<ItemStack>getOres(java.lang.Integer id) +
      Deprecated. 
      +
      static java.util.ArrayList<ItemStack>getOres(java.lang.String name) +
      Retrieves the ArrayList of items that are registered to this ore type.
      +
      static voidinitVanillaEntries() 
      static booleanitemMatches(ItemStack target, + ItemStack input, + boolean strict) 
      static voidrebakeMap() 
      static voidregisterOre(int id, + Block ore) +
      Deprecated. 
      +
      static voidregisterOre(int id, + Item ore) +
      Deprecated. 
      +
      static voidregisterOre(int id, + ItemStack ore) +
      Deprecated. 
      +
      static voidregisterOre(java.lang.String name, + Block ore) 
      static voidregisterOre(java.lang.String name, + Item ore) 
      static voidregisterOre(java.lang.String name, + ItemStack ore) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        EMPTY_LIST

        +
        public static final java.util.ArrayList<ItemStack> EMPTY_LIST
        +
        • +
      + + + +
        +
      • +

        WILDCARD_VALUE

        +
        public static final int WILDCARD_VALUE
        +
        Minecraft changed from -1 to Short.MAX_VALUE in 1.5 release for the "block wildcard". Use this in case it + changes again.
        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OreDictionary

        +
        public OreDictionary()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initVanillaEntries

        +
        public static void initVanillaEntries()
        +
        • +
      + + + +
        +
      • +

        getOreID

        +
        public static int getOreID(java.lang.String name)
        +
        Gets the integer ID for the specified ore name. + If the name does not have a ID it assigns it a new one.
        +
        Parameters:
        name - The unique name for this ore 'oreIron', 'ingotIron', etc..
        +
        Returns:
        A number representing the ID for this ore type
        +
        • +
      + + + +
        +
      • +

        getOreName

        +
        public static java.lang.String getOreName(int id)
        +
        Reverse of getOreID, will not create new entries.
        +
        Parameters:
        id - The ID to translate to a string
        +
        Returns:
        The String name, or "Unknown" if not found.
        +
        • +
      + + + +
        +
      • +

        getOreID

        +
        @Deprecated
+public static int getOreID(ItemStack stack)
        +
        Deprecated. 
        +
        Gets the integer ID for the specified item stack. + If the item stack is not linked to any ore, this will return -1 and no new entry will be created.
        +
        Parameters:
        stack - The item stack of the ore.
        +
        Returns:
        A number representing the ID for this ore type, or -1 if couldn't find it.
        +
        • +
      + + + +
        +
      • +

        getOreIDs

        +
        public static int[] getOreIDs(ItemStack stack)
        +
        Gets all the integer ID for the ores that the specified item stakc is registered to. + If the item stack is not linked to any ore, this will return an empty array and no new entry will be created.
        +
        Parameters:
        stack - The item stack of the ore.
        +
        Returns:
        An array of ids that this ore is registerd as.
        +
        • +
      + + + +
        +
      • +

        getOres

        +
        public static java.util.ArrayList<ItemStack> getOres(java.lang.String name)
        +
        Retrieves the ArrayList of items that are registered to this ore type. + Creates the list as empty if it did not exist. + + The returned List is unmodifiable, but will be updated if a new ore + is registered using registerOre
        +
        Parameters:
        name - The ore name, directly calls getOreID
        +
        Returns:
        An arrayList containing ItemStacks registered for this ore
        +
        • +
      + + + +
        +
      • +

        getOreNames

        +
        public static java.lang.String[] getOreNames()
        +
        Retrieves a list of all unique ore names that are already registered.
        +
        Returns:
        All unique ore names that are currently registered.
        +
        • +
      + + + +
        +
      • +

        getOres

        +
        @Deprecated
+public static java.util.ArrayList<ItemStack> getOres(java.lang.Integer id)
        +
        Deprecated. 
        +
        Retrieves the ArrayList of items that are registered to this ore type. + Creates the list as empty if it did not exist. + + Warning: In 1.8, the return value will become a immutible list, + and this function WILL NOT create the entry if the ID doesn't exist, + IDs are intended to be internal OreDictionary things and modders + should not ever code them in.
        +
        Parameters:
        id - The ore ID, see getOreID
        +
        Returns:
        An List containing ItemStacks registered for this ore
        +
        • +
      + + + +
        +
      • +

        itemMatches

        +
        public static boolean itemMatches(ItemStack target,
+                  ItemStack input,
+                  boolean strict)
        +
        • +
      + + + +
        +
      • +

        registerOre

        +
        public static void registerOre(java.lang.String name,
+               Item ore)
        +
        • +
      + + + +
        +
      • +

        registerOre

        +
        public static void registerOre(java.lang.String name,
+               Block ore)
        +
        • +
      + + + +
        +
      • +

        registerOre

        +
        public static void registerOre(java.lang.String name,
+               ItemStack ore)
        +
        • +
      + + + +
        +
      • +

        registerOre

        +
        @Deprecated
+public static void registerOre(int id,
+                          Item ore)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        registerOre

        +
        @Deprecated
+public static void registerOre(int id,
+                          Block ore)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        registerOre

        +
        @Deprecated
+public static void registerOre(int id,
+                          ItemStack ore)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        rebakeMap

        +
        public static void rebakeMap()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/oredict/RecipeSorter.Category.html b/javadoc/net/minecraftforge/oredict/RecipeSorter.Category.html new file mode 100644 index 0000000..1834add --- /dev/null +++ b/javadoc/net/minecraftforge/oredict/RecipeSorter.Category.html @@ -0,0 +1,333 @@ + + + + + +RecipeSorter.Category (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.oredict
+

Enum RecipeSorter.Category

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      SHAPED 
      SHAPELESS 
      UNKNOWN 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static RecipeSorter.CategoryvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static RecipeSorter.Category[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static RecipeSorter.Category[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (RecipeSorter.Category c : RecipeSorter.Category.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static RecipeSorter.Category valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/oredict/RecipeSorter.html b/javadoc/net/minecraftforge/oredict/RecipeSorter.html new file mode 100644 index 0000000..b4c3e3b --- /dev/null +++ b/javadoc/net/minecraftforge/oredict/RecipeSorter.html @@ -0,0 +1,366 @@ + + + + + +RecipeSorter (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.oredict
+

Class RecipeSorter

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Comparator<IRecipe>
    +
    +
    +
    +
    public class RecipeSorter
+extends java.lang.Object
+implements java.util.Comparator<IRecipe>
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compare

        +
        public int compare(IRecipe r1,
+          IRecipe r2)
        +
        +
        Specified by:
        +
        compare in interface java.util.Comparator<IRecipe>
        +
        +
        • +
      + + + +
        +
      • +

        sortCraftManager

        +
        public static void sortCraftManager()
        +
        • +
      + + + +
        +
      • +

        register

        +
        public static void register(java.lang.String name,
+            java.lang.Class<?> recipe,
+            RecipeSorter.Category category,
+            java.lang.String dependancies)
        +
        • +
      + + + +
        +
      • +

        setCategory

        +
        public static void setCategory(java.lang.Class<?> recipe,
+               RecipeSorter.Category category)
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/oredict/ShapedOreRecipe.html b/javadoc/net/minecraftforge/oredict/ShapedOreRecipe.html new file mode 100644 index 0000000..fdf11d1 --- /dev/null +++ b/javadoc/net/minecraftforge/oredict/ShapedOreRecipe.html @@ -0,0 +1,378 @@ + + + + + +ShapedOreRecipe (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.oredict
+

Class ShapedOreRecipe

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IRecipe
    +
    +
    +
    +
    public class ShapedOreRecipe
+extends java.lang.Object
+implements IRecipe
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ShapedOreRecipe

        +
        public ShapedOreRecipe(Block result,
+               java.lang.Object... recipe)
        +
        • +
      + + + +
        +
      • +

        ShapedOreRecipe

        +
        public ShapedOreRecipe(Item result,
+               java.lang.Object... recipe)
        +
        • +
      + + + +
        +
      • +

        ShapedOreRecipe

        +
        public ShapedOreRecipe(ItemStack result,
+               java.lang.Object... recipe)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/oredict/ShapelessOreRecipe.html b/javadoc/net/minecraftforge/oredict/ShapelessOreRecipe.html new file mode 100644 index 0000000..04c804b --- /dev/null +++ b/javadoc/net/minecraftforge/oredict/ShapelessOreRecipe.html @@ -0,0 +1,365 @@ + + + + + +ShapelessOreRecipe (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.oredict
+

Class ShapelessOreRecipe

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IRecipe
    +
    +
    +
    +
    public class ShapelessOreRecipe
+extends java.lang.Object
+implements IRecipe
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ShapelessOreRecipe

        +
        public ShapelessOreRecipe(Block result,
+                  java.lang.Object... recipe)
        +
        • +
      + + + +
        +
      • +

        ShapelessOreRecipe

        +
        public ShapelessOreRecipe(Item result,
+                  java.lang.Object... recipe)
        +
        • +
      + + + +
        +
      • +

        ShapelessOreRecipe

        +
        public ShapelessOreRecipe(ItemStack result,
+                  java.lang.Object... recipe)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRecipeSize

        +
        public int getRecipeSize()
        +
        +
        Specified by:
        +
        getRecipeSize in interface IRecipe
        +
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        getInput

        +
        public java.util.ArrayList<java.lang.Object> getInput()
        +
        Returns the input for this recipe, any mod accessing this value should never + manipulate the values in this array as it will effect the recipe itself.
        +
        Returns:
        The recipes input vales.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/oredict/package-frame.html b/javadoc/net/minecraftforge/oredict/package-frame.html new file mode 100644 index 0000000..b79d9e3 --- /dev/null +++ b/javadoc/net/minecraftforge/oredict/package-frame.html @@ -0,0 +1,27 @@ + + + + + +net.minecraftforge.oredict (Forge API) + + + + +

net.minecraftforge.oredict

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/net/minecraftforge/oredict/package-summary.html b/javadoc/net/minecraftforge/oredict/package-summary.html new file mode 100644 index 0000000..5220bdc --- /dev/null +++ b/javadoc/net/minecraftforge/oredict/package-summary.html @@ -0,0 +1,162 @@ + + + + + +net.minecraftforge.oredict (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.oredict

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/oredict/package-tree.html b/javadoc/net/minecraftforge/oredict/package-tree.html new file mode 100644 index 0000000..972b009 --- /dev/null +++ b/javadoc/net/minecraftforge/oredict/package-tree.html @@ -0,0 +1,146 @@ + + + + + +net.minecraftforge.oredict Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.oredict

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/server/ForgeTimeTracker.html b/javadoc/net/minecraftforge/server/ForgeTimeTracker.html new file mode 100644 index 0000000..97c25b8 --- /dev/null +++ b/javadoc/net/minecraftforge/server/ForgeTimeTracker.html @@ -0,0 +1,334 @@ + + + + + +ForgeTimeTracker (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.server
+

Class ForgeTimeTracker

+
+
+ +
+
    +
  • +
    +
    +
    public class ForgeTimeTracker
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        tileEntityTracking

        +
        public static boolean tileEntityTracking
        +
        • +
      + + + +
        +
      • +

        tileEntityTrackingDuration

        +
        public static int tileEntityTrackingDuration
        +
        • +
      + + + +
        +
      • +

        tileEntityTrackingTime

        +
        public static long tileEntityTrackingTime
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTileTimings

        +
        public static com.google.common.collect.ImmutableMap<TileEntity,int[]> getTileTimings()
        +
        • +
      + + + +
        +
      • +

        trackStart

        +
        public static void trackStart(TileEntity tileEntity)
        +
        • +
      + + + +
        +
      • +

        trackEnd

        +
        public static void trackEnd(TileEntity tileEntity)
        +
        • +
      + + + +
        +
      • +

        trackStart

        +
        public static void trackStart(Entity par1Entity)
        +
        • +
      + + + +
        +
      • +

        trackEnd

        +
        public static void trackEnd(Entity par1Entity)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/server/command/ForgeCommand.html b/javadoc/net/minecraftforge/server/command/ForgeCommand.html new file mode 100644 index 0000000..b9bffae --- /dev/null +++ b/javadoc/net/minecraftforge/server/command/ForgeCommand.html @@ -0,0 +1,315 @@ + + + + + +ForgeCommand (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.server.command
+

Class ForgeCommand

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable, ICommand
    +
    +
    +
    +
    public class ForgeCommand
+extends CommandBase
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCommandName

        +
        public java.lang.String getCommandName()
        +
        • +
      + + + +
        +
      • +

        getCommandUsage

        +
        public java.lang.String getCommandUsage(ICommandSender icommandsender)
        +
        • +
      + + + + + + + +
        +
      • +

        processCommand

        +
        public void processCommand(ICommandSender sender,
+                  java.lang.String[] args)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/server/command/package-frame.html b/javadoc/net/minecraftforge/server/command/package-frame.html new file mode 100644 index 0000000..c9529e7 --- /dev/null +++ b/javadoc/net/minecraftforge/server/command/package-frame.html @@ -0,0 +1,19 @@ + + + + + +net.minecraftforge.server.command (Forge API) + + + + +

net.minecraftforge.server.command

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/server/command/package-summary.html b/javadoc/net/minecraftforge/server/command/package-summary.html new file mode 100644 index 0000000..1f0ae85 --- /dev/null +++ b/javadoc/net/minecraftforge/server/command/package-summary.html @@ -0,0 +1,131 @@ + + + + + +net.minecraftforge.server.command (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.server.command

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/server/command/package-tree.html b/javadoc/net/minecraftforge/server/command/package-tree.html new file mode 100644 index 0000000..99a9e5e --- /dev/null +++ b/javadoc/net/minecraftforge/server/command/package-tree.html @@ -0,0 +1,130 @@ + + + + + +net.minecraftforge.server.command Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.server.command

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/server/package-frame.html b/javadoc/net/minecraftforge/server/package-frame.html new file mode 100644 index 0000000..9898c7e --- /dev/null +++ b/javadoc/net/minecraftforge/server/package-frame.html @@ -0,0 +1,19 @@ + + + + + +net.minecraftforge.server (Forge API) + + + + +

net.minecraftforge.server

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/server/package-summary.html b/javadoc/net/minecraftforge/server/package-summary.html new file mode 100644 index 0000000..2126fd5 --- /dev/null +++ b/javadoc/net/minecraftforge/server/package-summary.html @@ -0,0 +1,131 @@ + + + + + +net.minecraftforge.server (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.server

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/server/package-tree.html b/javadoc/net/minecraftforge/server/package-tree.html new file mode 100644 index 0000000..9cfe831 --- /dev/null +++ b/javadoc/net/minecraftforge/server/package-tree.html @@ -0,0 +1,126 @@ + + + + + +net.minecraftforge.server Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.server

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/transformers/ForgeAccessTransformer.html b/javadoc/net/minecraftforge/transformers/ForgeAccessTransformer.html new file mode 100644 index 0000000..47cd9df --- /dev/null +++ b/javadoc/net/minecraftforge/transformers/ForgeAccessTransformer.html @@ -0,0 +1,245 @@ + + + + + +ForgeAccessTransformer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.transformers
+

Class ForgeAccessTransformer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.IClassTransformer
    +
    +
    +
    +
    public class ForgeAccessTransformer
+extends AccessTransformer
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeAccessTransformer

        +
        public ForgeAccessTransformer()
+                       throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/transformers/package-frame.html b/javadoc/net/minecraftforge/transformers/package-frame.html new file mode 100644 index 0000000..034cd60 --- /dev/null +++ b/javadoc/net/minecraftforge/transformers/package-frame.html @@ -0,0 +1,19 @@ + + + + + +net.minecraftforge.transformers (Forge API) + + + + +

net.minecraftforge.transformers

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/transformers/package-summary.html b/javadoc/net/minecraftforge/transformers/package-summary.html new file mode 100644 index 0000000..66183b9 --- /dev/null +++ b/javadoc/net/minecraftforge/transformers/package-summary.html @@ -0,0 +1,131 @@ + + + + + +net.minecraftforge.transformers (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.transformers

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/transformers/package-tree.html b/javadoc/net/minecraftforge/transformers/package-tree.html new file mode 100644 index 0000000..d0a2977 --- /dev/null +++ b/javadoc/net/minecraftforge/transformers/package-tree.html @@ -0,0 +1,130 @@ + + + + + +net.minecraftforge.transformers Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.transformers

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3