From dc3df3edd5843bde0c1335d6a8e460b2c832aa48 Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Sat, 17 Jun 2017 08:12:18 +0300 Subject: full project files --- .../CustomModLoadingErrorDisplayException.html | 336 +++++ .../mods/fml/client/ExtendedServerListData.html | 307 +++++ javadoc/cpw/mods/fml/client/FMLClientHandler.html | 1057 +++++++++++++++ .../FMLConfigGuiFactory.FMLConfigGuiScreen.html | 295 +++++ .../cpw/mods/fml/client/FMLConfigGuiFactory.html | 391 ++++++ .../cpw/mods/fml/client/FMLFileResourcePack.html | 350 +++++ .../cpw/mods/fml/client/FMLFolderResourcePack.html | 360 ++++++ javadoc/cpw/mods/fml/client/GuiAccessDenied.html | 344 +++++ javadoc/cpw/mods/fml/client/GuiBackupFailed.html | 344 +++++ javadoc/cpw/mods/fml/client/GuiConfirmation.html | 340 +++++ .../fml/client/GuiCustomModLoadingErrorScreen.html | 337 +++++ javadoc/cpw/mods/fml/client/GuiDupesFound.html | 337 +++++ .../cpw/mods/fml/client/GuiIngameModOptions.html | 370 ++++++ javadoc/cpw/mods/fml/client/GuiModList.html | 387 ++++++ javadoc/cpw/mods/fml/client/GuiModOptionList.html | 363 ++++++ javadoc/cpw/mods/fml/client/GuiModsMissing.html | 337 +++++ .../mods/fml/client/GuiModsMissingForServer.html | 342 +++++ javadoc/cpw/mods/fml/client/GuiNotification.html | 374 ++++++ .../cpw/mods/fml/client/GuiOldSaveLoadConfirm.html | 360 ++++++ javadoc/cpw/mods/fml/client/GuiScrollingList.html | 632 +++++++++ javadoc/cpw/mods/fml/client/GuiSlotModList.html | 384 ++++++ javadoc/cpw/mods/fml/client/GuiSortingProblem.html | 325 +++++ javadoc/cpw/mods/fml/client/GuiWrongMinecraft.html | 337 +++++ ...ModGuiFactory.RuntimeOptionCategoryElement.html | 282 ++++ .../IModGuiFactory.RuntimeOptionGuiHandler.html | 281 ++++ javadoc/cpw/mods/fml/client/IModGuiFactory.html | 325 +++++ .../cpw/mods/fml/client/config/ConfigGuiType.html | 377 ++++++ .../DummyConfigElement.DummyCategoryElement.html | 331 +++++ .../DummyConfigElement.DummyListElement.html | 600 +++++++++ .../mods/fml/client/config/DummyConfigElement.html | 1353 ++++++++++++++++++++ .../cpw/mods/fml/client/config/GuiButtonExt.html | 349 +++++ .../cpw/mods/fml/client/config/GuiCheckBox.html | 364 ++++++ javadoc/cpw/mods/fml/client/config/GuiConfig.html | 768 +++++++++++ .../client/config/GuiConfigEntries.ArrayEntry.html | 563 ++++++++ .../config/GuiConfigEntries.BooleanEntry.html | 511 ++++++++ .../config/GuiConfigEntries.ButtonEntry.html | 540 ++++++++ .../config/GuiConfigEntries.CategoryEntry.html | 772 +++++++++++ .../config/GuiConfigEntries.ChatColorEntry.html | 339 +++++ .../config/GuiConfigEntries.CycleValueEntry.html | 529 ++++++++ .../config/GuiConfigEntries.DoubleEntry.html | 426 ++++++ .../config/GuiConfigEntries.IConfigEntry.html | 501 ++++++++ .../config/GuiConfigEntries.IntegerEntry.html | 426 ++++++ .../config/GuiConfigEntries.ListEntryBase.html | 936 ++++++++++++++ .../config/GuiConfigEntries.NumberSliderEntry.html | 536 ++++++++ .../config/GuiConfigEntries.SelectValueEntry.html | 583 +++++++++ .../config/GuiConfigEntries.StringEntry.html | 603 +++++++++ .../mods/fml/client/config/GuiConfigEntries.html | 856 +++++++++++++ .../cpw/mods/fml/client/config/GuiEditArray.html | 540 ++++++++ .../config/GuiEditArrayEntries.BaseEntry.html | 569 ++++++++ .../config/GuiEditArrayEntries.BooleanEntry.html | 422 ++++++ .../config/GuiEditArrayEntries.DoubleEntry.html | 342 +++++ .../config/GuiEditArrayEntries.IArrayEntry.html | 297 +++++ .../config/GuiEditArrayEntries.IntegerEntry.html | 341 +++++ .../config/GuiEditArrayEntries.StringEntry.html | 431 +++++++ .../fml/client/config/GuiEditArrayEntries.html | 694 ++++++++++ .../mods/fml/client/config/GuiMessageDialog.html | 322 +++++ .../mods/fml/client/config/GuiSelectString.html | 510 ++++++++ .../GuiSelectStringEntries.EntryComparator.html | 276 ++++ ...ectStringEntries.IGuiSelectStringListEntry.html | 224 ++++ .../config/GuiSelectStringEntries.ListEntry.html | 405 ++++++ .../fml/client/config/GuiSelectStringEntries.html | 583 +++++++++ .../mods/fml/client/config/GuiSlider.ISlider.html | 208 +++ javadoc/cpw/mods/fml/client/config/GuiSlider.html | 699 ++++++++++ .../fml/client/config/GuiUnicodeGlyphButton.html | 373 ++++++ javadoc/cpw/mods/fml/client/config/GuiUtils.html | 529 ++++++++ .../cpw/mods/fml/client/config/HoverChecker.html | 344 +++++ .../cpw/mods/fml/client/config/IConfigElement.html | 679 ++++++++++ .../cpw/mods/fml/client/config/package-frame.html | 65 + .../mods/fml/client/config/package-summary.html | 400 ++++++ .../cpw/mods/fml/client/config/package-tree.html | 232 ++++ .../ConfigChangedEvent.OnConfigChangedEvent.html | 297 +++++ .../ConfigChangedEvent.PostConfigChangedEvent.html | 292 +++++ .../mods/fml/client/event/ConfigChangedEvent.html | 376 ++++++ .../cpw/mods/fml/client/event/package-frame.html | 21 + .../cpw/mods/fml/client/event/package-summary.html | 145 +++ .../cpw/mods/fml/client/event/package-tree.html | 135 ++ javadoc/cpw/mods/fml/client/package-frame.html | 50 + javadoc/cpw/mods/fml/client/package-summary.html | 273 ++++ javadoc/cpw/mods/fml/client/package-tree.html | 204 +++ .../mods/fml/client/registry/ClientRegistry.html | 290 +++++ .../registry/ISimpleBlockRenderingHandler.html | 265 ++++ .../fml/client/registry/RenderingRegistry.html | 421 ++++++ .../mods/fml/client/registry/package-frame.html | 24 + .../mods/fml/client/registry/package-summary.html | 150 +++ .../cpw/mods/fml/client/registry/package-tree.html | 131 ++ javadoc/cpw/mods/fml/common/API.html | 224 ++++ javadoc/cpw/mods/fml/common/BukkitPluginRef.html | 210 +++ javadoc/cpw/mods/fml/common/BukkitProxy.html | 159 +++ javadoc/cpw/mods/fml/common/CertificateHelper.html | 267 ++++ javadoc/cpw/mods/fml/common/DummyModContainer.html | 815 ++++++++++++ .../fml/common/DuplicateModsFoundException.html | 294 +++++ javadoc/cpw/mods/fml/common/FMLCommonHandler.html | 1096 ++++++++++++++++ javadoc/cpw/mods/fml/common/FMLContainer.html | 492 +++++++ javadoc/cpw/mods/fml/common/FMLLog.html | 420 ++++++ javadoc/cpw/mods/fml/common/FMLModContainer.html | 830 ++++++++++++ javadoc/cpw/mods/fml/common/IASMHook.html | 231 ++++ javadoc/cpw/mods/fml/common/ICrashCallable.html | 216 ++++ .../cpw/mods/fml/common/IFMLHandledException.html | 160 +++ javadoc/cpw/mods/fml/common/IFMLSidedHandler.html | 455 +++++++ javadoc/cpw/mods/fml/common/IFuelHandler.html | 204 +++ .../fml/common/ILanguageAdapter.JavaAdapter.html | 357 ++++++ .../fml/common/ILanguageAdapter.ScalaAdapter.html | 357 ++++++ javadoc/cpw/mods/fml/common/ILanguageAdapter.html | 296 +++++ javadoc/cpw/mods/fml/common/IWorldGenerator.html | 219 ++++ .../cpw/mods/fml/common/InjectedModContainer.html | 830 ++++++++++++ javadoc/cpw/mods/fml/common/LoadController.html | 416 ++++++ javadoc/cpw/mods/fml/common/Loader.html | 741 +++++++++++ javadoc/cpw/mods/fml/common/LoaderException.html | 269 ++++ .../cpw/mods/fml/common/LoaderState.ModState.html | 422 ++++++ javadoc/cpw/mods/fml/common/LoaderState.html | 521 ++++++++ javadoc/cpw/mods/fml/common/MCPDummyContainer.html | 337 +++++ .../MetadataCollection.ArtifactVersionAdapter.html | 297 +++++ .../cpw/mods/fml/common/MetadataCollection.html | 290 +++++ .../mods/fml/common/MinecraftDummyContainer.html | 300 +++++ .../cpw/mods/fml/common/MissingModsException.html | 289 +++++ .../cpw/mods/fml/common/Mod.CustomProperty.html | 220 ++++ javadoc/cpw/mods/fml/common/Mod.EventHandler.html | 184 +++ javadoc/cpw/mods/fml/common/Mod.Instance.html | 207 +++ .../cpw/mods/fml/common/Mod.InstanceFactory.html | 151 +++ javadoc/cpw/mods/fml/common/Mod.Metadata.html | 206 +++ javadoc/cpw/mods/fml/common/Mod.html | 565 ++++++++ javadoc/cpw/mods/fml/common/ModAPIManager.html | 359 ++++++ javadoc/cpw/mods/fml/common/ModClassLoader.html | 369 ++++++ .../mods/fml/common/ModContainer.Disableable.html | 345 +++++ javadoc/cpw/mods/fml/common/ModContainer.html | 639 +++++++++ .../cpw/mods/fml/common/ModContainerFactory.html | 288 +++++ javadoc/cpw/mods/fml/common/ModMetadata.html | 550 ++++++++ .../fml/common/ObfuscationReflectionHelper.html | 337 +++++ .../cpw/mods/fml/common/Optional.Interface.html | 256 ++++ .../mods/fml/common/Optional.InterfaceList.html | 203 +++ javadoc/cpw/mods/fml/common/Optional.Method.html | 203 +++ javadoc/cpw/mods/fml/common/Optional.html | 221 ++++ javadoc/cpw/mods/fml/common/ProxyInjector.html | 260 ++++ .../cpw/mods/fml/common/SaveInspectionHandler.html | 152 +++ javadoc/cpw/mods/fml/common/SidedProxy.html | 270 ++++ .../fml/common/StartupQuery.AbortedException.html | 218 ++++ javadoc/cpw/mods/fml/common/StartupQuery.html | 358 ++++++ .../cpw/mods/fml/common/TracingPrintStream.html | 326 +++++ .../cpw/mods/fml/common/WorldAccessContainer.html | 229 ++++ .../fml/common/WrongMinecraftVersionException.html | 289 +++++ javadoc/cpw/mods/fml/common/ZipperUtil.html | 315 +++++ .../cpw/mods/fml/common/asm/FMLSanityChecker.html | 324 +++++ .../mods/fml/common/asm/ReobfuscationMarker.html | 151 +++ javadoc/cpw/mods/fml/common/asm/package-frame.html | 23 + .../cpw/mods/fml/common/asm/package-summary.html | 148 +++ javadoc/cpw/mods/fml/common/asm/package-tree.html | 130 ++ .../common/asm/transformers/AccessTransformer.html | 321 +++++ .../asm/transformers/DeobfuscationTransformer.html | 301 +++++ .../transformers/EventSubscriptionTransformer.html | 267 ++++ .../asm/transformers/ItemStackTransformer.html | 267 ++++ .../common/asm/transformers/MarkerTransformer.html | 301 +++++ .../common/asm/transformers/ModAPITransformer.html | 280 ++++ .../asm/transformers/ModAccessTransformer.html | 276 ++++ .../asm/transformers/PatchingTransformer.html | 267 ++++ .../common/asm/transformers/SideTransformer.html | 267 ++++ .../TerminalTransformer.ExitVisitor.html | 333 +++++ .../asm/transformers/TerminalTransformer.html | 286 +++++ .../deobf/FMLDeobfuscatingRemapper.html | 421 ++++++ .../transformers/deobf/FMLRemappingAdapter.html | 335 +++++ .../asm/transformers/deobf/LZMAInputSupplier.html | 276 ++++ .../asm/transformers/deobf/package-frame.html | 21 + .../asm/transformers/deobf/package-summary.html | 139 ++ .../asm/transformers/deobf/package-tree.html | 144 +++ .../fml/common/asm/transformers/package-frame.html | 29 + .../common/asm/transformers/package-summary.html | 171 +++ .../fml/common/asm/transformers/package-tree.html | 143 +++ .../fml/common/discovery/ASMDataTable.ASMData.html | 336 +++++ .../mods/fml/common/discovery/ASMDataTable.html | 348 +++++ .../mods/fml/common/discovery/ContainerType.html | 332 +++++ .../fml/common/discovery/DirectoryDiscoverer.html | 301 +++++ .../mods/fml/common/discovery/ITypeDiscoverer.html | 246 ++++ .../mods/fml/common/discovery/JarDiscoverer.html | 280 ++++ .../mods/fml/common/discovery/ModCandidate.html | 434 +++++++ .../mods/fml/common/discovery/ModDiscoverer.html | 306 +++++ .../fml/common/discovery/asm/ASMModParser.html | 528 ++++++++ .../discovery/asm/ModAnnotation.EnumHolder.html | 232 ++++ .../fml/common/discovery/asm/ModAnnotation.html | 422 ++++++ .../common/discovery/asm/ModAnnotationVisitor.html | 382 ++++++ .../fml/common/discovery/asm/ModClassVisitor.html | 364 ++++++ .../fml/common/discovery/asm/ModFieldVisitor.html | 289 +++++ .../fml/common/discovery/asm/ModMethodVisitor.html | 291 +++++ .../fml/common/discovery/asm/package-frame.html | 24 + .../fml/common/discovery/asm/package-summary.html | 151 +++ .../fml/common/discovery/asm/package-tree.html | 148 +++ .../mods/fml/common/discovery/package-frame.html | 32 + .../mods/fml/common/discovery/package-summary.html | 181 +++ .../mods/fml/common/discovery/package-tree.html | 147 +++ .../fml/common/event/FMLConstructionEvent.html | 321 +++++ javadoc/cpw/mods/fml/common/event/FMLEvent.html | 271 ++++ .../common/event/FMLFingerprintViolationEvent.html | 319 +++++ .../fml/common/event/FMLInitializationEvent.html | 282 ++++ .../common/event/FMLInterModComms.IMCEvent.html | 289 +++++ .../common/event/FMLInterModComms.IMCMessage.html | 372 ++++++ .../mods/fml/common/event/FMLInterModComms.html | 397 ++++++ .../fml/common/event/FMLLoadCompleteEvent.html | 282 ++++ .../cpw/mods/fml/common/event/FMLLoadEvent.html | 226 ++++ .../event/FMLMissingMappingsEvent.Action.html | 378 ++++++ .../FMLMissingMappingsEvent.MissingMapping.html | 442 +++++++ .../fml/common/event/FMLMissingMappingsEvent.html | 341 +++++ .../mods/fml/common/event/FMLModDisabledEvent.html | 238 ++++ .../event/FMLModIdMappingEvent.ModRemapping.html | 309 +++++ .../event/FMLModIdMappingEvent.RemapTarget.html | 321 +++++ .../fml/common/event/FMLModIdMappingEvent.html | 297 +++++ .../common/event/FMLPostInitializationEvent.html | 297 +++++ .../common/event/FMLPreInitializationEvent.html | 419 ++++++ .../common/event/FMLServerAboutToStartEvent.html | 295 +++++ .../fml/common/event/FMLServerStartedEvent.html | 282 ++++ .../fml/common/event/FMLServerStartingEvent.html | 308 +++++ .../fml/common/event/FMLServerStoppedEvent.html | 282 ++++ .../fml/common/event/FMLServerStoppingEvent.html | 282 ++++ .../cpw/mods/fml/common/event/FMLStateEvent.html | 283 ++++ .../cpw/mods/fml/common/event/package-frame.html | 44 + .../cpw/mods/fml/common/event/package-summary.html | 243 ++++ .../cpw/mods/fml/common/event/package-tree.html | 166 +++ .../fml/common/eventhandler/ASMEventHandler.html | 313 +++++ .../mods/fml/common/eventhandler/Cancelable.html | 150 +++ .../fml/common/eventhandler/Event.HasResult.html | 150 +++ .../mods/fml/common/eventhandler/Event.Result.html | 333 +++++ .../cpw/mods/fml/common/eventhandler/Event.html | 442 +++++++ .../cpw/mods/fml/common/eventhandler/EventBus.html | 328 +++++ .../fml/common/eventhandler/EventPriority.html | 371 ++++++ .../eventhandler/IEventExceptionHandler.html | 221 ++++ .../fml/common/eventhandler/IEventListener.html | 208 +++ .../mods/fml/common/eventhandler/ListenerList.html | 365 ++++++ .../fml/common/eventhandler/SubscribeEvent.html | 219 ++++ .../fml/common/eventhandler/package-frame.html | 38 + .../fml/common/eventhandler/package-summary.html | 206 +++ .../mods/fml/common/eventhandler/package-tree.html | 153 +++ .../functions/ArtifactVersionNameFunction.html | 270 ++++ .../common/functions/CollectionWrapperFactory.html | 281 ++++ .../common/functions/GenericIterableFactory.html | 256 ++++ .../mods/fml/common/functions/ModIdFunction.html | 270 ++++ .../mods/fml/common/functions/ModNameFunction.html | 270 ++++ .../fml/common/functions/TypeCastFunction.html | 270 ++++ .../mods/fml/common/functions/package-frame.html | 24 + .../mods/fml/common/functions/package-summary.html | 151 +++ .../mods/fml/common/functions/package-tree.html | 131 ++ .../common/gameevent/InputEvent.KeyInputEvent.html | 269 ++++ .../gameevent/InputEvent.MouseInputEvent.html | 269 ++++ .../cpw/mods/fml/common/gameevent/InputEvent.html | 272 ++++ .../gameevent/PlayerEvent.ItemCraftedEvent.html | 329 +++++ .../gameevent/PlayerEvent.ItemPickupEvent.html | 314 +++++ .../gameevent/PlayerEvent.ItemSmeltedEvent.html | 314 +++++ .../PlayerEvent.PlayerChangedDimensionEvent.html | 329 +++++ .../gameevent/PlayerEvent.PlayerLoggedInEvent.html | 284 ++++ .../PlayerEvent.PlayerLoggedOutEvent.html | 284 ++++ .../gameevent/PlayerEvent.PlayerRespawnEvent.html | 284 ++++ .../cpw/mods/fml/common/gameevent/PlayerEvent.html | 294 +++++ .../gameevent/TickEvent.ClientTickEvent.html | 284 ++++ .../mods/fml/common/gameevent/TickEvent.Phase.html | 321 +++++ .../gameevent/TickEvent.PlayerTickEvent.html | 314 +++++ .../gameevent/TickEvent.RenderTickEvent.html | 314 +++++ .../gameevent/TickEvent.ServerTickEvent.html | 284 ++++ .../mods/fml/common/gameevent/TickEvent.Type.html | 357 ++++++ .../common/gameevent/TickEvent.WorldTickEvent.html | 316 +++++ .../cpw/mods/fml/common/gameevent/TickEvent.html | 358 ++++++ .../mods/fml/common/gameevent/package-frame.html | 40 + .../mods/fml/common/gameevent/package-summary.html | 214 ++++ .../mods/fml/common/gameevent/package-tree.html | 168 +++ .../mods/fml/common/launcher/FMLDeobfTweaker.html | 320 +++++ .../launcher/FMLInjectionAndSortingTweaker.html | 323 +++++ .../mods/fml/common/launcher/FMLServerTweaker.html | 295 +++++ .../cpw/mods/fml/common/launcher/FMLTweaker.html | 363 ++++++ .../mods/fml/common/launcher/TerminalTweaker.html | 320 +++++ .../cpw/mods/fml/common/launcher/Yggdrasil.html | 256 ++++ .../mods/fml/common/launcher/package-frame.html | 24 + .../mods/fml/common/launcher/package-summary.html | 155 +++ .../cpw/mods/fml/common/launcher/package-tree.html | 134 ++ .../cpw/mods/fml/common/network/ByteBufUtils.html | 461 +++++++ .../fml/common/network/FMLEmbeddedChannel.html | 369 ++++++ .../mods/fml/common/network/FMLEventChannel.html | 354 +++++ .../network/FMLIndexedMessageToMessageCodec.html | 527 ++++++++ ...LNetworkEvent.ClientConnectedToServerEvent.html | 328 +++++ .../FMLNetworkEvent.ClientCustomPacketEvent.html | 331 +++++ ...rkEvent.ClientDisconnectionFromServerEvent.html | 285 +++++ .../FMLNetworkEvent.CustomNetworkEvent.html | 294 +++++ .../network/FMLNetworkEvent.CustomPacketEvent.html | 329 +++++ ...NetworkEvent.CustomPacketRegistrationEvent.html | 348 +++++ ...tworkEvent.ServerConnectionFromClientEvent.html | 313 +++++ .../FMLNetworkEvent.ServerCustomPacketEvent.html | 331 +++++ ...rkEvent.ServerDisconnectionFromClientEvent.html | 285 +++++ .../mods/fml/common/network/FMLNetworkEvent.html | 331 +++++ .../fml/common/network/FMLNetworkException.html | 277 ++++ .../network/FMLOutboundHandler.OutboundTarget.html | 484 +++++++ .../fml/common/network/FMLOutboundHandler.html | 376 ++++++ .../cpw/mods/fml/common/network/IGuiHandler.html | 249 ++++ .../fml/common/network/NetworkCheckHandler.html | 164 +++ .../common/network/NetworkEventFiringHandler.html | 342 +++++ .../network/NetworkHandshakeEstablished.html | 298 +++++ .../network/NetworkRegistry.TargetPoint.html | 331 +++++ .../mods/fml/common/network/NetworkRegistry.html | 726 +++++++++++ .../handshake/ChannelRegistrationHandler.html | 349 +++++ .../network/handshake/FMLHandshakeCodec.html | 386 ++++++ .../handshake/FMLHandshakeMessage.ClientHello.html | 319 +++++ .../FMLHandshakeMessage.HandshakeAck.html | 323 +++++ .../FMLHandshakeMessage.HandshakeReset.html | 257 ++++ .../handshake/FMLHandshakeMessage.ModIdData.html | 374 ++++++ .../handshake/FMLHandshakeMessage.ModList.html | 374 ++++++ .../handshake/FMLHandshakeMessage.ServerHello.html | 319 +++++ .../network/handshake/FMLHandshakeMessage.html | 336 +++++ .../network/handshake/HandshakeInjector.html | 316 +++++ .../network/handshake/HandshakeMessageHandler.html | 393 ++++++ .../common/network/handshake/IHandshakeState.html | 206 +++ .../network/handshake/NetworkDispatcher.html | 791 ++++++++++++ .../common/network/handshake/package-frame.html | 34 + .../common/network/handshake/package-summary.html | 190 +++ .../fml/common/network/handshake/package-tree.html | 172 +++ .../network/internal/EntitySpawnHandler.html | 349 +++++ .../internal/FMLMessage.CompleteHandshake.html | 262 ++++ .../internal/FMLMessage.EntityAdjustMessage.html | 273 ++++ .../network/internal/FMLMessage.EntityMessage.html | 254 ++++ .../internal/FMLMessage.EntitySpawnMessage.html | 271 ++++ .../network/internal/FMLMessage.OpenGui.html | 250 ++++ .../fml/common/network/internal/FMLMessage.html | 265 ++++ .../common/network/internal/FMLNetworkHandler.html | 454 +++++++ .../common/network/internal/FMLProxyPacket.html | 464 +++++++ .../common/network/internal/FMLRuntimeCodec.html | 408 ++++++ .../internal/HandshakeCompletionHandler.html | 350 +++++ .../internal/NetworkModHolder.NetworkChecker.html | 260 ++++ .../common/network/internal/NetworkModHolder.html | 398 ++++++ .../common/network/internal/OpenGuiHandler.html | 349 +++++ .../fml/common/network/internal/package-frame.html | 31 + .../common/network/internal/package-summary.html | 179 +++ .../fml/common/network/internal/package-tree.html | 173 +++ .../cpw/mods/fml/common/network/package-frame.html | 53 + .../mods/fml/common/network/package-summary.html | 295 +++++ .../cpw/mods/fml/common/network/package-tree.html | 223 ++++ .../fml/common/network/simpleimpl/IMessage.html | 226 ++++ .../common/network/simpleimpl/IMessageHandler.html | 219 ++++ .../common/network/simpleimpl/MessageContext.html | 290 +++++ .../simpleimpl/SimpleChannelHandlerWrapper.html | 371 ++++++ .../network/simpleimpl/SimpleIndexedCodec.html | 386 ++++++ .../network/simpleimpl/SimpleNetworkWrapper.html | 463 +++++++ .../common/network/simpleimpl/package-frame.html | 27 + .../common/network/simpleimpl/package-summary.html | 170 +++ .../common/network/simpleimpl/package-tree.html | 158 +++ javadoc/cpw/mods/fml/common/package-frame.html | 86 ++ javadoc/cpw/mods/fml/common/package-summary.html | 454 +++++++ javadoc/cpw/mods/fml/common/package-tree.html | 248 ++++ .../cpw/mods/fml/common/patcher/ClassPatch.html | 369 ++++++ .../mods/fml/common/patcher/ClassPatchManager.html | 306 +++++ .../cpw/mods/fml/common/patcher/GenDiffSet.html | 257 ++++ .../cpw/mods/fml/common/patcher/package-frame.html | 21 + .../mods/fml/common/patcher/package-summary.html | 139 ++ .../cpw/mods/fml/common/patcher/package-tree.html | 128 ++ .../EntityRegistry.EntityRegistration.html | 405 ++++++ .../mods/fml/common/registry/EntityRegistry.html | 444 +++++++ .../registry/ExistingSubstitutionException.html | 250 ++++ .../registry/FMLControlledNamespacedRegistry.html | 605 +++++++++ .../common/registry/GameData.GameDataSnapshot.html | 296 +++++ javadoc/cpw/mods/fml/common/registry/GameData.html | 520 ++++++++ .../common/registry/GameRegistry.ObjectHolder.html | 207 +++ .../fml/common/registry/GameRegistry.Type.html | 334 +++++ .../registry/GameRegistry.UniqueIdentifier.html | 345 +++++ .../cpw/mods/fml/common/registry/GameRegistry.html | 781 +++++++++++ .../registry/IEntityAdditionalSpawnData.html | 229 ++++ .../mods/fml/common/registry/IThrowableEntity.html | 227 ++++ .../IncompatibleSubstitutionException.html | 257 ++++ .../mods/fml/common/registry/LanguageRegistry.html | 498 +++++++ .../fml/common/registry/ObjectHolderRegistry.html | 332 +++++ .../common/registry/RegistryDelegate.Delegate.html | 368 ++++++ .../mods/fml/common/registry/RegistryDelegate.html | 271 ++++ .../VillagerRegistry.IVillageCreationHandler.html | 265 ++++ .../VillagerRegistry.IVillageTradeHandler.html | 219 ++++ .../mods/fml/common/registry/VillagerRegistry.html | 525 ++++++++ .../mods/fml/common/registry/package-frame.html | 49 + .../mods/fml/common/registry/package-summary.html | 268 ++++ .../cpw/mods/fml/common/registry/package-tree.html | 182 +++ .../cpw/mods/fml/common/toposort/ModSorter.html | 256 ++++ .../ModSortingException.SortingExceptionData.html | 275 ++++ .../fml/common/toposort/ModSortingException.html | 306 +++++ .../toposort/TopologicalSort.DirectedGraph.html | 391 ++++++ .../mods/fml/common/toposort/TopologicalSort.html | 321 +++++ .../mods/fml/common/toposort/package-frame.html | 25 + .../mods/fml/common/toposort/package-summary.html | 158 +++ .../cpw/mods/fml/common/toposort/package-tree.html | 142 ++ .../fml/common/versioning/ArtifactVersion.html | 261 ++++ .../fml/common/versioning/ComparableVersion.html | 351 +++++ .../common/versioning/DefaultArtifactVersion.html | 420 ++++++ .../InvalidVersionSpecificationException.html | 249 ++++ .../mods/fml/common/versioning/Restriction.html | 400 ++++++ .../mods/fml/common/versioning/VersionParser.html | 289 +++++ .../mods/fml/common/versioning/VersionRange.html | 479 +++++++ .../mods/fml/common/versioning/package-frame.html | 31 + .../fml/common/versioning/package-summary.html | 192 +++ .../mods/fml/common/versioning/package-tree.html | 147 +++ .../cpw/mods/fml/relauncher/CoreModManager.html | 336 +++++ javadoc/cpw/mods/fml/relauncher/FMLCorePlugin.html | 389 ++++++ .../cpw/mods/fml/relauncher/FMLInjectionData.html | 290 +++++ .../cpw/mods/fml/relauncher/FMLLaunchHandler.html | 263 ++++ .../cpw/mods/fml/relauncher/FMLRelaunchLog.html | 411 ++++++ .../FMLSecurityManager.ExitTrappedException.html | 262 ++++ .../mods/fml/relauncher/FMLSecurityManager.html | 306 +++++ .../cpw/mods/fml/relauncher/FileListHelper.html | 269 ++++ javadoc/cpw/mods/fml/relauncher/IFMLCallHook.html | 229 ++++ .../relauncher/IFMLLoadingPlugin.DependsOn.html | 202 +++ .../relauncher/IFMLLoadingPlugin.MCVersion.html | 204 +++ .../fml/relauncher/IFMLLoadingPlugin.Name.html | 203 +++ .../relauncher/IFMLLoadingPlugin.SortingIndex.html | 203 +++ .../IFMLLoadingPlugin.TransformerExclusions.html | 208 +++ .../cpw/mods/fml/relauncher/IFMLLoadingPlugin.html | 346 +++++ .../fml/relauncher/ModListHelper.JsonModList.html | 292 +++++ javadoc/cpw/mods/fml/relauncher/ModListHelper.html | 281 ++++ ...lectionHelper.UnableToAccessFieldException.html | 259 ++++ ...eflectionHelper.UnableToFindClassException.html | 259 ++++ ...eflectionHelper.UnableToFindFieldException.html | 259 ++++ ...flectionHelper.UnableToFindMethodException.html | 259 ++++ .../cpw/mods/fml/relauncher/ReflectionHelper.html | 404 ++++++ .../mods/fml/relauncher/ServerLaunchWrapper.html | 221 ++++ javadoc/cpw/mods/fml/relauncher/Side.html | 353 +++++ javadoc/cpw/mods/fml/relauncher/SideOnly.html | 206 +++ javadoc/cpw/mods/fml/relauncher/package-frame.html | 55 + .../cpw/mods/fml/relauncher/package-summary.html | 293 +++++ javadoc/cpw/mods/fml/relauncher/package-tree.html | 191 +++ .../nothome/delta/ByteBufferSeekableSource.html | 356 +++++ .../fml/repackage/com/nothome/delta/Checksum.html | 346 +++++ .../com/nothome/delta/DebugDiffWriter.html | 350 +++++ .../fml/repackage/com/nothome/delta/Delta.html | 451 +++++++ .../repackage/com/nothome/delta/DiffWriter.html | 286 +++++ .../repackage/com/nothome/delta/GDiffPatcher.html | 355 +++++ .../repackage/com/nothome/delta/GDiffWriter.html | 564 ++++++++ .../com/nothome/delta/PatchException.html | 273 ++++ .../delta/RandomAccessFileSeekableSource.html | 358 ++++++ .../com/nothome/delta/SeekableSource.html | 250 ++++ .../repackage/com/nothome/delta/package-frame.html | 34 + .../com/nothome/delta/package-summary.html | 210 +++ .../repackage/com/nothome/delta/package-tree.html | 158 +++ javadoc/cpw/mods/fml/server/FMLServerHandler.html | 586 +++++++++ javadoc/cpw/mods/fml/server/package-frame.html | 19 + javadoc/cpw/mods/fml/server/package-summary.html | 144 +++ javadoc/cpw/mods/fml/server/package-tree.html | 126 ++ 431 files changed, 135696 insertions(+) create mode 100644 javadoc/cpw/mods/fml/client/CustomModLoadingErrorDisplayException.html create mode 100644 javadoc/cpw/mods/fml/client/ExtendedServerListData.html create mode 100644 javadoc/cpw/mods/fml/client/FMLClientHandler.html create mode 100644 javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.FMLConfigGuiScreen.html create mode 100644 javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.html create mode 100644 javadoc/cpw/mods/fml/client/FMLFileResourcePack.html create mode 100644 javadoc/cpw/mods/fml/client/FMLFolderResourcePack.html create mode 100644 javadoc/cpw/mods/fml/client/GuiAccessDenied.html create mode 100644 javadoc/cpw/mods/fml/client/GuiBackupFailed.html create mode 100644 javadoc/cpw/mods/fml/client/GuiConfirmation.html create mode 100644 javadoc/cpw/mods/fml/client/GuiCustomModLoadingErrorScreen.html create mode 100644 javadoc/cpw/mods/fml/client/GuiDupesFound.html create mode 100644 javadoc/cpw/mods/fml/client/GuiIngameModOptions.html create mode 100644 javadoc/cpw/mods/fml/client/GuiModList.html create mode 100644 javadoc/cpw/mods/fml/client/GuiModOptionList.html create mode 100644 javadoc/cpw/mods/fml/client/GuiModsMissing.html create mode 100644 javadoc/cpw/mods/fml/client/GuiModsMissingForServer.html create mode 100644 javadoc/cpw/mods/fml/client/GuiNotification.html create mode 100644 javadoc/cpw/mods/fml/client/GuiOldSaveLoadConfirm.html create mode 100644 javadoc/cpw/mods/fml/client/GuiScrollingList.html create mode 100644 javadoc/cpw/mods/fml/client/GuiSlotModList.html create mode 100644 javadoc/cpw/mods/fml/client/GuiSortingProblem.html create mode 100644 javadoc/cpw/mods/fml/client/GuiWrongMinecraft.html create mode 100644 javadoc/cpw/mods/fml/client/IModGuiFactory.RuntimeOptionCategoryElement.html create mode 100644 javadoc/cpw/mods/fml/client/IModGuiFactory.RuntimeOptionGuiHandler.html create mode 100644 javadoc/cpw/mods/fml/client/IModGuiFactory.html create mode 100644 javadoc/cpw/mods/fml/client/config/ConfigGuiType.html create mode 100644 javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyCategoryElement.html create mode 100644 javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyListElement.html create mode 100644 javadoc/cpw/mods/fml/client/config/DummyConfigElement.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiButtonExt.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiCheckBox.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfig.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ArrayEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.BooleanEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ButtonEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CategoryEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ChatColorEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CycleValueEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.DoubleEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IntegerEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ListEntryBase.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.NumberSliderEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.SelectValueEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.StringEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArray.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BaseEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BooleanEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.DoubleEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IntegerEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.StringEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiMessageDialog.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSelectString.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.EntryComparator.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.IGuiSelectStringListEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.ListEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSlider.ISlider.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSlider.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiUnicodeGlyphButton.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiUtils.html create mode 100644 javadoc/cpw/mods/fml/client/config/HoverChecker.html create mode 100644 javadoc/cpw/mods/fml/client/config/IConfigElement.html create mode 100644 javadoc/cpw/mods/fml/client/config/package-frame.html create mode 100644 javadoc/cpw/mods/fml/client/config/package-summary.html create mode 100644 javadoc/cpw/mods/fml/client/config/package-tree.html create mode 100644 javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.OnConfigChangedEvent.html create mode 100644 javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.PostConfigChangedEvent.html create mode 100644 javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.html create mode 100644 javadoc/cpw/mods/fml/client/event/package-frame.html create mode 100644 javadoc/cpw/mods/fml/client/event/package-summary.html create mode 100644 javadoc/cpw/mods/fml/client/event/package-tree.html create mode 100644 javadoc/cpw/mods/fml/client/package-frame.html create mode 100644 javadoc/cpw/mods/fml/client/package-summary.html create mode 100644 javadoc/cpw/mods/fml/client/package-tree.html create mode 100644 javadoc/cpw/mods/fml/client/registry/ClientRegistry.html create mode 100644 javadoc/cpw/mods/fml/client/registry/ISimpleBlockRenderingHandler.html create mode 100644 javadoc/cpw/mods/fml/client/registry/RenderingRegistry.html create mode 100644 javadoc/cpw/mods/fml/client/registry/package-frame.html create mode 100644 javadoc/cpw/mods/fml/client/registry/package-summary.html create mode 100644 javadoc/cpw/mods/fml/client/registry/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/API.html create mode 100644 javadoc/cpw/mods/fml/common/BukkitPluginRef.html create mode 100644 javadoc/cpw/mods/fml/common/BukkitProxy.html create mode 100644 javadoc/cpw/mods/fml/common/CertificateHelper.html create mode 100644 javadoc/cpw/mods/fml/common/DummyModContainer.html create mode 100644 javadoc/cpw/mods/fml/common/DuplicateModsFoundException.html create mode 100644 javadoc/cpw/mods/fml/common/FMLCommonHandler.html create mode 100644 javadoc/cpw/mods/fml/common/FMLContainer.html create mode 100644 javadoc/cpw/mods/fml/common/FMLLog.html create mode 100644 javadoc/cpw/mods/fml/common/FMLModContainer.html create mode 100644 javadoc/cpw/mods/fml/common/IASMHook.html create mode 100644 javadoc/cpw/mods/fml/common/ICrashCallable.html create mode 100644 javadoc/cpw/mods/fml/common/IFMLHandledException.html create mode 100644 javadoc/cpw/mods/fml/common/IFMLSidedHandler.html create mode 100644 javadoc/cpw/mods/fml/common/IFuelHandler.html create mode 100644 javadoc/cpw/mods/fml/common/ILanguageAdapter.JavaAdapter.html create mode 100644 javadoc/cpw/mods/fml/common/ILanguageAdapter.ScalaAdapter.html create mode 100644 javadoc/cpw/mods/fml/common/ILanguageAdapter.html create mode 100644 javadoc/cpw/mods/fml/common/IWorldGenerator.html create mode 100644 javadoc/cpw/mods/fml/common/InjectedModContainer.html create mode 100644 javadoc/cpw/mods/fml/common/LoadController.html create mode 100644 javadoc/cpw/mods/fml/common/Loader.html create mode 100644 javadoc/cpw/mods/fml/common/LoaderException.html create mode 100644 javadoc/cpw/mods/fml/common/LoaderState.ModState.html create mode 100644 javadoc/cpw/mods/fml/common/LoaderState.html create mode 100644 javadoc/cpw/mods/fml/common/MCPDummyContainer.html create mode 100644 javadoc/cpw/mods/fml/common/MetadataCollection.ArtifactVersionAdapter.html create mode 100644 javadoc/cpw/mods/fml/common/MetadataCollection.html create mode 100644 javadoc/cpw/mods/fml/common/MinecraftDummyContainer.html create mode 100644 javadoc/cpw/mods/fml/common/MissingModsException.html create mode 100644 javadoc/cpw/mods/fml/common/Mod.CustomProperty.html create mode 100644 javadoc/cpw/mods/fml/common/Mod.EventHandler.html create mode 100644 javadoc/cpw/mods/fml/common/Mod.Instance.html create mode 100644 javadoc/cpw/mods/fml/common/Mod.InstanceFactory.html create mode 100644 javadoc/cpw/mods/fml/common/Mod.Metadata.html create mode 100644 javadoc/cpw/mods/fml/common/Mod.html create mode 100644 javadoc/cpw/mods/fml/common/ModAPIManager.html create mode 100644 javadoc/cpw/mods/fml/common/ModClassLoader.html create mode 100644 javadoc/cpw/mods/fml/common/ModContainer.Disableable.html create mode 100644 javadoc/cpw/mods/fml/common/ModContainer.html create mode 100644 javadoc/cpw/mods/fml/common/ModContainerFactory.html create mode 100644 javadoc/cpw/mods/fml/common/ModMetadata.html create mode 100644 javadoc/cpw/mods/fml/common/ObfuscationReflectionHelper.html create mode 100644 javadoc/cpw/mods/fml/common/Optional.Interface.html create mode 100644 javadoc/cpw/mods/fml/common/Optional.InterfaceList.html create mode 100644 javadoc/cpw/mods/fml/common/Optional.Method.html create mode 100644 javadoc/cpw/mods/fml/common/Optional.html create mode 100644 javadoc/cpw/mods/fml/common/ProxyInjector.html create mode 100644 javadoc/cpw/mods/fml/common/SaveInspectionHandler.html create mode 100644 javadoc/cpw/mods/fml/common/SidedProxy.html create mode 100644 javadoc/cpw/mods/fml/common/StartupQuery.AbortedException.html create mode 100644 javadoc/cpw/mods/fml/common/StartupQuery.html create mode 100644 javadoc/cpw/mods/fml/common/TracingPrintStream.html create mode 100644 javadoc/cpw/mods/fml/common/WorldAccessContainer.html create mode 100644 javadoc/cpw/mods/fml/common/WrongMinecraftVersionException.html create mode 100644 javadoc/cpw/mods/fml/common/ZipperUtil.html create mode 100644 javadoc/cpw/mods/fml/common/asm/FMLSanityChecker.html create mode 100644 javadoc/cpw/mods/fml/common/asm/ReobfuscationMarker.html create mode 100644 javadoc/cpw/mods/fml/common/asm/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/asm/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/asm/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/AccessTransformer.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/DeobfuscationTransformer.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/EventSubscriptionTransformer.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/ItemStackTransformer.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/MarkerTransformer.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/ModAPITransformer.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/ModAccessTransformer.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/PatchingTransformer.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/SideTransformer.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/TerminalTransformer.ExitVisitor.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/TerminalTransformer.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/deobf/FMLDeobfuscatingRemapper.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/deobf/FMLRemappingAdapter.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/deobf/LZMAInputSupplier.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/deobf/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/deobf/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/deobf/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/asm/transformers/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/ASMDataTable.ASMData.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/ASMDataTable.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/ContainerType.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/DirectoryDiscoverer.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/ITypeDiscoverer.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/JarDiscoverer.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/ModCandidate.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/ModDiscoverer.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/asm/ASMModParser.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/asm/ModAnnotation.EnumHolder.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/asm/ModAnnotation.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/asm/ModAnnotationVisitor.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/asm/ModClassVisitor.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/asm/ModFieldVisitor.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/asm/ModMethodVisitor.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/asm/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/asm/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/asm/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/discovery/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLConstructionEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLFingerprintViolationEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLInitializationEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLInterModComms.IMCEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLInterModComms.IMCMessage.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLInterModComms.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLLoadCompleteEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLLoadEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLMissingMappingsEvent.Action.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLMissingMappingsEvent.MissingMapping.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLMissingMappingsEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLModDisabledEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLModIdMappingEvent.ModRemapping.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLModIdMappingEvent.RemapTarget.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLModIdMappingEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLPostInitializationEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLPreInitializationEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLServerAboutToStartEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLServerStartedEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLServerStartingEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLServerStoppedEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLServerStoppingEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/FMLStateEvent.html create mode 100644 javadoc/cpw/mods/fml/common/event/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/event/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/event/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/ASMEventHandler.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/Cancelable.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/Event.HasResult.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/Event.Result.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/Event.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/EventBus.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/EventPriority.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/IEventExceptionHandler.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/IEventListener.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/ListenerList.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/SubscribeEvent.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/eventhandler/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/functions/ArtifactVersionNameFunction.html create mode 100644 javadoc/cpw/mods/fml/common/functions/CollectionWrapperFactory.html create mode 100644 javadoc/cpw/mods/fml/common/functions/GenericIterableFactory.html create mode 100644 javadoc/cpw/mods/fml/common/functions/ModIdFunction.html create mode 100644 javadoc/cpw/mods/fml/common/functions/ModNameFunction.html create mode 100644 javadoc/cpw/mods/fml/common/functions/TypeCastFunction.html create mode 100644 javadoc/cpw/mods/fml/common/functions/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/functions/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/functions/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/InputEvent.KeyInputEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/InputEvent.MouseInputEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/InputEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.ItemCraftedEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.ItemPickupEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.ItemSmeltedEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerChangedDimensionEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerLoggedInEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerLoggedOutEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerRespawnEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/TickEvent.ClientTickEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/TickEvent.Phase.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/TickEvent.PlayerTickEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/TickEvent.RenderTickEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/TickEvent.ServerTickEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/TickEvent.Type.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/TickEvent.WorldTickEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/TickEvent.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/gameevent/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/launcher/FMLDeobfTweaker.html create mode 100644 javadoc/cpw/mods/fml/common/launcher/FMLInjectionAndSortingTweaker.html create mode 100644 javadoc/cpw/mods/fml/common/launcher/FMLServerTweaker.html create mode 100644 javadoc/cpw/mods/fml/common/launcher/FMLTweaker.html create mode 100644 javadoc/cpw/mods/fml/common/launcher/TerminalTweaker.html create mode 100644 javadoc/cpw/mods/fml/common/launcher/Yggdrasil.html create mode 100644 javadoc/cpw/mods/fml/common/launcher/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/launcher/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/launcher/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/network/ByteBufUtils.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLEmbeddedChannel.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLEventChannel.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientConnectedToServerEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientCustomPacketEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientDisconnectionFromServerEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomNetworkEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketRegistrationEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerConnectionFromClientEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerCustomPacketEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerDisconnectionFromClientEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkException.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.OutboundTarget.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/IGuiHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/NetworkCheckHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/NetworkEventFiringHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/NetworkHandshakeEstablished.html create mode 100644 javadoc/cpw/mods/fml/common/network/NetworkRegistry.TargetPoint.html create mode 100644 javadoc/cpw/mods/fml/common/network/NetworkRegistry.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/ChannelRegistrationHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeCodec.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ClientHello.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeAck.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeReset.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModIdData.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModList.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ServerHello.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/HandshakeInjector.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/HandshakeMessageHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/IHandshakeState.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/NetworkDispatcher.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/EntitySpawnHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLMessage.CompleteHandshake.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityAdjustMessage.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityMessage.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntitySpawnMessage.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLMessage.OpenGui.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLMessage.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLNetworkHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLProxyPacket.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLRuntimeCodec.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/HandshakeCompletionHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.NetworkChecker.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/OpenGuiHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/network/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/network/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/network/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/IMessage.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/IMessageHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/MessageContext.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleChannelHandlerWrapper.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleIndexedCodec.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleNetworkWrapper.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/patcher/ClassPatch.html create mode 100644 javadoc/cpw/mods/fml/common/patcher/ClassPatchManager.html create mode 100644 javadoc/cpw/mods/fml/common/patcher/GenDiffSet.html create mode 100644 javadoc/cpw/mods/fml/common/patcher/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/patcher/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/patcher/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/registry/EntityRegistry.EntityRegistration.html create mode 100644 javadoc/cpw/mods/fml/common/registry/EntityRegistry.html create mode 100644 javadoc/cpw/mods/fml/common/registry/ExistingSubstitutionException.html create mode 100644 javadoc/cpw/mods/fml/common/registry/FMLControlledNamespacedRegistry.html create mode 100644 javadoc/cpw/mods/fml/common/registry/GameData.GameDataSnapshot.html create mode 100644 javadoc/cpw/mods/fml/common/registry/GameData.html create mode 100644 javadoc/cpw/mods/fml/common/registry/GameRegistry.ObjectHolder.html create mode 100644 javadoc/cpw/mods/fml/common/registry/GameRegistry.Type.html create mode 100644 javadoc/cpw/mods/fml/common/registry/GameRegistry.UniqueIdentifier.html create mode 100644 javadoc/cpw/mods/fml/common/registry/GameRegistry.html create mode 100644 javadoc/cpw/mods/fml/common/registry/IEntityAdditionalSpawnData.html create mode 100644 javadoc/cpw/mods/fml/common/registry/IThrowableEntity.html create mode 100644 javadoc/cpw/mods/fml/common/registry/IncompatibleSubstitutionException.html create mode 100644 javadoc/cpw/mods/fml/common/registry/LanguageRegistry.html create mode 100644 javadoc/cpw/mods/fml/common/registry/ObjectHolderRegistry.html create mode 100644 javadoc/cpw/mods/fml/common/registry/RegistryDelegate.Delegate.html create mode 100644 javadoc/cpw/mods/fml/common/registry/RegistryDelegate.html create mode 100644 javadoc/cpw/mods/fml/common/registry/VillagerRegistry.IVillageCreationHandler.html create mode 100644 javadoc/cpw/mods/fml/common/registry/VillagerRegistry.IVillageTradeHandler.html create mode 100644 javadoc/cpw/mods/fml/common/registry/VillagerRegistry.html create mode 100644 javadoc/cpw/mods/fml/common/registry/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/registry/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/registry/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/toposort/ModSorter.html create mode 100644 javadoc/cpw/mods/fml/common/toposort/ModSortingException.SortingExceptionData.html create mode 100644 javadoc/cpw/mods/fml/common/toposort/ModSortingException.html create mode 100644 javadoc/cpw/mods/fml/common/toposort/TopologicalSort.DirectedGraph.html create mode 100644 javadoc/cpw/mods/fml/common/toposort/TopologicalSort.html create mode 100644 javadoc/cpw/mods/fml/common/toposort/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/toposort/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/toposort/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/versioning/ArtifactVersion.html create mode 100644 javadoc/cpw/mods/fml/common/versioning/ComparableVersion.html create mode 100644 javadoc/cpw/mods/fml/common/versioning/DefaultArtifactVersion.html create mode 100644 javadoc/cpw/mods/fml/common/versioning/InvalidVersionSpecificationException.html create mode 100644 javadoc/cpw/mods/fml/common/versioning/Restriction.html create mode 100644 javadoc/cpw/mods/fml/common/versioning/VersionParser.html create mode 100644 javadoc/cpw/mods/fml/common/versioning/VersionRange.html create mode 100644 javadoc/cpw/mods/fml/common/versioning/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/versioning/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/versioning/package-tree.html create mode 100644 javadoc/cpw/mods/fml/relauncher/CoreModManager.html create mode 100644 javadoc/cpw/mods/fml/relauncher/FMLCorePlugin.html create mode 100644 javadoc/cpw/mods/fml/relauncher/FMLInjectionData.html create mode 100644 javadoc/cpw/mods/fml/relauncher/FMLLaunchHandler.html create mode 100644 javadoc/cpw/mods/fml/relauncher/FMLRelaunchLog.html create mode 100644 javadoc/cpw/mods/fml/relauncher/FMLSecurityManager.ExitTrappedException.html create mode 100644 javadoc/cpw/mods/fml/relauncher/FMLSecurityManager.html create mode 100644 javadoc/cpw/mods/fml/relauncher/FileListHelper.html create mode 100644 javadoc/cpw/mods/fml/relauncher/IFMLCallHook.html create mode 100644 javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.DependsOn.html create mode 100644 javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.MCVersion.html create mode 100644 javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.Name.html create mode 100644 javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.SortingIndex.html create mode 100644 javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.TransformerExclusions.html create mode 100644 javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.html create mode 100644 javadoc/cpw/mods/fml/relauncher/ModListHelper.JsonModList.html create mode 100644 javadoc/cpw/mods/fml/relauncher/ModListHelper.html create mode 100644 javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToAccessFieldException.html create mode 100644 javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToFindClassException.html create mode 100644 javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToFindFieldException.html create mode 100644 javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToFindMethodException.html create mode 100644 javadoc/cpw/mods/fml/relauncher/ReflectionHelper.html create mode 100644 javadoc/cpw/mods/fml/relauncher/ServerLaunchWrapper.html create mode 100644 javadoc/cpw/mods/fml/relauncher/Side.html create mode 100644 javadoc/cpw/mods/fml/relauncher/SideOnly.html create mode 100644 javadoc/cpw/mods/fml/relauncher/package-frame.html create mode 100644 javadoc/cpw/mods/fml/relauncher/package-summary.html create mode 100644 javadoc/cpw/mods/fml/relauncher/package-tree.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/ByteBufferSeekableSource.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/Checksum.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/DebugDiffWriter.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/Delta.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/DiffWriter.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/GDiffPatcher.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/GDiffWriter.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/PatchException.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/RandomAccessFileSeekableSource.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/SeekableSource.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/package-frame.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/package-summary.html create mode 100644 javadoc/cpw/mods/fml/repackage/com/nothome/delta/package-tree.html create mode 100644 javadoc/cpw/mods/fml/server/FMLServerHandler.html create mode 100644 javadoc/cpw/mods/fml/server/package-frame.html create mode 100644 javadoc/cpw/mods/fml/server/package-summary.html create mode 100644 javadoc/cpw/mods/fml/server/package-tree.html (limited to 'javadoc/cpw') diff --git a/javadoc/cpw/mods/fml/client/CustomModLoadingErrorDisplayException.html b/javadoc/cpw/mods/fml/client/CustomModLoadingErrorDisplayException.html new file mode 100644 index 0000000..cb82220 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/CustomModLoadingErrorDisplayException.html @@ -0,0 +1,336 @@ + + + + + +CustomModLoadingErrorDisplayException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class CustomModLoadingErrorDisplayException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IFMLHandledException, java.io.Serializable
    +
    +
    +
    +
    public abstract class CustomModLoadingErrorDisplayException
+extends java.lang.RuntimeException
+implements IFMLHandledException
    +
    If a mod throws this exception during loading, it will be called back to render + the error screen through the methods below. This error will not be cleared, and will + not allow the game to carry on, but might be useful if your mod wishes to report + a fatal configuration error in a pretty way. + + Throw this through a proxy. It won't work on the dedicated server environment.
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      abstract voiddrawScreen(GuiErrorScreen errorScreen, + FontRenderer fontRenderer, + int mouseRelX, + int mouseRelY, + float tickTime) +
      Draw your error to the screen.
      +
      abstract voidinitGui(GuiErrorScreen errorScreen, + FontRenderer fontRenderer) +
      Called after the GUI is inited by the parent code.
      +
      +
        +
      • + + +

        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

      + + + +
        +
      • +

        CustomModLoadingErrorDisplayException

        +
        public CustomModLoadingErrorDisplayException()
        +
        • +
      + + + +
        +
      • +

        CustomModLoadingErrorDisplayException

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

      Method Detail

      + + + +
        +
      • +

        initGui

        +
        public abstract void initGui(GuiErrorScreen errorScreen,
+           FontRenderer fontRenderer)
        +
        Called after the GUI is inited by the parent code. You can do extra stuff here, maybe?
        +
        Parameters:
        errorScreen - The error screen we're painting
        fontRenderer - A font renderer for you
        +
        • +
      + + + +
        +
      • +

        drawScreen

        +
        public abstract void drawScreen(GuiErrorScreen errorScreen,
+              FontRenderer fontRenderer,
+              int mouseRelX,
+              int mouseRelY,
+              float tickTime)
        +
        Draw your error to the screen. + +
        Warning: Minecraft is in a deep error state. All it can do is stop. + Do not try and do anything involving complex user interaction here.
        +
        Parameters:
        errorScreen - The error screen to draw to
        fontRenderer - A font renderer for you
        mouseRelX - Mouse X
        mouseRelY - Mouse Y
        tickTime - tick time
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/ExtendedServerListData.html b/javadoc/cpw/mods/fml/client/ExtendedServerListData.html new file mode 100644 index 0000000..55afaec --- /dev/null +++ b/javadoc/cpw/mods/fml/client/ExtendedServerListData.html @@ -0,0 +1,307 @@ + + + + + +ExtendedServerListData (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class ExtendedServerListData

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

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      booleanisBlocked 
      booleanisCompatible 
      java.util.Map<java.lang.String,java.lang.String>modData 
      java.lang.Stringtype 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ExtendedServerListData(java.lang.String type, + boolean isCompatible, + java.util.Map<java.lang.String,java.lang.String> modData, + boolean isBlocked) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        type

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

        isCompatible

        +
        public final boolean isCompatible
        +
        • +
      + + + +
        +
      • +

        modData

        +
        public final java.util.Map<java.lang.String,java.lang.String> modData
        +
        • +
      + + + +
        +
      • +

        isBlocked

        +
        public final boolean isBlocked
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ExtendedServerListData

        +
        public ExtendedServerListData(java.lang.String type,
+                      boolean isCompatible,
+                      java.util.Map<java.lang.String,java.lang.String> modData,
+                      boolean isBlocked)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/FMLClientHandler.html b/javadoc/cpw/mods/fml/client/FMLClientHandler.html new file mode 100644 index 0000000..d363d40 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/FMLClientHandler.html @@ -0,0 +1,1057 @@ + + + + + +FMLClientHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class FMLClientHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IFMLSidedHandler
    +
    +
    +
    +
    public class FMLClientHandler
+extends java.lang.Object
+implements IFMLSidedHandler
    +
    Handles primary communication from hooked code into the system + + The FML entry point is #beginMinecraftLoading(Minecraft, List) called from + Minecraft + + Obfuscated code should focus on this class and other members of the "server" + (or "client") code + + The actual mod loading is handled at arms length by Loader + + It is expected that a similar class will exist for each target environment: + Bukkit and Client side. + + It should not be directly modified.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLClientHandler

        +
        public FMLClientHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        beginMinecraftLoading

        +
        public void beginMinecraftLoading(Minecraft minecraft,
+                         java.util.List resourcePackList,
+                         IReloadableResourceManager resourceManager)
        +
        Called to start the whole game off
        +
        Parameters:
        minecraft - The minecraft instance being launched
        resourcePackList - The resource pack list we will populate with mods
        resourceManager - The resource manager
        +
        • +
      + + + +
        +
      • +

        haltGame

        +
        public void haltGame(java.lang.String message,
+            java.lang.Throwable t)
        +
        +
        Specified by:
        +
        haltGame in interface IFMLSidedHandler
        +
        +
        • +
      + + + +
        +
      • +

        finishMinecraftLoading

        +
        public void finishMinecraftLoading()
        +
        Called a bit later on during initialization to finish loading mods + Also initializes key bindings
        +
        • +
      + + + +
        +
      • +

        extendModList

        +
        public void extendModList()
        +
        • +
      + + + +
        +
      • +

        onInitializationComplete

        +
        public void onInitializationComplete()
        +
        • +
      + + + +
        +
      • +

        getClient

        +
        public Minecraft getClient()
        +
        Get the server instance
        +
        • +
      + + + +
        +
      • +

        instance

        +
        public static FMLClientHandler instance()
        +
        Returns:
        the instance
        +
        • +
      + + + +
        +
      • +

        displayGuiScreen

        +
        public void displayGuiScreen(EntityPlayer player,
+                    GuiScreen gui)
        +
        Parameters:
        player -
        gui -
        +
        • +
      + + + +
        +
      • +

        addSpecialModEntries

        +
        public void addSpecialModEntries(java.util.ArrayList<ModContainer> mods)
        +
        Parameters:
        mods -
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        hasOptifine

        +
        public boolean hasOptifine()
        +
        • +
      + + + +
        +
      • +

        showGuiScreen

        +
        public void showGuiScreen(java.lang.Object clientGuiElement)
        +
        +
        Specified by:
        +
        showGuiScreen in interface IFMLSidedHandler
        +
        +
        • +
      + + + +
        +
      • +

        queryUser

        +
        public void queryUser(StartupQuery query)
+               throws java.lang.InterruptedException
        +
        +
        Specified by:
        +
        queryUser in interface IFMLSidedHandler
        +
        Throws:
        +
        java.lang.InterruptedException
        +
        • +
      + + + +
        +
      • +

        handleLoadingScreen

        +
        public boolean handleLoadingScreen(ScaledResolution scaledResolution)
        +
        • +
      + + + +
        +
      • +

        getWorldClient

        +
        public WorldClient getWorldClient()
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        displayMissingMods

        +
        public void displayMissingMods(java.lang.Object modMissingPacket)
        +
        • +
      + + + +
        +
      • +

        isLoading

        +
        public boolean isLoading()
        +
        If the client is in the midst of loading, we disable saving so that custom settings aren't wiped out
        +
        • +
      + + + + + + + +
        +
      • +

        isGUIOpen

        +
        public boolean isGUIOpen(java.lang.Class<? extends GuiScreen> gui)
        +
        Is this GUI type open?
        +
        Parameters:
        gui - The type of GUI to test for
        +
        Returns:
        if a GUI of this type is open
        +
        • +
      + + + + + + + +
        +
      • +

        getResourcePackFor

        +
        public IResourcePack getResourcePackFor(java.lang.String modId)
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        handleClientWorldClosing

        +
        public void handleClientWorldClosing(WorldClient world)
        +
        • +
      + + + +
        +
      • +

        startIntegratedServer

        +
        public void startIntegratedServer(java.lang.String id,
+                         java.lang.String name,
+                         WorldSettings settings)
        +
        • +
      + + + +
        +
      • +

        getSavesDir

        +
        public java.io.File getSavesDir()
        +
        • +
      + + + +
        +
      • +

        tryLoadExistingWorld

        +
        public void tryLoadExistingWorld(GuiSelectWorld selectWorldGUI,
+                        java.lang.String dirName,
+                        java.lang.String saveName)
        +
        • +
      + + + +
        +
      • +

        showInGameModOptions

        +
        public void showInGameModOptions(GuiIngameMenu guiIngameMenu)
        +
        • +
      + + + + + + + +
        +
      • +

        setupServerList

        +
        public void setupServerList()
        +
        • +
      + + + +
        +
      • +

        captureAdditionalData

        +
        public void captureAdditionalData(ServerStatusResponse serverstatusresponse,
+                         com.google.gson.JsonObject jsonobject)
        +
        • +
      + + + + + + + +
        +
      • +

        enhanceServerListEntry

        +
        public java.lang.String enhanceServerListEntry(ServerListEntryNormal serverListEntry,
+                                      ServerData serverEntry,
+                                      int x,
+                                      int width,
+                                      int y,
+                                      int relativeMouseX,
+                                      int relativeMouseY)
        +
        • +
      + + + +
        +
      • +

        fixDescription

        +
        public java.lang.String fixDescription(java.lang.String description)
        +
        • +
      + + + +
        +
      • +

        connectToServerAtStartup

        +
        public void connectToServerAtStartup(java.lang.String host,
+                            int port)
        +
        • +
      + + + +
        +
      • +

        connectToServer

        +
        public void connectToServer(GuiScreen guiMultiplayer,
+                   ServerData serverEntry)
        +
        • +
      + + + +
        +
      • +

        connectToRealmsServer

        +
        public void connectToRealmsServer(java.lang.String host,
+                         int port)
        +
        • +
      + + + + + + + + + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.FMLConfigGuiScreen.html b/javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.FMLConfigGuiScreen.html new file mode 100644 index 0000000..c9a6516 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.FMLConfigGuiScreen.html @@ -0,0 +1,295 @@ + + + + + +FMLConfigGuiFactory.FMLConfigGuiScreen (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client
+

Class FMLConfigGuiFactory.FMLConfigGuiScreen

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

      Constructor Detail

      + + + +
        +
      • +

        FMLConfigGuiFactory.FMLConfigGuiScreen

        +
        public FMLConfigGuiFactory.FMLConfigGuiScreen(GuiScreen parent)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.html b/javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.html new file mode 100644 index 0000000..5f3605c --- /dev/null +++ b/javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.html @@ -0,0 +1,391 @@ + + + + + +FMLConfigGuiFactory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class FMLConfigGuiFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IModGuiFactory
    +
    +
    +
    +
    public class FMLConfigGuiFactory
+extends java.lang.Object
+implements IModGuiFactory
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLConfigGuiFactory

        +
        public FMLConfigGuiFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      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/cpw/mods/fml/client/FMLFileResourcePack.html b/javadoc/cpw/mods/fml/client/FMLFileResourcePack.html new file mode 100644 index 0000000..ac99c67 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/FMLFileResourcePack.html @@ -0,0 +1,350 @@ + + + + + +FMLFileResourcePack (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class FMLFileResourcePack

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.lang.AutoCloseable, IResourcePack
    +
    +
    +
    +
    public class FMLFileResourcePack
+extends FileResourcePack
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/FMLFolderResourcePack.html b/javadoc/cpw/mods/fml/client/FMLFolderResourcePack.html new file mode 100644 index 0000000..ea3a63d --- /dev/null +++ b/javadoc/cpw/mods/fml/client/FMLFolderResourcePack.html @@ -0,0 +1,360 @@ + + + + + +FMLFolderResourcePack (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class FMLFolderResourcePack

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiAccessDenied.html b/javadoc/cpw/mods/fml/client/GuiAccessDenied.html new file mode 100644 index 0000000..411f3c2 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiAccessDenied.html @@ -0,0 +1,344 @@ + + + + + +GuiAccessDenied (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiAccessDenied

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiAccessDenied
+extends GuiScreen
    +
    • +
+
+
+ +
+
+
    +
  • + + + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiBackupFailed.html b/javadoc/cpw/mods/fml/client/GuiBackupFailed.html new file mode 100644 index 0000000..a7b4f27 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiBackupFailed.html @@ -0,0 +1,344 @@ + + + + + +GuiBackupFailed (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiBackupFailed

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiBackupFailed
+extends GuiScreen
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiBackupFailed

        +
        public GuiBackupFailed(GuiScreen parent,
+               java.io.File zipName)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiConfirmation.html b/javadoc/cpw/mods/fml/client/GuiConfirmation.html new file mode 100644 index 0000000..82c7230 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiConfirmation.html @@ -0,0 +1,340 @@ + + + + + +GuiConfirmation (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiConfirmation

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiCustomModLoadingErrorScreen.html b/javadoc/cpw/mods/fml/client/GuiCustomModLoadingErrorScreen.html new file mode 100644 index 0000000..939d8c1 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiCustomModLoadingErrorScreen.html @@ -0,0 +1,337 @@ + + + + + +GuiCustomModLoadingErrorScreen (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiCustomModLoadingErrorScreen

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiCustomModLoadingErrorScreen
+extends GuiErrorScreen
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiDupesFound.html b/javadoc/cpw/mods/fml/client/GuiDupesFound.html new file mode 100644 index 0000000..aa3913f --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiDupesFound.html @@ -0,0 +1,337 @@ + + + + + +GuiDupesFound (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiDupesFound

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiIngameModOptions.html b/javadoc/cpw/mods/fml/client/GuiIngameModOptions.html new file mode 100644 index 0000000..7bb5a4b --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiIngameModOptions.html @@ -0,0 +1,370 @@ + + + + + +GuiIngameModOptions (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiIngameModOptions

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiIngameModOptions
+extends GuiScreen
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        title

        +
        protected java.lang.String title
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiIngameModOptions

        +
        public GuiIngameModOptions(GuiScreen parentScreen)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initGui

        +
        public void initGui()
        +
        +
        Overrides:
        +
        initGui in class GuiScreen
        +
        +
        • +
      + + + + + + + +
        +
      • +

        drawScreen

        +
        public void drawScreen(int p_73863_1_,
+              int p_73863_2_,
+              float p_73863_3_)
        +
        +
        Overrides:
        +
        drawScreen in class GuiScreen
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiModList.html b/javadoc/cpw/mods/fml/client/GuiModList.html new file mode 100644 index 0000000..08dfee2 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiModList.html @@ -0,0 +1,387 @@ + + + + + +GuiModList (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiModList

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiModList
+extends GuiScreen
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiModList

        +
        public GuiModList(GuiScreen mainMenu)
        +
        Parameters:
        mainMenu -
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initGui

        +
        public void initGui()
        +
        +
        Overrides:
        +
        initGui in class GuiScreen
        +
        +
        • +
      + + + + + + + +
        +
      • +

        drawLine

        +
        public int drawLine(java.lang.String line,
+           int offset,
+           int shifty)
        +
        • +
      + + + +
        +
      • +

        drawScreen

        +
        public void drawScreen(int p_571_1_,
+              int p_571_2_,
+              float p_571_3_)
        +
        +
        Overrides:
        +
        drawScreen in class GuiScreen
        +
        +
        • +
      + + + +
        +
      • +

        selectModIndex

        +
        public void selectModIndex(int var1)
        +
        Parameters:
        var1 -
        +
        • +
      + + + +
        +
      • +

        modIndexSelected

        +
        public boolean modIndexSelected(int var1)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiModOptionList.html b/javadoc/cpw/mods/fml/client/GuiModOptionList.html new file mode 100644 index 0000000..5b43fa8 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiModOptionList.html @@ -0,0 +1,363 @@ + + + + + +GuiModOptionList (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiModOptionList

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiModsMissing.html b/javadoc/cpw/mods/fml/client/GuiModsMissing.html new file mode 100644 index 0000000..4c4d4a5 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiModsMissing.html @@ -0,0 +1,337 @@ + + + + + +GuiModsMissing (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiModsMissing

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiModsMissingForServer.html b/javadoc/cpw/mods/fml/client/GuiModsMissingForServer.html new file mode 100644 index 0000000..3602df0 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiModsMissingForServer.html @@ -0,0 +1,342 @@ + + + + + +GuiModsMissingForServer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiModsMissingForServer

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiModsMissingForServer
+extends GuiScreen
    +
    • +
+
+
+ +
+
+
    +
  • + + + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiNotification.html b/javadoc/cpw/mods/fml/client/GuiNotification.html new file mode 100644 index 0000000..136db8a --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiNotification.html @@ -0,0 +1,374 @@ + + + + + +GuiNotification (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiNotification

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

      Constructor Detail

      + + + +
        +
      • +

        GuiNotification

        +
        public GuiNotification(StartupQuery query)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiOldSaveLoadConfirm.html b/javadoc/cpw/mods/fml/client/GuiOldSaveLoadConfirm.html new file mode 100644 index 0000000..656bb81 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiOldSaveLoadConfirm.html @@ -0,0 +1,360 @@ + + + + + +GuiOldSaveLoadConfirm (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiOldSaveLoadConfirm

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

      Constructor Detail

      + + + +
        +
      • +

        GuiOldSaveLoadConfirm

        +
        public GuiOldSaveLoadConfirm(java.lang.String dirName,
+                     java.lang.String saveName,
+                     GuiScreen parent)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        drawScreen

        +
        public void drawScreen(int p_73863_1_,
+              int p_73863_2_,
+              float p_73863_3_)
        +
        +
        Overrides:
        +
        drawScreen in class GuiYesNo
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiScrollingList.html b/javadoc/cpw/mods/fml/client/GuiScrollingList.html new file mode 100644 index 0000000..43455cf --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiScrollingList.html @@ -0,0 +1,632 @@ + + + + + +GuiScrollingList (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiScrollingList

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

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected intbottom 
      protected intleft 
      protected intlistHeight 
      protected intlistWidth 
      protected intmouseX 
      protected intmouseY 
      protected intslotHeight 
      protected inttop 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      GuiScrollingList(Minecraft client, + int width, + int height, + int top, + int bottom, + int left, + int entryHeight) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidactionPerformed(GuiButton button) 
      protected abstract voiddrawBackground() 
      protected voiddrawGradientRect(int par1, + int par2, + int par3, + int par4, + int par5, + int par6) 
      voiddrawScreen(int mouseX, + int mouseY, + float p_22243_3_) 
      protected abstract voiddrawSlot(int var1, + int var2, + int var3, + int var4, + Tessellator var5) 
      protected abstract voidelementClicked(int index, + boolean doubleClick) 
      protected voidfunc_27255_a(int p_27255_1_, + int p_27255_2_) 
      intfunc_27256_c(int p_27256_1_, + int p_27256_2_) 
      protected voidfunc_27257_b(int p_27257_1_, + int p_27257_2_) 
      voidfunc_27258_a(boolean p_27258_1_) 
      protected voidfunc_27259_a(boolean p_27259_1_, + int p_27259_2_) 
      protected voidfunc_27260_a(int p_27260_1_, + int p_27260_2_, + Tessellator p_27260_3_) 
      protected intgetContentHeight() 
      protected abstract intgetSize() 
      protected abstract booleanisSelected(int index) 
      voidregisterScrollButtons(java.util.List p_22240_1_, + int p_22240_2_, + int p_22240_3_) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        listWidth

        +
        protected final int listWidth
        +
        • +
      + + + +
        +
      • +

        listHeight

        +
        protected final int listHeight
        +
        • +
      + + + +
        +
      • +

        top

        +
        protected final int top
        +
        • +
      + + + +
        +
      • +

        bottom

        +
        protected final int bottom
        +
        • +
      + + + +
        +
      • +

        left

        +
        protected final int left
        +
        • +
      + + + +
        +
      • +

        slotHeight

        +
        protected final int slotHeight
        +
        • +
      + + + +
        +
      • +

        mouseX

        +
        protected int mouseX
        +
        • +
      + + + +
        +
      • +

        mouseY

        +
        protected int mouseY
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiScrollingList

        +
        public GuiScrollingList(Minecraft client,
+                int width,
+                int height,
+                int top,
+                int bottom,
+                int left,
+                int entryHeight)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        func_27258_a

        +
        public void func_27258_a(boolean p_27258_1_)
        +
        • +
      + + + +
        +
      • +

        func_27259_a

        +
        protected void func_27259_a(boolean p_27259_1_,
+                int p_27259_2_)
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        protected abstract int getSize()
        +
        • +
      + + + +
        +
      • +

        elementClicked

        +
        protected abstract void elementClicked(int index,
+                  boolean doubleClick)
        +
        • +
      + + + +
        +
      • +

        isSelected

        +
        protected abstract boolean isSelected(int index)
        +
        • +
      + + + +
        +
      • +

        getContentHeight

        +
        protected int getContentHeight()
        +
        • +
      + + + +
        +
      • +

        drawBackground

        +
        protected abstract void drawBackground()
        +
        • +
      + + + +
        +
      • +

        drawSlot

        +
        protected abstract void drawSlot(int var1,
+            int var2,
+            int var3,
+            int var4,
+            Tessellator var5)
        +
        • +
      + + + +
        +
      • +

        func_27260_a

        +
        protected void func_27260_a(int p_27260_1_,
+                int p_27260_2_,
+                Tessellator p_27260_3_)
        +
        • +
      + + + +
        +
      • +

        func_27255_a

        +
        protected void func_27255_a(int p_27255_1_,
+                int p_27255_2_)
        +
        • +
      + + + +
        +
      • +

        func_27257_b

        +
        protected void func_27257_b(int p_27257_1_,
+                int p_27257_2_)
        +
        • +
      + + + +
        +
      • +

        func_27256_c

        +
        public int func_27256_c(int p_27256_1_,
+               int p_27256_2_)
        +
        • +
      + + + +
        +
      • +

        registerScrollButtons

        +
        public void registerScrollButtons(java.util.List p_22240_1_,
+                         int p_22240_2_,
+                         int p_22240_3_)
        +
        • +
      + + + +
        +
      • +

        actionPerformed

        +
        public void actionPerformed(GuiButton button)
        +
        • +
      + + + +
        +
      • +

        drawScreen

        +
        public void drawScreen(int mouseX,
+              int mouseY,
+              float p_22243_3_)
        +
        • +
      + + + +
        +
      • +

        drawGradientRect

        +
        protected void drawGradientRect(int par1,
+                    int par2,
+                    int par3,
+                    int par4,
+                    int par5,
+                    int par6)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiSlotModList.html b/javadoc/cpw/mods/fml/client/GuiSlotModList.html new file mode 100644 index 0000000..b034d40 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiSlotModList.html @@ -0,0 +1,384 @@ + + + + + +GuiSlotModList (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiSlotModList

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiSortingProblem.html b/javadoc/cpw/mods/fml/client/GuiSortingProblem.html new file mode 100644 index 0000000..4ce95cb --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiSortingProblem.html @@ -0,0 +1,325 @@ + + + + + +GuiSortingProblem (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiSortingProblem

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiSortingProblem
+extends GuiScreen
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initGui

        +
        public void initGui()
        +
        +
        Overrides:
        +
        initGui in class GuiScreen
        +
        +
        • +
      + + + +
        +
      • +

        drawScreen

        +
        public void drawScreen(int p_73863_1_,
+              int p_73863_2_,
+              float p_73863_3_)
        +
        +
        Overrides:
        +
        drawScreen in class GuiScreen
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/GuiWrongMinecraft.html b/javadoc/cpw/mods/fml/client/GuiWrongMinecraft.html new file mode 100644 index 0000000..9dd156b --- /dev/null +++ b/javadoc/cpw/mods/fml/client/GuiWrongMinecraft.html @@ -0,0 +1,337 @@ + + + + + +GuiWrongMinecraft (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class GuiWrongMinecraft

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/IModGuiFactory.RuntimeOptionCategoryElement.html b/javadoc/cpw/mods/fml/client/IModGuiFactory.RuntimeOptionCategoryElement.html new file mode 100644 index 0000000..26acbb7 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/IModGuiFactory.RuntimeOptionCategoryElement.html @@ -0,0 +1,282 @@ + + + + + +IModGuiFactory.RuntimeOptionCategoryElement (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class IModGuiFactory.RuntimeOptionCategoryElement

+
+
+ +
+
    +
  • +
    +
    Enclosing interface:
    +
    IModGuiFactory
    +
    +
    +
    +
    public static class IModGuiFactory.RuntimeOptionCategoryElement
+extends java.lang.Object
    +
    Represents an option category and entry in the runtime gui options list.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      java.lang.Stringchild 
      java.lang.Stringparent 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        parent

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

        child

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

      Constructor Detail

      + + + +
        +
      • +

        IModGuiFactory.RuntimeOptionCategoryElement

        +
        public IModGuiFactory.RuntimeOptionCategoryElement(java.lang.String parent,
+                                           java.lang.String child)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/IModGuiFactory.RuntimeOptionGuiHandler.html b/javadoc/cpw/mods/fml/client/IModGuiFactory.RuntimeOptionGuiHandler.html new file mode 100644 index 0000000..0d8e3a4 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/IModGuiFactory.RuntimeOptionGuiHandler.html @@ -0,0 +1,281 @@ + + + + + +IModGuiFactory.RuntimeOptionGuiHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client
+

Interface IModGuiFactory.RuntimeOptionGuiHandler

+
+
+
+
    +
  • +
    +
    Enclosing interface:
    +
    IModGuiFactory
    +
    +
    +
    +
    public static interface IModGuiFactory.RuntimeOptionGuiHandler
    +
    Responsible for painting the mod specific section of runtime options GUI for a particular category
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidactionCallback(int actionId) +
      Called if a widget with id >= 100 is fired.
      +
      voidaddWidgets(java.util.List<Gui> widgetList, + int x, + int y, + int w, + int h) +
      Called to add widgets to the screen, such as buttons.
      +
      voidclose() +
      Called when this handler is about to go away (probably replaced by another one, or closing the + option screen)
      +
      voidpaint(int x, + int y, + int w, + int h) +
      Called to paint the rectangle specified.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addWidgets

        +
        void addWidgets(java.util.List<Gui> widgetList,
+              int x,
+              int y,
+              int w,
+              int h)
        +
        Called to add widgets to the screen, such as buttons. + GUI identifier numbers should start at 100 and increase. + The callback will be through actionCallback(int)
        +
        Parameters:
        x - X
        y - Y
        w - width
        h - height
        +
        • +
      + + + +
        +
      • +

        paint

        +
        void paint(int x,
+         int y,
+         int w,
+         int h)
        +
        Called to paint the rectangle specified.
        +
        Parameters:
        x - X
        y - Y
        w - width
        h - height
        +
        • +
      + + + +
        +
      • +

        actionCallback

        +
        void actionCallback(int actionId)
        +
        Called if a widget with id >= 100 is fired.
        +
        Parameters:
        actionId - the actionId of the firing widget
        +
        • +
      + + + +
        +
      • +

        close

        +
        void close()
        +
        Called when this handler is about to go away (probably replaced by another one, or closing the + option screen)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/IModGuiFactory.html b/javadoc/cpw/mods/fml/client/IModGuiFactory.html new file mode 100644 index 0000000..748db9f --- /dev/null +++ b/javadoc/cpw/mods/fml/client/IModGuiFactory.html @@ -0,0 +1,325 @@ + + + + + +IModGuiFactory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client
+

Interface IModGuiFactory

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

      Method Detail

      + + + +
        +
      • +

        initialize

        +
        void initialize(Minecraft minecraftInstance)
        +
        Called when instantiated to initialize with the active minecraft instance.
        +
        Parameters:
        minecraftInstance - the instance
        +
        • +
      + + + +
        +
      • +

        mainConfigGuiClass

        +
        java.lang.Class<? extends GuiScreen> mainConfigGuiClass()
        +
        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.
        +
        Returns:
        A class that will be instantiated on clicks on the config button + or null if no GUI is desired.
        +
        • +
      + + + +
        +
      • +

        runtimeGuiCategories

        +
        java.util.Set<IModGuiFactory.RuntimeOptionCategoryElement> runtimeGuiCategories()
        +
        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.
        +
        Returns:
        the set of options this mod wishes to have available, or empty if none
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/ConfigGuiType.html b/javadoc/cpw/mods/fml/client/config/ConfigGuiType.html new file mode 100644 index 0000000..b7858b2 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/ConfigGuiType.html @@ -0,0 +1,377 @@ + + + + + +ConfigGuiType (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Enum ConfigGuiType

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static ConfigGuiTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ConfigGuiType[]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 ConfigGuiType[] 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 (ConfigGuiType c : ConfigGuiType.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ConfigGuiType 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/cpw/mods/fml/client/config/DummyConfigElement.DummyCategoryElement.html b/javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyCategoryElement.html new file mode 100644 index 0000000..15ac098 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyCategoryElement.html @@ -0,0 +1,331 @@ + + + + + +DummyConfigElement.DummyCategoryElement (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class DummyConfigElement.DummyCategoryElement<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IConfigElement<T>
    +
    +
    +
    Enclosing class:
    +
    DummyConfigElement<T>
    +
    +
    +
    +
    public static class DummyConfigElement.DummyCategoryElement<T>
+extends DummyConfigElement<T>
    +
    This class provides a Dummy Category IConfigElement. It can be used to define a custom list of GUI entries that will + appear on the child screen or to specify a custom IGuiConfigListEntryfor a special category.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DummyConfigElement.DummyCategoryElement

        +
        public DummyConfigElement.DummyCategoryElement(java.lang.String name,
+                                       java.lang.String langKey,
+                                       java.util.List<IConfigElement> childElements)
        +
        • +
      + + + +
        +
      • +

        DummyConfigElement.DummyCategoryElement

        +
        public DummyConfigElement.DummyCategoryElement(java.lang.String name,
+                                       java.lang.String langKey,
+                                       java.lang.Class<? extends GuiConfigEntries.IConfigEntry> customListEntryClass)
        +
        • +
      + + + +
        +
      • +

        DummyConfigElement.DummyCategoryElement

        +
        public DummyConfigElement.DummyCategoryElement(java.lang.String name,
+                                       java.lang.String langKey,
+                                       java.util.List<IConfigElement> childElements,
+                                       java.lang.Class<? extends GuiConfigEntries.IConfigEntry> customListEntryClass)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyListElement.html b/javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyListElement.html new file mode 100644 index 0000000..fc4f576 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyListElement.html @@ -0,0 +1,600 @@ + + + + + +DummyConfigElement.DummyListElement (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class DummyConfigElement.DummyListElement<T>

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

      Constructor Detail

      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
+                                   T[] defaultValues,
+                                   ConfigGuiType type,
+                                   java.lang.String langKey,
+                                   boolean isListFixedLength,
+                                   int maxListLength,
+                                   java.util.regex.Pattern validStringPattern,
+                                   T minValue,
+                                   T maxValue)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
+                                   T[] defaultValues,
+                                   ConfigGuiType type,
+                                   java.lang.String langKey)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
+                                   T[] defaultValues,
+                                   ConfigGuiType type,
+                                   java.lang.String langKey,
+                                   boolean isListFixedLength)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
+                                   T[] defaultValues,
+                                   ConfigGuiType type,
+                                   java.lang.String langKey,
+                                   int maxListLength)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
+                                   T[] defaultValues,
+                                   ConfigGuiType type,
+                                   java.lang.String langKey,
+                                   T minValue,
+                                   T maxValue)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
+                                   T[] defaultValues,
+                                   ConfigGuiType type,
+                                   java.lang.String langKey,
+                                   boolean isListFixedLength,
+                                   T minValue,
+                                   T maxValue)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
+                                   T[] defaultValues,
+                                   ConfigGuiType type,
+                                   java.lang.String langKey,
+                                   int maxListLength,
+                                   T minValue,
+                                   T maxValue)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
+                                   T[] defaultValues,
+                                   ConfigGuiType type,
+                                   java.lang.String langKey,
+                                   boolean isListFixedLength,
+                                   int maxListLength,
+                                   T minValue,
+                                   T maxValue)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
+                                   T[] defaultValues,
+                                   ConfigGuiType type,
+                                   java.lang.String langKey,
+                                   java.util.regex.Pattern validStringPattern)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
+                                   T[] defaultValues,
+                                   ConfigGuiType type,
+                                   java.lang.String langKey,
+                                   boolean isListFixedLength,
+                                   java.util.regex.Pattern validStringPattern)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
+                                   T[] defaultValues,
+                                   ConfigGuiType type,
+                                   java.lang.String langKey,
+                                   int maxListLength,
+                                   java.util.regex.Pattern validStringPattern)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/DummyConfigElement.html b/javadoc/cpw/mods/fml/client/config/DummyConfigElement.html new file mode 100644 index 0000000..c6266ea --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/DummyConfigElement.html @@ -0,0 +1,1353 @@ + + + + + +DummyConfigElement (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class DummyConfigElement<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IConfigElement<T>
    +
    +
    +
    Direct Known Subclasses:
    +
    DummyConfigElement.DummyCategoryElement, DummyConfigElement.DummyListElement
    +
    +
    +
    +
    public class DummyConfigElement<T>
+extends java.lang.Object
+implements IConfigElement<T>
    +
    This class's main purpose is to provide the necessary objects for a sample Config GUI for FML, although + there may be practical uses for the objects defined here such as using the DummyCategoryElement object as a + wrapper for a custom IGuiConfigListEntry object that opens a special screen.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        isProperty

        +
        protected boolean isProperty
        +
        • +
      + + + +
        +
      • +

        isList

        +
        protected boolean isList
        +
        • +
      + + + + + + + +
        +
      • +

        name

        +
        protected java.lang.String name
        +
        • +
      + + + +
        +
      • +

        langKey

        +
        protected java.lang.String langKey
        +
        • +
      + + + +
        +
      • +

        value

        +
        protected java.lang.Object value
        +
        • +
      + + + +
        +
      • +

        defaultValue

        +
        protected java.lang.Object defaultValue
        +
        • +
      + + + +
        +
      • +

        values

        +
        protected T[] values
        +
        • +
      + + + +
        +
      • +

        defaultValues

        +
        protected T[] defaultValues
        +
        • +
      + + + +
        +
      • +

        validValues

        +
        protected java.lang.String[] validValues
        +
        • +
      + + + +
        +
      • +

        validStringPattern

        +
        protected java.util.regex.Pattern validStringPattern
        +
        • +
      + + + +
        +
      • +

        minValue

        +
        protected T minValue
        +
        • +
      + + + +
        +
      • +

        maxValue

        +
        protected T maxValue
        +
        • +
      + + + +
        +
      • +

        requiresWorldRestart

        +
        protected boolean requiresWorldRestart
        +
        • +
      + + + +
        +
      • +

        requiresMcRestart

        +
        protected boolean requiresMcRestart
        +
        • +
      + + + +
        +
      • +

        isListFixedLength

        +
        protected boolean isListFixedLength
        +
        • +
      + + + +
        +
      • +

        maxListLength

        +
        protected int maxListLength
        +
        • +
      + + + +
        +
      • +

        childElements

        +
        protected java.util.List<IConfigElement> childElements
        +
        • +
      + + + + + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + + + +
        +
      • +

        DummyConfigElement

        +
        public DummyConfigElement(java.lang.String name,
+                  T defaultValue,
+                  ConfigGuiType type,
+                  java.lang.String langKey,
+                  java.lang.String[] validValues,
+                  java.util.regex.Pattern validStringPattern,
+                  T minValue,
+                  T maxValue)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement

        +
        public DummyConfigElement(java.lang.String name,
+                  T defaultValue,
+                  ConfigGuiType type,
+                  java.lang.String langKey,
+                  java.util.regex.Pattern validStringPattern)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement

        +
        public DummyConfigElement(java.lang.String name,
+                  T defaultValue,
+                  ConfigGuiType type,
+                  java.lang.String langKey,
+                  java.lang.String[] validValues)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement

        +
        public DummyConfigElement(java.lang.String name,
+                  T defaultValue,
+                  ConfigGuiType type,
+                  java.lang.String langKey)
        +
        • +
      + + + + + +
        +
      • +

        DummyConfigElement

        +
        public DummyConfigElement(java.lang.String name,
+                  T defaultValue,
+                  ConfigGuiType type,
+                  java.lang.String langKey,
+                  T minValue,
+                  T maxValue)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        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>
        +
        +
        • +
      + + + +
        +
      • +

        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>
        +
        +
        • +
      + + + +
        +
      • +

        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>
        +
        +
        • +
      + + + +
        +
      • +

        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>
        +
        +
        • +
      + + + +
        +
      • +

        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>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        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>
        +
        +
        • +
      + + + +
        +
      • +

        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>
        +
        +
        • +
      + + + +
        +
      • +

        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 T[] getDefaults()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Gets this property's default values.
        +
        +
        Specified by:
        +
        getDefaults 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>
        +
        +
        • +
      + + + +
        +
      • +

        setRequiresWorldRestart

        +
        public IConfigElement<T> setRequiresWorldRestart(boolean requiresWorldRestart)
        +
        • +
      + + + +
        +
      • +

        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>
        +
        +
        • +
      + + + +
        +
      • +

        setRequiresMcRestart

        +
        public IConfigElement<T> setRequiresMcRestart(boolean requiresMcRestart)
        +
        • +
      + + + +
        +
      • +

        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>
        +
        +
        • +
      + + + +
        +
      • +

        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 T[] 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>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiButtonExt.html b/javadoc/cpw/mods/fml/client/config/GuiButtonExt.html new file mode 100644 index 0000000..efb681c --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiButtonExt.html @@ -0,0 +1,349 @@ + + + + + +GuiButtonExt (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiButtonExt

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    GuiSlider, GuiUnicodeGlyphButton
    +
    +
    +
    +
    public class GuiButtonExt
+extends GuiButton
    +
    This class provides a button that fixes several bugs present in the vanilla GuiButton drawing code. + The gist of it is that it allows buttons of any size without gaps in the graphics and with the + borders drawn properly. It also prevents button text from extending out of the sides of the button by + trimming the end of the string and adding an ellipsis.

    + + The code that handles drawing the button is in GuiUtils.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiButtonExt

        +
        public GuiButtonExt(int id,
+            int xPos,
+            int yPos,
+            java.lang.String displayString)
        +
        • +
      + + + +
        +
      • +

        GuiButtonExt

        +
        public GuiButtonExt(int id,
+            int xPos,
+            int yPos,
+            int width,
+            int height,
+            java.lang.String displayString)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        drawButton

        +
        public void drawButton(Minecraft mc,
+              int mouseX,
+              int mouseY)
        +
        Draws this button to the screen.
        +
        +
        Overrides:
        +
        drawButton in class GuiButton
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiCheckBox.html b/javadoc/cpw/mods/fml/client/config/GuiCheckBox.html new file mode 100644 index 0000000..4ca2fc9 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiCheckBox.html @@ -0,0 +1,364 @@ + + + + + +GuiCheckBox (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiCheckBox

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiCheckBox
+extends GuiButton
    +
    This class provides a checkbox style control.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiCheckBox

        +
        public GuiCheckBox(int id,
+           int xPos,
+           int yPos,
+           java.lang.String displayString,
+           boolean isChecked)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        mousePressed

        +
        public boolean mousePressed(Minecraft p_146116_1_,
+                   int p_146116_2_,
+                   int p_146116_3_)
        +
        +
        Overrides:
        +
        mousePressed in class GuiButton
        +
        +
        • +
      + + + +
        +
      • +

        isChecked

        +
        public boolean isChecked()
        +
        • +
      + + + +
        +
      • +

        setIsChecked

        +
        public void setIsChecked(boolean isChecked)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfig.html b/javadoc/cpw/mods/fml/client/config/GuiConfig.html new file mode 100644 index 0000000..01bb38f --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfig.html @@ -0,0 +1,768 @@ + + + + + +GuiConfig (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfig

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

      Field Detail

      + + + +
        +
      • +

        parentScreen

        +
        public final GuiScreen parentScreen
        +
        A reference to the screen object that created this. Used for navigating between screens.
        +
        • +
      + + + +
        +
      • +

        title

        +
        public java.lang.String title
        +
        • +
      + + + +
        +
      • +

        titleLine2

        +
        public java.lang.String titleLine2
        +
        • +
      + + + +
        +
      • +

        configElements

        +
        public final java.util.List<IConfigElement> configElements
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        modID

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

        configID

        +
        public final java.lang.String configID
        +
        When set to a non-null value the OnConfigChanged and PostConfigChanged events will be posted when the Done button is pressed + if any configElements were changed (includes child screens). If not defined, the events will be posted if the parent gui is null + or if the parent gui is not an instance of GuiConfig.
        +
        • +
      + + + +
        +
      • +

        isWorldRunning

        +
        public final boolean isWorldRunning
        +
        • +
      + + + +
        +
      • +

        allRequireWorldRestart

        +
        public final boolean allRequireWorldRestart
        +
        • +
      + + + +
        +
      • +

        allRequireMcRestart

        +
        public final boolean allRequireMcRestart
        +
        • +
      + + + +
        +
      • +

        needsRefresh

        +
        public boolean needsRefresh
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiConfig

        +
        public GuiConfig(GuiScreen parentScreen,
+         java.util.List<IConfigElement> configElements,
+         java.lang.String modID,
+         java.lang.String configID,
+         boolean allRequireWorldRestart,
+         boolean allRequireMcRestart,
+         java.lang.String title)
        +
        GuiConfig constructor that will use ConfigChangedEvent when editing is concluded. If a non-null value is passed for configID, + the OnConfigChanged and PostConfigChanged events will be posted when the Done button is pressed if any configElements were changed + (includes child screens). If configID is not defined, the events will be posted if the parent gui is null or if the parent gui + is not an instance of GuiConfig.
        +
        Parameters:
        parentScreen - the parent GuiScreen object
        configElements - a List of IConfigProperty objects
        modID - the mod ID for the mod whose config settings will be edited
        configID - an identifier that will be passed to the OnConfigChanged and PostConfigChanged events. Setting this value will force + the save action to be called when the Done button is pressed on this screen if any configElements were changed.
        allRequireWorldRestart - send true if all configElements on this screen require a world restart
        allRequireMcRestart - send true if all configElements on this screen require MC to be restarted
        title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being + edited.
        +
        • +
      + + + +
        +
      • +

        GuiConfig

        +
        public GuiConfig(GuiScreen parentScreen,
+         java.util.List<IConfigElement> configElements,
+         java.lang.String modID,
+         boolean allRequireWorldRestart,
+         boolean allRequireMcRestart,
+         java.lang.String title)
        +
        GuiConfig constructor that will use ConfigChangedEvent when editing is concluded. This constructor passes null for configID. + If configID is not defined, the events will be posted if the parent gui is null or if the parent gui is not an instance of GuiConfig.
        +
        Parameters:
        parentScreen - the parent GuiScreen object
        configElements - a List of IConfigProperty objects
        modID - the mod ID for the mod whose config settings will be edited
        allRequireWorldRestart - send true if all configElements on this screen require a world restart
        allRequireMcRestart - send true if all configElements on this screen require MC to be restarted
        title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being + edited.
        +
        • +
      + + + +
        +
      • +

        GuiConfig

        +
        public GuiConfig(GuiScreen parentScreen,
+         java.util.List<IConfigElement> configElements,
+         java.lang.String modID,
+         boolean allRequireWorldRestart,
+         boolean allRequireMcRestart,
+         java.lang.String title,
+         java.lang.String titleLine2)
        +
        GuiConfig constructor that will use ConfigChangedEvent when editing is concluded. This constructor passes null for configID. + If configID is not defined, the events will be posted if the parent gui is null or if the parent gui is not an instance of GuiConfig.
        +
        Parameters:
        parentScreen - the parent GuiScreen object
        configElements - a List of IConfigProperty objects
        modID - the mod ID for the mod whose config settings will be edited
        allRequireWorldRestart - send true if all configElements on this screen require a world restart
        allRequireMcRestart - send true if all configElements on this screen require MC to be restarted
        title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being + edited.
        titleLine2 - the desired title second line for this screen. Typically this is used to send the category name of the category + currently being edited.
        +
        • +
      + + + +
        +
      • +

        GuiConfig

        +
        public GuiConfig(GuiScreen parentScreen,
+         java.util.List<IConfigElement> configElements,
+         java.lang.String modID,
+         java.lang.String configID,
+         boolean allRequireWorldRestart,
+         boolean allRequireMcRestart,
+         java.lang.String title,
+         java.lang.String titleLine2)
        +
        GuiConfig constructor that will use ConfigChangedEvent when editing is concluded. titleLine2 is specified in this constructor. + If a non-null value is passed for configID, the OnConfigChanged and PostConfigChanged events will be posted when the Done button is + pressed if any configElements were changed (includes child screens). If configID is not defined, the events will be posted if the parent + gui is null or if the parent gui is not an instance of GuiConfig.
        +
        Parameters:
        parentScreen - the parent GuiScreen object
        configElements - a List of IConfigProperty objects
        modID - the mod ID for the mod whose config settings will be edited
        configID - an identifier that will be passed to the OnConfigChanged and PostConfigChanged events
        allRequireWorldRestart - send true if all configElements on this screen require a world restart
        allRequireMcRestart - send true if all configElements on this screen require MC to be restarted
        title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being + edited.
        titleLine2 - the desired title second line for this screen. Typically this is used to send the category name of the category + currently being edited.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAbridgedConfigPath

        +
        public static java.lang.String getAbridgedConfigPath(java.lang.String path)
        +
        • +
      + + + +
        +
      • +

        initGui

        +
        public void initGui()
        +
        +
        Overrides:
        +
        initGui in class GuiScreen
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        mouseClicked

        +
        protected void mouseClicked(int x,
+                int y,
+                int mouseEvent)
        +
        +
        Overrides:
        +
        mouseClicked in class GuiScreen
        +
        +
        • +
      + + + +
        +
      • +

        mouseMovedOrUp

        +
        protected void mouseMovedOrUp(int x,
+                  int y,
+                  int mouseEvent)
        +
        +
        Overrides:
        +
        mouseMovedOrUp in class GuiScreen
        +
        +
        • +
      + + + +
        +
      • +

        keyTyped

        +
        protected void keyTyped(char eventChar,
+            int eventKey)
        +
        +
        Overrides:
        +
        keyTyped in class GuiScreen
        +
        +
        • +
      + + + + + + + +
        +
      • +

        drawScreen

        +
        public void drawScreen(int mouseX,
+              int mouseY,
+              float partialTicks)
        +
        +
        Overrides:
        +
        drawScreen in class GuiScreen
        +
        +
        • +
      + + + +
        +
      • +

        drawToolTip

        +
        public void drawToolTip(java.util.List stringList,
+               int x,
+               int y)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ArrayEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ArrayEntry.html new file mode 100644 index 0000000..3946ec7 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ArrayEntry.html @@ -0,0 +1,563 @@ + + + + + +GuiConfigEntries.ArrayEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.ArrayEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.BooleanEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.BooleanEntry.html new file mode 100644 index 0000000..ca90f34 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.BooleanEntry.html @@ -0,0 +1,511 @@ + + + + + +GuiConfigEntries.BooleanEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.BooleanEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ButtonEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ButtonEntry.html new file mode 100644 index 0000000..8c8f0f6 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ButtonEntry.html @@ -0,0 +1,540 @@ + + + + + +GuiConfigEntries.ButtonEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.ButtonEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CategoryEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CategoryEntry.html new file mode 100644 index 0000000..8c8473a --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CategoryEntry.html @@ -0,0 +1,772 @@ + + + + + +GuiConfigEntries.CategoryEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.CategoryEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ChatColorEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ChatColorEntry.html new file mode 100644 index 0000000..ceefad4 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ChatColorEntry.html @@ -0,0 +1,339 @@ + + + + + +GuiConfigEntries.ChatColorEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.ChatColorEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CycleValueEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CycleValueEntry.html new file mode 100644 index 0000000..725b778 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CycleValueEntry.html @@ -0,0 +1,529 @@ + + + + + +GuiConfigEntries.CycleValueEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.CycleValueEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.DoubleEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.DoubleEntry.html new file mode 100644 index 0000000..fb7a265 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.DoubleEntry.html @@ -0,0 +1,426 @@ + + + + + +GuiConfigEntries.DoubleEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.DoubleEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html new file mode 100644 index 0000000..5903589 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html @@ -0,0 +1,501 @@ + + + + + +GuiConfigEntries.IConfigEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Interface GuiConfigEntries.IConfigEntry<T>

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddrawToolTip(int mouseX, + int mouseY) +
      Handles drawing any tooltips that apply to this entry.
      +
      booleanenabled() +
      Is this list entry enabled?
      +
      IConfigElementgetConfigElement() +
      Gets the IConfigElement object owned by this entry.
      +
      TgetCurrentValue() +
      Gets the current value of this entry as a String.
      +
      T[]getCurrentValues() +
      Gets the current values of this list entry as a String[].
      +
      intgetEntryRightBound() +
      Gets this entry's right-hand x boundary.
      +
      intgetLabelWidth() +
      Gets this entry's label width.
      +
      java.lang.StringgetName() +
      Gets the name of the ConfigElement owned by this entry.
      +
      booleanisChanged() +
      Has the value of this entry changed?
      +
      booleanisDefault() +
      Is this entry's value equal to the default value? Generally true should be returned if this entry is not a property or category + entry.
      +
      voidkeyTyped(char eventChar, + int eventKey) +
      Handles user keystrokes for any GuiTextField objects in this entry.
      +
      voidmouseClicked(int x, + int y, + int mouseEvent) +
      Call GuiTextField.mouseClicked() for and GuiTextField objects in this entry.
      +
      voidonGuiClosed() +
      This method is called when the parent GUI is closed.
      +
      booleansaveConfigElement() +
      Handles saving any changes that have been made to this entry back to the underlying object.
      +
      voidsetToDefault() +
      Sets this entry's value to the default value.
      +
      voidundoChanges() +
      Handles reverting any changes that have occurred to this entry.
      +
      voidupdateCursorCounter() +
      Call GuiTextField.updateCursorCounter() for any GuiTextField objects in this entry.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getConfigElement

        +
        IConfigElement getConfigElement()
        +
        Gets the IConfigElement object owned by this entry.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Gets the name of the ConfigElement owned by this entry.
        +
        • +
      + + + +
        +
      • +

        getCurrentValue

        +
        T getCurrentValue()
        +
        Gets the current value of this entry as a String.
        +
        • +
      + + + +
        +
      • +

        getCurrentValues

        +
        T[] getCurrentValues()
        +
        Gets the current values of this list entry as a String[].
        +
        • +
      + + + +
        +
      • +

        enabled

        +
        boolean enabled()
        +
        Is this list entry enabled?
        +
        Returns:
        true if this entry's controls should be enabled, false otherwise.
        +
        • +
      + + + +
        +
      • +

        keyTyped

        +
        void keyTyped(char eventChar,
+            int eventKey)
        +
        Handles user keystrokes for any GuiTextField objects in this entry. Call GuiTextField.keyTyped() for any GuiTextField + objects that should receive the input provided.
        +
        • +
      + + + +
        +
      • +

        updateCursorCounter

        +
        void updateCursorCounter()
        +
        Call GuiTextField.updateCursorCounter() for any GuiTextField objects in this entry.
        +
        • +
      + + + +
        +
      • +

        mouseClicked

        +
        void mouseClicked(int x,
+                int y,
+                int mouseEvent)
        +
        Call GuiTextField.mouseClicked() for and GuiTextField objects in this entry.
        +
        • +
      + + + +
        +
      • +

        isDefault

        +
        boolean isDefault()
        +
        Is this entry's value equal to the default value? Generally true should be returned if this entry is not a property or category + entry.
        +
        Returns:
        true if this entry's value is equal to this entry's default value.
        +
        • +
      + + + +
        +
      • +

        setToDefault

        +
        void setToDefault()
        +
        Sets this entry's value to the default value.
        +
        • +
      + + + +
        +
      • +

        undoChanges

        +
        void undoChanges()
        +
        Handles reverting any changes that have occurred to this entry.
        +
        • +
      + + + +
        +
      • +

        isChanged

        +
        boolean isChanged()
        +
        Has the value of this entry changed?
        +
        Returns:
        true if changes have been made to this entry's value, false otherwise.
        +
        • +
      + + + +
        +
      • +

        saveConfigElement

        +
        boolean saveConfigElement()
        +
        Handles saving any changes that have been made to this entry back to the underlying object. It is a good practice to check + isChanged() before performing the save action. This method should return true if the element has changed AND REQUIRES A RESTART.
        +
        • +
      + + + +
        +
      • +

        drawToolTip

        +
        void drawToolTip(int mouseX,
+               int mouseY)
        +
        Handles drawing any tooltips that apply to this entry. This method is called after all other GUI elements have been drawn to the + screen, so it could also be used to draw any GUI element that needs to be drawn after all entries have had drawEntry() called.
        +
        • +
      + + + +
        +
      • +

        getLabelWidth

        +
        int getLabelWidth()
        +
        Gets this entry's label width.
        +
        • +
      + + + +
        +
      • +

        getEntryRightBound

        +
        int getEntryRightBound()
        +
        Gets this entry's right-hand x boundary. This value is used to control where the scroll bar is placed.
        +
        • +
      + + + +
        +
      • +

        onGuiClosed

        +
        void onGuiClosed()
        +
        This method is called when the parent GUI is closed. Most handlers won't need this; it is provided for special cases.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IntegerEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IntegerEntry.html new file mode 100644 index 0000000..10bec07 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IntegerEntry.html @@ -0,0 +1,426 @@ + + + + + +GuiConfigEntries.IntegerEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.IntegerEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ListEntryBase.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ListEntryBase.html new file mode 100644 index 0000000..727ef75 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ListEntryBase.html @@ -0,0 +1,936 @@ + + + + + +GuiConfigEntries.ListEntryBase (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.ListEntryBase

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddrawEntry(int slotIndex, + int x, + int y, + int listWidth, + int slotHeight, + Tessellator tessellator, + int mouseX, + int mouseY, + boolean isSelected) 
      voiddrawToolTip(int mouseX, + int mouseY) +
      Handles drawing any tooltips that apply to this entry.
      +
      booleanenabled() +
      Is this list entry enabled?
      +
      IConfigElementgetConfigElement() +
      Gets the IConfigElement object owned by this entry.
      +
      abstract java.lang.ObjectgetCurrentValue() +
      Gets the current value of this entry as a String.
      +
      abstract java.lang.Object[]getCurrentValues() +
      Gets the current values of this list entry as a String[].
      +
      intgetEntryRightBound() +
      Gets this entry's right-hand x boundary.
      +
      intgetLabelWidth() +
      Gets this entry's label width.
      +
      java.lang.StringgetName() +
      Gets the name of the ConfigElement owned by this entry.
      +
      abstract booleanisChanged() +
      Has the value of this entry changed?
      +
      abstract booleanisDefault() +
      Is this entry's value equal to the default value? Generally true should be returned if this entry is not a property or category + entry.
      +
      abstract voidkeyTyped(char eventChar, + int eventKey) +
      Handles user keystrokes for any GuiTextField objects in this entry.
      +
      abstract voidmouseClicked(int x, + int y, + int mouseEvent) +
      Call GuiTextField.mouseClicked() for and GuiTextField objects in this entry.
      +
      booleanmousePressed(int index, + int x, + int y, + int mouseEvent, + int relativeX, + int relativeY) 
      voidmouseReleased(int index, + int x, + int y, + int mouseEvent, + int relativeX, + int relativeY) 
      voidonGuiClosed() +
      This method is called when the parent GUI is closed.
      +
      abstract booleansaveConfigElement() +
      Handles saving any changes that have been made to this entry back to the underlying object.
      +
      abstract voidsetToDefault() +
      Sets this entry's value to the default value.
      +
      abstract voidundoChanges() +
      Handles reverting any changes that have occurred to this entry.
      +
      abstract voidupdateCursorCounter() +
      Call GuiTextField.updateCursorCounter() for any GuiTextField objects in this entry.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.NumberSliderEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.NumberSliderEntry.html new file mode 100644 index 0000000..43f6bb7 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.NumberSliderEntry.html @@ -0,0 +1,536 @@ + + + + + +GuiConfigEntries.NumberSliderEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.NumberSliderEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.SelectValueEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.SelectValueEntry.html new file mode 100644 index 0000000..4c6af89 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.SelectValueEntry.html @@ -0,0 +1,583 @@ + + + + + +GuiConfigEntries.SelectValueEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.SelectValueEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.StringEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.StringEntry.html new file mode 100644 index 0000000..2f13a06 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.StringEntry.html @@ -0,0 +1,603 @@ + + + + + +GuiConfigEntries.StringEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.StringEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.html new file mode 100644 index 0000000..958ffde --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.html @@ -0,0 +1,856 @@ + + + + + +GuiConfigEntries (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiConfigEntries
+extends GuiListExtended
    +
    This class implements the scrolling list functionality of the config GUI screens. It also provides all the default control handlers + for the various property types.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        owningScreen

        +
        public final GuiConfig owningScreen
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        maxLabelTextWidth

        +
        public int maxLabelTextWidth
        +
        The max width of the label of all IConfigEntry objects.
        +
        • +
      + + + +
        +
      • +

        maxEntryRightBound

        +
        public int maxEntryRightBound
        +
        The max x boundary of all IConfigEntry objects.
        +
        • +
      + + + +
        +
      • +

        labelX

        +
        public int labelX
        +
        The x position where the label should be drawn.
        +
        • +
      + + + +
        +
      • +

        controlX

        +
        public int controlX
        +
        The x position where the control should be drawn.
        +
        • +
      + + + +
        +
      • +

        controlWidth

        +
        public int controlWidth
        +
        The width of the control.
        +
        • +
      + + + +
        +
      • +

        resetX

        +
        public int resetX
        +
        The minimum x position where the Undo/Default buttons will start
        +
        • +
      + + + +
        +
      • +

        scrollBarX

        +
        public int scrollBarX
        +
        The x position of the scroll bar.
        +
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initGui

        +
        protected void initGui()
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        +
        Specified by:
        +
        getSize in class GuiSlot
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getScrollBarX

        +
        public int getScrollBarX()
        +
        +
        Overrides:
        +
        getScrollBarX in class GuiSlot
        +
        +
        • +
      + + + +
        +
      • +

        getListWidth

        +
        public int getListWidth()
        +
        Gets the width of the list
        +
        +
        Overrides:
        +
        getListWidth in class GuiSlot
        +
        +
        • +
      + + + +
        +
      • +

        keyTyped

        +
        public void keyTyped(char eventChar,
+            int eventKey)
        +
        This method is a pass-through for IConfigEntry objects that require keystrokes. Called from the parent GuiConfig screen.
        +
        • +
      + + + +
        +
      • +

        updateScreen

        +
        public void updateScreen()
        +
        This method is a pass-through for IConfigEntry objects that contain GuiTextField elements. Called from the parent GuiConfig + screen.
        +
        • +
      + + + +
        +
      • +

        mouseClicked

        +
        public void mouseClicked(int mouseX,
+                int mouseY,
+                int mouseEvent)
        +
        This method is a pass-through for IConfigEntry objects that contain GuiTextField elements. Called from the parent GuiConfig + screen.
        +
        • +
      + + + +
        +
      • +

        onGuiClosed

        +
        public void onGuiClosed()
        +
        This method is a pass-through for IConfigListEntry objects that need to perform actions when the containing GUI is closed.
        +
        • +
      + + + +
        +
      • +

        saveConfigElements

        +
        public boolean saveConfigElements()
        +
        Saves all properties on this screen / child screens. This method returns true if any elements were changed that require + a restart for proper handling.
        +
        • +
      + + + +
        +
      • +

        areAllEntriesDefault

        +
        public boolean areAllEntriesDefault(boolean includeChildren)
        +
        Returns true if all IConfigEntry objects on this screen are set to default. If includeChildren is true sub-category + objects are checked as well.
        +
        • +
      + + + +
        +
      • +

        setAllToDefault

        +
        public void setAllToDefault(boolean includeChildren)
        +
        Sets all IConfigEntry objects on this screen to default. If includeChildren is true sub-category objects are set as + well.
        +
        • +
      + + + +
        +
      • +

        hasChangedEntry

        +
        public boolean hasChangedEntry(boolean includeChildren)
        +
        Returns true if any IConfigEntry objects on this screen are changed. If includeChildren is true sub-category objects + are checked as well.
        +
        • +
      + + + +
        +
      • +

        areAnyEntriesEnabled

        +
        public boolean areAnyEntriesEnabled(boolean includeChildren)
        +
        Returns true if any IConfigEntry objects on this screen are enabled. If includeChildren is true sub-category objects + are checked as well.
        +
        • +
      + + + +
        +
      • +

        undoAllChanges

        +
        public void undoAllChanges(boolean includeChildren)
        +
        Reverts changes to all IConfigEntry objects on this screen. If includeChildren is true sub-category objects are + reverted as well.
        +
        • +
      + + + +
        +
      • +

        drawScreenPost

        +
        public void drawScreenPost(int mouseX,
+                  int mouseY,
+                  float partialTicks)
        +
        Calls the drawToolTip() method for all IConfigEntry objects on this screen. This is called from the parent GuiConfig screen + after drawing all other elements.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArray.html b/javadoc/cpw/mods/fml/client/config/GuiEditArray.html new file mode 100644 index 0000000..3803491 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArray.html @@ -0,0 +1,540 @@ + + + + + +GuiEditArray (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiEditArray

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiEditArray
+extends GuiScreen
    +
    This class is the base screen used for editing an array-type property. It provides a list of array entries for the user to edit. + This screen is invoked from a GuiConfig screen by controls that use the EditListPropEntry IGuiConfigListEntry object.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        parentScreen

        +
        protected GuiScreen parentScreen
        +
        • +
      + + + + + + + +
        +
      • +

        titleLine2

        +
        protected java.lang.String titleLine2
        +
        • +
      + + + +
        +
      • +

        titleLine3

        +
        protected java.lang.String titleLine3
        +
        • +
      + + + +
        +
      • +

        slotIndex

        +
        protected int slotIndex
        +
        • +
      + + + +
        +
      • +

        enabled

        +
        protected boolean enabled
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiEditArray

        +
        public GuiEditArray(GuiScreen parentScreen,
+            IConfigElement configElement,
+            int slotIndex,
+            java.lang.Object[] currentValues,
+            boolean enabled)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initGui

        +
        public void initGui()
        +
        +
        Overrides:
        +
        initGui in class GuiScreen
        +
        +
        • +
      + + + + + + + +
        +
      • +

        mouseClicked

        +
        protected void mouseClicked(int x,
+                int y,
+                int mouseEvent)
        +
        +
        Overrides:
        +
        mouseClicked in class GuiScreen
        +
        +
        • +
      + + + +
        +
      • +

        mouseMovedOrUp

        +
        protected void mouseMovedOrUp(int x,
+                  int y,
+                  int mouseEvent)
        +
        +
        Overrides:
        +
        mouseMovedOrUp in class GuiScreen
        +
        +
        • +
      + + + +
        +
      • +

        keyTyped

        +
        protected void keyTyped(char eventChar,
+            int eventKey)
        +
        +
        Overrides:
        +
        keyTyped in class GuiScreen
        +
        +
        • +
      + + + + + + + +
        +
      • +

        drawScreen

        +
        public void drawScreen(int par1,
+              int par2,
+              float par3)
        +
        +
        Overrides:
        +
        drawScreen in class GuiScreen
        +
        +
        • +
      + + + +
        +
      • +

        drawToolTip

        +
        public void drawToolTip(java.util.List stringList,
+               int x,
+               int y)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BaseEntry.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BaseEntry.html new file mode 100644 index 0000000..520d874 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BaseEntry.html @@ -0,0 +1,569 @@ + + + + + +GuiEditArrayEntries.BaseEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiEditArrayEntries.BaseEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BooleanEntry.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BooleanEntry.html new file mode 100644 index 0000000..9709de7 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BooleanEntry.html @@ -0,0 +1,422 @@ + + + + + +GuiEditArrayEntries.BooleanEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiEditArrayEntries.BooleanEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.DoubleEntry.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.DoubleEntry.html new file mode 100644 index 0000000..33aa899 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.DoubleEntry.html @@ -0,0 +1,342 @@ + + + + + +GuiEditArrayEntries.DoubleEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiEditArrayEntries.DoubleEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html new file mode 100644 index 0000000..872c560 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html @@ -0,0 +1,297 @@ + + + + + +GuiEditArrayEntries.IArrayEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Interface GuiEditArrayEntries.IArrayEntry

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

      Method Detail

      + + + +
        +
      • +

        keyTyped

        +
        void keyTyped(char eventChar,
+            int eventKey)
        +
        • +
      + + + +
        +
      • +

        updateCursorCounter

        +
        void updateCursorCounter()
        +
        • +
      + + + +
        +
      • +

        mouseClicked

        +
        void mouseClicked(int x,
+                int y,
+                int mouseEvent)
        +
        • +
      + + + +
        +
      • +

        drawToolTip

        +
        void drawToolTip(int mouseX,
+               int mouseY)
        +
        • +
      + + + +
        +
      • +

        isValueSavable

        +
        boolean isValueSavable()
        +
        • +
      + + + +
        +
      • +

        getValue

        +
        java.lang.Object getValue()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IntegerEntry.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IntegerEntry.html new file mode 100644 index 0000000..9fac5ee --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IntegerEntry.html @@ -0,0 +1,341 @@ + + + + + +GuiEditArrayEntries.IntegerEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiEditArrayEntries.IntegerEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.StringEntry.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.StringEntry.html new file mode 100644 index 0000000..f08b640 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.StringEntry.html @@ -0,0 +1,431 @@ + + + + + +GuiEditArrayEntries.StringEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiEditArrayEntries.StringEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.html new file mode 100644 index 0000000..2cc304c --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.html @@ -0,0 +1,694 @@ + + + + + +GuiEditArrayEntries (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiEditArrayEntries

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiEditArrayEntries
+extends GuiListExtended
    +
    This class implements the scrolling list functionality of the GuiEditList screen. It also provides all the default controls + for editing array-type properties.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

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

        isDefault

        +
        public boolean isDefault
        +
        • +
      + + + +
        +
      • +

        isChanged

        +
        public boolean isChanged
        +
        • +
      + + + +
        +
      • +

        canAddMoreEntries

        +
        public boolean canAddMoreEntries
        +
        • +
      + + + +
        +
      • +

        controlWidth

        +
        public final int controlWidth
        +
        • +
      + + + +
        +
      • +

        beforeValues

        +
        public final java.lang.Object[] beforeValues
        +
        • +
      + + + +
        +
      • +

        currentValues

        +
        public java.lang.Object[] currentValues
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiEditArrayEntries

        +
        public GuiEditArrayEntries(GuiEditArray parent,
+                   Minecraft mc,
+                   IConfigElement configElement,
+                   java.lang.Object[] beforeValues,
+                   java.lang.Object[] currentValues)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getScrollBarX

        +
        protected int getScrollBarX()
        +
        +
        Overrides:
        +
        getScrollBarX in class GuiSlot
        +
        +
        • +
      + + + +
        +
      • +

        getListWidth

        +
        public int getListWidth()
        +
        Gets the width of the list
        +
        +
        Overrides:
        +
        getListWidth in class GuiSlot
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getSize

        +
        protected int getSize()
        +
        +
        Specified by:
        +
        getSize in class GuiSlot
        +
        +
        • +
      + + + +
        +
      • +

        addNewEntry

        +
        public void addNewEntry(int index)
        +
        • +
      + + + +
        +
      • +

        removeEntry

        +
        public void removeEntry(int index)
        +
        • +
      + + + +
        +
      • +

        isChanged

        +
        public boolean isChanged()
        +
        • +
      + + + +
        +
      • +

        isDefault

        +
        public boolean isDefault()
        +
        • +
      + + + +
        +
      • +

        recalculateState

        +
        public void recalculateState()
        +
        • +
      + + + +
        +
      • +

        keyTyped

        +
        protected void keyTyped(char eventChar,
+            int eventKey)
        +
        • +
      + + + +
        +
      • +

        updateScreen

        +
        protected void updateScreen()
        +
        • +
      + + + +
        +
      • +

        mouseClicked

        +
        protected void mouseClicked(int x,
+                int y,
+                int mouseEvent)
        +
        • +
      + + + +
        +
      • +

        isListSavable

        +
        protected boolean isListSavable()
        +
        • +
      + + + +
        +
      • +

        saveListChanges

        +
        protected void saveListChanges()
        +
        • +
      + + + +
        +
      • +

        drawScreenPost

        +
        protected void drawScreenPost(int mouseX,
+                  int mouseY,
+                  float f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiMessageDialog.html b/javadoc/cpw/mods/fml/client/config/GuiMessageDialog.html new file mode 100644 index 0000000..7824835 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiMessageDialog.html @@ -0,0 +1,322 @@ + + + + + +GuiMessageDialog (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiMessageDialog

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

      Constructor Detail

      + + + +
        +
      • +

        GuiMessageDialog

        +
        public GuiMessageDialog(GuiScreen nextScreen,
+                java.lang.String title,
+                IChatComponent message,
+                java.lang.String buttonText)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSelectString.html b/javadoc/cpw/mods/fml/client/config/GuiSelectString.html new file mode 100644 index 0000000..40123e6 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSelectString.html @@ -0,0 +1,510 @@ + + + + + +GuiSelectString (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiSelectString

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiSelectString
+extends GuiScreen
    +
    This class provides a screen that allows the user to select a value from a list.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        parentScreen

        +
        protected GuiScreen parentScreen
        +
        • +
      + + + + + + + +
        +
      • +

        titleLine2

        +
        protected java.lang.String titleLine2
        +
        • +
      + + + +
        +
      • +

        titleLine3

        +
        protected java.lang.String titleLine3
        +
        • +
      + + + +
        +
      • +

        slotIndex

        +
        protected int slotIndex
        +
        • +
      + + + +
        +
      • +

        beforeValue

        +
        public final java.lang.Object beforeValue
        +
        • +
      + + + +
        +
      • +

        currentValue

        +
        public java.lang.Object currentValue
        +
        • +
      + + + +
        +
      • +

        enabled

        +
        protected boolean enabled
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiSelectString

        +
        public GuiSelectString(GuiScreen parentScreen,
+               IConfigElement configElement,
+               int slotIndex,
+               java.util.Map<java.lang.Object,java.lang.String> selectableValues,
+               java.lang.Object currentValue,
+               boolean enabled)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initGui

        +
        public void initGui()
        +
        +
        Overrides:
        +
        initGui in class GuiScreen
        +
        +
        • +
      + + + + + + + +
        +
      • +

        mouseMovedOrUp

        +
        protected void mouseMovedOrUp(int x,
+                  int y,
+                  int mouseEvent)
        +
        +
        Overrides:
        +
        mouseMovedOrUp in class GuiScreen
        +
        +
        • +
      + + + +
        +
      • +

        drawScreen

        +
        public void drawScreen(int par1,
+              int par2,
+              float par3)
        +
        +
        Overrides:
        +
        drawScreen in class GuiScreen
        +
        +
        • +
      + + + +
        +
      • +

        drawToolTip

        +
        public void drawToolTip(java.util.List stringList,
+               int x,
+               int y)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.EntryComparator.html b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.EntryComparator.html new file mode 100644 index 0000000..3f88cbe --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.EntryComparator.html @@ -0,0 +1,276 @@ + + + + + +GuiSelectStringEntries.EntryComparator (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiSelectStringEntries.EntryComparator

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Comparator<java.util.Map.Entry<java.lang.Object,java.lang.String>>
    +
    +
    +
    Enclosing class:
    +
    GuiSelectStringEntries
    +
    +
    +
    +
    public static class GuiSelectStringEntries.EntryComparator
+extends java.lang.Object
+implements java.util.Comparator<java.util.Map.Entry<java.lang.Object,java.lang.String>>
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intcompare(java.util.Map.Entry<java.lang.Object,java.lang.String> o1, + java.util.Map.Entry<java.lang.Object,java.lang.String> o2) 
      +
        +
      • + + +

        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
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiSelectStringEntries.EntryComparator

        +
        public GuiSelectStringEntries.EntryComparator()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compare

        +
        public int compare(java.util.Map.Entry<java.lang.Object,java.lang.String> o1,
+          java.util.Map.Entry<java.lang.Object,java.lang.String> o2)
        +
        +
        Specified by:
        +
        compare in interface java.util.Comparator<java.util.Map.Entry<java.lang.Object,java.lang.String>>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.IGuiSelectStringListEntry.html b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.IGuiSelectStringListEntry.html new file mode 100644 index 0000000..d96393b --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.IGuiSelectStringListEntry.html @@ -0,0 +1,224 @@ + + + + + +GuiSelectStringEntries.IGuiSelectStringListEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Interface GuiSelectStringEntries.IGuiSelectStringListEntry

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

      Method Detail

      + + + +
        +
      • +

        getValue

        +
        java.lang.Object getValue()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.ListEntry.html b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.ListEntry.html new file mode 100644 index 0000000..8a99981 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.ListEntry.html @@ -0,0 +1,405 @@ + + + + + +GuiSelectStringEntries.ListEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiSelectStringEntries.ListEntry

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

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected GuiSelectStringEntriesowningList 
      protected java.util.Map.Entry<java.lang.Object,java.lang.String>value 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddrawEntry(int slotIndex, + int x, + int y, + int listWidth, + int slotHeight, + Tessellator tessellator, + int mouseX, + int mouseY, + boolean isSelected) 
      java.lang.ObjectgetValue() 
      booleanmousePressed(int index, + int x, + int y, + int mouseEvent, + int relativeX, + int relativeY) 
      voidmouseReleased(int index, + int x, + int y, + int mouseEvent, + int relativeX, + int relativeY) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.html b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.html new file mode 100644 index 0000000..90a0296 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.html @@ -0,0 +1,583 @@ + + + + + +GuiSelectStringEntries (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiSelectStringEntries

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiSelectStringEntries
+extends GuiListExtended
    +
    This class implements the scrolling list functionality of the GuiSelectString screen.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiSelectStringEntries

        +
        public GuiSelectStringEntries(GuiSelectString owningScreen,
+                      Minecraft mc,
+                      IConfigElement configElement,
+                      java.util.Map<java.lang.Object,java.lang.String> selectableValues)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        elementClicked

        +
        protected void elementClicked(int index,
+                  boolean doubleClick,
+                  int mouseX,
+                  int mouseY)
        +
        The element in the slot that was clicked, boolean for whether it was double clicked or not
        +
        +
        Overrides:
        +
        elementClicked in class GuiListExtended
        +
        +
        • +
      + + + +
        +
      • +

        isSelected

        +
        protected boolean isSelected(int index)
        +
        Returns true if the element passed in is currently selected
        +
        +
        Overrides:
        +
        isSelected in class GuiListExtended
        +
        +
        • +
      + + + +
        +
      • +

        getScrollBarX

        +
        protected int getScrollBarX()
        +
        +
        Overrides:
        +
        getScrollBarX in class GuiSlot
        +
        +
        • +
      + + + +
        +
      • +

        getListWidth

        +
        public int getListWidth()
        +
        Gets the width of the list
        +
        +
        Overrides:
        +
        getListWidth in class GuiSlot
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getSize

        +
        protected int getSize()
        +
        +
        Specified by:
        +
        getSize in class GuiSlot
        +
        +
        • +
      + + + +
        +
      • +

        isChanged

        +
        public boolean isChanged()
        +
        • +
      + + + +
        +
      • +

        isDefault

        +
        public boolean isDefault()
        +
        • +
      + + + +
        +
      • +

        saveChanges

        +
        public void saveChanges()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSlider.ISlider.html b/javadoc/cpw/mods/fml/client/config/GuiSlider.ISlider.html new file mode 100644 index 0000000..c0ef078 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSlider.ISlider.html @@ -0,0 +1,208 @@ + + + + + +GuiSlider.ISlider (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Interface GuiSlider.ISlider

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    GuiSlider
    +
    +
    +
    +
    public static interface GuiSlider.ISlider
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onChangeSliderValue

        +
        void onChangeSliderValue(GuiSlider slider)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSlider.html b/javadoc/cpw/mods/fml/client/config/GuiSlider.html new file mode 100644 index 0000000..e5ce3af --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSlider.html @@ -0,0 +1,699 @@ + + + + + +GuiSlider (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiSlider

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiSlider
+extends GuiButtonExt
    +
    This class is blatantly stolen from iChunUtils with permission.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        sliderValue

        +
        public double sliderValue
        +
        The value of this slider control.
        +
        • +
      + + + +
        +
      • +

        dispString

        +
        public java.lang.String dispString
        +
        • +
      + + + +
        +
      • +

        dragging

        +
        public boolean dragging
        +
        Is this slider control being dragged.
        +
        • +
      + + + +
        +
      • +

        showDecimal

        +
        public boolean showDecimal
        +
        • +
      + + + +
        +
      • +

        minValue

        +
        public double minValue
        +
        • +
      + + + +
        +
      • +

        maxValue

        +
        public double maxValue
        +
        • +
      + + + +
        +
      • +

        precision

        +
        public int precision
        +
        • +
      + + + + + + + +
        +
      • +

        suffix

        +
        public java.lang.String suffix
        +
        • +
      + + + +
        +
      • +

        drawString

        +
        public boolean drawString
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiSlider

        +
        public GuiSlider(int id,
+         int xPos,
+         int yPos,
+         int width,
+         int height,
+         java.lang.String prefix,
+         java.lang.String suf,
+         double minVal,
+         double maxVal,
+         double currentVal,
+         boolean showDec,
+         boolean drawStr)
        +
        • +
      + + + +
        +
      • +

        GuiSlider

        +
        public GuiSlider(int id,
+         int xPos,
+         int yPos,
+         int width,
+         int height,
+         java.lang.String prefix,
+         java.lang.String suf,
+         double minVal,
+         double maxVal,
+         double currentVal,
+         boolean showDec,
+         boolean drawStr,
+         GuiSlider.ISlider par)
        +
        • +
      + + + +
        +
      • +

        GuiSlider

        +
        public GuiSlider(int id,
+         int xPos,
+         int yPos,
+         java.lang.String displayStr,
+         double minVal,
+         double maxVal,
+         double currentVal,
+         GuiSlider.ISlider par)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHoverState

        +
        public int getHoverState(boolean par1)
        +
        Returns 0 if the button is disabled, 1 if the mouse is NOT hovering over this button and 2 if it IS hovering over + this button.
        +
        +
        Overrides:
        +
        getHoverState in class GuiButton
        +
        +
        • +
      + + + +
        +
      • +

        mouseDragged

        +
        protected void mouseDragged(Minecraft par1Minecraft,
+                int par2,
+                int par3)
        +
        Fired when the mouse button is dragged. Equivalent of MouseListener.mouseDragged(MouseEvent e).
        +
        +
        Overrides:
        +
        mouseDragged in class GuiButton
        +
        +
        • +
      + + + +
        +
      • +

        mousePressed

        +
        public boolean mousePressed(Minecraft par1Minecraft,
+                   int par2,
+                   int par3)
        +
        Returns true if the mouse has been pressed on this control. Equivalent of MouseListener.mousePressed(MouseEvent + e).
        +
        +
        Overrides:
        +
        mousePressed in class GuiButton
        +
        +
        • +
      + + + +
        +
      • +

        updateSlider

        +
        public void updateSlider()
        +
        • +
      + + + +
        +
      • +

        mouseReleased

        +
        public void mouseReleased(int par1,
+                 int par2)
        +
        Fired when the mouse button is released. Equivalent of MouseListener.mouseReleased(MouseEvent e).
        +
        +
        Overrides:
        +
        mouseReleased in class GuiButton
        +
        +
        • +
      + + + +
        +
      • +

        getValueInt

        +
        public int getValueInt()
        +
        • +
      + + + +
        +
      • +

        getValue

        +
        public double getValue()
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public void setValue(double d)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiUnicodeGlyphButton.html b/javadoc/cpw/mods/fml/client/config/GuiUnicodeGlyphButton.html new file mode 100644 index 0000000..70fec5f --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiUnicodeGlyphButton.html @@ -0,0 +1,373 @@ + + + + + +GuiUnicodeGlyphButton (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiUnicodeGlyphButton

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiUnicodeGlyphButton
+extends GuiButtonExt
    +
    This class provides a button that shows a string glyph at the beginning. The glyph can be scaled using the glyphScale parameter.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        glyph

        +
        public java.lang.String glyph
        +
        • +
      + + + +
        +
      • +

        glyphScale

        +
        public float glyphScale
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiUnicodeGlyphButton

        +
        public GuiUnicodeGlyphButton(int id,
+                     int xPos,
+                     int yPos,
+                     int width,
+                     int height,
+                     java.lang.String displayString,
+                     java.lang.String glyph,
+                     float glyphScale)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiUtils.html b/javadoc/cpw/mods/fml/client/config/GuiUtils.html new file mode 100644 index 0000000..829c221 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiUtils.html @@ -0,0 +1,529 @@ + + + + + +GuiUtils (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class GuiUtils

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiUtils
+extends java.lang.Object
    +
    This class provides several methods and constants used by the Config GUI classes.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringINVALID 
      static java.lang.StringRESET_CHAR 
      static java.lang.StringUNDO_CHAR 
      static java.lang.StringVALID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voiddrawContinuousTexturedBox(int x, + int y, + int u, + int v, + int width, + int height, + int textureWidth, + int textureHeight, + int borderSize, + float zLevel) +
      Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler.
      +
      static voiddrawContinuousTexturedBox(int x, + int y, + int u, + int v, + int width, + int height, + int textureWidth, + int textureHeight, + int topBorder, + int bottomBorder, + int leftBorder, + int rightBorder, + float zLevel) +
      Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler.
      +
      static voiddrawContinuousTexturedBox(ResourceLocation res, + int x, + int y, + int u, + int v, + int width, + int height, + int textureWidth, + int textureHeight, + int borderSize, + float zLevel) +
      Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler.
      +
      static voiddrawContinuousTexturedBox(ResourceLocation res, + int x, + int y, + int u, + int v, + int width, + int height, + int textureWidth, + int textureHeight, + int topBorder, + int bottomBorder, + int leftBorder, + int rightBorder, + float zLevel) +
      Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler.
      +
      static voiddrawTexturedModalRect(int x, + int y, + int u, + int v, + int width, + int height, + float zLevel) 
      static intgetColorCode(char c, + boolean isLighter) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        GuiUtils

        +
        public GuiUtils()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getColorCode

        +
        public static int getColorCode(char c,
+               boolean isLighter)
        +
        • +
      + + + +
        +
      • +

        drawContinuousTexturedBox

        +
        public static void drawContinuousTexturedBox(int x,
+                             int y,
+                             int u,
+                             int v,
+                             int width,
+                             int height,
+                             int textureWidth,
+                             int textureHeight,
+                             int borderSize,
+                             float zLevel)
        +
        Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler. It is assumed that the desired texture ResourceLocation object has been bound using + Minecraft.getMinecraft().getTextureManager().bindTexture(resourceLocation).
        +
        Parameters:
        x - x axis offset
        y - y axis offset
        u - bound resource location image x offset
        v - bound resource location image y offset
        width - the desired box width
        height - the desired box height
        textureWidth - the width of the box texture in the resource location image
        textureHeight - the height of the box texture in the resource location image
        borderSize - the size of the box's borders
        zLevel - the zLevel to draw at
        +
        • +
      + + + +
        +
      • +

        drawContinuousTexturedBox

        +
        public static void drawContinuousTexturedBox(ResourceLocation res,
+                             int x,
+                             int y,
+                             int u,
+                             int v,
+                             int width,
+                             int height,
+                             int textureWidth,
+                             int textureHeight,
+                             int borderSize,
+                             float zLevel)
        +
        Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler. The provided ResourceLocation object will be bound using + Minecraft.getMinecraft().getTextureManager().bindTexture(resourceLocation).
        +
        Parameters:
        res - the ResourceLocation object that contains the desired image
        x - x axis offset
        y - y axis offset
        u - bound resource location image x offset
        v - bound resource location image y offset
        width - the desired box width
        height - the desired box height
        textureWidth - the width of the box texture in the resource location image
        textureHeight - the height of the box texture in the resource location image
        borderSize - the size of the box's borders
        zLevel - the zLevel to draw at
        +
        • +
      + + + +
        +
      • +

        drawContinuousTexturedBox

        +
        public static void drawContinuousTexturedBox(ResourceLocation res,
+                             int x,
+                             int y,
+                             int u,
+                             int v,
+                             int width,
+                             int height,
+                             int textureWidth,
+                             int textureHeight,
+                             int topBorder,
+                             int bottomBorder,
+                             int leftBorder,
+                             int rightBorder,
+                             float zLevel)
        +
        Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler. The provided ResourceLocation object will be bound using + Minecraft.getMinecraft().getTextureManager().bindTexture(resourceLocation).
        +
        Parameters:
        res - the ResourceLocation object that contains the desired image
        x - x axis offset
        y - y axis offset
        u - bound resource location image x offset
        v - bound resource location image y offset
        width - the desired box width
        height - the desired box height
        textureWidth - the width of the box texture in the resource location image
        textureHeight - the height of the box texture in the resource location image
        topBorder - the size of the box's top border
        bottomBorder - the size of the box's bottom border
        leftBorder - the size of the box's left border
        rightBorder - the size of the box's right border
        zLevel - the zLevel to draw at
        +
        • +
      + + + +
        +
      • +

        drawContinuousTexturedBox

        +
        public static void drawContinuousTexturedBox(int x,
+                             int y,
+                             int u,
+                             int v,
+                             int width,
+                             int height,
+                             int textureWidth,
+                             int textureHeight,
+                             int topBorder,
+                             int bottomBorder,
+                             int leftBorder,
+                             int rightBorder,
+                             float zLevel)
        +
        Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler. It is assumed that the desired texture ResourceLocation object has been bound using + Minecraft.getMinecraft().getTextureManager().bindTexture(resourceLocation).
        +
        Parameters:
        x - x axis offset
        y - y axis offset
        u - bound resource location image x offset
        v - bound resource location image y offset
        width - the desired box width
        height - the desired box height
        textureWidth - the width of the box texture in the resource location image
        textureHeight - the height of the box texture in the resource location image
        topBorder - the size of the box's top border
        bottomBorder - the size of the box's bottom border
        leftBorder - the size of the box's left border
        rightBorder - the size of the box's right border
        zLevel - the zLevel to draw at
        +
        • +
      + + + +
        +
      • +

        drawTexturedModalRect

        +
        public static void drawTexturedModalRect(int x,
+                         int y,
+                         int u,
+                         int v,
+                         int width,
+                         int height,
+                         float zLevel)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/HoverChecker.html b/javadoc/cpw/mods/fml/client/config/HoverChecker.html new file mode 100644 index 0000000..a36ced1 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/HoverChecker.html @@ -0,0 +1,344 @@ + + + + + +HoverChecker (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Class HoverChecker

+
+
+ +
+
    +
  • +
    +
    +
    public class HoverChecker
+extends java.lang.Object
    +
    This class implements an easy way to check if the mouse has hovered within a certain region of the screen for a given + period of time. The region can be defined manually or by supplying a GuiButton object.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      HoverChecker(GuiButton button, + int threshold) 
      HoverChecker(int top, + int bottom, + int left, + int right, + int threshold) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleancheckHover(int mouseX, + int mouseY) +
      Checks if the mouse is in the hover region.
      +
      booleancheckHover(int mouseX, + int mouseY, + boolean canHover) +
      Checks if the mouse is in the hover region.
      +
      voidresetHoverTimer() +
      Manually resets the hover timer.
      +
      voidupdateBounds(int top, + int bottom, + int left, + int right) +
      Call this method if the intended region has changed such as if the region must follow a scrolling list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        HoverChecker

        +
        public HoverChecker(int top,
+            int bottom,
+            int left,
+            int right,
+            int threshold)
        +
        • +
      + + + +
        +
      • +

        HoverChecker

        +
        public HoverChecker(GuiButton button,
+            int threshold)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        updateBounds

        +
        public void updateBounds(int top,
+                int bottom,
+                int left,
+                int right)
        +
        Call this method if the intended region has changed such as if the region must follow a scrolling list. + It is not necessary to call this method if a GuiButton defines the hover region.
        +
        • +
      + + + +
        +
      • +

        checkHover

        +
        public boolean checkHover(int mouseX,
+                 int mouseY)
        +
        Checks if the mouse is in the hover region. If the specified time period has elapsed the method returns true. + The hover timer is reset if the mouse is not within the region.
        +
        • +
      + + + +
        +
      • +

        checkHover

        +
        public boolean checkHover(int mouseX,
+                 int mouseY,
+                 boolean canHover)
        +
        Checks if the mouse is in the hover region. If the specified time period has elapsed the method returns true. + The hover timer is reset if the mouse is not within the region.
        +
        • +
      + + + +
        +
      • +

        resetHoverTimer

        +
        public void resetHoverTimer()
        +
        Manually resets the hover timer.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/IConfigElement.html b/javadoc/cpw/mods/fml/client/config/IConfigElement.html new file mode 100644 index 0000000..ede0fd2 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/IConfigElement.html @@ -0,0 +1,679 @@ + + + + + +IConfigElement (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client.config
+

Interface IConfigElement<T>

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

      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.
      +
      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?
      +
      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.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Property Detail

      + + + +
        +
      • +

        is

        +
        [Property, Category] Is this object a property object?
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isProperty

        +
        boolean isProperty()
        +
        [Property, Category] Is this object a property object?
        +
        • +
      + + + +
        +
      • +

        getConfigEntryClass

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

        getArrayEntryClass

        +
        java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> getArrayEntryClass()
        +
        This method returns a class that implements IArrayEntry. This class MUST provide a constructor with the + following parameter types: GuiEditArray, GuiEditArrayEntries, IConfigElement, Object
        +
        • +
      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        [Property, Category] Gets the name of this object.
        +
        • +
      + + + +
        +
      • +

        getQualifiedName

        +
        java.lang.String getQualifiedName()
        +
        [Category] Gets the qualified name of this object. This is typically only used for category objects.
        +
        • +
      + + + +
        +
      • +

        getLanguageKey

        +
        java.lang.String getLanguageKey()
        +
        [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.
        +
        • +
      + + + +
        +
      • +

        getComment

        +
        java.lang.String getComment()
        +
        [Property, Category] Gets the comment for this object. Used for the tooltip if getLanguageKey() + ".tooltip" is not defined in the + .lang file.
        +
        • +
      + + + +
        +
      • +

        getChildElements

        +
        java.util.List<IConfigElement> getChildElements()
        +
        [Category] Gets this category's child categories/properties.
        +
        • +
      + + + +
        +
      • +

        getType

        +
        ConfigGuiType getType()
        +
        [Property, Category] Gets the ConfigGuiType value corresponding to the type of this property object, or CONFIG_CATEGORY if this is a + category object.
        +
        • +
      + + + +
        +
      • +

        isList

        +
        boolean isList()
        +
        [Property] Is this property object a list?
        +
        • +
      + + + +
        +
      • +

        isListLengthFixed

        +
        boolean isListLengthFixed()
        +
        [Property] Does this list property have to remain a fixed length?
        +
        • +
      + + + +
        +
      • +

        getMaxListLength

        +
        int getMaxListLength()
        +
        [Property] Gets the max length of this list property, or -1 if the length is unlimited.
        +
        • +
      + + + +
        +
      • +

        isDefault

        +
        boolean isDefault()
        +
        [Property] Is this property value equal to the default value?
        +
        • +
      + + + +
        +
      • +

        getDefault

        +
        java.lang.Object getDefault()
        +
        [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()
        +
        • +
      + + + +
        +
      • +

        getDefaults

        +
        java.lang.Object[] getDefaults()
        +
        [Property] Gets this property's default values.
        +
        • +
      + + + +
        +
      • +

        setToDefault

        +
        void setToDefault()
        +
        [Property] Sets this property's value to the default value.
        +
        • +
      + + + +
        +
      • +

        requiresWorldRestart

        +
        boolean requiresWorldRestart()
        +
        [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.
        +
        • +
      + + + +
        +
      • +

        showInGui

        +
        boolean showInGui()
        +
        [Property, Category] Whether or not this element should be allowed to show on config GUIs.
        +
        • +
      + + + +
        +
      • +

        requiresMcRestart

        +
        boolean requiresMcRestart()
        +
        [Property, Category] Whether or not this element requires Minecraft to be restarted when changed.
        +
        • +
      + + + +
        +
      • +

        get

        +
        java.lang.Object get()
        +
        [Property] Gets this property value.
        +
        • +
      + + + +
        +
      • +

        getList

        +
        java.lang.Object[] getList()
        +
        [Property] Gets this property value as a list. Generally you should be sure of whether the property is a list before calling this.
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        void set(T value)
        +
        [Property] Sets this property's value.
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        void set(T[] aVal)
        +
        [Property] Sets this property's value to the specified array.
        +
        • +
      + + + +
        +
      • +

        getValidValues

        +
        java.lang.String[] getValidValues()
        +
        [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.
        +
        • +
      + + + +
        +
      • +

        getMinValue

        +
        T getMinValue()
        +
        [Property] Gets this property's minimum value.
        +
        • +
      + + + +
        +
      • +

        getMaxValue

        +
        T getMaxValue()
        +
        [Property] Gets this property's maximum value.
        +
        • +
      + + + +
        +
      • +

        getValidationPattern

        +
        java.util.regex.Pattern getValidationPattern()
        +
        [Property] Gets a Pattern object used in String property input validation.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/package-frame.html b/javadoc/cpw/mods/fml/client/config/package-frame.html new file mode 100644 index 0000000..003cbb9 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/package-frame.html @@ -0,0 +1,65 @@ + + + + + +cpw.mods.fml.client.config (Forge API) + + + + +

cpw.mods.fml.client.config

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/cpw/mods/fml/client/config/package-summary.html b/javadoc/cpw/mods/fml/client/config/package-summary.html new file mode 100644 index 0000000..d27d8eb --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/package-summary.html @@ -0,0 +1,400 @@ + + + + + +cpw.mods.fml.client.config (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.client.config

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/config/package-tree.html b/javadoc/cpw/mods/fml/client/config/package-tree.html new file mode 100644 index 0000000..5874d2f --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/package-tree.html @@ -0,0 +1,232 @@ + + + + + +cpw.mods.fml.client.config Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.client.config

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.OnConfigChangedEvent.html b/javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.OnConfigChangedEvent.html new file mode 100644 index 0000000..41ad96e --- /dev/null +++ b/javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.OnConfigChangedEvent.html @@ -0,0 +1,297 @@ + + + + + +ConfigChangedEvent.OnConfigChangedEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client.event
+

Class ConfigChangedEvent.OnConfigChangedEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ConfigChangedEvent
    +
    +
    +
    +
    public static class ConfigChangedEvent.OnConfigChangedEvent
+extends ConfigChangedEvent
    +
    This event is intended to be consumed by the mod whose config has been changed. It fires when the Done button + has been clicked on a GuiConfig screen and the following conditions are met:
    + - at least one config element has been changed
    + - one of these 2 conditions are met:
    + 1) the parent screen is null or is not an instance of GuiConfig
    + 2) the configID field has been set to a non-null value for the GuiConfig screen

    + Modders should check the modID field of the event to ensure they are only acting on their own config screen's event!
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConfigChangedEvent.OnConfigChangedEvent

        +
        public ConfigChangedEvent.OnConfigChangedEvent(java.lang.String modID,
+                                       java.lang.String configID,
+                                       boolean isWorldRunning,
+                                       boolean requiresMcRestart)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.PostConfigChangedEvent.html b/javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.PostConfigChangedEvent.html new file mode 100644 index 0000000..6e3f024 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.PostConfigChangedEvent.html @@ -0,0 +1,292 @@ + + + + + +ConfigChangedEvent.PostConfigChangedEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client.event
+

Class ConfigChangedEvent.PostConfigChangedEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ConfigChangedEvent
    +
    +
    +
    +
    public static class ConfigChangedEvent.PostConfigChangedEvent
+extends ConfigChangedEvent
    +
    This event is provided for mods to consume if they want to be able to check if other mods' configs have been changed. + This event only fires if the OnConfigChangedEvent result is not DENY.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConfigChangedEvent.PostConfigChangedEvent

        +
        public ConfigChangedEvent.PostConfigChangedEvent(java.lang.String modID,
+                                         java.lang.String configID,
+                                         boolean isWorldRunning,
+                                         boolean requiresMcRestart)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.html b/javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.html new file mode 100644 index 0000000..9935f52 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/event/ConfigChangedEvent.html @@ -0,0 +1,376 @@ + + + + + +ConfigChangedEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client.event
+

Class ConfigChangedEvent

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    ConfigChangedEvent.OnConfigChangedEvent, ConfigChangedEvent.PostConfigChangedEvent
    +
    +
    +
    +
    public class ConfigChangedEvent
+extends Event
    +
    These events are posted from the GuiConfig screen when the done button is pressed. The events are only posted + if the parent screen is not an instance of GuiConfig or if the configID field has been set for + the GuiConfig screen. + + Listeners for this event should use OnConfigChanged or PostConfigChanged and check for a specific mod ID. + For best results the listener should refresh any objects/fields that are set based on the mod's config + and should serialize the modified config.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      java.lang.StringconfigID +
      A String identifier for this ConfigChangedEvent.
      +
      booleanisWorldRunning +
      Whether or not a world is currently running.
      +
      java.lang.StringmodID +
      The Mod ID of the mod whose configuration just changed.
      +
      booleanrequiresMcRestart +
      Will be set to true if any elements were changed that require a restart of Minecraft.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ConfigChangedEvent(java.lang.String modID, + java.lang.String configID, + boolean isWorldRunning, + boolean requiresMcRestart) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        modID

        +
        public final java.lang.String modID
        +
        The Mod ID of the mod whose configuration just changed.
        +
        • +
      + + + +
        +
      • +

        isWorldRunning

        +
        public final boolean isWorldRunning
        +
        Whether or not a world is currently running.
        +
        • +
      + + + +
        +
      • +

        requiresMcRestart

        +
        public final boolean requiresMcRestart
        +
        Will be set to true if any elements were changed that require a restart of Minecraft.
        +
        • +
      + + + +
        +
      • +

        configID

        +
        public final java.lang.String configID
        +
        A String identifier for this ConfigChangedEvent.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConfigChangedEvent

        +
        public ConfigChangedEvent(java.lang.String modID,
+                  java.lang.String configID,
+                  boolean isWorldRunning,
+                  boolean requiresMcRestart)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/event/package-frame.html b/javadoc/cpw/mods/fml/client/event/package-frame.html new file mode 100644 index 0000000..f1e9f8b --- /dev/null +++ b/javadoc/cpw/mods/fml/client/event/package-frame.html @@ -0,0 +1,21 @@ + + + + + +cpw.mods.fml.client.event (Forge API) + + + + +

cpw.mods.fml.client.event

+
+

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/client/event/package-summary.html b/javadoc/cpw/mods/fml/client/event/package-summary.html new file mode 100644 index 0000000..1ecd2d2 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/event/package-summary.html @@ -0,0 +1,145 @@ + + + + + +cpw.mods.fml.client.event (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.client.event

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/event/package-tree.html b/javadoc/cpw/mods/fml/client/event/package-tree.html new file mode 100644 index 0000000..252f7d8 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/event/package-tree.html @@ -0,0 +1,135 @@ + + + + + +cpw.mods.fml.client.event Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.client.event

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/package-frame.html b/javadoc/cpw/mods/fml/client/package-frame.html new file mode 100644 index 0000000..89c8752 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/package-frame.html @@ -0,0 +1,50 @@ + + + + + +cpw.mods.fml.client (Forge API) + + + + +

cpw.mods.fml.client

+
+

Interfaces

+ +

Classes

+ +

Exceptions

+ +
+ + diff --git a/javadoc/cpw/mods/fml/client/package-summary.html b/javadoc/cpw/mods/fml/client/package-summary.html new file mode 100644 index 0000000..0395704 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/package-summary.html @@ -0,0 +1,273 @@ + + + + + +cpw.mods.fml.client (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.client

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/package-tree.html b/javadoc/cpw/mods/fml/client/package-tree.html new file mode 100644 index 0000000..f8de4a2 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/package-tree.html @@ -0,0 +1,204 @@ + + + + + +cpw.mods.fml.client Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.client

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/registry/ClientRegistry.html b/javadoc/cpw/mods/fml/client/registry/ClientRegistry.html new file mode 100644 index 0000000..bdb9831 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/registry/ClientRegistry.html @@ -0,0 +1,290 @@ + + + + + +ClientRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.client.registry
+

Class ClientRegistry

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

      Constructor Detail

      + + + +
        +
      • +

        ClientRegistry

        +
        public ClientRegistry()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerTileEntity

        +
        public static void registerTileEntity(java.lang.Class<? extends TileEntity> tileEntityClass,
+                      java.lang.String id,
+                      TileEntitySpecialRenderer specialRenderer)
        +
        Utility method for registering a tile entity and it's renderer at once - generally you should register them separately
        +
        Parameters:
        tileEntityClass -
        id -
        specialRenderer -
        +
        • +
      + + + +
        +
      • +

        bindTileEntitySpecialRenderer

        +
        public static void bindTileEntitySpecialRenderer(java.lang.Class<? extends TileEntity> tileEntityClass,
+                                 TileEntitySpecialRenderer specialRenderer)
        +
        • +
      + + + +
        +
      • +

        registerKeyBinding

        +
        public static void registerKeyBinding(KeyBinding key)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/registry/ISimpleBlockRenderingHandler.html b/javadoc/cpw/mods/fml/client/registry/ISimpleBlockRenderingHandler.html new file mode 100644 index 0000000..0e337ce --- /dev/null +++ b/javadoc/cpw/mods/fml/client/registry/ISimpleBlockRenderingHandler.html @@ -0,0 +1,265 @@ + + + + + +ISimpleBlockRenderingHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.client.registry
+

Interface ISimpleBlockRenderingHandler

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    RenderBlockFluid
    +
    +
    +
    +
    public interface ISimpleBlockRenderingHandler
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        renderInventoryBlock

        +
        void renderInventoryBlock(Block block,
+                        int metadata,
+                        int modelId,
+                        RenderBlocks renderer)
        +
        • +
      + + + +
        +
      • +

        renderWorldBlock

        +
        boolean renderWorldBlock(IBlockAccess world,
+                       int x,
+                       int y,
+                       int z,
+                       Block block,
+                       int modelId,
+                       RenderBlocks renderer)
        +
        • +
      + + + +
        +
      • +

        shouldRender3DInInventory

        +
        boolean shouldRender3DInInventory(int modelId)
        +
        • +
      + + + +
        +
      • +

        getRenderId

        +
        int getRenderId()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/registry/RenderingRegistry.html b/javadoc/cpw/mods/fml/client/registry/RenderingRegistry.html new file mode 100644 index 0000000..b5d7ba4 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/registry/RenderingRegistry.html @@ -0,0 +1,421 @@ + + + + + +RenderingRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.client.registry
+

Class RenderingRegistry

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

      Constructor Detail

      + + + +
        +
      • +

        RenderingRegistry

        +
        public RenderingRegistry()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addNewArmourRendererPrefix

        +
        public static int addNewArmourRendererPrefix(java.lang.String armor)
        +
        Add a new armour prefix to the RenderPlayer
        +
        Parameters:
        armor -
        +
        • +
      + + + +
        +
      • +

        registerEntityRenderingHandler

        +
        public static void registerEntityRenderingHandler(java.lang.Class<? extends Entity> entityClass,
+                                  Render renderer)
        +
        Register an entity rendering handler. This will, after mod initialization, be inserted into the main + render map for entities
        +
        Parameters:
        entityClass -
        renderer -
        +
        • +
      + + + +
        +
      • +

        registerBlockHandler

        +
        public static void registerBlockHandler(ISimpleBlockRenderingHandler handler)
        +
        Register a simple block rendering handler
        +
        Parameters:
        handler -
        +
        • +
      + + + +
        +
      • +

        registerBlockHandler

        +
        public static void registerBlockHandler(int renderId,
+                        ISimpleBlockRenderingHandler handler)
        +
        Register the simple block rendering handler + This version will not call getRenderId on the passed in handler, instead using the supplied ID, so you + can easily re-use the same rendering handler for multiple IDs
        +
        Parameters:
        renderId -
        handler -
        +
        • +
      + + + +
        +
      • +

        getNextAvailableRenderId

        +
        public static int getNextAvailableRenderId()
        +
        Get the next available renderId from the block render ID list
        +
        • +
      + + + +
        +
      • +

        instance

        +
        @Deprecated
+public static RenderingRegistry instance()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        renderWorldBlock

        +
        public boolean renderWorldBlock(RenderBlocks renderer,
+                       IBlockAccess world,
+                       int x,
+                       int y,
+                       int z,
+                       Block block,
+                       int modelId)
        +
        • +
      + + + +
        +
      • +

        renderInventoryBlock

        +
        public void renderInventoryBlock(RenderBlocks renderer,
+                        Block block,
+                        int metadata,
+                        int modelID)
        +
        • +
      + + + +
        +
      • +

        renderItemAsFull3DBlock

        +
        public boolean renderItemAsFull3DBlock(int modelId)
        +
        • +
      + + + +
        +
      • +

        loadEntityRenderers

        +
        public void loadEntityRenderers(java.util.Map<java.lang.Class<? extends Entity>,Render> rendererMap)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/registry/package-frame.html b/javadoc/cpw/mods/fml/client/registry/package-frame.html new file mode 100644 index 0000000..9f67699 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/registry/package-frame.html @@ -0,0 +1,24 @@ + + + + + +cpw.mods.fml.client.registry (Forge API) + + + + +

cpw.mods.fml.client.registry

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/client/registry/package-summary.html b/javadoc/cpw/mods/fml/client/registry/package-summary.html new file mode 100644 index 0000000..30754a9 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/registry/package-summary.html @@ -0,0 +1,150 @@ + + + + + +cpw.mods.fml.client.registry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.client.registry

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/client/registry/package-tree.html b/javadoc/cpw/mods/fml/client/registry/package-tree.html new file mode 100644 index 0000000..3d72ae6 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/registry/package-tree.html @@ -0,0 +1,131 @@ + + + + + +cpw.mods.fml.client.registry Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.client.registry

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/API.html b/javadoc/cpw/mods/fml/common/API.html new file mode 100644 index 0000000..1c3a7df --- /dev/null +++ b/javadoc/cpw/mods/fml/common/API.html @@ -0,0 +1,224 @@ + + + + + +API (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type API

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=PACKAGE)
+public @interface API
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.StringapiVersion 
      java.lang.Stringowner 
      java.lang.Stringprovides 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        owner

        +
        public abstract java.lang.String owner
        +
        • +
      + + + +
        +
      • +

        provides

        +
        public abstract java.lang.String provides
        +
        • +
      + + + +
        +
      • +

        apiVersion

        +
        public abstract java.lang.String apiVersion
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/BukkitPluginRef.html b/javadoc/cpw/mods/fml/common/BukkitPluginRef.html new file mode 100644 index 0000000..beeec51 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/BukkitPluginRef.html @@ -0,0 +1,210 @@ + + + + + +BukkitPluginRef (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type BukkitPluginRef

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=FIELD)
+public @interface BukkitPluginRef
    +
    Declare a variable to be populated by a Bukkit Plugin proxy instance if the bukkit coremod + is available. It can only be applied to field typed as BukkitProxy + Generally it should be used in conjunction with Mod.bukkitPlugin() specifying the + plugin to load.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringvalue +
      A reference (possibly version specific) to a Bukkit Plugin by name, using the name@versionbound + specification.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        A reference (possibly version specific) to a Bukkit Plugin by name, using the name@versionbound + specification. If this is a bukkit enabled environment the field annotated by this + will be populated with a BukkitProxy instance if possible. This proxy will be gotten by + reflectively calling the "getModProxy" method on the bukkit plugin instance.
        +
        Returns:
        The name of the plugin which we will inject into this field
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/BukkitProxy.html b/javadoc/cpw/mods/fml/common/BukkitProxy.html new file mode 100644 index 0000000..7e2c179 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/BukkitProxy.html @@ -0,0 +1,159 @@ + + + + + +BukkitProxy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Interface BukkitProxy

+
+
+
+
    +
  • +
    +
    +
    public interface BukkitProxy
    +
    A marker interface for retrieving a proxy to a bukkit plugin. + Fields associated with BukkitPluginRef annotations should + declare this type and cast down if the target is available (not null)
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/CertificateHelper.html b/javadoc/cpw/mods/fml/common/CertificateHelper.html new file mode 100644 index 0000000..c1ed651 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/CertificateHelper.html @@ -0,0 +1,267 @@ + + + + + +CertificateHelper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class CertificateHelper

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

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static java.lang.StringgetFingerprint(java.nio.ByteBuffer buffer) 
      static java.lang.StringgetFingerprint(java.security.cert.Certificate certificate) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        CertificateHelper

        +
        public CertificateHelper()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFingerprint

        +
        public static java.lang.String getFingerprint(java.security.cert.Certificate certificate)
        +
        • +
      + + + +
        +
      • +

        getFingerprint

        +
        public static java.lang.String getFingerprint(java.nio.ByteBuffer buffer)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/DummyModContainer.html b/javadoc/cpw/mods/fml/common/DummyModContainer.html new file mode 100644 index 0000000..95fddbb --- /dev/null +++ b/javadoc/cpw/mods/fml/common/DummyModContainer.html @@ -0,0 +1,815 @@ + + + + + +DummyModContainer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class DummyModContainer

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

      Constructor Detail

      + + + +
        +
      • +

        DummyModContainer

        +
        public DummyModContainer(ModMetadata md)
        +
        • +
      + + + +
        +
      • +

        DummyModContainer

        +
        public DummyModContainer(java.lang.String label)
        +
        • +
      + + + +
        +
      • +

        DummyModContainer

        +
        public DummyModContainer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getDependants

        +
        public java.util.List<ArtifactVersion> getDependants()
        +
        Description copied from interface: ModContainer
        +
        A list of modids that should be loaded after this one. The + special value * indicates to load before any + other mod.
        +
        +
        Specified by:
        +
        getDependants in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getDependencies

        +
        public java.util.List<ArtifactVersion> getDependencies()
        +
        Description copied from interface: ModContainer
        +
        A list of modids that should be loaded prior to this one. The special + value * indicates to load after any other mod.
        +
        +
        Specified by:
        +
        getDependencies in interface ModContainer
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getMod

        +
        public java.lang.Object getMod()
        +
        Description copied from interface: ModContainer
        +
        Get the actual mod object
        +
        +
        Specified by:
        +
        getMod in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getModId

        +
        public java.lang.String getModId()
        +
        Description copied from interface: ModContainer
        +
        The globally unique modid for this mod
        +
        +
        Specified by:
        +
        getModId in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: ModContainer
        +
        A human readable name
        +
        +
        Specified by:
        +
        getName in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getSortingRules

        +
        public java.lang.String getSortingRules()
        +
        Description copied from interface: ModContainer
        +
        A representative string encapsulating the sorting preferences for this + mod
        +
        +
        Specified by:
        +
        getSortingRules in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getSource

        +
        public java.io.File getSource()
        +
        Description copied from interface: ModContainer
        +
        The location on the file system which this mod came from
        +
        +
        Specified by:
        +
        getSource in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        Description copied from interface: ModContainer
        +
        A human readable version identifier
        +
        +
        Specified by:
        +
        getVersion in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        matches

        +
        public boolean matches(java.lang.Object mod)
        +
        Description copied from interface: ModContainer
        +
        Does this mod match the supplied mod
        +
        +
        Specified by:
        +
        matches in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        setEnabledState

        +
        public void setEnabledState(boolean enabled)
        +
        Description copied from interface: ModContainer
        +
        Set the enabled/disabled state of this mod
        +
        +
        Specified by:
        +
        setEnabledState in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        registerBus

        +
        public boolean registerBus(com.google.common.eventbus.EventBus bus,
+                  LoadController controller)
        +
        Description copied from interface: ModContainer
        +
        Register the event bus for the mod and the controller for error handling + Returns if this bus was successfully registered - disabled mods and other + mods that don't need real events should return false and avoid further + processing
        +
        +
        Specified by:
        +
        registerBus in interface ModContainer
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        toString

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

        getCustomModProperties

        +
        public java.util.Map<java.lang.String,java.lang.String> getCustomModProperties()
        +
        +
        Specified by:
        +
        getCustomModProperties in interface ModContainer
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getSharedModDescriptor

        +
        public java.util.Map<java.lang.String,java.lang.String> getSharedModDescriptor()
        +
        +
        Specified by:
        +
        getSharedModDescriptor in interface ModContainer
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getOwnedPackages

        +
        public java.util.List<java.lang.String> getOwnedPackages()
        +
        +
        Specified by:
        +
        getOwnedPackages in interface ModContainer
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/DuplicateModsFoundException.html b/javadoc/cpw/mods/fml/common/DuplicateModsFoundException.html new file mode 100644 index 0000000..01133d0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/DuplicateModsFoundException.html @@ -0,0 +1,294 @@ + + + + + +DuplicateModsFoundException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class DuplicateModsFoundException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class DuplicateModsFoundException
+extends LoaderException
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      com.google.common.collect.SetMultimap<ModContainer,java.io.File>dupes 
      +
      • +
    + + + +
      +
    • + + +

      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
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        dupes

        +
        public com.google.common.collect.SetMultimap<ModContainer,java.io.File> dupes
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DuplicateModsFoundException

        +
        public DuplicateModsFoundException(com.google.common.collect.SetMultimap<ModContainer,java.io.File> dupes)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/FMLCommonHandler.html b/javadoc/cpw/mods/fml/common/FMLCommonHandler.html new file mode 100644 index 0000000..79752d1 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/FMLCommonHandler.html @@ -0,0 +1,1096 @@ + + + + + +FMLCommonHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class FMLCommonHandler

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLCommonHandler
+extends java.lang.Object
    +
    The main class for non-obfuscated hook handling code + + Anything that doesn't require obfuscated or client/server specific code should + go in this handler + + It also contains a reference to the sided handler instance that is valid + allowing for common code to access specific properties from the obfuscated world + without a direct dependency
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLCommonHandler

        +
        public FMLCommonHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        bus

        +
        public EventBus bus()
        +
        The FML event bus. Subscribe here for FML related events
        +
        Returns:
        the event bus
        +
        • +
      + + + + + + + +
        +
      • +

        instance

        +
        public static FMLCommonHandler instance()
        +
        Returns:
        the instance
        +
        • +
      + + + +
        +
      • +

        findContainerFor

        +
        public ModContainer findContainerFor(java.lang.Object mod)
        +
        Find the container that associates with the supplied mod object
        +
        Parameters:
        mod -
        +
        • +
      + + + +
        +
      • +

        getFMLLogger

        +
        public org.apache.logging.log4j.Logger getFMLLogger()
        +
        Get the forge mod loader logging instance (goes to the forgemodloader log file)
        +
        Returns:
        The log instance for the FML log file
        +
        • +
      + + + +
        +
      • +

        getSide

        +
        public Side getSide()
        +
        • +
      + + + +
        +
      • +

        getEffectiveSide

        +
        public Side getEffectiveSide()
        +
        Return the effective side for the context in the game. This is dependent + on thread analysis to try and determine whether the code is running in the + server or not. Use at your own risk
        +
        • +
      + + + +
        +
      • +

        raiseException

        +
        public void raiseException(java.lang.Throwable exception,
+                  java.lang.String message,
+                  boolean stopGame)
        +
        Raise an exception
        +
        • +
      + + + +
        +
      • +

        computeBranding

        +
        public void computeBranding()
        +
        • +
      + + + +
        +
      • +

        getBrandings

        +
        public java.util.List<java.lang.String> getBrandings(boolean includeMC)
        +
        • +
      + + + + + + + +
        +
      • +

        onPostServerTick

        +
        public void onPostServerTick()
        +
        • +
      + + + +
        +
      • +

        onPostWorldTick

        +
        public void onPostWorldTick(World world)
        +
        Every tick just after world and other ticks occur
        +
        • +
      + + + +
        +
      • +

        onPreServerTick

        +
        public void onPreServerTick()
        +
        • +
      + + + +
        +
      • +

        onPreWorldTick

        +
        public void onPreWorldTick(World world)
        +
        Every tick just before world and other ticks occur
        +
        • +
      + + + +
        +
      • +

        handleServerAboutToStart

        +
        public boolean handleServerAboutToStart(MinecraftServer server)
        +
        • +
      + + + +
        +
      • +

        handleServerStarting

        +
        public boolean handleServerStarting(MinecraftServer server)
        +
        • +
      + + + +
        +
      • +

        handleServerStarted

        +
        public void handleServerStarted()
        +
        • +
      + + + +
        +
      • +

        handleServerStopping

        +
        public void handleServerStopping()
        +
        • +
      + + + +
        +
      • +

        getSavesDirectory

        +
        public java.io.File getSavesDirectory()
        +
        • +
      + + + +
        +
      • +

        getMinecraftServerInstance

        +
        public MinecraftServer getMinecraftServerInstance()
        +
        • +
      + + + +
        +
      • +

        showGuiScreen

        +
        public void showGuiScreen(java.lang.Object clientGuiElement)
        +
        • +
      + + + +
        +
      • +

        queryUser

        +
        public void queryUser(StartupQuery query)
+               throws java.lang.InterruptedException
        +
        Throws:
        +
        java.lang.InterruptedException
        +
        • +
      + + + +
        +
      • +

        onServerStart

        +
        public void onServerStart(MinecraftServer dedicatedServer)
        +
        • +
      + + + +
        +
      • +

        onServerStarted

        +
        public void onServerStarted()
        +
        • +
      + + + +
        +
      • +

        onPreClientTick

        +
        public void onPreClientTick()
        +
        • +
      + + + +
        +
      • +

        onPostClientTick

        +
        public void onPostClientTick()
        +
        • +
      + + + +
        +
      • +

        onRenderTickStart

        +
        public void onRenderTickStart(float timer)
        +
        • +
      + + + +
        +
      • +

        onRenderTickEnd

        +
        public void onRenderTickEnd(float timer)
        +
        • +
      + + + +
        +
      • +

        onPlayerPreTick

        +
        public void onPlayerPreTick(EntityPlayer player)
        +
        • +
      + + + +
        +
      • +

        onPlayerPostTick

        +
        public void onPlayerPostTick(EntityPlayer player)
        +
        • +
      + + + +
        +
      • +

        registerCrashCallable

        +
        public void registerCrashCallable(ICrashCallable callable)
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        confirmBackupLevelDatUse

        +
        public void confirmBackupLevelDatUse(SaveHandler handler)
        +
        • +
      + + + +
        +
      • +

        shouldServerBeKilledQuietly

        +
        public boolean shouldServerBeKilledQuietly()
        +
        • +
      + + + +
        +
      • +

        expectServerStopped

        +
        public void expectServerStopped()
        +
        Make handleExit() wait for handleServerStopped(). + + For internal use only!
        +
        • +
      + + + +
        +
      • +

        handleExit

        +
        public void handleExit(int retVal)
        +
        Delayed System.exit() until the server is actually stopped/done saving. + + For internal use only!
        +
        Parameters:
        retVal - Exit code for System.exit()
        +
        • +
      + + + +
        +
      • +

        handleServerStopped

        +
        public void handleServerStopped()
        +
        • +
      + + + +
        +
      • +

        getModName

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

        addModToResourcePack

        +
        public void addModToResourcePack(ModContainer container)
        +
        • +
      + + + +
        +
      • +

        getCurrentLanguage

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

        bootstrap

        +
        public void bootstrap()
        +
        • +
      + + + +
        +
      • +

        getClientToServerNetworkManager

        +
        public NetworkManager getClientToServerNetworkManager()
        +
        • +
      + + + +
        +
      • +

        fireMouseInput

        +
        public void fireMouseInput()
        +
        • +
      + + + +
        +
      • +

        fireKeyInput

        +
        public void fireKeyInput()
        +
        • +
      + + + +
        +
      • +

        firePlayerChangedDimensionEvent

        +
        public void firePlayerChangedDimensionEvent(EntityPlayer player,
+                                   int fromDim,
+                                   int toDim)
        +
        • +
      + + + +
        +
      • +

        firePlayerLoggedIn

        +
        public void firePlayerLoggedIn(EntityPlayer player)
        +
        • +
      + + + +
        +
      • +

        firePlayerLoggedOut

        +
        public void firePlayerLoggedOut(EntityPlayer player)
        +
        • +
      + + + +
        +
      • +

        firePlayerRespawnEvent

        +
        public void firePlayerRespawnEvent(EntityPlayer player)
        +
        • +
      + + + +
        +
      • +

        firePlayerItemPickupEvent

        +
        public void firePlayerItemPickupEvent(EntityPlayer player,
+                             EntityItem item)
        +
        • +
      + + + + + + + +
        +
      • +

        firePlayerSmeltedEvent

        +
        public void firePlayerSmeltedEvent(EntityPlayer player,
+                          ItemStack smelted)
        +
        • +
      + + + +
        +
      • +

        getClientPlayHandler

        +
        public INetHandler getClientPlayHandler()
        +
        • +
      + + + +
        +
      • +

        waitForPlayClient

        +
        public void waitForPlayClient()
        +
        • +
      + + + +
        +
      • +

        fireNetRegistrationEvent

        +
        public void fireNetRegistrationEvent(NetworkManager manager,
+                            java.util.Set<java.lang.String> channelSet,
+                            java.lang.String channel,
+                            Side side)
        +
        • +
      + + + +
        +
      • +

        shouldAllowPlayerLogins

        +
        public boolean shouldAllowPlayerLogins()
        +
        • +
      + + + +
        +
      • +

        exitJava

        +
        public void exitJava(int exitCode,
+            boolean hardExit)
        +
        Used to exit from java, with system exit preventions in place. Will be tidy about it and just log a message, + unless debugging is enabled
        +
        Parameters:
        exitCode - The exit code
        hardExit - Perform a halt instead of an exit (only use when the world is unsavable) - read the warnings at Runtime.halt(int)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/FMLContainer.html b/javadoc/cpw/mods/fml/common/FMLContainer.html new file mode 100644 index 0000000..5ef9237 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/FMLContainer.html @@ -0,0 +1,492 @@ + + + + + +FMLContainer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class FMLContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/FMLLog.html b/javadoc/cpw/mods/fml/common/FMLLog.html new file mode 100644 index 0000000..1a746ea --- /dev/null +++ b/javadoc/cpw/mods/fml/common/FMLLog.html @@ -0,0 +1,420 @@ + + + + + +FMLLog (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class FMLLog

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

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidbigWarning(java.lang.String format, + java.lang.Object... data) 
      static voidfine(java.lang.String format, + java.lang.Object... data) 
      static voidfiner(java.lang.String format, + java.lang.Object... data) 
      static org.apache.logging.log4j.LoggergetLogger() 
      static voidinfo(java.lang.String format, + java.lang.Object... data) 
      static voidlog(org.apache.logging.log4j.Level level, + java.lang.String format, + java.lang.Object... data) 
      static voidlog(org.apache.logging.log4j.Level level, + java.lang.Throwable ex, + java.lang.String format, + java.lang.Object... data) 
      static voidlog(java.lang.String targetLog, + org.apache.logging.log4j.Level level, + java.lang.String format, + java.lang.Object... data) 
      static voidlog(java.lang.String targetLog, + org.apache.logging.log4j.Level level, + java.lang.Throwable ex, + java.lang.String format, + java.lang.Object... data) 
      static voidsevere(java.lang.String format, + java.lang.Object... data) 
      static voidwarning(java.lang.String format, + java.lang.Object... data) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FMLLog

        +
        public FMLLog()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        log

        +
        public static void log(java.lang.String targetLog,
+       org.apache.logging.log4j.Level level,
+       java.lang.String format,
+       java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        log

        +
        public static void log(org.apache.logging.log4j.Level level,
+       java.lang.String format,
+       java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        log

        +
        public static void log(java.lang.String targetLog,
+       org.apache.logging.log4j.Level level,
+       java.lang.Throwable ex,
+       java.lang.String format,
+       java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        log

        +
        public static void log(org.apache.logging.log4j.Level level,
+       java.lang.Throwable ex,
+       java.lang.String format,
+       java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        severe

        +
        public static void severe(java.lang.String format,
+          java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        bigWarning

        +
        public static void bigWarning(java.lang.String format,
+              java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        warning

        +
        public static void warning(java.lang.String format,
+           java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        info

        +
        public static void info(java.lang.String format,
+        java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        fine

        +
        public static void fine(java.lang.String format,
+        java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        finer

        +
        public static void finer(java.lang.String format,
+         java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        getLogger

        +
        public static org.apache.logging.log4j.Logger getLogger()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/FMLModContainer.html b/javadoc/cpw/mods/fml/common/FMLModContainer.html new file mode 100644 index 0000000..a16dd8f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/FMLModContainer.html @@ -0,0 +1,830 @@ + + + + + +FMLModContainer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class FMLModContainer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    ModContainer
    +
    +
    +
    +
    public class FMLModContainer
+extends java.lang.Object
+implements ModContainer
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLModContainer

        +
        public FMLModContainer(java.lang.String className,
+               ModCandidate container,
+               java.util.Map<java.lang.String,java.lang.Object> modDescriptor)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getModId

        +
        public java.lang.String getModId()
        +
        Description copied from interface: ModContainer
        +
        The globally unique modid for this mod
        +
        +
        Specified by:
        +
        getModId in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: ModContainer
        +
        A human readable name
        +
        +
        Specified by:
        +
        getName in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        Description copied from interface: ModContainer
        +
        A human readable version identifier
        +
        +
        Specified by:
        +
        getVersion in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getSource

        +
        public java.io.File getSource()
        +
        Description copied from interface: ModContainer
        +
        The location on the file system which this mod came from
        +
        +
        Specified by:
        +
        getSource in interface ModContainer
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        searchForVersionProperties

        +
        public java.util.Properties searchForVersionProperties()
        +
        • +
      + + + +
        +
      • +

        setEnabledState

        +
        public void setEnabledState(boolean enabled)
        +
        Description copied from interface: ModContainer
        +
        Set the enabled/disabled state of this mod
        +
        +
        Specified by:
        +
        setEnabledState in interface ModContainer
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getDependencies

        +
        public java.util.List<ArtifactVersion> getDependencies()
        +
        Description copied from interface: ModContainer
        +
        A list of modids that should be loaded prior to this one. The special + value * indicates to load after any other mod.
        +
        +
        Specified by:
        +
        getDependencies in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getDependants

        +
        public java.util.List<ArtifactVersion> getDependants()
        +
        Description copied from interface: ModContainer
        +
        A list of modids that should be loaded after this one. The + special value * indicates to load before any + other mod.
        +
        +
        Specified by:
        +
        getDependants in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getSortingRules

        +
        public java.lang.String getSortingRules()
        +
        Description copied from interface: ModContainer
        +
        A representative string encapsulating the sorting preferences for this + mod
        +
        +
        Specified by:
        +
        getSortingRules in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        matches

        +
        public boolean matches(java.lang.Object mod)
        +
        Description copied from interface: ModContainer
        +
        Does this mod match the supplied mod
        +
        +
        Specified by:
        +
        matches in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getMod

        +
        public java.lang.Object getMod()
        +
        Description copied from interface: ModContainer
        +
        Get the actual mod object
        +
        +
        Specified by:
        +
        getMod in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        registerBus

        +
        public boolean registerBus(com.google.common.eventbus.EventBus bus,
+                  LoadController controller)
        +
        Description copied from interface: ModContainer
        +
        Register the event bus for the mod and the controller for error handling + Returns if this bus was successfully registered - disabled mods and other + mods that don't need real events should return false and avoid further + processing
        +
        +
        Specified by:
        +
        registerBus in interface ModContainer
        +
        +
        • +
      + + + + + + + +
        +
      • +

        handleModStateEvent

        +
        public void handleModStateEvent(FMLEvent event)
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        toString

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

        getCustomModProperties

        +
        public java.util.Map<java.lang.String,java.lang.String> getCustomModProperties()
        +
        +
        Specified by:
        +
        getCustomModProperties in interface ModContainer
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getSharedModDescriptor

        +
        public java.util.Map<java.lang.String,java.lang.String> getSharedModDescriptor()
        +
        +
        Specified by:
        +
        getSharedModDescriptor in interface ModContainer
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getOwnedPackages

        +
        public java.util.List<java.lang.String> getOwnedPackages()
        +
        +
        Specified by:
        +
        getOwnedPackages in interface ModContainer
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/IASMHook.html b/javadoc/cpw/mods/fml/common/IASMHook.html new file mode 100644 index 0000000..a53c223 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/IASMHook.html @@ -0,0 +1,231 @@ + + + + + +IASMHook (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Interface IASMHook

+
+
+
+
    +
  • +
    +
    +
    public interface IASMHook
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      org.objectweb.asm.tree.ClassNode[]inject(org.objectweb.asm.tree.ClassNode modClassNode) +
      Inject the Mod class node into this instance.
      +
      voidmodifyClass(java.lang.String className, + org.objectweb.asm.tree.ClassNode node) +
      Allow mods to manipulate classes loaded from this Mod's jar file.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        inject

        +
        org.objectweb.asm.tree.ClassNode[] inject(org.objectweb.asm.tree.ClassNode modClassNode)
        +
        Inject the Mod class node into this instance. This allows retrieval from custom + attributes or other artifacts in your mod class
        +
        Parameters:
        modClassNode - The mod class
        +
        Returns:
        optionally some code generated classes that will be injected into the classloader
        +
        • +
      + + + +
        +
      • +

        modifyClass

        +
        void modifyClass(java.lang.String className,
+               org.objectweb.asm.tree.ClassNode node)
        +
        Allow mods to manipulate classes loaded from this Mod's jar file. The Mod + class is always guaranteed to be called first. + The node state should be changed in place.
        +
        Parameters:
        node - The class being loaded
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/ICrashCallable.html b/javadoc/cpw/mods/fml/common/ICrashCallable.html new file mode 100644 index 0000000..2c58691 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ICrashCallable.html @@ -0,0 +1,216 @@ + + + + + +ICrashCallable (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Interface ICrashCallable

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.util.concurrent.Callable<java.lang.String>
    +
    +
    +
    +
    public interface ICrashCallable
+extends java.util.concurrent.Callable<java.lang.String>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetLabel() 
      +
        +
      • + + +

        Methods inherited from interface java.util.concurrent.Callable

        +call
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLabel

        +
        java.lang.String getLabel()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/IFMLHandledException.html b/javadoc/cpw/mods/fml/common/IFMLHandledException.html new file mode 100644 index 0000000..4cb7982 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/IFMLHandledException.html @@ -0,0 +1,160 @@ + + + + + +IFMLHandledException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Interface IFMLHandledException

+
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/IFMLSidedHandler.html b/javadoc/cpw/mods/fml/common/IFMLSidedHandler.html new file mode 100644 index 0000000..ec4ece4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/IFMLSidedHandler.html @@ -0,0 +1,455 @@ + + + + + +IFMLSidedHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Interface IFMLSidedHandler

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

      Method Detail

      + + + +
        +
      • +

        getAdditionalBrandingInformation

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

        getSide

        +
        Side getSide()
        +
        • +
      + + + +
        +
      • +

        haltGame

        +
        void haltGame(java.lang.String message,
+            java.lang.Throwable exception)
        +
        • +
      + + + +
        +
      • +

        showGuiScreen

        +
        void showGuiScreen(java.lang.Object clientGuiElement)
        +
        • +
      + + + +
        +
      • +

        queryUser

        +
        void queryUser(StartupQuery query)
+               throws java.lang.InterruptedException
        +
        Throws:
        +
        java.lang.InterruptedException
        +
        • +
      + + + +
        +
      • +

        beginServerLoading

        +
        void beginServerLoading(MinecraftServer server)
        +
        • +
      + + + +
        +
      • +

        finishServerLoading

        +
        void finishServerLoading()
        +
        • +
      + + + +
        +
      • +

        getSavesDirectory

        +
        java.io.File getSavesDirectory()
        +
        • +
      + + + + + + + +
        +
      • +

        shouldServerShouldBeKilledQuietly

        +
        boolean shouldServerShouldBeKilledQuietly()
        +
        • +
      + + + +
        +
      • +

        addModAsResource

        +
        void addModAsResource(ModContainer container)
        +
        • +
      + + + +
        +
      • +

        getCurrentLanguage

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

        serverStopped

        +
        void serverStopped()
        +
        • +
      + + + +
        +
      • +

        getClientToServerNetworkManager

        +
        NetworkManager getClientToServerNetworkManager()
        +
        • +
      + + + +
        +
      • +

        getClientPlayHandler

        +
        INetHandler getClientPlayHandler()
        +
        • +
      + + + +
        +
      • +

        waitForPlayClient

        +
        void waitForPlayClient()
        +
        • +
      + + + +
        +
      • +

        fireNetRegistrationEvent

        +
        void fireNetRegistrationEvent(EventBus bus,
+                            NetworkManager manager,
+                            java.util.Set<java.lang.String> channelSet,
+                            java.lang.String channel,
+                            Side side)
        +
        • +
      + + + +
        +
      • +

        shouldAllowPlayerLogins

        +
        boolean shouldAllowPlayerLogins()
        +
        • +
      + + + +
        +
      • +

        allowLogins

        +
        void allowLogins()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/IFuelHandler.html b/javadoc/cpw/mods/fml/common/IFuelHandler.html new file mode 100644 index 0000000..8659cd7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/IFuelHandler.html @@ -0,0 +1,204 @@ + + + + + +IFuelHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Interface IFuelHandler

+
+
+
+
    +
  • +
    +
    +
    public interface IFuelHandler
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intgetBurnTime(ItemStack fuel) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBurnTime

        +
        int getBurnTime(ItemStack fuel)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/ILanguageAdapter.JavaAdapter.html b/javadoc/cpw/mods/fml/common/ILanguageAdapter.JavaAdapter.html new file mode 100644 index 0000000..775f5e8 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ILanguageAdapter.JavaAdapter.html @@ -0,0 +1,357 @@ + + + + + +ILanguageAdapter.JavaAdapter (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class ILanguageAdapter.JavaAdapter

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

      Constructor Detail

      + + + +
        +
      • +

        ILanguageAdapter.JavaAdapter

        +
        public ILanguageAdapter.JavaAdapter()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getNewInstance

        +
        public java.lang.Object getNewInstance(FMLModContainer container,
+                              java.lang.Class<?> objectClass,
+                              java.lang.ClassLoader classLoader,
+                              java.lang.reflect.Method factoryMarkedMethod)
+                                throws java.lang.Exception
        +
        +
        Specified by:
        +
        getNewInstance in interface ILanguageAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + + + +
        +
      • +

        setProxy

        +
        public void setProxy(java.lang.reflect.Field target,
+            java.lang.Class<?> proxyTarget,
+            java.lang.Object proxy)
+              throws java.lang.IllegalArgumentException,
+                     java.lang.IllegalAccessException,
+                     java.lang.NoSuchFieldException,
+                     java.lang.SecurityException
        +
        +
        Specified by:
        +
        setProxy in interface ILanguageAdapter
        +
        Throws:
        +
        java.lang.IllegalArgumentException
        +
        java.lang.IllegalAccessException
        +
        java.lang.NoSuchFieldException
        +
        java.lang.SecurityException
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/ILanguageAdapter.ScalaAdapter.html b/javadoc/cpw/mods/fml/common/ILanguageAdapter.ScalaAdapter.html new file mode 100644 index 0000000..d4705e4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ILanguageAdapter.ScalaAdapter.html @@ -0,0 +1,357 @@ + + + + + +ILanguageAdapter.ScalaAdapter (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class ILanguageAdapter.ScalaAdapter

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

      Constructor Detail

      + + + +
        +
      • +

        ILanguageAdapter.ScalaAdapter

        +
        public ILanguageAdapter.ScalaAdapter()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getNewInstance

        +
        public java.lang.Object getNewInstance(FMLModContainer container,
+                              java.lang.Class<?> scalaObjectClass,
+                              java.lang.ClassLoader classLoader,
+                              java.lang.reflect.Method factoryMarkedAnnotation)
+                                throws java.lang.Exception
        +
        +
        Specified by:
        +
        getNewInstance in interface ILanguageAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + + + +
        +
      • +

        setProxy

        +
        public void setProxy(java.lang.reflect.Field target,
+            java.lang.Class<?> proxyTarget,
+            java.lang.Object proxy)
+              throws java.lang.IllegalArgumentException,
+                     java.lang.IllegalAccessException,
+                     java.lang.NoSuchFieldException,
+                     java.lang.SecurityException
        +
        +
        Specified by:
        +
        setProxy in interface ILanguageAdapter
        +
        Throws:
        +
        java.lang.IllegalArgumentException
        +
        java.lang.IllegalAccessException
        +
        java.lang.NoSuchFieldException
        +
        java.lang.SecurityException
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/ILanguageAdapter.html b/javadoc/cpw/mods/fml/common/ILanguageAdapter.html new file mode 100644 index 0000000..3160484 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ILanguageAdapter.html @@ -0,0 +1,296 @@ + + + + + +ILanguageAdapter (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Interface ILanguageAdapter

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

      Method Detail

      + + + +
        +
      • +

        getNewInstance

        +
        java.lang.Object getNewInstance(FMLModContainer container,
+                              java.lang.Class<?> objectClass,
+                              java.lang.ClassLoader classLoader,
+                              java.lang.reflect.Method factoryMarkedAnnotation)
+                                throws java.lang.Exception
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        supportsStatics

        +
        boolean supportsStatics()
        +
        • +
      + + + +
        +
      • +

        setProxy

        +
        void setProxy(java.lang.reflect.Field target,
+            java.lang.Class<?> proxyTarget,
+            java.lang.Object proxy)
+              throws java.lang.IllegalArgumentException,
+                     java.lang.IllegalAccessException,
+                     java.lang.NoSuchFieldException,
+                     java.lang.SecurityException
        +
        Throws:
        +
        java.lang.IllegalArgumentException
        +
        java.lang.IllegalAccessException
        +
        java.lang.NoSuchFieldException
        +
        java.lang.SecurityException
        +
        • +
      + + + +
        +
      • +

        setInternalProxies

        +
        void setInternalProxies(ModContainer mod,
+                      Side side,
+                      java.lang.ClassLoader loader)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/IWorldGenerator.html b/javadoc/cpw/mods/fml/common/IWorldGenerator.html new file mode 100644 index 0000000..0a5c38c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/IWorldGenerator.html @@ -0,0 +1,219 @@ + + + + + +IWorldGenerator (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Interface IWorldGenerator

+
+
+
+
    +
  • +
    +
    +
    public interface IWorldGenerator
    +
    This is called back during world generation.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidgenerate(java.util.Random random, + int chunkX, + int chunkZ, + World world, + IChunkProvider chunkGenerator, + IChunkProvider chunkProvider) +
      Generate some world
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        generate

        +
        void generate(java.util.Random random,
+            int chunkX,
+            int chunkZ,
+            World world,
+            IChunkProvider chunkGenerator,
+            IChunkProvider chunkProvider)
        +
        Generate some world
        +
        Parameters:
        random - the chunk specific Random.
        chunkX - the chunk X coordinate of this chunk.
        chunkZ - the chunk Z coordinate of this chunk.
        world - : additionalData[0] The minecraft World we're generating for.
        chunkGenerator - : additionalData[1] The IChunkProvider that is generating.
        chunkProvider - : additionalData[2] IChunkProvider that is requesting the world generation.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/InjectedModContainer.html b/javadoc/cpw/mods/fml/common/InjectedModContainer.html new file mode 100644 index 0000000..eef0d6e --- /dev/null +++ b/javadoc/cpw/mods/fml/common/InjectedModContainer.html @@ -0,0 +1,830 @@ + + + + + +InjectedModContainer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class InjectedModContainer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    ModContainer
    +
    +
    +
    +
    public class InjectedModContainer
+extends java.lang.Object
+implements ModContainer
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        wrappedContainer

        +
        public final ModContainer wrappedContainer
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InjectedModContainer

        +
        public InjectedModContainer(ModContainer mc,
+                    java.io.File source)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getModId

        +
        public java.lang.String getModId()
        +
        Description copied from interface: ModContainer
        +
        The globally unique modid for this mod
        +
        +
        Specified by:
        +
        getModId in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: ModContainer
        +
        A human readable name
        +
        +
        Specified by:
        +
        getName in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        Description copied from interface: ModContainer
        +
        A human readable version identifier
        +
        +
        Specified by:
        +
        getVersion in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getSource

        +
        public java.io.File getSource()
        +
        Description copied from interface: ModContainer
        +
        The location on the file system which this mod came from
        +
        +
        Specified by:
        +
        getSource in interface ModContainer
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        setEnabledState

        +
        public void setEnabledState(boolean enabled)
        +
        Description copied from interface: ModContainer
        +
        Set the enabled/disabled state of this mod
        +
        +
        Specified by:
        +
        setEnabledState in interface ModContainer
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getDependencies

        +
        public java.util.List<ArtifactVersion> getDependencies()
        +
        Description copied from interface: ModContainer
        +
        A list of modids that should be loaded prior to this one. The special + value * indicates to load after any other mod.
        +
        +
        Specified by:
        +
        getDependencies in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getDependants

        +
        public java.util.List<ArtifactVersion> getDependants()
        +
        Description copied from interface: ModContainer
        +
        A list of modids that should be loaded after this one. The + special value * indicates to load before any + other mod.
        +
        +
        Specified by:
        +
        getDependants in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getSortingRules

        +
        public java.lang.String getSortingRules()
        +
        Description copied from interface: ModContainer
        +
        A representative string encapsulating the sorting preferences for this + mod
        +
        +
        Specified by:
        +
        getSortingRules in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        registerBus

        +
        public boolean registerBus(com.google.common.eventbus.EventBus bus,
+                  LoadController controller)
        +
        Description copied from interface: ModContainer
        +
        Register the event bus for the mod and the controller for error handling + Returns if this bus was successfully registered - disabled mods and other + mods that don't need real events should return false and avoid further + processing
        +
        +
        Specified by:
        +
        registerBus in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        matches

        +
        public boolean matches(java.lang.Object mod)
        +
        Description copied from interface: ModContainer
        +
        Does this mod match the supplied mod
        +
        +
        Specified by:
        +
        matches in interface ModContainer
        +
        +
        • +
      + + + +
        +
      • +

        getMod

        +
        public java.lang.Object getMod()
        +
        Description copied from interface: ModContainer
        +
        Get the actual mod object
        +
        +
        Specified by:
        +
        getMod in interface ModContainer
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        getWrappedWorldAccessContainer

        +
        public WorldAccessContainer getWrappedWorldAccessContainer()
        +
        • +
      + + + + + + + +
        +
      • +

        toString

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

        getCustomModProperties

        +
        public java.util.Map<java.lang.String,java.lang.String> getCustomModProperties()
        +
        +
        Specified by:
        +
        getCustomModProperties in interface ModContainer
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getSharedModDescriptor

        +
        public java.util.Map<java.lang.String,java.lang.String> getSharedModDescriptor()
        +
        +
        Specified by:
        +
        getSharedModDescriptor in interface ModContainer
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getOwnedPackages

        +
        public java.util.List<java.lang.String> getOwnedPackages()
        +
        +
        Specified by:
        +
        getOwnedPackages in interface ModContainer
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/LoadController.html b/javadoc/cpw/mods/fml/common/LoadController.html new file mode 100644 index 0000000..83c66b7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/LoadController.html @@ -0,0 +1,416 @@ + + + + + +LoadController (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class LoadController

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

      Constructor Detail

      + + + +
        +
      • +

        LoadController

        +
        public LoadController(Loader loader)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        buildModList

        +
        public void buildModList(FMLLoadEvent event)
        +
        • +
      + + + +
        +
      • +

        distributeStateMessage

        +
        public void distributeStateMessage(LoaderState state,
+                          java.lang.Object... eventData)
        +
        • +
      + + + +
        +
      • +

        transition

        +
        public void transition(LoaderState desiredState,
+              boolean forceState)
        +
        • +
      + + + +
        +
      • +

        activeContainer

        +
        public ModContainer activeContainer()
        +
        • +
      + + + +
        +
      • +

        propogateStateMessage

        +
        public void propogateStateMessage(FMLEvent stateEvent)
        +
        • +
      + + + +
        +
      • +

        buildModObjectList

        +
        public com.google.common.collect.ImmutableBiMap<ModContainer,java.lang.Object> buildModObjectList()
        +
        • +
      + + + +
        +
      • +

        errorOccurred

        +
        public void errorOccurred(ModContainer modContainer,
+                 java.lang.Throwable exception)
        +
        • +
      + + + +
        +
      • +

        printModStates

        +
        public void printModStates(java.lang.StringBuilder ret)
        +
        • +
      + + + +
        +
      • +

        getActiveModList

        +
        public java.util.List<ModContainer> getActiveModList()
        +
        • +
      + + + + + + + +
        +
      • +

        distributeStateMessage

        +
        public void distributeStateMessage(java.lang.Class<?> customEvent)
        +
        • +
      + + + +
        +
      • +

        getModObjectList

        +
        public com.google.common.collect.BiMap<ModContainer,java.lang.Object> getModObjectList()
        +
        • +
      + + + +
        +
      • +

        isInState

        +
        public boolean isInState(LoaderState state)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/Loader.html b/javadoc/cpw/mods/fml/common/Loader.html new file mode 100644 index 0000000..bd0395a --- /dev/null +++ b/javadoc/cpw/mods/fml/common/Loader.html @@ -0,0 +1,741 @@ + + + + + +Loader (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class Loader

+
+
+ +
+
    +
  • +
    +
    +
    public class Loader
+extends java.lang.Object
    +
    The loader class performs the actual loading of the mod code from disk. + +

    + There are several LoaderStates to mod loading, triggered in two + different stages from the FML handler code's hooks into the minecraft code. +

    + +
      +
    1. LOADING. Scanning the filesystem for mod containers to load (zips, jars, + directories), adding them to the modClassLoader Scanning, the loaded + containers for mod classes to load and registering them appropriately.
      2. +
    2. PREINIT. The mod classes are configured, they are sorted into a load + order, and instances of the mods are constructed.
      3. +
    3. INIT. The mod instances are initialized. For BaseMod mods, this involves + calling the load method.
      4. +
    4. POSTINIT. The mod instances are post initialized. For BaseMod mods this + involves calling the modsLoaded method.
      5. +
    5. UP. The Loader is complete
      6. +
    6. ERRORED. The loader encountered an error during the LOADING phase and + dropped to this state instead. It will not complete loading from this state, + but it attempts to continue loading before abandoning and giving a fatal + error.
      7. +
    + + Phase 1 code triggers the LOADING and PREINIT states. Phase 2 code triggers + the INIT and POSTINIT states.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        instance

        +
        public static Loader instance()
        +
        • +
      + + + +
        +
      • +

        injectData

        +
        public static void injectData(java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        getModList

        +
        public java.util.List<ModContainer> getModList()
        +
        • +
      + + + +
        +
      • +

        loadMods

        +
        public void loadMods()
        +
        Called from the hook to start mod loading. We trigger the + identifyMods() and Constructing, Preinitalization, and Initalization phases here. Finally, + the mod list is frozen completely and is consider immutable from then on.
        +
        • +
      + + + +
        +
      • +

        preinitializeMods

        +
        public void preinitializeMods()
        +
        • +
      + + + +
        +
      • +

        isModLoaded

        +
        public static boolean isModLoaded(java.lang.String modname)
        +
        Query if we know of a mod named modname
        +
        Parameters:
        modname -
        +
        Returns:
        If the mod is loaded
        +
        • +
      + + + +
        +
      • +

        getConfigDir

        +
        public java.io.File getConfigDir()
        +
        • +
      + + + +
        +
      • +

        getCrashInformation

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

        getFMLVersionString

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

        getModClassLoader

        +
        public java.lang.ClassLoader getModClassLoader()
        +
        • +
      + + + +
        +
      • +

        computeDependencies

        +
        public void computeDependencies(java.lang.String dependencyString,
+                       java.util.Set<ArtifactVersion> requirements,
+                       java.util.List<ArtifactVersion> dependencies,
+                       java.util.List<ArtifactVersion> dependants)
        +
        • +
      + + + +
        +
      • +

        getIndexedModList

        +
        public java.util.Map<java.lang.String,ModContainer> getIndexedModList()
        +
        • +
      + + + +
        +
      • +

        initializeMods

        +
        public void initializeMods()
        +
        • +
      + + + +
        +
      • +

        getCallableCrashInformation

        +
        public ICrashCallable getCallableCrashInformation()
        +
        • +
      + + + +
        +
      • +

        getActiveModList

        +
        public java.util.List<ModContainer> getActiveModList()
        +
        • +
      + + + + + + + +
        +
      • +

        getMCVersionString

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

        serverStarting

        +
        public boolean serverStarting(java.lang.Object server)
        +
        • +
      + + + +
        +
      • +

        serverStarted

        +
        public void serverStarted()
        +
        • +
      + + + +
        +
      • +

        serverStopping

        +
        public void serverStopping()
        +
        • +
      + + + +
        +
      • +

        getModObjectList

        +
        public com.google.common.collect.BiMap<ModContainer,java.lang.Object> getModObjectList()
        +
        • +
      + + + +
        +
      • +

        getReversedModObjectList

        +
        public com.google.common.collect.BiMap<java.lang.Object,ModContainer> getReversedModObjectList()
        +
        • +
      + + + +
        +
      • +

        activeModContainer

        +
        public ModContainer activeModContainer()
        +
        • +
      + + + +
        +
      • +

        isInState

        +
        public boolean isInState(LoaderState state)
        +
        • +
      + + + + + + + +
        +
      • +

        hasReachedState

        +
        public boolean hasReachedState(LoaderState state)
        +
        • +
      + + + +
        +
      • +

        getMCPVersionString

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

        serverStopped

        +
        public void serverStopped()
        +
        • +
      + + + +
        +
      • +

        serverAboutToStart

        +
        public boolean serverAboutToStart(java.lang.Object server)
        +
        • +
      + + + +
        +
      • +

        getFMLBrandingProperties

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

        getCustomModProperties

        +
        public java.util.Map<java.lang.String,java.lang.String> getCustomModProperties(java.lang.String modId)
        +
        • +
      + + + +
        +
      • +

        fireMissingMappingEvent

        +
        public java.util.List<java.lang.String> fireMissingMappingEvent(java.util.LinkedHashMap<java.lang.String,java.lang.Integer> missing,
+                                                       boolean isLocalWorld,
+                                                       GameData gameData,
+                                                       java.util.Map<java.lang.String,java.lang.Integer[]> remaps)
        +
        Fire a FMLMissingMappingsEvent to let mods determine how blocks/items defined in the world + save, but missing from the runtime, are to be handled.
        +
        Parameters:
        missing - Map containing missing names with their associated id, blocks need to come before items for remapping.
        isLocalWorld - Whether this is executing for a world load (local/server) or a client.
        gameData - GameData instance where the new map's config is to be loaded into.
        +
        Returns:
        List with the mapping results.
        +
        • +
      + + + +
        +
      • +

        fireRemapEvent

        +
        public void fireRemapEvent(java.util.Map<java.lang.String,java.lang.Integer[]> remaps)
        +
        • +
      + + + +
        +
      • +

        runtimeDisableMod

        +
        public void runtimeDisableMod(java.lang.String modId)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/LoaderException.html b/javadoc/cpw/mods/fml/common/LoaderException.html new file mode 100644 index 0000000..08f7fca --- /dev/null +++ b/javadoc/cpw/mods/fml/common/LoaderException.html @@ -0,0 +1,269 @@ + + + + + +LoaderException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Class LoaderException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    DuplicateModsFoundException
    +
    +
    +
    +
    public class LoaderException
+extends java.lang.RuntimeException
    +
    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

      + + + +
        +
      • +

        LoaderException

        +
        public LoaderException(java.lang.Throwable wrapped)
        +
        • +
      + + + +
        +
      • +

        LoaderException

        +
        public LoaderException()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/LoaderState.ModState.html b/javadoc/cpw/mods/fml/common/LoaderState.ModState.html new file mode 100644 index 0000000..3979ae5 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/LoaderState.ModState.html @@ -0,0 +1,422 @@ + + + + + +LoaderState.ModState (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Enum LoaderState.ModState

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

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringtoString() 
      static LoaderState.ModStatevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static LoaderState.ModState[]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, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static LoaderState.ModState[] 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 (LoaderState.ModState c : LoaderState.ModState.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static LoaderState.ModState 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
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Enum<LoaderState.ModState>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/LoaderState.html b/javadoc/cpw/mods/fml/common/LoaderState.html new file mode 100644 index 0000000..f6062c3 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/LoaderState.html @@ -0,0 +1,521 @@ + + + + + +LoaderState (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Enum LoaderState

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<LoaderState>
    +
    +
    +
    +
    public enum LoaderState
+extends java.lang.Enum<LoaderState>
    +
    The state enum used to help track state progression for the loader
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        NOINIT

        +
        public static final LoaderState NOINIT
        +
        • +
      + + + +
        +
      • +

        LOADING

        +
        public static final LoaderState LOADING
        +
        • +
      + + + +
        +
      • +

        CONSTRUCTING

        +
        public static final LoaderState CONSTRUCTING
        +
        • +
      + + + +
        +
      • +

        PREINITIALIZATION

        +
        public static final LoaderState PREINITIALIZATION
        +
        • +
      + + + +
        +
      • +

        INITIALIZATION

        +
        public static final LoaderState INITIALIZATION
        +
        • +
      + + + +
        +
      • +

        POSTINITIALIZATION

        +
        public static final LoaderState POSTINITIALIZATION
        +
        • +
      + + + +
        +
      • +

        AVAILABLE

        +
        public static final LoaderState AVAILABLE
        +
        • +
      + + + +
        +
      • +

        SERVER_ABOUT_TO_START

        +
        public static final LoaderState SERVER_ABOUT_TO_START
        +
        • +
      + + + +
        +
      • +

        SERVER_STARTING

        +
        public static final LoaderState SERVER_STARTING
        +
        • +
      + + + +
        +
      • +

        SERVER_STARTED

        +
        public static final LoaderState SERVER_STARTED
        +
        • +
      + + + +
        +
      • +

        SERVER_STOPPING

        +
        public static final LoaderState SERVER_STOPPING
        +
        • +
      + + + +
        +
      • +

        SERVER_STOPPED

        +
        public static final LoaderState SERVER_STOPPED
        +
        • +
      + + + +
        +
      • +

        ERRORED

        +
        public static final LoaderState ERRORED
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static LoaderState[] 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 (LoaderState c : LoaderState.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static LoaderState 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
        +
        • +
      + + + +
        +
      • +

        transition

        +
        public LoaderState transition(boolean errored)
        +
        • +
      + + + +
        +
      • +

        hasEvent

        +
        public boolean hasEvent()
        +
        • +
      + + + +
        +
      • +

        getEvent

        +
        public FMLStateEvent getEvent(java.lang.Object... eventData)
        +
        • +
      + + + +
        +
      • +

        requiredState

        +
        public LoaderState requiredState()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/MCPDummyContainer.html b/javadoc/cpw/mods/fml/common/MCPDummyContainer.html new file mode 100644 index 0000000..5ccdbc5 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/MCPDummyContainer.html @@ -0,0 +1,337 @@ + + + + + +MCPDummyContainer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class MCPDummyContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/MetadataCollection.ArtifactVersionAdapter.html b/javadoc/cpw/mods/fml/common/MetadataCollection.ArtifactVersionAdapter.html new file mode 100644 index 0000000..f51d7b2 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/MetadataCollection.ArtifactVersionAdapter.html @@ -0,0 +1,297 @@ + + + + + +MetadataCollection.ArtifactVersionAdapter (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class MetadataCollection.ArtifactVersionAdapter

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    MetadataCollection
    +
    +
    +
    +
    public static class MetadataCollection.ArtifactVersionAdapter
+extends com.google.gson.TypeAdapter<ArtifactVersion>
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      ArtifactVersionread(com.google.gson.stream.JsonReader in) 
      voidwrite(com.google.gson.stream.JsonWriter out, + ArtifactVersion value) 
      +
        +
      • + + +

        Methods inherited from class com.google.gson.TypeAdapter

        +fromJson, fromJson, fromJsonTree, nullSafe, toJson, toJson, toJsonTree
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MetadataCollection.ArtifactVersionAdapter

        +
        public MetadataCollection.ArtifactVersionAdapter()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        write

        +
        public void write(com.google.gson.stream.JsonWriter out,
+         ArtifactVersion value)
+           throws java.io.IOException
        +
        +
        Specified by:
        +
        write in class com.google.gson.TypeAdapter<ArtifactVersion>
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        read

        +
        public ArtifactVersion read(com.google.gson.stream.JsonReader in)
+                     throws java.io.IOException
        +
        +
        Specified by:
        +
        read in class com.google.gson.TypeAdapter<ArtifactVersion>
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/MetadataCollection.html b/javadoc/cpw/mods/fml/common/MetadataCollection.html new file mode 100644 index 0000000..56b536f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/MetadataCollection.html @@ -0,0 +1,290 @@ + + + + + +MetadataCollection (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class MetadataCollection

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

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static MetadataCollectionfrom(java.io.InputStream inputStream, + java.lang.String sourceName) 
      ModMetadatagetMetadataForId(java.lang.String modId, + java.util.Map<java.lang.String,java.lang.Object> extraData) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MetadataCollection

        +
        public MetadataCollection()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        from

        +
        public static MetadataCollection from(java.io.InputStream inputStream,
+                      java.lang.String sourceName)
        +
        • +
      + + + +
        +
      • +

        getMetadataForId

        +
        public ModMetadata getMetadataForId(java.lang.String modId,
+                           java.util.Map<java.lang.String,java.lang.Object> extraData)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/MinecraftDummyContainer.html b/javadoc/cpw/mods/fml/common/MinecraftDummyContainer.html new file mode 100644 index 0000000..3442c13 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/MinecraftDummyContainer.html @@ -0,0 +1,300 @@ + + + + + +MinecraftDummyContainer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class MinecraftDummyContainer

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

      Constructor Detail

      + + + +
        +
      • +

        MinecraftDummyContainer

        +
        public MinecraftDummyContainer(java.lang.String actualMCVersion)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStaticVersionRange

        +
        public VersionRange getStaticVersionRange()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/MissingModsException.html b/javadoc/cpw/mods/fml/common/MissingModsException.html new file mode 100644 index 0000000..d83b12d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/MissingModsException.html @@ -0,0 +1,289 @@ + + + + + +MissingModsException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class MissingModsException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class MissingModsException
+extends java.lang.RuntimeException
    +
    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

      + + + +
        +
      • +

        MissingModsException

        +
        public MissingModsException(java.util.Set<ArtifactVersion> missingMods)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/Mod.CustomProperty.html b/javadoc/cpw/mods/fml/common/Mod.CustomProperty.html new file mode 100644 index 0000000..97f5519 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/Mod.CustomProperty.html @@ -0,0 +1,220 @@ + + + + + +Mod.CustomProperty (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type Mod.CustomProperty

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value={})
+public static @interface Mod.CustomProperty
    +
    A custom key => value property pair for use with Mod.customProperties()
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringk +
      A key.
      +
      java.lang.Stringv +
      A value.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        k

        +
        public abstract java.lang.String k
        +
        A key. Should be unique.
        +
        Returns:
        A key
        +
        • +
      + + + +
        +
      • +

        v

        +
        public abstract java.lang.String v
        +
        A value. Can be anything.
        +
        Returns:
        A value
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/Mod.EventHandler.html b/javadoc/cpw/mods/fml/common/Mod.EventHandler.html new file mode 100644 index 0000000..c16d246 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/Mod.EventHandler.html @@ -0,0 +1,184 @@ + + + + + +Mod.EventHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type Mod.EventHandler

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=METHOD)
+public static @interface Mod.EventHandler
    +
    Marks the associated method as handling an FML lifecycle event. + The method must have a single parameter, one of the following types. This annotation + replaces the multiple different annotations that previously were used. + + Current event classes. This first section is standard lifecycle events. They are dispatched + at various phases as the game starts. Each event should have information useful to that + phase of the lifecycle. They are fired in this order. + + These suggestions are mostly just suggestions on what to do in each event. + +

    These are the server lifecycle events. They are fired whenever a server is running, or about to run. Each time a server + starts they will be fired in this sequence. +

    + The second set of events are more specialized, for receiving notification of specific + information. +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/Mod.Instance.html b/javadoc/cpw/mods/fml/common/Mod.Instance.html new file mode 100644 index 0000000..5da35be --- /dev/null +++ b/javadoc/cpw/mods/fml/common/Mod.Instance.html @@ -0,0 +1,207 @@ + + + + + +Mod.Instance (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type Mod.Instance

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=FIELD)
+public static @interface Mod.Instance
    +
    Populate the annotated field with the mod instance based on the specified ModId. This can be used + to retrieve instances of other mods.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Stringvalue +
      The mod object to inject into this field
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        The mod object to inject into this field
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/Mod.InstanceFactory.html b/javadoc/cpw/mods/fml/common/Mod.InstanceFactory.html new file mode 100644 index 0000000..c2c5536 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/Mod.InstanceFactory.html @@ -0,0 +1,151 @@ + + + + + +Mod.InstanceFactory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type Mod.InstanceFactory

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=METHOD)
+public static @interface Mod.InstanceFactory
    +
    Mod instance factory method. Should return an instance of the mod. Applies only to static methods on the same class as Mod.
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/Mod.Metadata.html b/javadoc/cpw/mods/fml/common/Mod.Metadata.html new file mode 100644 index 0000000..d53267b --- /dev/null +++ b/javadoc/cpw/mods/fml/common/Mod.Metadata.html @@ -0,0 +1,206 @@ + + + + + +Mod.Metadata (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type Mod.Metadata

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=FIELD)
+public static @interface Mod.Metadata
    +
    Populate the annotated field with the mod's metadata.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Stringvalue +
      The mod id specifying the metadata to load here
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        The mod id specifying the metadata to load here
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/Mod.html b/javadoc/cpw/mods/fml/common/Mod.html new file mode 100644 index 0000000..a392d90 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/Mod.html @@ -0,0 +1,565 @@ + + + + + +Mod (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type Mod

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=TYPE)
+public @interface Mod
    +
    This defines a Mod to FML. + Any class found with this annotation applied will be loaded as a Mod. The instance that is loaded will + represent the mod to other Mods in the system. It will be sent various subclasses of FMLEvent + at pre-defined times during the loading of the game, based on where you have applied the Mod.EventHandler + annotation. + +

    This is a simple example of a Mod. It has the modId of "MyModId", the name of "My example mod", it is + version 1.0, and depends on FML being loaded. + 

    package mymod;
+ // Declare that this is a mod with modId "MyModId", name "My example mod", version "1.0" and dependency on FML.
+ {@literal @}Mod(modId="MyModId",name="My example mod",version="1.0",dependencies="required-after:FML")
+ public class MyMod {
+      // Populate this field with the instance of the mod created by FML
+      {@literal @}Instance("MyModId")
+      public MyMod instance;
+
+      // Mark this method for receiving an {@link FMLEvent} (in this case, it's the {@link FMLPreInitializationEvent})
+      {@literal @}EventHandler public void preInit(FMLPreInitializationEvent event)
+      {
+          // Do stuff in pre-init phase (read config, create blocks and items, register them)
+      }
+ }
+ 
+
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringmodid +
      The unique mod identifier for this mod
      +
      +
      • +
    + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.StringacceptableRemoteVersions +
      A replacement for the no-longer-existing "versionRange" of NetworkMod.
      +
      java.lang.StringacceptableSaveVersions +
      A version range specifying compatible save version information.
      +
      java.lang.StringacceptedMinecraftVersions +
      The acceptable range of minecraft versions that this mod will load and run in + The default ("empty string") indicates that only the current minecraft version is acceptable.
      +
      java.lang.StringasmHookClass +
      Deprecated. 
      +
      java.lang.StringbukkitPlugin +
      An optional bukkit plugin that will be injected into the bukkit plugin framework if + this mod is loaded into the FML framework and the bukkit coremod is present.
      +
      booleancanBeDeactivated +
      If your mod doesn't have a runtime persistent effect on the state of the game, and can be disabled without side effects + (minimap mods, graphical tweak mods) then you can set true here and receive the FMLDeactivationEvent to perform deactivation + tasks.
      +
      java.lang.StringcertificateFingerprint +
      Specifying this field allows for a mod to expect a signed jar with a fingerprint matching this value.
      +
      Mod.CustomProperty[]customProperties +
      A list of custom properties for this mod.
      +
      java.lang.Stringdependencies +
      A simple dependency string for this mod (see modloader's "priorities" string specification)
      +
      java.lang.StringguiFactory +
      An optional GUI factory for this mod.
      +
      java.lang.StringmodLanguage +
      The language the mod is authored in.
      +
      java.lang.Stringname +
      A user friendly name for the mod
      +
      booleanuseMetadata +
      Whether to use the mcmod.info metadata by default for this mod.
      +
      java.lang.Stringversion +
      A version string for this mod
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        modid

        +
        public abstract java.lang.String modid
        +
        The unique mod identifier for this mod
        +
        • +
      + + + +
        +
      • +

        name

        +
        public abstract java.lang.String name
        +
        A user friendly name for the mod
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        version

        +
        public abstract java.lang.String version
        +
        A version string for this mod
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        dependencies

        +
        public abstract java.lang.String dependencies
        +
        A simple dependency string for this mod (see modloader's "priorities" string specification)
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        useMetadata

        +
        public abstract boolean useMetadata
        +
        Whether to use the mcmod.info metadata by default for this mod. + If true, settings in the mcmod.info file will override settings in these annotations.
        +
        +
        Default:
        +
        false
        +
        +
        • +
      + + + +
        +
      • +

        acceptedMinecraftVersions

        +
        public abstract java.lang.String acceptedMinecraftVersions
        +
        The acceptable range of minecraft versions that this mod will load and run in + The default ("empty string") indicates that only the current minecraft version is acceptable. + FML will refuse to run with an error if the minecraft version is not in this range across all mods.
        +
        Returns:
        A version range as specified by the maven version range specification or the empty string
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        acceptableRemoteVersions

        +
        public abstract java.lang.String acceptableRemoteVersions
        +
        A replacement for the no-longer-existing "versionRange" of NetworkMod. Specify a remote version range + that this mod will accept as valid. Defaults to nothing, which is interpreted as "only this version". + Another special value is '*' which means accept all versions. + + This is ignored if there is a NetworkCheckHandler annotation on a method in this class.
        +
        Returns:
        A version range as specified by the maven version range specification or the empty string
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        acceptableSaveVersions

        +
        public abstract java.lang.String acceptableSaveVersions
        +
        A version range specifying compatible save version information. If your mod follows good version numbering + practice Like this (http://semver.org/) then this should be sufficient. + + Advanced users can specify a SaveInspectionHandler instead.
        +
        Returns:
        A version range as specified by the maven version range specification or the empty string
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        bukkitPlugin

        +
        public abstract java.lang.String bukkitPlugin
        +
        An optional bukkit plugin that will be injected into the bukkit plugin framework if + this mod is loaded into the FML framework and the bukkit coremod is present. + Instances of the bukkit plugin can be obtained via the BukkitPluginRef annotation on fields. + + This may be implemented by a bukkit integration. It is not provided with vanilla FML or MinecraftForge.
        +
        Returns:
        The name of the plugin to load for this mod
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        certificateFingerprint

        +
        public abstract java.lang.String certificateFingerprint
        +
        Specifying this field allows for a mod to expect a signed jar with a fingerprint matching this value. + The fingerprint should be SHA-1 encoded, lowercase with ':' removed. An empty value indicates that + the mod is not expecting to be signed. + + Any incorrectness of the fingerprint, be it missing or wrong, will result in the FMLFingerprintViolationEvent + event firing prior to any other event on the mod.
        +
        Returns:
        A certificate fingerprint that is expected for this mod.
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        modLanguage

        +
        public abstract java.lang.String modLanguage
        +
        The language the mod is authored in. This will be used to control certain compatibility behaviours for this mod. + Valid values are currently "java", "scala"
        +
        Returns:
        The language the mod is authored in
        +
        +
        Default:
        +
        "java"
        +
        +
        • +
      + + + +
        +
      • +

        asmHookClass

        +
        @Deprecated
+public abstract java.lang.String asmHookClass
        +
        Deprecated. 
        +
        NOT YET IMPLEMENTED.
        + An optional ASM hook class, that can be used to apply ASM to classes loaded from this mod. It is also given + the ASM tree of the class declaring Mod to do with what it will.
        +
        Returns:
        The name of a class to be loaded and executed. Must implement IASMHook.
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        canBeDeactivated

        +
        public abstract boolean canBeDeactivated
        +
        If your mod doesn't have a runtime persistent effect on the state of the game, and can be disabled without side effects + (minimap mods, graphical tweak mods) then you can set true here and receive the FMLDeactivationEvent to perform deactivation + tasks. + This does not affect administrative disabling through the system property fml.modStates or the config file fmlModState.properties. + The mod will only be deactivated outside of a running game world - FML will never allow mod deactivation whilst a game server + is running.
        +
        Returns:
        if this mod can be deactivated whilst the game is open.
        +
        +
        Default:
        +
        false
        +
        +
        • +
      + + + +
        +
      • +

        guiFactory

        +
        public abstract java.lang.String guiFactory
        +
        An optional GUI factory for this mod. This is the name of a class implementing IModGuiFactory that will be instantiated + on the client side, and will have certain configuration/options guis requested from it.
        +
        Returns:
        The name of a class implementing IModGuiFactory
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        customProperties

        +
        public abstract Mod.CustomProperty[] customProperties
        +
        A list of custom properties for this mod. Completely up to the mod author if/when they + want to put anything in here.
        +
        Returns:
        an optional list of custom properties
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/ModAPIManager.html b/javadoc/cpw/mods/fml/common/ModAPIManager.html new file mode 100644 index 0000000..d8e67e5 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ModAPIManager.html @@ -0,0 +1,359 @@ + + + + + +ModAPIManager (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class ModAPIManager

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

      Constructor Detail

      + + + +
        +
      • +

        ModAPIManager

        +
        public ModAPIManager()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerDataTableAndParseAPI

        +
        public void registerDataTableAndParseAPI(ASMDataTable dataTable)
        +
        • +
      + + + + + + + +
        +
      • +

        injectAPIModContainers

        +
        public void injectAPIModContainers(java.util.List<ModContainer> mods,
+                          java.util.Map<java.lang.String,ModContainer> nameLookup)
        +
        • +
      + + + +
        +
      • +

        cleanupAPIContainers

        +
        public void cleanupAPIContainers(java.util.List<ModContainer> mods)
        +
        • +
      + + + +
        +
      • +

        hasAPI

        +
        public boolean hasAPI(java.lang.String modId)
        +
        • +
      + + + +
        +
      • +

        getAPIList

        +
        public java.lang.Iterable<? extends ModContainer> getAPIList()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/ModClassLoader.html b/javadoc/cpw/mods/fml/common/ModClassLoader.html new file mode 100644 index 0000000..748f0a4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ModClassLoader.html @@ -0,0 +1,369 @@ + + + + + +ModClassLoader (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class ModClassLoader

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    +
    public class ModClassLoader
+extends java.net.URLClassLoader
    +
    A simple delegating class loader used to load mods into the system
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ModClassLoader(java.lang.ClassLoader parent) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddFile(java.io.File modFile) 
      ModAPITransformeraddModAPITransformer(ASMDataTable dataTable) 
      voidclearNegativeCacheFor(java.util.Set<java.lang.String> classList) 
      java.util.List<java.lang.String>getDefaultLibraries() 
      java.io.File[]getParentSources() 
      java.lang.Class<?>loadClass(java.lang.String name) 
      +
        +
      • + + +

        Methods inherited from class java.net.URLClassLoader

        +addURL, close, definePackage, findClass, findResource, findResources, getPermissions, getResourceAsStream, getURLs, newInstance, newInstance
        • +
      +
        +
      • + + +

        Methods inherited from class java.security.SecureClassLoader

        +defineClass, defineClass
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.ClassLoader

        +clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findLibrary, findLoadedClass, findSystemClass, getClassLoadingLock, getPackage, getPackages, getParent, getResource, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, registerAsParallelCapable, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModClassLoader

        +
        public ModClassLoader(java.lang.ClassLoader parent)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addFile

        +
        public void addFile(java.io.File modFile)
+             throws java.net.MalformedURLException
        +
        Throws:
        +
        java.net.MalformedURLException
        +
        • +
      + + + +
        +
      • +

        loadClass

        +
        public java.lang.Class<?> loadClass(java.lang.String name)
+                             throws java.lang.ClassNotFoundException
        +
        +
        Overrides:
        +
        loadClass in class java.lang.ClassLoader
        +
        Throws:
        +
        java.lang.ClassNotFoundException
        +
        • +
      + + + +
        +
      • +

        getParentSources

        +
        public java.io.File[] getParentSources()
        +
        • +
      + + + +
        +
      • +

        getDefaultLibraries

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

        clearNegativeCacheFor

        +
        public void clearNegativeCacheFor(java.util.Set<java.lang.String> classList)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/ModContainer.Disableable.html b/javadoc/cpw/mods/fml/common/ModContainer.Disableable.html new file mode 100644 index 0000000..9ccf1af --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ModContainer.Disableable.html @@ -0,0 +1,345 @@ + + + + + +ModContainer.Disableable (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Enum ModContainer.Disableable

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static ModContainer.DisableablevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ModContainer.Disableable[]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 ModContainer.Disableable[] 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 (ModContainer.Disableable c : ModContainer.Disableable.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ModContainer.Disableable 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/cpw/mods/fml/common/ModContainer.html b/javadoc/cpw/mods/fml/common/ModContainer.html new file mode 100644 index 0000000..76443eb --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ModContainer.html @@ -0,0 +1,639 @@ + + + + + +ModContainer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Interface ModContainer

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

      Field Detail

      + + + +
        +
      • +

        EMPTY_PROPERTIES

        +
        static final java.util.Map<java.lang.String,java.lang.String> EMPTY_PROPERTIES
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getModId

        +
        java.lang.String getModId()
        +
        The globally unique modid for this mod
        +
        • +
      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        A human readable name
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        java.lang.String getVersion()
        +
        A human readable version identifier
        +
        • +
      + + + +
        +
      • +

        getSource

        +
        java.io.File getSource()
        +
        The location on the file system which this mod came from
        +
        • +
      + + + +
        +
      • +

        getMetadata

        +
        ModMetadata getMetadata()
        +
        The metadata for this mod
        +
        • +
      + + + +
        +
      • +

        bindMetadata

        +
        void bindMetadata(MetadataCollection mc)
        +
        Attach this mod to it's metadata from the supplied metadata collection
        +
        • +
      + + + +
        +
      • +

        setEnabledState

        +
        void setEnabledState(boolean enabled)
        +
        Set the enabled/disabled state of this mod
        +
        • +
      + + + +
        +
      • +

        getRequirements

        +
        java.util.Set<ArtifactVersion> getRequirements()
        +
        A list of the modids that this mod requires loaded prior to loading
        +
        • +
      + + + +
        +
      • +

        getDependencies

        +
        java.util.List<ArtifactVersion> getDependencies()
        +
        A list of modids that should be loaded prior to this one. The special + value * indicates to load after any other mod.
        +
        • +
      + + + +
        +
      • +

        getDependants

        +
        java.util.List<ArtifactVersion> getDependants()
        +
        A list of modids that should be loaded after this one. The + special value * indicates to load before any + other mod.
        +
        • +
      + + + +
        +
      • +

        getSortingRules

        +
        java.lang.String getSortingRules()
        +
        A representative string encapsulating the sorting preferences for this + mod
        +
        • +
      + + + +
        +
      • +

        registerBus

        +
        boolean registerBus(com.google.common.eventbus.EventBus bus,
+                  LoadController controller)
        +
        Register the event bus for the mod and the controller for error handling + Returns if this bus was successfully registered - disabled mods and other + mods that don't need real events should return false and avoid further + processing
        +
        Parameters:
        bus -
        controller -
        +
        • +
      + + + +
        +
      • +

        matches

        +
        boolean matches(java.lang.Object mod)
        +
        Does this mod match the supplied mod
        +
        Parameters:
        mod -
        +
        • +
      + + + +
        +
      • +

        getMod

        +
        java.lang.Object getMod()
        +
        Get the actual mod object
        +
        • +
      + + + + + + + +
        +
      • +

        isImmutable

        +
        boolean isImmutable()
        +
        • +
      + + + +
        +
      • +

        getDisplayVersion

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

        acceptableMinecraftVersionRange

        +
        VersionRange acceptableMinecraftVersionRange()
        +
        • +
      + + + +
        +
      • +

        getSigningCertificate

        +
        java.security.cert.Certificate getSigningCertificate()
        +
        • +
      + + + +
        +
      • +

        getCustomModProperties

        +
        java.util.Map<java.lang.String,java.lang.String> getCustomModProperties()
        +
        • +
      + + + +
        +
      • +

        getCustomResourcePackClass

        +
        java.lang.Class<?> getCustomResourcePackClass()
        +
        • +
      + + + +
        +
      • +

        getSharedModDescriptor

        +
        java.util.Map<java.lang.String,java.lang.String> getSharedModDescriptor()
        +
        • +
      + + + + + + + +
        +
      • +

        getGuiClassName

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

        getOwnedPackages

        +
        java.util.List<java.lang.String> getOwnedPackages()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/ModContainerFactory.html b/javadoc/cpw/mods/fml/common/ModContainerFactory.html new file mode 100644 index 0000000..0825351 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ModContainerFactory.html @@ -0,0 +1,288 @@ + + + + + +ModContainerFactory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class ModContainerFactory

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

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.util.Map<org.objectweb.asm.Type,java.lang.reflect.Constructor<? extends ModContainer>>modTypes 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        modTypes

        +
        public static java.util.Map<org.objectweb.asm.Type,java.lang.reflect.Constructor<? extends ModContainer>> modTypes
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/ModMetadata.html b/javadoc/cpw/mods/fml/common/ModMetadata.html new file mode 100644 index 0000000..2a45a39 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ModMetadata.html @@ -0,0 +1,550 @@ + + + + + +ModMetadata (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class ModMetadata

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

      Field Detail

      + + + +
        +
      • +

        modId

        +
        public java.lang.String modId
        +
        • +
      + + + +
        +
      • +

        name

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

        description

        +
        public java.lang.String description
        +
        • +
      + + + +
        +
      • +

        url

        +
        public java.lang.String url
        +
        • +
      + + + +
        +
      • +

        updateUrl

        +
        public java.lang.String updateUrl
        +
        • +
      + + + +
        +
      • +

        logoFile

        +
        public java.lang.String logoFile
        +
        • +
      + + + +
        +
      • +

        version

        +
        public java.lang.String version
        +
        • +
      + + + +
        +
      • +

        authorList

        +
        public java.util.List<java.lang.String> authorList
        +
        • +
      + + + +
        +
      • +

        credits

        +
        public java.lang.String credits
        +
        • +
      + + + +
        +
      • +

        parent

        +
        public java.lang.String parent
        +
        • +
      + + + +
        +
      • +

        screenshots

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

        childMods

        +
        public transient java.util.List<ModContainer> childMods
        +
        • +
      + + + +
        +
      • +

        useDependencyInformation

        +
        public boolean useDependencyInformation
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        autogenerated

        +
        public transient boolean autogenerated
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ModMetadata

        +
        public ModMetadata()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getChildModCountString

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

        getAuthorList

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

        getChildModList

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

        printableSortingRules

        +
        public java.lang.String printableSortingRules()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/ObfuscationReflectionHelper.html b/javadoc/cpw/mods/fml/common/ObfuscationReflectionHelper.html new file mode 100644 index 0000000..804bee1 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ObfuscationReflectionHelper.html @@ -0,0 +1,337 @@ + + + + + +ObfuscationReflectionHelper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class ObfuscationReflectionHelper

+
+
+ +
+
    +
  • +
    +
    +
    public class ObfuscationReflectionHelper
+extends java.lang.Object
    +
    Some reflection helper code.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <T,E> TgetPrivateValue(java.lang.Class<? super E> classToAccess, + E instance, + int fieldIndex) 
      static <T,E> TgetPrivateValue(java.lang.Class<? super E> classToAccess, + E instance, + java.lang.String... fieldNames) 
      static java.lang.String[]remapFieldNames(java.lang.String className, + java.lang.String... fieldNames) 
      static <T,E> voidsetPrivateValue(java.lang.Class<? super T> classToAccess, + T instance, + E value, + int fieldIndex) 
      static <T,E> voidsetPrivateValue(java.lang.Class<? super T> classToAccess, + T instance, + E value, + java.lang.String... fieldNames) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ObfuscationReflectionHelper

        +
        public ObfuscationReflectionHelper()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        getPrivateValue

        +
        public static <T,E> T getPrivateValue(java.lang.Class<? super E> classToAccess,
+                      E instance,
+                      int fieldIndex)
        +
        • +
      + + + +
        +
      • +

        remapFieldNames

        +
        public static java.lang.String[] remapFieldNames(java.lang.String className,
+                                 java.lang.String... fieldNames)
        +
        • +
      + + + + + +
        +
      • +

        getPrivateValue

        +
        public static <T,E> T getPrivateValue(java.lang.Class<? super E> classToAccess,
+                      E instance,
+                      java.lang.String... fieldNames)
        +
        • +
      + + + + + +
        +
      • +

        setPrivateValue

        +
        public static <T,E> void setPrivateValue(java.lang.Class<? super T> classToAccess,
+                         T instance,
+                         E value,
+                         int fieldIndex)
        +
        • +
      + + + + + +
        +
      • +

        setPrivateValue

        +
        public static <T,E> void setPrivateValue(java.lang.Class<? super T> classToAccess,
+                         T instance,
+                         E value,
+                         java.lang.String... fieldNames)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/Optional.Interface.html b/javadoc/cpw/mods/fml/common/Optional.Interface.html new file mode 100644 index 0000000..de4ab3f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/Optional.Interface.html @@ -0,0 +1,256 @@ + + + + + +Optional.Interface (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type Optional.Interface

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=TYPE)
+public static @interface Optional.Interface
    +
    Used to remove optional interfaces
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringiface +
      The fully qualified name of the interface to be stripped
      +
      java.lang.Stringmodid +
      The modid that is required to be present for stripping NOT to occur
      +
      +
      • +
    + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      booleanstriprefs +
      Strip references to this interface in method declarations? (Useful to kill synthetic methods from scala f.e.)
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        iface

        +
        public abstract java.lang.String iface
        +
        The fully qualified name of the interface to be stripped
        +
        Returns:
        the interface name
        +
        • +
      + + + +
        +
      • +

        modid

        +
        public abstract java.lang.String modid
        +
        The modid that is required to be present for stripping NOT to occur
        +
        Returns:
        the modid
        +
        • +
      + + + +
        +
      • +

        striprefs

        +
        public abstract boolean striprefs
        +
        Strip references to this interface in method declarations? (Useful to kill synthetic methods from scala f.e.)
        +
        Returns:
        if references should be stripped
        +
        +
        Default:
        +
        false
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/Optional.InterfaceList.html b/javadoc/cpw/mods/fml/common/Optional.InterfaceList.html new file mode 100644 index 0000000..39cb2ff --- /dev/null +++ b/javadoc/cpw/mods/fml/common/Optional.InterfaceList.html @@ -0,0 +1,203 @@ + + + + + +Optional.InterfaceList (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type Optional.InterfaceList

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=TYPE)
+public static @interface Optional.InterfaceList
    +
    Mark a list of interfaces as removable
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      Optional.Interface[]value +
      Mark a list of interfaces for optional removal.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract Optional.Interface[] value
        +
        Mark a list of interfaces for optional removal.
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/Optional.Method.html b/javadoc/cpw/mods/fml/common/Optional.Method.html new file mode 100644 index 0000000..afe9b2d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/Optional.Method.html @@ -0,0 +1,203 @@ + + + + + +Optional.Method (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type Optional.Method

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=METHOD)
+public static @interface Optional.Method
    +
    Used to remove optional methods
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringmodid +
      The modid that is required to be present for stripping NOT to occur
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        modid

        +
        public abstract java.lang.String modid
        +
        The modid that is required to be present for stripping NOT to occur
        +
        Returns:
        the modid
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/Optional.html b/javadoc/cpw/mods/fml/common/Optional.html new file mode 100644 index 0000000..39b40c4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/Optional.html @@ -0,0 +1,221 @@ + + + + + +Optional (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Class Optional

+
+
+ +
+
    +
  • +
    +
    +
    public final class Optional
+extends java.lang.Object
    +
    Classes annotated with this will have the named interface or method removed from the runtime definition of the class + if the modid specified is missing.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static interface Optional.Interface +
      Used to remove optional interfaces
      +
      static interface Optional.InterfaceList +
      Mark a list of interfaces as removable
      +
      static interface Optional.Method +
      Used to remove optional methods
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/ProxyInjector.html b/javadoc/cpw/mods/fml/common/ProxyInjector.html new file mode 100644 index 0000000..1a181dc --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ProxyInjector.html @@ -0,0 +1,260 @@ + + + + + +ProxyInjector (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class ProxyInjector

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

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidinject(ModContainer mod, + ASMDataTable data, + Side side, + ILanguageAdapter languageAdapter) 
      +
        +
      • + + +

        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/cpw/mods/fml/common/SaveInspectionHandler.html b/javadoc/cpw/mods/fml/common/SaveInspectionHandler.html new file mode 100644 index 0000000..c58bc26 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/SaveInspectionHandler.html @@ -0,0 +1,152 @@ + + + + + +SaveInspectionHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type SaveInspectionHandler

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface SaveInspectionHandler
    +
    A method annotated with this on the Mod will be called whenever a local save is listed in + the save games list.
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/SidedProxy.html b/javadoc/cpw/mods/fml/common/SidedProxy.html new file mode 100644 index 0000000..b382668 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/SidedProxy.html @@ -0,0 +1,270 @@ + + + + + +SidedProxy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type SidedProxy

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=FIELD)
+public @interface SidedProxy
    +
    Sided proxies are loaded based on the specific environment they find themselves loaded into. + They are used to ensure that client-specific code (such as GUIs) is only loaded into the game + on the client side. + It is applied to static fields of a class, anywhere in your mod code. FML will scan + and load any classes with this annotation at mod construction time. + +

    + This example will load a CommonProxy on the server side, and a ClientProxy on the client side. + + 

    public class MySidedProxyHolder {
+      {@literal @}SidedProxy(modId="MyModId",clientSide="mymod.ClientProxy", serverSide="mymod.CommonProxy")
+      public static CommonProxy proxy;
+  }
+
+  public class CommonProxy {
+      // Common or server stuff here that needs to be overridden on the client
+  }
+
+  public class ClientProxy extends CommonProxy {
+      // Override common stuff with client specific stuff here
+  }
+ 
+
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.StringclientSide +
      The name of the client side class to load and populate
      +
      java.lang.StringmodId +
      The (optional) name of a mod to load this proxy for.
      +
      java.lang.StringserverSide +
      The name of the server side class to load and populate
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        clientSide

        +
        public abstract java.lang.String clientSide
        +
        The name of the client side class to load and populate
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        serverSide

        +
        public abstract java.lang.String serverSide
        +
        The name of the server side class to load and populate
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        modId

        +
        public abstract java.lang.String modId
        +
        The (optional) name of a mod to load this proxy for. This will help ensure correct behaviour when loading a combined + scala/java mod package. It is almost never going to be required, unless you ship both Scala and Java Mod content + in a single jar.
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/StartupQuery.AbortedException.html b/javadoc/cpw/mods/fml/common/StartupQuery.AbortedException.html new file mode 100644 index 0000000..fd352b9 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/StartupQuery.AbortedException.html @@ -0,0 +1,218 @@ + + + + + +StartupQuery.AbortedException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Class StartupQuery.AbortedException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Enclosing class:
    +
    StartupQuery
    +
    +
    +
    +
    public static class StartupQuery.AbortedException
+extends java.lang.RuntimeException
    +
    Exception not being caught by the crash report generation logic.
    +
    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
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/StartupQuery.html b/javadoc/cpw/mods/fml/common/StartupQuery.html new file mode 100644 index 0000000..bb6aab3 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/StartupQuery.html @@ -0,0 +1,358 @@ + + + + + +StartupQuery (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Class StartupQuery

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

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class StartupQuery.AbortedException +
      Exception not being caught by the crash report generation logic.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidabort() 
      static booleancheck() 
      static booleanconfirm(java.lang.String text) 
      voidfinish() 
      java.lang.BooleangetResult() 
      java.lang.StringgetText() 
      booleanisSynchronous() 
      static voidnotify(java.lang.String text) 
      static voidreset() 
      voidsetResult(boolean result) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        confirm

        +
        public static boolean confirm(java.lang.String text)
        +
        • +
      + + + +
        +
      • +

        notify

        +
        public static void notify(java.lang.String text)
        +
        • +
      + + + +
        +
      • +

        abort

        +
        public static void abort()
        +
        • +
      + + + +
        +
      • +

        reset

        +
        public static void reset()
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static boolean check()
        +
        • +
      + + + +
        +
      • +

        getResult

        +
        public java.lang.Boolean getResult()
        +
        • +
      + + + +
        +
      • +

        setResult

        +
        public void setResult(boolean result)
        +
        • +
      + + + +
        +
      • +

        getText

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

        isSynchronous

        +
        public boolean isSynchronous()
        +
        • +
      + + + +
        +
      • +

        finish

        +
        public void finish()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/TracingPrintStream.html b/javadoc/cpw/mods/fml/common/TracingPrintStream.html new file mode 100644 index 0000000..7a2ed92 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/TracingPrintStream.html @@ -0,0 +1,326 @@ + + + + + +TracingPrintStream (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class TracingPrintStream

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable
    +
    +
    +
    +
    public class TracingPrintStream
+extends java.io.PrintStream
    +
    PrintStream which redirects it's output to a given logger.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class java.io.FilterOutputStream

        +out
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      TracingPrintStream(org.apache.logging.log4j.Logger logger, + java.io.PrintStream original) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidprintln(java.lang.Object o) 
      voidprintln(java.lang.String s) 
      +
        +
      • + + +

        Methods inherited from class java.io.PrintStream

        +append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, setError, write, write
        • +
      +
        +
      • + + +

        Methods inherited from class java.io.FilterOutputStream

        +write
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TracingPrintStream

        +
        public TracingPrintStream(org.apache.logging.log4j.Logger logger,
+                  java.io.PrintStream original)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        println

        +
        public void println(java.lang.Object o)
        +
        +
        Overrides:
        +
        println in class java.io.PrintStream
        +
        +
        • +
      + + + +
        +
      • +

        println

        +
        public void println(java.lang.String s)
        +
        +
        Overrides:
        +
        println in class java.io.PrintStream
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/WorldAccessContainer.html b/javadoc/cpw/mods/fml/common/WorldAccessContainer.html new file mode 100644 index 0000000..5be894f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/WorldAccessContainer.html @@ -0,0 +1,229 @@ + + + + + +WorldAccessContainer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common
+

Interface WorldAccessContainer

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/WrongMinecraftVersionException.html b/javadoc/cpw/mods/fml/common/WrongMinecraftVersionException.html new file mode 100644 index 0000000..3ea3a0b --- /dev/null +++ b/javadoc/cpw/mods/fml/common/WrongMinecraftVersionException.html @@ -0,0 +1,289 @@ + + + + + +WrongMinecraftVersionException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class WrongMinecraftVersionException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class WrongMinecraftVersionException
+extends java.lang.RuntimeException
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      ModContainermod 
      +
      • +
    + + + +
      +
    • + + +

      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

      + + + +
        +
      • +

        WrongMinecraftVersionException

        +
        public WrongMinecraftVersionException(ModContainer mod)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/ZipperUtil.html b/javadoc/cpw/mods/fml/common/ZipperUtil.html new file mode 100644 index 0000000..810c1cd --- /dev/null +++ b/javadoc/cpw/mods/fml/common/ZipperUtil.html @@ -0,0 +1,315 @@ + + + + + +ZipperUtil (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class ZipperUtil

+
+
+ +
+
    +
  • +
    +
    +
    public class ZipperUtil
+extends java.lang.Object
    +
    Copied from http://stackoverflow.com/questions/1399126/java-util-zip-recreating-directory-structure + because the code looked very tidy and neat. Thanks, McDowell!
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidbackupWorld() 
      static voidbackupWorld(java.lang.String dirName) 
      static voidbackupWorld(java.lang.String dirName, + java.lang.String saveName) +
      Deprecated. 
      +
      static voidzip(java.io.File directory, + java.io.File zipfile) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ZipperUtil

        +
        public ZipperUtil()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        zip

        +
        public static void zip(java.io.File directory,
+       java.io.File zipfile)
+                throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        backupWorld

        +
        public static void backupWorld()
+                        throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        backupWorld

        +
        @Deprecated
+public static void backupWorld(java.lang.String dirName,
+                          java.lang.String saveName)
+                        throws java.io.IOException
        +
        Deprecated. 
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        backupWorld

        +
        public static void backupWorld(java.lang.String dirName)
+                        throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/FMLSanityChecker.html b/javadoc/cpw/mods/fml/common/asm/FMLSanityChecker.html new file mode 100644 index 0000000..20a3a62 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/FMLSanityChecker.html @@ -0,0 +1,324 @@ + + + + + +FMLSanityChecker (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.asm
+

Class FMLSanityChecker

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IFMLCallHook, java.util.concurrent.Callable<java.lang.Void>
    +
    +
    +
    +
    public class FMLSanityChecker
+extends java.lang.Object
+implements IFMLCallHook
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.io.FilefmlLocation 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Voidcall() 
      voidinjectData(java.util.Map<java.lang.String,java.lang.Object> data) +
      Injected with data from the FML environment: + "classLoader" : The FML Class Loader
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        fmlLocation

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

      Constructor Detail

      + + + +
        +
      • +

        FMLSanityChecker

        +
        public FMLSanityChecker()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        call

        +
        public java.lang.Void call()
+                    throws java.lang.Exception
        +
        +
        Specified by:
        +
        call in interface java.util.concurrent.Callable<java.lang.Void>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        injectData

        +
        public void injectData(java.util.Map<java.lang.String,java.lang.Object> data)
        +
        Description copied from interface: IFMLCallHook
        +
        Injected with data from the FML environment: + "classLoader" : The FML Class Loader
        +
        +
        Specified by:
        +
        injectData in interface IFMLCallHook
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/ReobfuscationMarker.html b/javadoc/cpw/mods/fml/common/asm/ReobfuscationMarker.html new file mode 100644 index 0000000..d368f6d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/ReobfuscationMarker.html @@ -0,0 +1,151 @@ + + + + + +ReobfuscationMarker (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.asm
+

Annotation Type ReobfuscationMarker

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=TYPE)
+public @interface ReobfuscationMarker
    +
    Used to force certain classes to reobfuscate
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/package-frame.html b/javadoc/cpw/mods/fml/common/asm/package-frame.html new file mode 100644 index 0000000..36dad53 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/package-frame.html @@ -0,0 +1,23 @@ + + + + + +cpw.mods.fml.common.asm (Forge API) + + + + +

cpw.mods.fml.common.asm

+
+

Classes

+ +

Annotation Types

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/asm/package-summary.html b/javadoc/cpw/mods/fml/common/asm/package-summary.html new file mode 100644 index 0000000..c74a1ae --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/package-summary.html @@ -0,0 +1,148 @@ + + + + + +cpw.mods.fml.common.asm (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.asm

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/package-tree.html b/javadoc/cpw/mods/fml/common/asm/package-tree.html new file mode 100644 index 0000000..2eb350d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/package-tree.html @@ -0,0 +1,130 @@ + + + + + +cpw.mods.fml.common.asm Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.asm

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Annotation Type Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/AccessTransformer.html b/javadoc/cpw/mods/fml/common/asm/transformers/AccessTransformer.html new file mode 100644 index 0000000..988f6ea --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/AccessTransformer.html @@ -0,0 +1,321 @@ + + + + + +AccessTransformer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers
+

Class AccessTransformer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.IClassTransformer
    +
    +
    +
    Direct Known Subclasses:
    +
    ForgeAccessTransformer, ModAccessTransformer
    +
    +
    +
    +
    public class AccessTransformer
+extends java.lang.Object
+implements net.minecraft.launchwrapper.IClassTransformer
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
       AccessTransformer() 
      protected AccessTransformer(java.lang.String rulesFile) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidmain(java.lang.String[] args) 
      protected voidprocessATFile(com.google.common.io.CharSource rulesResource) 
      byte[]transform(java.lang.String name, + java.lang.String transformedName, + byte[] bytes) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        AccessTransformer

        +
        public AccessTransformer()
+                  throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        AccessTransformer

        +
        protected AccessTransformer(java.lang.String rulesFile)
+                     throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        processATFile

        +
        protected void processATFile(com.google.common.io.CharSource rulesResource)
+                      throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        transform

        +
        public byte[] transform(java.lang.String name,
+               java.lang.String transformedName,
+               byte[] bytes)
        +
        +
        Specified by:
        +
        transform in interface net.minecraft.launchwrapper.IClassTransformer
        +
        +
        • +
      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String[] args)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/DeobfuscationTransformer.html b/javadoc/cpw/mods/fml/common/asm/transformers/DeobfuscationTransformer.html new file mode 100644 index 0000000..88915f8 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/DeobfuscationTransformer.html @@ -0,0 +1,301 @@ + + + + + +DeobfuscationTransformer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers
+

Class DeobfuscationTransformer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.IClassNameTransformer, net.minecraft.launchwrapper.IClassTransformer
    +
    +
    +
    +
    public class DeobfuscationTransformer
+extends java.lang.Object
+implements net.minecraft.launchwrapper.IClassTransformer, net.minecraft.launchwrapper.IClassNameTransformer
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringremapClassName(java.lang.String name) 
      byte[]transform(java.lang.String name, + java.lang.String transformedName, + byte[] bytes) 
      java.lang.StringunmapClassName(java.lang.String name) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DeobfuscationTransformer

        +
        public DeobfuscationTransformer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        transform

        +
        public byte[] transform(java.lang.String name,
+               java.lang.String transformedName,
+               byte[] bytes)
        +
        +
        Specified by:
        +
        transform in interface net.minecraft.launchwrapper.IClassTransformer
        +
        +
        • +
      + + + +
        +
      • +

        remapClassName

        +
        public java.lang.String remapClassName(java.lang.String name)
        +
        +
        Specified by:
        +
        remapClassName in interface net.minecraft.launchwrapper.IClassNameTransformer
        +
        +
        • +
      + + + +
        +
      • +

        unmapClassName

        +
        public java.lang.String unmapClassName(java.lang.String name)
        +
        +
        Specified by:
        +
        unmapClassName in interface net.minecraft.launchwrapper.IClassNameTransformer
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/EventSubscriptionTransformer.html b/javadoc/cpw/mods/fml/common/asm/transformers/EventSubscriptionTransformer.html new file mode 100644 index 0000000..5b6d126 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/EventSubscriptionTransformer.html @@ -0,0 +1,267 @@ + + + + + +EventSubscriptionTransformer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers
+

Class EventSubscriptionTransformer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.IClassTransformer
    +
    +
    +
    +
    public class EventSubscriptionTransformer
+extends java.lang.Object
+implements net.minecraft.launchwrapper.IClassTransformer
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      byte[]transform(java.lang.String name, + java.lang.String transformedName, + byte[] bytes) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        EventSubscriptionTransformer

        +
        public EventSubscriptionTransformer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        transform

        +
        public byte[] transform(java.lang.String name,
+               java.lang.String transformedName,
+               byte[] bytes)
        +
        +
        Specified by:
        +
        transform in interface net.minecraft.launchwrapper.IClassTransformer
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/ItemStackTransformer.html b/javadoc/cpw/mods/fml/common/asm/transformers/ItemStackTransformer.html new file mode 100644 index 0000000..9a2828c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/ItemStackTransformer.html @@ -0,0 +1,267 @@ + + + + + +ItemStackTransformer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers
+

Class ItemStackTransformer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.IClassTransformer
    +
    +
    +
    +
    public class ItemStackTransformer
+extends java.lang.Object
+implements net.minecraft.launchwrapper.IClassTransformer
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      byte[]transform(java.lang.String name, + java.lang.String transformedName, + byte[] basicClass) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ItemStackTransformer

        +
        public ItemStackTransformer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        transform

        +
        public byte[] transform(java.lang.String name,
+               java.lang.String transformedName,
+               byte[] basicClass)
        +
        +
        Specified by:
        +
        transform in interface net.minecraft.launchwrapper.IClassTransformer
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/MarkerTransformer.html b/javadoc/cpw/mods/fml/common/asm/transformers/MarkerTransformer.html new file mode 100644 index 0000000..d3b3fa5 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/MarkerTransformer.html @@ -0,0 +1,301 @@ + + + + + +MarkerTransformer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers
+

Class MarkerTransformer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.IClassTransformer
    +
    +
    +
    +
    public class MarkerTransformer
+extends java.lang.Object
+implements net.minecraft.launchwrapper.IClassTransformer
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
       MarkerTransformer() 
      protected MarkerTransformer(java.lang.String rulesFile) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidmain(java.lang.String[] args) 
      byte[]transform(java.lang.String name, + java.lang.String transformedName, + byte[] bytes) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MarkerTransformer

        +
        public MarkerTransformer()
+                  throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        MarkerTransformer

        +
        protected MarkerTransformer(java.lang.String rulesFile)
+                     throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        transform

        +
        public byte[] transform(java.lang.String name,
+               java.lang.String transformedName,
+               byte[] bytes)
        +
        +
        Specified by:
        +
        transform in interface net.minecraft.launchwrapper.IClassTransformer
        +
        +
        • +
      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String[] args)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/ModAPITransformer.html b/javadoc/cpw/mods/fml/common/asm/transformers/ModAPITransformer.html new file mode 100644 index 0000000..cead986 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/ModAPITransformer.html @@ -0,0 +1,280 @@ + + + + + +ModAPITransformer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers
+

Class ModAPITransformer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.IClassTransformer
    +
    +
    +
    +
    public class ModAPITransformer
+extends java.lang.Object
+implements net.minecraft.launchwrapper.IClassTransformer
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidinitTable(ASMDataTable dataTable) 
      byte[]transform(java.lang.String name, + java.lang.String transformedName, + byte[] basicClass) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModAPITransformer

        +
        public ModAPITransformer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        transform

        +
        public byte[] transform(java.lang.String name,
+               java.lang.String transformedName,
+               byte[] basicClass)
        +
        +
        Specified by:
        +
        transform in interface net.minecraft.launchwrapper.IClassTransformer
        +
        +
        • +
      + + + +
        +
      • +

        initTable

        +
        public void initTable(ASMDataTable dataTable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/ModAccessTransformer.html b/javadoc/cpw/mods/fml/common/asm/transformers/ModAccessTransformer.html new file mode 100644 index 0000000..b2ea527 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/ModAccessTransformer.html @@ -0,0 +1,276 @@ + + + + + +ModAccessTransformer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers
+

Class ModAccessTransformer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.IClassTransformer
    +
    +
    +
    +
    public class ModAccessTransformer
+extends AccessTransformer
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidaddJar(java.util.jar.JarFile jar) 
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModAccessTransformer

        +
        public ModAccessTransformer()
+                     throws java.lang.Exception
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addJar

        +
        public static void addJar(java.util.jar.JarFile jar)
+                   throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/PatchingTransformer.html b/javadoc/cpw/mods/fml/common/asm/transformers/PatchingTransformer.html new file mode 100644 index 0000000..23c2659 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/PatchingTransformer.html @@ -0,0 +1,267 @@ + + + + + +PatchingTransformer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers
+

Class PatchingTransformer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.IClassTransformer
    +
    +
    +
    +
    public class PatchingTransformer
+extends java.lang.Object
+implements net.minecraft.launchwrapper.IClassTransformer
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      byte[]transform(java.lang.String name, + java.lang.String transformedName, + byte[] bytes) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        PatchingTransformer

        +
        public PatchingTransformer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        transform

        +
        public byte[] transform(java.lang.String name,
+               java.lang.String transformedName,
+               byte[] bytes)
        +
        +
        Specified by:
        +
        transform in interface net.minecraft.launchwrapper.IClassTransformer
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/SideTransformer.html b/javadoc/cpw/mods/fml/common/asm/transformers/SideTransformer.html new file mode 100644 index 0000000..ae2002c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/SideTransformer.html @@ -0,0 +1,267 @@ + + + + + +SideTransformer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers
+

Class SideTransformer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.IClassTransformer
    +
    +
    +
    +
    public class SideTransformer
+extends java.lang.Object
+implements net.minecraft.launchwrapper.IClassTransformer
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      byte[]transform(java.lang.String name, + java.lang.String transformedName, + byte[] bytes) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SideTransformer

        +
        public SideTransformer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        transform

        +
        public byte[] transform(java.lang.String name,
+               java.lang.String transformedName,
+               byte[] bytes)
        +
        +
        Specified by:
        +
        transform in interface net.minecraft.launchwrapper.IClassTransformer
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/TerminalTransformer.ExitVisitor.html b/javadoc/cpw/mods/fml/common/asm/transformers/TerminalTransformer.ExitVisitor.html new file mode 100644 index 0000000..8e044f2 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/TerminalTransformer.ExitVisitor.html @@ -0,0 +1,333 @@ + + + + + +TerminalTransformer.ExitVisitor (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers
+

Class TerminalTransformer.ExitVisitor

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TerminalTransformer
    +
    +
    +
    +
    public static class TerminalTransformer.ExitVisitor
+extends org.objectweb.asm.ClassVisitor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class org.objectweb.asm.ClassVisitor

        +api, cv
        • +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidruntimeExitCalled(java.lang.Runtime runtime, + int status) 
      static voidruntimeHaltCalled(java.lang.Runtime runtime, + int status) 
      static voidsystemExitCalled(int status) 
      voidvisit(int version, + int access, + java.lang.String name, + java.lang.String signature, + java.lang.String superName, + java.lang.String[] interfaces) 
      org.objectweb.asm.MethodVisitorvisitMethod(int mAccess, + java.lang.String mName, + java.lang.String mDesc, + java.lang.String mSignature, + java.lang.String[] mExceptions) 
      +
        +
      • + + +

        Methods inherited from class org.objectweb.asm.ClassVisitor

        +visitAnnotation, visitAttribute, visitEnd, visitField, visitInnerClass, visitOuterClass, visitSource, visitTypeAnnotation
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        visit

        +
        public void visit(int version,
+         int access,
+         java.lang.String name,
+         java.lang.String signature,
+         java.lang.String superName,
+         java.lang.String[] interfaces)
        +
        +
        Overrides:
        +
        visit in class org.objectweb.asm.ClassVisitor
        +
        +
        • +
      + + + +
        +
      • +

        visitMethod

        +
        public org.objectweb.asm.MethodVisitor visitMethod(int mAccess,
+                                          java.lang.String mName,
+                                          java.lang.String mDesc,
+                                          java.lang.String mSignature,
+                                          java.lang.String[] mExceptions)
        +
        +
        Overrides:
        +
        visitMethod in class org.objectweb.asm.ClassVisitor
        +
        +
        • +
      + + + +
        +
      • +

        systemExitCalled

        +
        public static void systemExitCalled(int status)
        +
        • +
      + + + +
        +
      • +

        runtimeExitCalled

        +
        public static void runtimeExitCalled(java.lang.Runtime runtime,
+                     int status)
        +
        • +
      + + + +
        +
      • +

        runtimeHaltCalled

        +
        public static void runtimeHaltCalled(java.lang.Runtime runtime,
+                     int status)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/TerminalTransformer.html b/javadoc/cpw/mods/fml/common/asm/transformers/TerminalTransformer.html new file mode 100644 index 0000000..3e1870c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/TerminalTransformer.html @@ -0,0 +1,286 @@ + + + + + +TerminalTransformer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers
+

Class TerminalTransformer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.IClassTransformer
    +
    +
    +
    +
    public class TerminalTransformer
+extends java.lang.Object
+implements net.minecraft.launchwrapper.IClassTransformer
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      byte[]transform(java.lang.String name, + java.lang.String transformedName, + byte[] basicClass) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TerminalTransformer

        +
        public TerminalTransformer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        transform

        +
        public byte[] transform(java.lang.String name,
+               java.lang.String transformedName,
+               byte[] basicClass)
        +
        +
        Specified by:
        +
        transform in interface net.minecraft.launchwrapper.IClassTransformer
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/deobf/FMLDeobfuscatingRemapper.html b/javadoc/cpw/mods/fml/common/asm/transformers/deobf/FMLDeobfuscatingRemapper.html new file mode 100644 index 0000000..baf71fa --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/deobf/FMLDeobfuscatingRemapper.html @@ -0,0 +1,421 @@ + + + + + +FMLDeobfuscatingRemapper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers.deobf
+

Class FMLDeobfuscatingRemapper

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLDeobfuscatingRemapper
+extends org.objectweb.asm.commons.Remapper
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.util.Set<java.lang.String>getObfedClasses() 
      java.lang.StringgetStaticFieldType(java.lang.String oldType, + java.lang.String oldName, + java.lang.String newType, + java.lang.String newName) 
      booleanisRemappedClass(java.lang.String className) 
      java.lang.Stringmap(java.lang.String typeName) 
      java.lang.StringmapFieldName(java.lang.String owner, + java.lang.String name, + java.lang.String desc) 
      java.lang.StringmapMethodName(java.lang.String owner, + java.lang.String name, + java.lang.String desc) 
      voidmergeSuperMaps(java.lang.String name, + java.lang.String superName, + java.lang.String[] interfaces) 
      voidsetup(java.io.File mcDir, + net.minecraft.launchwrapper.LaunchClassLoader classLoader, + java.lang.String deobfFileName) 
      voidsetupLoadOnly(java.lang.String deobfFileName, + boolean loadAll) 
      java.lang.Stringunmap(java.lang.String typeName) 
      +
        +
      • + + +

        Methods inherited from class org.objectweb.asm.commons.Remapper

        +createRemappingSignatureAdapter, mapDesc, mapInvokeDynamicMethodName, mapMethodDesc, mapSignature, mapType, mapTypes, mapValue
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        setupLoadOnly

        +
        public void setupLoadOnly(java.lang.String deobfFileName,
+                 boolean loadAll)
        +
        • +
      + + + +
        +
      • +

        setup

        +
        public void setup(java.io.File mcDir,
+         net.minecraft.launchwrapper.LaunchClassLoader classLoader,
+         java.lang.String deobfFileName)
        +
        • +
      + + + +
        +
      • +

        isRemappedClass

        +
        public boolean isRemappedClass(java.lang.String className)
        +
        • +
      + + + +
        +
      • +

        mapFieldName

        +
        public java.lang.String mapFieldName(java.lang.String owner,
+                            java.lang.String name,
+                            java.lang.String desc)
        +
        +
        Overrides:
        +
        mapFieldName in class org.objectweb.asm.commons.Remapper
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public java.lang.String map(java.lang.String typeName)
        +
        +
        Overrides:
        +
        map in class org.objectweb.asm.commons.Remapper
        +
        +
        • +
      + + + +
        +
      • +

        unmap

        +
        public java.lang.String unmap(java.lang.String typeName)
        +
        • +
      + + + +
        +
      • +

        mapMethodName

        +
        public java.lang.String mapMethodName(java.lang.String owner,
+                             java.lang.String name,
+                             java.lang.String desc)
        +
        +
        Overrides:
        +
        mapMethodName in class org.objectweb.asm.commons.Remapper
        +
        +
        • +
      + + + +
        +
      • +

        mergeSuperMaps

        +
        public void mergeSuperMaps(java.lang.String name,
+                  java.lang.String superName,
+                  java.lang.String[] interfaces)
        +
        • +
      + + + +
        +
      • +

        getObfedClasses

        +
        public java.util.Set<java.lang.String> getObfedClasses()
        +
        • +
      + + + +
        +
      • +

        getStaticFieldType

        +
        public java.lang.String getStaticFieldType(java.lang.String oldType,
+                                  java.lang.String oldName,
+                                  java.lang.String newType,
+                                  java.lang.String newName)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/deobf/FMLRemappingAdapter.html b/javadoc/cpw/mods/fml/common/asm/transformers/deobf/FMLRemappingAdapter.html new file mode 100644 index 0000000..596c8c5 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/deobf/FMLRemappingAdapter.html @@ -0,0 +1,335 @@ + + + + + +FMLRemappingAdapter (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers.deobf
+

Class FMLRemappingAdapter

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLRemappingAdapter
+extends org.objectweb.asm.commons.RemappingClassAdapter
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class org.objectweb.asm.commons.RemappingClassAdapter

        +className, remapper
        • +
      +
        +
      • + + +

        Fields inherited from class org.objectweb.asm.ClassVisitor

        +api, cv
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FMLRemappingAdapter(org.objectweb.asm.ClassVisitor cv) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected org.objectweb.asm.MethodVisitorcreateRemappingMethodAdapter(int access, + java.lang.String newDesc, + org.objectweb.asm.MethodVisitor mv) 
      voidvisit(int version, + int access, + java.lang.String name, + java.lang.String signature, + java.lang.String superName, + java.lang.String[] interfaces) 
      +
        +
      • + + +

        Methods inherited from class org.objectweb.asm.commons.RemappingClassAdapter

        +createRemappingAnnotationAdapter, createRemappingFieldAdapter, visitAnnotation, visitField, visitInnerClass, visitMethod, visitOuterClass, visitTypeAnnotation
        • +
      +
        +
      • + + +

        Methods inherited from class org.objectweb.asm.ClassVisitor

        +visitAttribute, visitEnd, visitSource
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FMLRemappingAdapter

        +
        public FMLRemappingAdapter(org.objectweb.asm.ClassVisitor cv)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        visit

        +
        public void visit(int version,
+         int access,
+         java.lang.String name,
+         java.lang.String signature,
+         java.lang.String superName,
+         java.lang.String[] interfaces)
        +
        +
        Overrides:
        +
        visit in class org.objectweb.asm.commons.RemappingClassAdapter
        +
        +
        • +
      + + + +
        +
      • +

        createRemappingMethodAdapter

        +
        protected org.objectweb.asm.MethodVisitor createRemappingMethodAdapter(int access,
+                                                           java.lang.String newDesc,
+                                                           org.objectweb.asm.MethodVisitor mv)
        +
        +
        Overrides:
        +
        createRemappingMethodAdapter in class org.objectweb.asm.commons.RemappingClassAdapter
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/deobf/LZMAInputSupplier.html b/javadoc/cpw/mods/fml/common/asm/transformers/deobf/LZMAInputSupplier.html new file mode 100644 index 0000000..3952769 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/deobf/LZMAInputSupplier.html @@ -0,0 +1,276 @@ + + + + + +LZMAInputSupplier (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.asm.transformers.deobf
+

Class LZMAInputSupplier

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.common.io.InputSupplier<java.io.InputStream>
    +
    +
    +
    +
    public class LZMAInputSupplier
+extends com.google.common.io.ByteSource
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      LZMAInputSupplier(java.io.InputStream compressedData) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.io.InputStreamopenStream() 
      +
        +
      • + + +

        Methods inherited from class com.google.common.io.ByteSource

        +asCharSource, concat, concat, concat, contentEquals, copyTo, copyTo, empty, getInput, hash, isEmpty, openBufferedStream, read, read, size, slice, wrap
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        LZMAInputSupplier

        +
        public LZMAInputSupplier(java.io.InputStream compressedData)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openStream

        +
        public java.io.InputStream openStream()
+                               throws java.io.IOException
        +
        +
        Specified by:
        +
        openStream in class com.google.common.io.ByteSource
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/deobf/package-frame.html b/javadoc/cpw/mods/fml/common/asm/transformers/deobf/package-frame.html new file mode 100644 index 0000000..5b447f6 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/deobf/package-frame.html @@ -0,0 +1,21 @@ + + + + + +cpw.mods.fml.common.asm.transformers.deobf (Forge API) + + + + +

cpw.mods.fml.common.asm.transformers.deobf

+
+

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/deobf/package-summary.html b/javadoc/cpw/mods/fml/common/asm/transformers/deobf/package-summary.html new file mode 100644 index 0000000..1df709e --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/deobf/package-summary.html @@ -0,0 +1,139 @@ + + + + + +cpw.mods.fml.common.asm.transformers.deobf (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.asm.transformers.deobf

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/deobf/package-tree.html b/javadoc/cpw/mods/fml/common/asm/transformers/deobf/package-tree.html new file mode 100644 index 0000000..c02a31d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/deobf/package-tree.html @@ -0,0 +1,144 @@ + + + + + +cpw.mods.fml.common.asm.transformers.deobf Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.asm.transformers.deobf

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/package-frame.html b/javadoc/cpw/mods/fml/common/asm/transformers/package-frame.html new file mode 100644 index 0000000..03c4172 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/package-frame.html @@ -0,0 +1,29 @@ + + + + + +cpw.mods.fml.common.asm.transformers (Forge API) + + + + +

cpw.mods.fml.common.asm.transformers

+
+

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/package-summary.html b/javadoc/cpw/mods/fml/common/asm/transformers/package-summary.html new file mode 100644 index 0000000..bec0ace --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/package-summary.html @@ -0,0 +1,171 @@ + + + + + +cpw.mods.fml.common.asm.transformers (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.asm.transformers

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/asm/transformers/package-tree.html b/javadoc/cpw/mods/fml/common/asm/transformers/package-tree.html new file mode 100644 index 0000000..13c9c36 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/asm/transformers/package-tree.html @@ -0,0 +1,143 @@ + + + + + +cpw.mods.fml.common.asm.transformers Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.asm.transformers

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/ASMDataTable.ASMData.html b/javadoc/cpw/mods/fml/common/discovery/ASMDataTable.ASMData.html new file mode 100644 index 0000000..790574a --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/ASMDataTable.ASMData.html @@ -0,0 +1,336 @@ + + + + + +ASMDataTable.ASMData (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.discovery
+

Class ASMDataTable.ASMData

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    Enclosing class:
    +
    ASMDataTable
    +
    +
    +
    +
    public static final class ASMDataTable.ASMData
+extends java.lang.Object
+implements java.lang.Cloneable
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ASMDataTable.ASMData(ModCandidate candidate, + java.lang.String annotationName, + java.lang.String className, + java.lang.String objectName, + java.util.Map<java.lang.String,java.lang.Object> info) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      ASMDataTable.ASMDatacopy(java.util.Map<java.lang.String,java.lang.Object> newAnnotationInfo) 
      java.util.Map<java.lang.String,java.lang.Object>getAnnotationInfo() 
      java.lang.StringgetAnnotationName() 
      ModCandidategetCandidate() 
      java.lang.StringgetClassName() 
      java.lang.StringgetObjectName() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ASMDataTable.ASMData

        +
        public ASMDataTable.ASMData(ModCandidate candidate,
+                    java.lang.String annotationName,
+                    java.lang.String className,
+                    java.lang.String objectName,
+                    java.util.Map<java.lang.String,java.lang.Object> info)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getAnnotationName

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

        getClassName

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

        getObjectName

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

        getAnnotationInfo

        +
        public java.util.Map<java.lang.String,java.lang.Object> getAnnotationInfo()
        +
        • +
      + + + +
        +
      • +

        copy

        +
        public ASMDataTable.ASMData copy(java.util.Map<java.lang.String,java.lang.Object> newAnnotationInfo)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/ASMDataTable.html b/javadoc/cpw/mods/fml/common/discovery/ASMDataTable.html new file mode 100644 index 0000000..469f961 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/ASMDataTable.html @@ -0,0 +1,348 @@ + + + + + +ASMDataTable (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.discovery
+

Class ASMDataTable

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

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class ASMDataTable.ASMData 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

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

      Constructor Detail

      + + + +
        +
      • +

        ASMDataTable

        +
        public ASMDataTable()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

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

        addASMData

        +
        public void addASMData(ModCandidate candidate,
+              java.lang.String annotation,
+              java.lang.String className,
+              java.lang.String objectName,
+              java.util.Map<java.lang.String,java.lang.Object> annotationInfo)
        +
        • +
      + + + +
        +
      • +

        addContainer

        +
        public void addContainer(ModContainer container)
        +
        • +
      + + + +
        +
      • +

        registerPackage

        +
        public void registerPackage(ModCandidate modCandidate,
+                   java.lang.String pkg)
        +
        • +
      + + + +
        +
      • +

        getCandidatesFor

        +
        public java.util.Set<ModCandidate> getCandidatesFor(java.lang.String pkg)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/ContainerType.html b/javadoc/cpw/mods/fml/common/discovery/ContainerType.html new file mode 100644 index 0000000..746027d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/ContainerType.html @@ -0,0 +1,332 @@ + + + + + +ContainerType (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.discovery
+

Enum ContainerType

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

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      DIR 
      JAR 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.util.List<ModContainer>findMods(ModCandidate candidate, + ASMDataTable table) 
      static ContainerTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ContainerType[]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 ContainerType[] 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 (ContainerType c : ContainerType.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ContainerType 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/cpw/mods/fml/common/discovery/DirectoryDiscoverer.html b/javadoc/cpw/mods/fml/common/discovery/DirectoryDiscoverer.html new file mode 100644 index 0000000..a85e335 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/DirectoryDiscoverer.html @@ -0,0 +1,301 @@ + + + + + +DirectoryDiscoverer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.discovery
+

Class DirectoryDiscoverer

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/ITypeDiscoverer.html b/javadoc/cpw/mods/fml/common/discovery/ITypeDiscoverer.html new file mode 100644 index 0000000..7aa40a4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/ITypeDiscoverer.html @@ -0,0 +1,246 @@ + + + + + +ITypeDiscoverer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.discovery
+

Interface ITypeDiscoverer

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

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.util.regex.PatternclassFile 
      +
      • +
    + + +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/JarDiscoverer.html b/javadoc/cpw/mods/fml/common/discovery/JarDiscoverer.html new file mode 100644 index 0000000..6d2dfca --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/JarDiscoverer.html @@ -0,0 +1,280 @@ + + + + + +JarDiscoverer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.discovery
+

Class JarDiscoverer

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

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.util.List<ModContainer>discover(ModCandidate candidate, + ASMDataTable table) 
      +
        +
      • + + +

        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/cpw/mods/fml/common/discovery/ModCandidate.html b/javadoc/cpw/mods/fml/common/discovery/ModCandidate.html new file mode 100644 index 0000000..b43007d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/ModCandidate.html @@ -0,0 +1,434 @@ + + + + + +ModCandidate (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.discovery
+

Class ModCandidate

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

      Constructor Detail

      + + + +
        +
      • +

        ModCandidate

        +
        public ModCandidate(java.io.File classPathRoot,
+            java.io.File modContainer,
+            ContainerType sourceType)
        +
        • +
      + + + +
        +
      • +

        ModCandidate

        +
        public ModCandidate(java.io.File classPathRoot,
+            java.io.File modContainer,
+            ContainerType sourceType,
+            boolean isMinecraft,
+            boolean classpath)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getClassPathRoot

        +
        public java.io.File getClassPathRoot()
        +
        • +
      + + + +
        +
      • +

        getModContainer

        +
        public java.io.File getModContainer()
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        addClassEntry

        +
        public void addClassEntry(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        isClasspath

        +
        public boolean isClasspath()
        +
        • +
      + + + +
        +
      • +

        rememberBaseModType

        +
        public void rememberBaseModType(java.lang.String className)
        +
        • +
      + + + +
        +
      • +

        getRememberedBaseMods

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

        isMinecraftJar

        +
        public boolean isMinecraftJar()
        +
        • +
      + + + +
        +
      • +

        rememberModCandidateType

        +
        public void rememberModCandidateType(ASMModParser modParser)
        +
        • +
      + + + +
        +
      • +

        getClassList

        +
        public java.util.Set<java.lang.String> getClassList()
        +
        • +
      + + + +
        +
      • +

        getContainedMods

        +
        public java.util.List<ModContainer> getContainedMods()
        +
        • +
      + + + +
        +
      • +

        getContainedPackages

        +
        public java.util.List<java.lang.String> getContainedPackages()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/ModDiscoverer.html b/javadoc/cpw/mods/fml/common/discovery/ModDiscoverer.html new file mode 100644 index 0000000..47da3b7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/ModDiscoverer.html @@ -0,0 +1,306 @@ + + + + + +ModDiscoverer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.discovery
+

Class ModDiscoverer

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

      Constructor Detail

      + + + +
        +
      • +

        ModDiscoverer

        +
        public ModDiscoverer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        findClasspathMods

        +
        public void findClasspathMods(ModClassLoader modClassLoader)
        +
        • +
      + + + +
        +
      • +

        findModDirMods

        +
        public void findModDirMods(java.io.File modsDir)
        +
        • +
      + + + +
        +
      • +

        identifyMods

        +
        public java.util.List<ModContainer> identifyMods()
        +
        • +
      + + + + + + + +
        +
      • +

        getNonModLibs

        +
        public java.util.List<java.io.File> getNonModLibs()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/asm/ASMModParser.html b/javadoc/cpw/mods/fml/common/discovery/asm/ASMModParser.html new file mode 100644 index 0000000..2f20de2 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/asm/ASMModParser.html @@ -0,0 +1,528 @@ + + + + + +ASMModParser (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.discovery.asm
+

Class ASMModParser

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

      Constructor Detail

      + + + +
        +
      • +

        ASMModParser

        +
        public ASMModParser(java.io.InputStream stream)
+             throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        beginNewTypeName

        +
        public void beginNewTypeName(java.lang.String typeQName,
+                    int classVersion,
+                    java.lang.String superClassQName)
        +
        • +
      + + + +
        +
      • +

        startClassAnnotation

        +
        public void startClassAnnotation(java.lang.String annotationName)
        +
        • +
      + + + +
        +
      • +

        addAnnotationProperty

        +
        public void addAnnotationProperty(java.lang.String key,
+                         java.lang.Object value)
        +
        • +
      + + + +
        +
      • +

        startFieldAnnotation

        +
        public void startFieldAnnotation(java.lang.String fieldName,
+                        java.lang.String annotationName)
        +
        • +
      + + + +
        +
      • +

        toString

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

        getASMType

        +
        public org.objectweb.asm.Type getASMType()
        +
        • +
      + + + +
        +
      • +

        getClassVersion

        +
        public int getClassVersion()
        +
        • +
      + + + +
        +
      • +

        getASMSuperType

        +
        public org.objectweb.asm.Type getASMSuperType()
        +
        • +
      + + + +
        +
      • +

        getAnnotations

        +
        public java.util.LinkedList<ModAnnotation> getAnnotations()
        +
        • +
      + + + +
        +
      • +

        validate

        +
        public void validate()
        +
        • +
      + + + +
        +
      • +

        isBaseMod

        +
        public boolean isBaseMod(java.util.List<java.lang.String> rememberedTypes)
        +
        • +
      + + + +
        +
      • +

        setBaseModProperties

        +
        public void setBaseModProperties(java.lang.String foundProperties)
        +
        • +
      + + + +
        +
      • +

        getBaseModProperties

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

        addAnnotationArray

        +
        public void addAnnotationArray(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        addAnnotationEnumProperty

        +
        public void addAnnotationEnumProperty(java.lang.String name,
+                             java.lang.String desc,
+                             java.lang.String value)
        +
        • +
      + + + +
        +
      • +

        endArray

        +
        public void endArray()
        +
        • +
      + + + +
        +
      • +

        addSubAnnotation

        +
        public void addSubAnnotation(java.lang.String name,
+                    java.lang.String desc)
        +
        • +
      + + + +
        +
      • +

        endSubAnnotation

        +
        public void endSubAnnotation()
        +
        • +
      + + + +
        +
      • +

        startMethodAnnotation

        +
        public void startMethodAnnotation(java.lang.String methodName,
+                         java.lang.String methodDescriptor,
+                         java.lang.String annotationName)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/asm/ModAnnotation.EnumHolder.html b/javadoc/cpw/mods/fml/common/discovery/asm/ModAnnotation.EnumHolder.html new file mode 100644 index 0000000..6749699 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/asm/ModAnnotation.EnumHolder.html @@ -0,0 +1,232 @@ + + + + + +ModAnnotation.EnumHolder (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.discovery.asm
+

Class ModAnnotation.EnumHolder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ModAnnotation
    +
    +
    +
    +
    public class ModAnnotation.EnumHolder
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ModAnnotation.EnumHolder(java.lang.String desc, + java.lang.String value) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModAnnotation.EnumHolder

        +
        public ModAnnotation.EnumHolder(java.lang.String desc,
+                        java.lang.String value)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/asm/ModAnnotation.html b/javadoc/cpw/mods/fml/common/discovery/asm/ModAnnotation.html new file mode 100644 index 0000000..b53276b --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/asm/ModAnnotation.html @@ -0,0 +1,422 @@ + + + + + +ModAnnotation (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.discovery.asm
+

Class ModAnnotation

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

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      class ModAnnotation.EnumHolder 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ModAnnotation(cpw.mods.fml.common.discovery.asm.ASMModParser.AnnotationType type, + org.objectweb.asm.Type asmType, + ModAnnotation parent) 
      ModAnnotation(cpw.mods.fml.common.discovery.asm.ASMModParser.AnnotationType type, + org.objectweb.asm.Type asmType, + java.lang.String member) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddArray(java.lang.String name) 
      ModAnnotationaddChildAnnotation(java.lang.String name, + java.lang.String desc) 
      voidaddEnumProperty(java.lang.String key, + java.lang.String enumName, + java.lang.String value) 
      voidaddProperty(java.lang.String key, + java.lang.Object value) 
      voidendArray() 
      org.objectweb.asm.TypegetASMType() 
      java.lang.StringgetMember() 
      cpw.mods.fml.common.discovery.asm.ASMModParser.AnnotationTypegetType() 
      java.util.Map<java.lang.String,java.lang.Object>getValues() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModAnnotation

        +
        public ModAnnotation(cpw.mods.fml.common.discovery.asm.ASMModParser.AnnotationType type,
+             org.objectweb.asm.Type asmType,
+             java.lang.String member)
        +
        • +
      + + + +
        +
      • +

        ModAnnotation

        +
        public ModAnnotation(cpw.mods.fml.common.discovery.asm.ASMModParser.AnnotationType type,
+             org.objectweb.asm.Type asmType,
+             ModAnnotation parent)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

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

        getType

        +
        public cpw.mods.fml.common.discovery.asm.ASMModParser.AnnotationType getType()
        +
        • +
      + + + +
        +
      • +

        getASMType

        +
        public org.objectweb.asm.Type getASMType()
        +
        • +
      + + + +
        +
      • +

        getMember

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

        getValues

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

        addArray

        +
        public void addArray(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        addProperty

        +
        public void addProperty(java.lang.String key,
+               java.lang.Object value)
        +
        • +
      + + + +
        +
      • +

        addEnumProperty

        +
        public void addEnumProperty(java.lang.String key,
+                   java.lang.String enumName,
+                   java.lang.String value)
        +
        • +
      + + + +
        +
      • +

        endArray

        +
        public void endArray()
        +
        • +
      + + + +
        +
      • +

        addChildAnnotation

        +
        public ModAnnotation addChildAnnotation(java.lang.String name,
+                               java.lang.String desc)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/asm/ModAnnotationVisitor.html b/javadoc/cpw/mods/fml/common/discovery/asm/ModAnnotationVisitor.html new file mode 100644 index 0000000..c65a2c7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/asm/ModAnnotationVisitor.html @@ -0,0 +1,382 @@ + + + + + +ModAnnotationVisitor (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.discovery.asm
+

Class ModAnnotationVisitor

+
+
+ +
+
    +
  • +
    +
    +
    public class ModAnnotationVisitor
+extends org.objectweb.asm.AnnotationVisitor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class org.objectweb.asm.AnnotationVisitor

        +api, av
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidvisit(java.lang.String key, + java.lang.Object value) 
      org.objectweb.asm.AnnotationVisitorvisitAnnotation(java.lang.String name, + java.lang.String desc) 
      org.objectweb.asm.AnnotationVisitorvisitArray(java.lang.String name) 
      voidvisitEnd() 
      voidvisitEnum(java.lang.String name, + java.lang.String desc, + java.lang.String value) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModAnnotationVisitor

        +
        public ModAnnotationVisitor(ASMModParser discoverer)
        +
        • +
      + + + +
        +
      • +

        ModAnnotationVisitor

        +
        public ModAnnotationVisitor(ASMModParser discoverer,
+                    java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        ModAnnotationVisitor

        +
        public ModAnnotationVisitor(ASMModParser discoverer,
+                    boolean isSubAnnotation)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        visit

        +
        public void visit(java.lang.String key,
+         java.lang.Object value)
        +
        +
        Overrides:
        +
        visit in class org.objectweb.asm.AnnotationVisitor
        +
        +
        • +
      + + + +
        +
      • +

        visitEnum

        +
        public void visitEnum(java.lang.String name,
+             java.lang.String desc,
+             java.lang.String value)
        +
        +
        Overrides:
        +
        visitEnum in class org.objectweb.asm.AnnotationVisitor
        +
        +
        • +
      + + + +
        +
      • +

        visitArray

        +
        public org.objectweb.asm.AnnotationVisitor visitArray(java.lang.String name)
        +
        +
        Overrides:
        +
        visitArray in class org.objectweb.asm.AnnotationVisitor
        +
        +
        • +
      + + + +
        +
      • +

        visitAnnotation

        +
        public org.objectweb.asm.AnnotationVisitor visitAnnotation(java.lang.String name,
+                                                  java.lang.String desc)
        +
        +
        Overrides:
        +
        visitAnnotation in class org.objectweb.asm.AnnotationVisitor
        +
        +
        • +
      + + + +
        +
      • +

        visitEnd

        +
        public void visitEnd()
        +
        +
        Overrides:
        +
        visitEnd in class org.objectweb.asm.AnnotationVisitor
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/asm/ModClassVisitor.html b/javadoc/cpw/mods/fml/common/discovery/asm/ModClassVisitor.html new file mode 100644 index 0000000..161e483 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/asm/ModClassVisitor.html @@ -0,0 +1,364 @@ + + + + + +ModClassVisitor (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.discovery.asm
+

Class ModClassVisitor

+
+
+ +
+
    +
  • +
    +
    +
    public class ModClassVisitor
+extends org.objectweb.asm.ClassVisitor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class org.objectweb.asm.ClassVisitor

        +api, cv
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidvisit(int version, + int access, + java.lang.String name, + java.lang.String signature, + java.lang.String superName, + java.lang.String[] interfaces) 
      org.objectweb.asm.AnnotationVisitorvisitAnnotation(java.lang.String annotationName, + boolean runtimeVisible) 
      org.objectweb.asm.FieldVisitorvisitField(int access, + java.lang.String name, + java.lang.String desc, + java.lang.String signature, + java.lang.Object value) 
      org.objectweb.asm.MethodVisitorvisitMethod(int access, + java.lang.String name, + java.lang.String desc, + java.lang.String signature, + java.lang.String[] exceptions) 
      +
        +
      • + + +

        Methods inherited from class org.objectweb.asm.ClassVisitor

        +visitAttribute, visitEnd, visitInnerClass, visitOuterClass, visitSource, visitTypeAnnotation
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModClassVisitor

        +
        public ModClassVisitor(ASMModParser discoverer)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        visit

        +
        public void visit(int version,
+         int access,
+         java.lang.String name,
+         java.lang.String signature,
+         java.lang.String superName,
+         java.lang.String[] interfaces)
        +
        +
        Overrides:
        +
        visit in class org.objectweb.asm.ClassVisitor
        +
        +
        • +
      + + + +
        +
      • +

        visitAnnotation

        +
        public org.objectweb.asm.AnnotationVisitor visitAnnotation(java.lang.String annotationName,
+                                                  boolean runtimeVisible)
        +
        +
        Overrides:
        +
        visitAnnotation in class org.objectweb.asm.ClassVisitor
        +
        +
        • +
      + + + +
        +
      • +

        visitField

        +
        public org.objectweb.asm.FieldVisitor visitField(int access,
+                                        java.lang.String name,
+                                        java.lang.String desc,
+                                        java.lang.String signature,
+                                        java.lang.Object value)
        +
        +
        Overrides:
        +
        visitField in class org.objectweb.asm.ClassVisitor
        +
        +
        • +
      + + + +
        +
      • +

        visitMethod

        +
        public org.objectweb.asm.MethodVisitor visitMethod(int access,
+                                          java.lang.String name,
+                                          java.lang.String desc,
+                                          java.lang.String signature,
+                                          java.lang.String[] exceptions)
        +
        +
        Overrides:
        +
        visitMethod in class org.objectweb.asm.ClassVisitor
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/asm/ModFieldVisitor.html b/javadoc/cpw/mods/fml/common/discovery/asm/ModFieldVisitor.html new file mode 100644 index 0000000..1e8832d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/asm/ModFieldVisitor.html @@ -0,0 +1,289 @@ + + + + + +ModFieldVisitor (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.discovery.asm
+

Class ModFieldVisitor

+
+
+ +
+
    +
  • +
    +
    +
    public class ModFieldVisitor
+extends org.objectweb.asm.FieldVisitor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class org.objectweb.asm.FieldVisitor

        +api, fv
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ModFieldVisitor(java.lang.String name, + ASMModParser discoverer) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      org.objectweb.asm.AnnotationVisitorvisitAnnotation(java.lang.String annotationName, + boolean runtimeVisible) 
      +
        +
      • + + +

        Methods inherited from class org.objectweb.asm.FieldVisitor

        +visitAttribute, visitEnd, visitTypeAnnotation
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModFieldVisitor

        +
        public ModFieldVisitor(java.lang.String name,
+               ASMModParser discoverer)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        visitAnnotation

        +
        public org.objectweb.asm.AnnotationVisitor visitAnnotation(java.lang.String annotationName,
+                                                  boolean runtimeVisible)
        +
        +
        Overrides:
        +
        visitAnnotation in class org.objectweb.asm.FieldVisitor
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/asm/ModMethodVisitor.html b/javadoc/cpw/mods/fml/common/discovery/asm/ModMethodVisitor.html new file mode 100644 index 0000000..32bd0f3 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/asm/ModMethodVisitor.html @@ -0,0 +1,291 @@ + + + + + +ModMethodVisitor (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.discovery.asm
+

Class ModMethodVisitor

+
+
+ +
+
    +
  • +
    +
    +
    public class ModMethodVisitor
+extends org.objectweb.asm.MethodVisitor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class org.objectweb.asm.MethodVisitor

        +api, mv
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ModMethodVisitor(java.lang.String name, + java.lang.String desc, + ASMModParser discoverer) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      org.objectweb.asm.AnnotationVisitorvisitAnnotation(java.lang.String annotationName, + boolean runtimeVisible) 
      +
        +
      • + + +

        Methods inherited from class org.objectweb.asm.MethodVisitor

        +visitAnnotationDefault, visitAttribute, visitCode, visitEnd, visitFieldInsn, visitFrame, visitIincInsn, visitInsn, visitInsnAnnotation, visitIntInsn, visitInvokeDynamicInsn, visitJumpInsn, visitLabel, visitLdcInsn, visitLineNumber, visitLocalVariable, visitLocalVariableAnnotation, visitLookupSwitchInsn, visitMaxs, visitMethodInsn, visitMethodInsn, visitMultiANewArrayInsn, visitParameter, visitParameterAnnotation, visitTableSwitchInsn, visitTryCatchAnnotation, visitTryCatchBlock, visitTypeAnnotation, visitTypeInsn, visitVarInsn
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModMethodVisitor

        +
        public ModMethodVisitor(java.lang.String name,
+                java.lang.String desc,
+                ASMModParser discoverer)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        visitAnnotation

        +
        public org.objectweb.asm.AnnotationVisitor visitAnnotation(java.lang.String annotationName,
+                                                  boolean runtimeVisible)
        +
        +
        Overrides:
        +
        visitAnnotation in class org.objectweb.asm.MethodVisitor
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/asm/package-frame.html b/javadoc/cpw/mods/fml/common/discovery/asm/package-frame.html new file mode 100644 index 0000000..9cf5833 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/asm/package-frame.html @@ -0,0 +1,24 @@ + + + + + +cpw.mods.fml.common.discovery.asm (Forge API) + + + + +

cpw.mods.fml.common.discovery.asm

+
+

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/discovery/asm/package-summary.html b/javadoc/cpw/mods/fml/common/discovery/asm/package-summary.html new file mode 100644 index 0000000..cf895ad --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/asm/package-summary.html @@ -0,0 +1,151 @@ + + + + + +cpw.mods.fml.common.discovery.asm (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.discovery.asm

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/asm/package-tree.html b/javadoc/cpw/mods/fml/common/discovery/asm/package-tree.html new file mode 100644 index 0000000..7b2e951 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/asm/package-tree.html @@ -0,0 +1,148 @@ + + + + + +cpw.mods.fml.common.discovery.asm Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.discovery.asm

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/package-frame.html b/javadoc/cpw/mods/fml/common/discovery/package-frame.html new file mode 100644 index 0000000..7d9fbfe --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/package-frame.html @@ -0,0 +1,32 @@ + + + + + +cpw.mods.fml.common.discovery (Forge API) + + + + +

cpw.mods.fml.common.discovery

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/discovery/package-summary.html b/javadoc/cpw/mods/fml/common/discovery/package-summary.html new file mode 100644 index 0000000..c8e299e --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/package-summary.html @@ -0,0 +1,181 @@ + + + + + +cpw.mods.fml.common.discovery (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.discovery

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/discovery/package-tree.html b/javadoc/cpw/mods/fml/common/discovery/package-tree.html new file mode 100644 index 0000000..c2346aa --- /dev/null +++ b/javadoc/cpw/mods/fml/common/discovery/package-tree.html @@ -0,0 +1,147 @@ + + + + + +cpw.mods.fml.common.discovery Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.discovery

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLConstructionEvent.html b/javadoc/cpw/mods/fml/common/event/FMLConstructionEvent.html new file mode 100644 index 0000000..2e6925b --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLConstructionEvent.html @@ -0,0 +1,321 @@ + + + + + +FMLConstructionEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLConstructionEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLConstructionEvent
+extends FMLStateEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLConstructionEvent

        +
        public FMLConstructionEvent(java.lang.Object... eventData)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getModClassLoader

        +
        public ModClassLoader getModClassLoader()
        +
        • +
      + + + + + + + +
        +
      • +

        getASMHarvestedData

        +
        public ASMDataTable getASMHarvestedData()
        +
        • +
      + + + +
        +
      • +

        getReverseDependencies

        +
        public com.google.common.collect.ListMultimap<java.lang.String,java.lang.String> getReverseDependencies()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLEvent.html b/javadoc/cpw/mods/fml/common/event/FMLEvent.html new file mode 100644 index 0000000..f567ed9 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLEvent.html @@ -0,0 +1,271 @@ + + + + + +FMLEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLEvent

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

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidapplyModContainer(ModContainer activeContainer) 
      java.lang.StringgetEventType() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FMLEvent

        +
        public FMLEvent()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getEventType

        +
        public final java.lang.String getEventType()
        +
        • +
      + + + +
        +
      • +

        applyModContainer

        +
        public void applyModContainer(ModContainer activeContainer)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLFingerprintViolationEvent.html b/javadoc/cpw/mods/fml/common/event/FMLFingerprintViolationEvent.html new file mode 100644 index 0000000..1fd6204 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLFingerprintViolationEvent.html @@ -0,0 +1,319 @@ + + + + + +FMLFingerprintViolationEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLFingerprintViolationEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLFingerprintViolationEvent
+extends FMLEvent
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FMLFingerprintViolationEvent(boolean isDirectory, + java.io.File source, + com.google.common.collect.ImmutableSet<java.lang.String> fingerprints, + java.lang.String expectedFingerprint) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        isDirectory

        +
        public final boolean isDirectory
        +
        • +
      + + + +
        +
      • +

        fingerprints

        +
        public final java.util.Set<java.lang.String> fingerprints
        +
        • +
      + + + +
        +
      • +

        source

        +
        public final java.io.File source
        +
        • +
      + + + +
        +
      • +

        expectedFingerprint

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

      Constructor Detail

      + + + +
        +
      • +

        FMLFingerprintViolationEvent

        +
        public FMLFingerprintViolationEvent(boolean isDirectory,
+                            java.io.File source,
+                            com.google.common.collect.ImmutableSet<java.lang.String> fingerprints,
+                            java.lang.String expectedFingerprint)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLInitializationEvent.html b/javadoc/cpw/mods/fml/common/event/FMLInitializationEvent.html new file mode 100644 index 0000000..cf5a1aa --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLInitializationEvent.html @@ -0,0 +1,282 @@ + + + + + +FMLInitializationEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLInitializationEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLInitializationEvent
+extends FMLStateEvent
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLInterModComms.IMCEvent.html b/javadoc/cpw/mods/fml/common/event/FMLInterModComms.IMCEvent.html new file mode 100644 index 0000000..9ca59ea --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLInterModComms.IMCEvent.html @@ -0,0 +1,289 @@ + + + + + +FMLInterModComms.IMCEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLInterModComms.IMCEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FMLInterModComms
    +
    +
    +
    +
    public static class FMLInterModComms.IMCEvent
+extends FMLEvent
    +
    Subscribe to this event to receive your messages (they are sent between + Init and PostInit)
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLInterModComms.IMCMessage.html b/javadoc/cpw/mods/fml/common/event/FMLInterModComms.IMCMessage.html new file mode 100644 index 0000000..2c44ec5 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLInterModComms.IMCMessage.html @@ -0,0 +1,372 @@ + + + + + +FMLInterModComms.IMCMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLInterModComms.IMCMessage

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FMLInterModComms
    +
    +
    +
    +
    public static final class FMLInterModComms.IMCMessage
+extends java.lang.Object
    +
    You will receive an instance of this for each message sent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        key

        +
        public final java.lang.String key
        +
        This field, and value are both at the mod's discretion
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

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

        getSender

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

        getStringValue

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

        getItemStackValue

        +
        public ItemStack getItemStackValue()
        +
        • +
      + + + +
        +
      • +

        getMessageType

        +
        public java.lang.Class<?> getMessageType()
        +
        • +
      + + + +
        +
      • +

        isStringMessage

        +
        public boolean isStringMessage()
        +
        • +
      + + + +
        +
      • +

        isItemStackMessage

        +
        public boolean isItemStackMessage()
        +
        • +
      + + + +
        +
      • +

        isNBTMessage

        +
        public boolean isNBTMessage()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLInterModComms.html b/javadoc/cpw/mods/fml/common/event/FMLInterModComms.html new file mode 100644 index 0000000..ccff6d1 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLInterModComms.html @@ -0,0 +1,397 @@ + + + + + +FMLInterModComms (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLInterModComms

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLInterModComms
+extends java.lang.Object
    +
    Simple intermod communications to receive simple messages directed at you + from other mods
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class FMLInterModComms.IMCEvent +
      Subscribe to this event to receive your messages (they are sent between + Init and PostInit)
      +
      static class FMLInterModComms.IMCMessage +
      You will receive an instance of this for each message sent
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static com.google.common.collect.ImmutableList<FMLInterModComms.IMCMessage>fetchRuntimeMessages(java.lang.Object forMod) +
      Retrieve any pending runtime messages for the mod
      +
      static booleansendMessage(java.lang.String modId, + java.lang.String key, + ItemStack value) 
      static booleansendMessage(java.lang.String modId, + java.lang.String key, + NBTTagCompound value) 
      static booleansendMessage(java.lang.String modId, + java.lang.String key, + java.lang.String value) 
      static voidsendRuntimeMessage(java.lang.Object sourceMod, + java.lang.String modId, + java.lang.String key, + ItemStack value) 
      static voidsendRuntimeMessage(java.lang.Object sourceMod, + java.lang.String modId, + java.lang.String key, + NBTTagCompound value) 
      static voidsendRuntimeMessage(java.lang.Object sourceMod, + java.lang.String modId, + java.lang.String key, + java.lang.String value) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FMLInterModComms

        +
        public FMLInterModComms()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sendMessage

        +
        public static boolean sendMessage(java.lang.String modId,
+                  java.lang.String key,
+                  NBTTagCompound value)
        +
        • +
      + + + +
        +
      • +

        sendMessage

        +
        public static boolean sendMessage(java.lang.String modId,
+                  java.lang.String key,
+                  ItemStack value)
        +
        • +
      + + + +
        +
      • +

        sendMessage

        +
        public static boolean sendMessage(java.lang.String modId,
+                  java.lang.String key,
+                  java.lang.String value)
        +
        • +
      + + + +
        +
      • +

        sendRuntimeMessage

        +
        public static void sendRuntimeMessage(java.lang.Object sourceMod,
+                      java.lang.String modId,
+                      java.lang.String key,
+                      NBTTagCompound value)
        +
        • +
      + + + +
        +
      • +

        sendRuntimeMessage

        +
        public static void sendRuntimeMessage(java.lang.Object sourceMod,
+                      java.lang.String modId,
+                      java.lang.String key,
+                      ItemStack value)
        +
        • +
      + + + +
        +
      • +

        sendRuntimeMessage

        +
        public static void sendRuntimeMessage(java.lang.Object sourceMod,
+                      java.lang.String modId,
+                      java.lang.String key,
+                      java.lang.String value)
        +
        • +
      + + + +
        +
      • +

        fetchRuntimeMessages

        +
        public static com.google.common.collect.ImmutableList<FMLInterModComms.IMCMessage> fetchRuntimeMessages(java.lang.Object forMod)
        +
        Retrieve any pending runtime messages for the mod
        +
        Parameters:
        forMod - The Mod.Instance of the Mod to fetch messages for
        +
        Returns:
        any messages - the collection will never be null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLLoadCompleteEvent.html b/javadoc/cpw/mods/fml/common/event/FMLLoadCompleteEvent.html new file mode 100644 index 0000000..7b59161 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLLoadCompleteEvent.html @@ -0,0 +1,282 @@ + + + + + +FMLLoadCompleteEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLLoadCompleteEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLLoadCompleteEvent
+extends FMLStateEvent
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLLoadEvent.html b/javadoc/cpw/mods/fml/common/event/FMLLoadEvent.html new file mode 100644 index 0000000..7e30ad2 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLLoadEvent.html @@ -0,0 +1,226 @@ + + + + + +FMLLoadEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLLoadEvent

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

      Constructor Summary

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

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FMLLoadEvent

        +
        public FMLLoadEvent()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLMissingMappingsEvent.Action.html b/javadoc/cpw/mods/fml/common/event/FMLMissingMappingsEvent.Action.html new file mode 100644 index 0000000..c3e8ab0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLMissingMappingsEvent.Action.html @@ -0,0 +1,378 @@ + + + + + +FMLMissingMappingsEvent.Action (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Enum FMLMissingMappingsEvent.Action

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<FMLMissingMappingsEvent.Action>
    +
    +
    +
    Enclosing class:
    +
    FMLMissingMappingsEvent
    +
    +
    +
    +
    public static enum FMLMissingMappingsEvent.Action
+extends java.lang.Enum<FMLMissingMappingsEvent.Action>
    +
    Actions you can take with this missing mapping. +
      +
    • IGNORE means this missing mapping will be ignored. +
    • WARN means this missing mapping will generate a warning. +
    • FAIL means this missing mapping will prevent the world from loading. +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      DEFAULT +
      Take the default action
      +
      FAIL +
      Fail to load
      +
      IGNORE +
      Ignore this missing mapping.
      +
      REMAP +
      Remap this name to a new name (add a migration mapping)
      +
      WARN +
      Generate a warning but allow loading to continue
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static FMLMissingMappingsEvent.ActionvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static FMLMissingMappingsEvent.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 FMLMissingMappingsEvent.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 (FMLMissingMappingsEvent.Action c : FMLMissingMappingsEvent.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 FMLMissingMappingsEvent.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/cpw/mods/fml/common/event/FMLMissingMappingsEvent.MissingMapping.html b/javadoc/cpw/mods/fml/common/event/FMLMissingMappingsEvent.MissingMapping.html new file mode 100644 index 0000000..4227927 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLMissingMappingsEvent.MissingMapping.html @@ -0,0 +1,442 @@ + + + + + +FMLMissingMappingsEvent.MissingMapping (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLMissingMappingsEvent.MissingMapping

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FMLMissingMappingsEvent
    +
    +
    +
    +
    public static class FMLMissingMappingsEvent.MissingMapping
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      intid 
      java.lang.Stringname 
      GameRegistry.Typetype 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidfail() +
      Prevent the world from loading due to the missing item.
      +
      FMLMissingMappingsEvent.ActiongetAction() 
      java.lang.ObjectgetTarget() 
      voidignore() +
      Ignore the missing item.
      +
      voidremap(Block target) +
      Remap the missing item to the specified Block.
      +
      voidremap(Item target) +
      Remap the missing item to the specified Item.
      +
      voidsetAction(FMLMissingMappingsEvent.Action target) +
      Deprecated.  +
      use ignore(), warn(), fail() or remap() instead
      +
      +
      voidwarn() +
      Warn the user about the missing item.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + + + + + +
        +
      • +

        name

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

        id

        +
        public final int id
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLMissingMappingsEvent.MissingMapping

        +
        public FMLMissingMappingsEvent.MissingMapping(java.lang.String name,
+                                      int id)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setAction

        +
        @Deprecated
+public void setAction(FMLMissingMappingsEvent.Action target)
        +
        Deprecated. use ignore(), warn(), fail() or remap() instead
        +
        • +
      + + + +
        +
      • +

        ignore

        +
        public void ignore()
        +
        Ignore the missing item.
        +
        • +
      + + + +
        +
      • +

        warn

        +
        public void warn()
        +
        Warn the user about the missing item.
        +
        • +
      + + + +
        +
      • +

        fail

        +
        public void fail()
        +
        Prevent the world from loading due to the missing item.
        +
        • +
      + + + +
        +
      • +

        remap

        +
        public void remap(Block target)
        +
        Remap the missing item to the specified Block. + + Use this if you have renamed a Block, don't forget to handle the ItemBlock. + Existing references using the old name will point to the new one.
        +
        Parameters:
        target - Block to remap to.
        +
        • +
      + + + +
        +
      • +

        remap

        +
        public void remap(Item target)
        +
        Remap the missing item to the specified Item. + + Use this if you have renamed an Item. + Existing references using the old name will point to the new one.
        +
        Parameters:
        target - Item to remap to.
        +
        • +
      + + + + + + + +
        +
      • +

        getTarget

        +
        public java.lang.Object getTarget()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLMissingMappingsEvent.html b/javadoc/cpw/mods/fml/common/event/FMLMissingMappingsEvent.html new file mode 100644 index 0000000..d36da0a --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLMissingMappingsEvent.html @@ -0,0 +1,341 @@ + + + + + +FMLMissingMappingsEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLMissingMappingsEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLMissingMappingsEvent
+extends FMLEvent
    +
    This event is fired if a world is loaded that has block and item mappings referring the mod that are not + in existence. + These can be remapped to other existing objects, or simply discarded. + Use get() and getAll() to process this event.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        get

        +
        public java.util.List<FMLMissingMappingsEvent.MissingMapping> get()
        +
        Get the list of missing mappings for the active mod. + + Process the list entries by calling ignore(), warn(), fail() or remap() on each entry.
        +
        Returns:
        list of missing mappings
        +
        • +
      + + + +
        +
      • +

        getAll

        +
        public java.util.List<FMLMissingMappingsEvent.MissingMapping> getAll()
        +
        Get the list of missing mappings for all mods. + + Only use this if you need to handle mod id changes, e.g. if you renamed your mod or + split/merge into/from multiple mods. + + Process the list entries by calling ignore(), warn(), fail() or remap() on each entry you + want to handle.
        +
        Returns:
        list of missing mappings
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLModDisabledEvent.html b/javadoc/cpw/mods/fml/common/event/FMLModDisabledEvent.html new file mode 100644 index 0000000..ba4cd95 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLModDisabledEvent.html @@ -0,0 +1,238 @@ + + + + + +FMLModDisabledEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLModDisabledEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLModDisabledEvent
+extends FMLEvent
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FMLModDisabledEvent

        +
        public FMLModDisabledEvent()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLModIdMappingEvent.ModRemapping.html b/javadoc/cpw/mods/fml/common/event/FMLModIdMappingEvent.ModRemapping.html new file mode 100644 index 0000000..b07c576 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLModIdMappingEvent.ModRemapping.html @@ -0,0 +1,309 @@ + + + + + +FMLModIdMappingEvent.ModRemapping (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLModIdMappingEvent.ModRemapping

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FMLModIdMappingEvent
    +
    +
    +
    +
    public class FMLModIdMappingEvent.ModRemapping
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FMLModIdMappingEvent.ModRemapping

        +
        public FMLModIdMappingEvent.ModRemapping(int oldId,
+                                 int newId,
+                                 java.lang.String tag)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLModIdMappingEvent.RemapTarget.html b/javadoc/cpw/mods/fml/common/event/FMLModIdMappingEvent.RemapTarget.html new file mode 100644 index 0000000..e107632 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLModIdMappingEvent.RemapTarget.html @@ -0,0 +1,321 @@ + + + + + +FMLModIdMappingEvent.RemapTarget (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Enum FMLModIdMappingEvent.RemapTarget

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

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      BLOCK 
      ITEM 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static FMLModIdMappingEvent.RemapTargetvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static FMLModIdMappingEvent.RemapTarget[]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 FMLModIdMappingEvent.RemapTarget[] 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 (FMLModIdMappingEvent.RemapTarget c : FMLModIdMappingEvent.RemapTarget.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static FMLModIdMappingEvent.RemapTarget 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/cpw/mods/fml/common/event/FMLModIdMappingEvent.html b/javadoc/cpw/mods/fml/common/event/FMLModIdMappingEvent.html new file mode 100644 index 0000000..be10ed3 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLModIdMappingEvent.html @@ -0,0 +1,297 @@ + + + + + +FMLModIdMappingEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLModIdMappingEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLModIdMappingEvent
+extends FMLEvent
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLModIdMappingEvent

        +
        public FMLModIdMappingEvent(java.util.Map<java.lang.String,java.lang.Integer[]> mappings)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLPostInitializationEvent.html b/javadoc/cpw/mods/fml/common/event/FMLPostInitializationEvent.html new file mode 100644 index 0000000..50d18a7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLPostInitializationEvent.html @@ -0,0 +1,297 @@ + + + + + +FMLPostInitializationEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLPostInitializationEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLPostInitializationEvent
+extends FMLStateEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLPostInitializationEvent

        +
        public FMLPostInitializationEvent(java.lang.Object... data)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        buildSoftDependProxy

        +
        public java.lang.Object buildSoftDependProxy(java.lang.String modId,
+                                    java.lang.String className)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLPreInitializationEvent.html b/javadoc/cpw/mods/fml/common/event/FMLPreInitializationEvent.html new file mode 100644 index 0000000..dd74212 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLPreInitializationEvent.html @@ -0,0 +1,419 @@ + + + + + +FMLPreInitializationEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLPreInitializationEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLPreInitializationEvent
+extends FMLStateEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLPreInitializationEvent

        +
        public FMLPreInitializationEvent(java.lang.Object... data)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

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

        getSourceFile

        +
        public java.io.File getSourceFile()
        +
        • +
      + + + +
        +
      • +

        getModMetadata

        +
        public ModMetadata getModMetadata()
        +
        • +
      + + + +
        +
      • +

        getModConfigurationDirectory

        +
        public java.io.File getModConfigurationDirectory()
        +
        • +
      + + + +
        +
      • +

        getSuggestedConfigurationFile

        +
        public java.io.File getSuggestedConfigurationFile()
        +
        • +
      + + + + + + + +
        +
      • +

        getVersionProperties

        +
        public java.util.Properties getVersionProperties()
        +
        • +
      + + + +
        +
      • +

        getModLog

        +
        public org.apache.logging.log4j.Logger getModLog()
        +
        Get a logger instance configured to write to the FML Log as a parent, identified by modid. Handy for mod logging! + Configurations can be applied through the config/logging.properties file, specifying logging levels + for your ModID. Use this!
        +
        Returns:
        A logger
        +
        • +
      + + + +
        +
      • +

        getFMLSigningCertificates

        +
        @Deprecated
+public java.security.cert.Certificate[] getFMLSigningCertificates()
        +
        Deprecated. 
        +
        Retrieve the FML signing certificates, if any. Validate these against the + published FML certificates in your mod, if you wish. + + Deprecated because mods should NOT trust this code. Rather + they should copy this, or something like this, into their own mods.
        +
        Returns:
        Certificates used to sign FML and Forge
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLServerAboutToStartEvent.html b/javadoc/cpw/mods/fml/common/event/FMLServerAboutToStartEvent.html new file mode 100644 index 0000000..6cf624f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLServerAboutToStartEvent.html @@ -0,0 +1,295 @@ + + + + + +FMLServerAboutToStartEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLServerAboutToStartEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLServerAboutToStartEvent
+extends FMLStateEvent
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLServerStartedEvent.html b/javadoc/cpw/mods/fml/common/event/FMLServerStartedEvent.html new file mode 100644 index 0000000..efc0ee4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLServerStartedEvent.html @@ -0,0 +1,282 @@ + + + + + +FMLServerStartedEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLServerStartedEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLServerStartedEvent
+extends FMLStateEvent
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLServerStartingEvent.html b/javadoc/cpw/mods/fml/common/event/FMLServerStartingEvent.html new file mode 100644 index 0000000..a0a2031 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLServerStartingEvent.html @@ -0,0 +1,308 @@ + + + + + +FMLServerStartingEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLServerStartingEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLServerStartingEvent
+extends FMLStateEvent
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLServerStoppedEvent.html b/javadoc/cpw/mods/fml/common/event/FMLServerStoppedEvent.html new file mode 100644 index 0000000..cb5f16d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLServerStoppedEvent.html @@ -0,0 +1,282 @@ + + + + + +FMLServerStoppedEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLServerStoppedEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLServerStoppedEvent
+extends FMLStateEvent
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLServerStoppingEvent.html b/javadoc/cpw/mods/fml/common/event/FMLServerStoppingEvent.html new file mode 100644 index 0000000..10449dc --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLServerStoppingEvent.html @@ -0,0 +1,282 @@ + + + + + +FMLServerStoppingEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLServerStoppingEvent

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLServerStoppingEvent
+extends FMLStateEvent
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/FMLStateEvent.html b/javadoc/cpw/mods/fml/common/event/FMLStateEvent.html new file mode 100644 index 0000000..c8f1051 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/FMLStateEvent.html @@ -0,0 +1,283 @@ + + + + + +FMLStateEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.event
+

Class FMLStateEvent

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

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FMLStateEvent(java.lang.Object... data) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLStateEvent

        +
        public FMLStateEvent(java.lang.Object... data)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/package-frame.html b/javadoc/cpw/mods/fml/common/event/package-frame.html new file mode 100644 index 0000000..ca65fba --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/package-frame.html @@ -0,0 +1,44 @@ + + + + + +cpw.mods.fml.common.event (Forge API) + + + + +

cpw.mods.fml.common.event

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/event/package-summary.html b/javadoc/cpw/mods/fml/common/event/package-summary.html new file mode 100644 index 0000000..72d06e4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/package-summary.html @@ -0,0 +1,243 @@ + + + + + +cpw.mods.fml.common.event (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.event

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/event/package-tree.html b/javadoc/cpw/mods/fml/common/event/package-tree.html new file mode 100644 index 0000000..b24946f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/event/package-tree.html @@ -0,0 +1,166 @@ + + + + + +cpw.mods.fml.common.event Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.event

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/eventhandler/ASMEventHandler.html b/javadoc/cpw/mods/fml/common/eventhandler/ASMEventHandler.html new file mode 100644 index 0000000..d98e7f0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/ASMEventHandler.html @@ -0,0 +1,313 @@ + + + + + +ASMEventHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.eventhandler
+

Class ASMEventHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IEventListener
    +
    +
    +
    +
    public class ASMEventHandler
+extends java.lang.Object
+implements IEventListener
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ASMEventHandler(java.lang.Object target, + java.lang.reflect.Method method, + ModContainer owner) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Class<?>createWrapper(java.lang.reflect.Method callback) 
      EventPrioritygetPriority() 
      voidinvoke(Event event) 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ASMEventHandler

        +
        public ASMEventHandler(java.lang.Object target,
+               java.lang.reflect.Method method,
+               ModContainer owner)
+                throws java.lang.Exception
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

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

        createWrapper

        +
        public java.lang.Class<?> createWrapper(java.lang.reflect.Method callback)
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/eventhandler/Cancelable.html b/javadoc/cpw/mods/fml/common/eventhandler/Cancelable.html new file mode 100644 index 0000000..83cf4de --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/Cancelable.html @@ -0,0 +1,150 @@ + + + + + +Cancelable (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.eventhandler
+

Annotation Type Cancelable

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=TYPE)
+public @interface Cancelable
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/eventhandler/Event.HasResult.html b/javadoc/cpw/mods/fml/common/eventhandler/Event.HasResult.html new file mode 100644 index 0000000..2c27000 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/Event.HasResult.html @@ -0,0 +1,150 @@ + + + + + +Event.HasResult (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.eventhandler
+

Annotation Type Event.HasResult

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=TYPE)
+public static @interface Event.HasResult
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/eventhandler/Event.Result.html b/javadoc/cpw/mods/fml/common/eventhandler/Event.Result.html new file mode 100644 index 0000000..8910f52 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/Event.Result.html @@ -0,0 +1,333 @@ + + + + + +Event.Result (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.eventhandler
+

Enum Event.Result

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Event.Result>
    +
    +
    +
    Enclosing class:
    +
    Event
    +
    +
    +
    +
    public static enum Event.Result
+extends java.lang.Enum<Event.Result>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      ALLOW 
      DEFAULT 
      DENY 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static Event.ResultvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Event.Result[]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 Event.Result[] 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 (Event.Result c : Event.Result.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Event.Result 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/cpw/mods/fml/common/eventhandler/Event.html b/javadoc/cpw/mods/fml/common/eventhandler/Event.html new file mode 100644 index 0000000..7f4af89 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/Event.html @@ -0,0 +1,442 @@ + + + + + +Event (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.eventhandler
+

Class Event

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

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static interface Event.HasResult 
      static class Event.Result 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      ListenerListgetListenerList() +
      Returns a ListenerList object that contains all listeners + that are registered to this event.
      +
      EventPrioritygetPhase() 
      Event.ResultgetResult() +
      Returns the value set as the result of this event
      +
      booleanhasResult() +
      Determines if this event expects a significant result value.
      +
      booleanisCancelable() +
      Determine if this function is cancelable at all.
      +
      booleanisCanceled() +
      Determine if this event is canceled and should stop executing.
      +
      voidsetCanceled(boolean cancel) +
      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.
      +
      voidsetPhase(EventPriority value) 
      voidsetResult(Event.Result value) +
      Sets the result value for this event, not all events can have a result set, and any attempt to + set a result for a event that isn't expecting it will result in a IllegalArgumentException.
      +
      protected voidsetup() +
      Called by the base constructor, this is used by ASM generated + event classes to setup various functionality such as the listenerlist.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Event

        +
        public Event()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isCancelable

        +
        public boolean isCancelable()
        +
        Determine if this function is cancelable at all.
        +
        Returns:
        If access to setCanceled should be allowed
        +
        • +
      + + + +
        +
      • +

        isCanceled

        +
        public boolean isCanceled()
        +
        Determine if this event is canceled and should stop executing.
        +
        Returns:
        The current canceled state
        +
        • +
      + + + +
        +
      • +

        setCanceled

        +
        public void setCanceled(boolean cancel)
        +
        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.
        +
        Parameters:
        cancel - The new canceled value
        +
        • +
      + + + +
        +
      • +

        hasResult

        +
        public boolean hasResult()
        +
        Determines if this event expects a significant result value.
        +
        • +
      + + + +
        +
      • +

        getResult

        +
        public Event.Result getResult()
        +
        Returns the value set as the result of this event
        +
        • +
      + + + +
        +
      • +

        setResult

        +
        public void setResult(Event.Result value)
        +
        Sets the result value for this event, not all events can have a result set, and any attempt to + set a result for a event that isn't expecting it will result in a IllegalArgumentException. + + The functionality of setting the result is defined on a per-event bases.
        +
        Parameters:
        value - The new result
        +
        • +
      + + + +
        +
      • +

        setup

        +
        protected void setup()
        +
        Called by the base constructor, this is used by ASM generated + event classes to setup various functionality such as the listenerlist.
        +
        • +
      + + + +
        +
      • +

        getListenerList

        +
        public ListenerList getListenerList()
        +
        Returns a ListenerList object that contains all listeners + that are registered to this event.
        +
        Returns:
        Listener List
        +
        • +
      + + + + + + + +
        +
      • +

        setPhase

        +
        public void setPhase(@Nonnull
+            EventPriority value)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/eventhandler/EventBus.html b/javadoc/cpw/mods/fml/common/eventhandler/EventBus.html new file mode 100644 index 0000000..31fe3ff --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/EventBus.html @@ -0,0 +1,328 @@ + + + + + +EventBus (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.eventhandler
+

Class EventBus

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidhandleException(EventBus bus, + Event event, + IEventListener[] listeners, + int index, + java.lang.Throwable throwable) +
      Fired when a EventListener throws an exception for the specified event on the event bus.
      +
      booleanpost(Event event) 
      voidregister(java.lang.Object target) 
      voidunregister(java.lang.Object object) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        register

        +
        public void register(java.lang.Object target)
        +
        • +
      + + + +
        +
      • +

        unregister

        +
        public void unregister(java.lang.Object object)
        +
        • +
      + + + +
        +
      • +

        post

        +
        public boolean post(Event event)
        +
        • +
      + + + +
        +
      • +

        handleException

        +
        public void handleException(EventBus bus,
+                   Event event,
+                   IEventListener[] listeners,
+                   int index,
+                   java.lang.Throwable throwable)
        +
        Description copied from interface: IEventExceptionHandler
        +
        Fired when a EventListener throws an exception for the specified event on the event bus. + After this function returns, the original Throwable will be propogated upwards.
        +
        +
        Specified by:
        +
        handleException in interface IEventExceptionHandler
        +
        Parameters:
        bus - The bus the event is being fired on
        event - The event that is being fired
        listeners - All listeners that are listening for this event, in order
        index - Index for the current listener being fired.
        throwable - The throwable being thrown
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/eventhandler/EventPriority.html b/javadoc/cpw/mods/fml/common/eventhandler/EventPriority.html new file mode 100644 index 0000000..b73779c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/EventPriority.html @@ -0,0 +1,371 @@ + + + + + +EventPriority (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.eventhandler
+

Enum EventPriority

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

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      HIGH 
      HIGHEST 
      LOW 
      LOWEST 
      NORMAL 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidinvoke(Event event) 
      static EventPriorityvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static EventPriority[]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 EventPriority[] 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 (EventPriority c : EventPriority.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static EventPriority 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/cpw/mods/fml/common/eventhandler/IEventExceptionHandler.html b/javadoc/cpw/mods/fml/common/eventhandler/IEventExceptionHandler.html new file mode 100644 index 0000000..1b32c8c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/IEventExceptionHandler.html @@ -0,0 +1,221 @@ + + + + + +IEventExceptionHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.eventhandler
+

Interface IEventExceptionHandler

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    EventBus
    +
    +
    +
    +
    public interface IEventExceptionHandler
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidhandleException(EventBus bus, + Event event, + IEventListener[] listeners, + int index, + java.lang.Throwable throwable) +
      Fired when a EventListener throws an exception for the specified event on the event bus.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        handleException

        +
        void handleException(EventBus bus,
+                   Event event,
+                   IEventListener[] listeners,
+                   int index,
+                   java.lang.Throwable throwable)
        +
        Fired when a EventListener throws an exception for the specified event on the event bus. + After this function returns, the original Throwable will be propogated upwards.
        +
        Parameters:
        bus - The bus the event is being fired on
        event - The event that is being fired
        listeners - All listeners that are listening for this event, in order
        index - Index for the current listener being fired.
        throwable - The throwable being thrown
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/eventhandler/IEventListener.html b/javadoc/cpw/mods/fml/common/eventhandler/IEventListener.html new file mode 100644 index 0000000..5b9459c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/IEventListener.html @@ -0,0 +1,208 @@ + + + + + +IEventListener (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.eventhandler
+

Interface IEventListener

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidinvoke(Event event) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        invoke

        +
        void invoke(Event event)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/eventhandler/ListenerList.html b/javadoc/cpw/mods/fml/common/eventhandler/ListenerList.html new file mode 100644 index 0000000..114d27a --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/ListenerList.html @@ -0,0 +1,365 @@ + + + + + +ListenerList (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.eventhandler
+

Class ListenerList

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

      Constructor Detail

      + + + +
        +
      • +

        ListenerList

        +
        public ListenerList()
        +
        • +
      + + + +
        +
      • +

        ListenerList

        +
        public ListenerList(ListenerList parent)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        resize

        +
        public static void resize(int max)
        +
        • +
      + + + +
        +
      • +

        resizeLists

        +
        public void resizeLists(int max)
        +
        • +
      + + + +
        +
      • +

        clearBusID

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

        getInstance

        +
        protected cpw.mods.fml.common.eventhandler.ListenerList.ListenerListInst getInstance(int id)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        unregister

        +
        public void unregister(int id,
+              IEventListener listener)
        +
        • +
      + + + +
        +
      • +

        unregisterAll

        +
        public static void unregisterAll(int id,
+                 IEventListener listener)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/eventhandler/SubscribeEvent.html b/javadoc/cpw/mods/fml/common/eventhandler/SubscribeEvent.html new file mode 100644 index 0000000..3b8dde8 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/SubscribeEvent.html @@ -0,0 +1,219 @@ + + + + + +SubscribeEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.eventhandler
+

Annotation Type SubscribeEvent

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface SubscribeEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        priority

        +
        public abstract EventPriority priority
        +
        +
        Default:
        +
        cpw.mods.fml.common.eventhandler.EventPriority.NORMAL
        +
        +
        • +
      + + + +
        +
      • +

        receiveCanceled

        +
        public abstract boolean receiveCanceled
        +
        +
        Default:
        +
        false
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/eventhandler/package-frame.html b/javadoc/cpw/mods/fml/common/eventhandler/package-frame.html new file mode 100644 index 0000000..ddf205b --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/package-frame.html @@ -0,0 +1,38 @@ + + + + + +cpw.mods.fml.common.eventhandler (Forge API) + + + + +

cpw.mods.fml.common.eventhandler

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +

Annotation Types

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/eventhandler/package-summary.html b/javadoc/cpw/mods/fml/common/eventhandler/package-summary.html new file mode 100644 index 0000000..b37ab9a --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/package-summary.html @@ -0,0 +1,206 @@ + + + + + +cpw.mods.fml.common.eventhandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.eventhandler

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/eventhandler/package-tree.html b/javadoc/cpw/mods/fml/common/eventhandler/package-tree.html new file mode 100644 index 0000000..b6a13f9 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/eventhandler/package-tree.html @@ -0,0 +1,153 @@ + + + + + +cpw.mods.fml.common.eventhandler Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.eventhandler

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Annotation Type Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/functions/ArtifactVersionNameFunction.html b/javadoc/cpw/mods/fml/common/functions/ArtifactVersionNameFunction.html new file mode 100644 index 0000000..a77b948 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/functions/ArtifactVersionNameFunction.html @@ -0,0 +1,270 @@ + + + + + +ArtifactVersionNameFunction (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.functions
+

Class ArtifactVersionNameFunction

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.common.base.Function<ArtifactVersion,java.lang.String>
    +
    +
    +
    +
    public class ArtifactVersionNameFunction
+extends java.lang.Object
+implements com.google.common.base.Function<ArtifactVersion,java.lang.String>
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Stringapply(ArtifactVersion v) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface com.google.common.base.Function

        +equals
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ArtifactVersionNameFunction

        +
        public ArtifactVersionNameFunction()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        apply

        +
        public java.lang.String apply(ArtifactVersion v)
        +
        +
        Specified by:
        +
        apply in interface com.google.common.base.Function<ArtifactVersion,java.lang.String>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/functions/CollectionWrapperFactory.html b/javadoc/cpw/mods/fml/common/functions/CollectionWrapperFactory.html new file mode 100644 index 0000000..c7929d7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/functions/CollectionWrapperFactory.html @@ -0,0 +1,281 @@ + + + + + +CollectionWrapperFactory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.functions
+

Class CollectionWrapperFactory

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <T> java.util.Collection<T>wrap(java.util.Collection coll, + java.lang.Class<T> elementType) +
      Return a read only cast view of the supplied ungeneric collection, based on the element type given
      +
      static <T> java.util.List<T>wrap(java.util.List list, + java.lang.Class<T> elementType) +
      Return a read only cast view of the supplied ungeneric list, based on the element type given
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        CollectionWrapperFactory

        +
        public CollectionWrapperFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        wrap

        +
        public static <T> java.util.Collection<T> wrap(java.util.Collection coll,
+                               java.lang.Class<T> elementType)
        +
        Return a read only cast view of the supplied ungeneric collection, based on the element type given
        +
        Parameters:
        coll - The collection to cast
        elementType - the supertype contained in the collection
        +
        Returns:
        a collection asserting that type relationship
        +
        • +
      + + + +
        +
      • +

        wrap

        +
        public static <T> java.util.List<T> wrap(java.util.List list,
+                         java.lang.Class<T> elementType)
        +
        Return a read only cast view of the supplied ungeneric list, based on the element type given
        +
        Parameters:
        list - The list to cast
        elementType - the supertype contained in the list
        +
        Returns:
        a list asserting that type relationship
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/functions/GenericIterableFactory.html b/javadoc/cpw/mods/fml/common/functions/GenericIterableFactory.html new file mode 100644 index 0000000..4ec7e2e --- /dev/null +++ b/javadoc/cpw/mods/fml/common/functions/GenericIterableFactory.html @@ -0,0 +1,256 @@ + + + + + +GenericIterableFactory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.functions
+

Class GenericIterableFactory

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <T> java.lang.Iterable<T>newCastingIterable(java.lang.Iterable<?> input, + java.lang.Class<T> type) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        GenericIterableFactory

        +
        public GenericIterableFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        newCastingIterable

        +
        public static <T> java.lang.Iterable<T> newCastingIterable(java.lang.Iterable<?> input,
+                                           java.lang.Class<T> type)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/functions/ModIdFunction.html b/javadoc/cpw/mods/fml/common/functions/ModIdFunction.html new file mode 100644 index 0000000..e377b07 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/functions/ModIdFunction.html @@ -0,0 +1,270 @@ + + + + + +ModIdFunction (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.functions
+

Class ModIdFunction

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.common.base.Function<ModContainer,java.lang.String>
    +
    +
    +
    +
    public final class ModIdFunction
+extends java.lang.Object
+implements com.google.common.base.Function<ModContainer,java.lang.String>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Stringapply(ModContainer container) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface com.google.common.base.Function

        +equals
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ModIdFunction

        +
        public ModIdFunction()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        apply

        +
        public java.lang.String apply(ModContainer container)
        +
        +
        Specified by:
        +
        apply in interface com.google.common.base.Function<ModContainer,java.lang.String>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/functions/ModNameFunction.html b/javadoc/cpw/mods/fml/common/functions/ModNameFunction.html new file mode 100644 index 0000000..4741f58 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/functions/ModNameFunction.html @@ -0,0 +1,270 @@ + + + + + +ModNameFunction (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.functions
+

Class ModNameFunction

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.common.base.Function<ModContainer,java.lang.String>
    +
    +
    +
    +
    public class ModNameFunction
+extends java.lang.Object
+implements com.google.common.base.Function<ModContainer,java.lang.String>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Stringapply(ModContainer input) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface com.google.common.base.Function

        +equals
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ModNameFunction

        +
        public ModNameFunction()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        apply

        +
        public java.lang.String apply(ModContainer input)
        +
        +
        Specified by:
        +
        apply in interface com.google.common.base.Function<ModContainer,java.lang.String>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/functions/TypeCastFunction.html b/javadoc/cpw/mods/fml/common/functions/TypeCastFunction.html new file mode 100644 index 0000000..3a94b27 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/functions/TypeCastFunction.html @@ -0,0 +1,270 @@ + + + + + +TypeCastFunction (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.functions
+

Class TypeCastFunction<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.common.base.Function<java.lang.Object,T>
    +
    +
    +
    +
    public class TypeCastFunction<T>
+extends java.lang.Object
+implements com.google.common.base.Function<java.lang.Object,T>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      TypeCastFunction(java.lang.Class<T> type) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Tapply(java.lang.Object input) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface com.google.common.base.Function

        +equals
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TypeCastFunction

        +
        public TypeCastFunction(java.lang.Class<T> type)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        apply

        +
        public T apply(java.lang.Object input)
        +
        +
        Specified by:
        +
        apply in interface com.google.common.base.Function<java.lang.Object,T>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/functions/package-frame.html b/javadoc/cpw/mods/fml/common/functions/package-frame.html new file mode 100644 index 0000000..aa59bfa --- /dev/null +++ b/javadoc/cpw/mods/fml/common/functions/package-frame.html @@ -0,0 +1,24 @@ + + + + + +cpw.mods.fml.common.functions (Forge API) + + + + +

cpw.mods.fml.common.functions

+
+

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/functions/package-summary.html b/javadoc/cpw/mods/fml/common/functions/package-summary.html new file mode 100644 index 0000000..dec2995 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/functions/package-summary.html @@ -0,0 +1,151 @@ + + + + + +cpw.mods.fml.common.functions (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.functions

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/functions/package-tree.html b/javadoc/cpw/mods/fml/common/functions/package-tree.html new file mode 100644 index 0000000..8d5e3a8 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/functions/package-tree.html @@ -0,0 +1,131 @@ + + + + + +cpw.mods.fml.common.functions Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.functions

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/InputEvent.KeyInputEvent.html b/javadoc/cpw/mods/fml/common/gameevent/InputEvent.KeyInputEvent.html new file mode 100644 index 0000000..7e0eee4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/InputEvent.KeyInputEvent.html @@ -0,0 +1,269 @@ + + + + + +InputEvent.KeyInputEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class InputEvent.KeyInputEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    InputEvent
    +
    +
    +
    +
    public static class InputEvent.KeyInputEvent
+extends InputEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InputEvent.KeyInputEvent

        +
        public InputEvent.KeyInputEvent()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/InputEvent.MouseInputEvent.html b/javadoc/cpw/mods/fml/common/gameevent/InputEvent.MouseInputEvent.html new file mode 100644 index 0000000..ae769b7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/InputEvent.MouseInputEvent.html @@ -0,0 +1,269 @@ + + + + + +InputEvent.MouseInputEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class InputEvent.MouseInputEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    InputEvent
    +
    +
    +
    +
    public static class InputEvent.MouseInputEvent
+extends InputEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InputEvent.MouseInputEvent

        +
        public InputEvent.MouseInputEvent()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/InputEvent.html b/javadoc/cpw/mods/fml/common/gameevent/InputEvent.html new file mode 100644 index 0000000..72245dd --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/InputEvent.html @@ -0,0 +1,272 @@ + + + + + +InputEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class InputEvent

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

      Constructor Detail

      + + + +
        +
      • +

        InputEvent

        +
        public InputEvent()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.ItemCraftedEvent.html b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.ItemCraftedEvent.html new file mode 100644 index 0000000..5c80cdd --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.ItemCraftedEvent.html @@ -0,0 +1,329 @@ + + + + + +PlayerEvent.ItemCraftedEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class PlayerEvent.ItemCraftedEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.ItemCraftedEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.ItemPickupEvent.html b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.ItemPickupEvent.html new file mode 100644 index 0000000..dabc5dc --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.ItemPickupEvent.html @@ -0,0 +1,314 @@ + + + + + +PlayerEvent.ItemPickupEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class PlayerEvent.ItemPickupEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.ItemPickupEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.ItemPickupEvent

        +
        public PlayerEvent.ItemPickupEvent(EntityPlayer player,
+                           EntityItem pickedUp)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.ItemSmeltedEvent.html b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.ItemSmeltedEvent.html new file mode 100644 index 0000000..c157bd4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.ItemSmeltedEvent.html @@ -0,0 +1,314 @@ + + + + + +PlayerEvent.ItemSmeltedEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class PlayerEvent.ItemSmeltedEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.ItemSmeltedEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.ItemSmeltedEvent

        +
        public PlayerEvent.ItemSmeltedEvent(EntityPlayer player,
+                            ItemStack crafting)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerChangedDimensionEvent.html b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerChangedDimensionEvent.html new file mode 100644 index 0000000..a31e44c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerChangedDimensionEvent.html @@ -0,0 +1,329 @@ + + + + + +PlayerEvent.PlayerChangedDimensionEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class PlayerEvent.PlayerChangedDimensionEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.PlayerChangedDimensionEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fromDim

        +
        public final int fromDim
        +
        • +
      + + + +
        +
      • +

        toDim

        +
        public final int toDim
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.PlayerChangedDimensionEvent

        +
        public PlayerEvent.PlayerChangedDimensionEvent(EntityPlayer player,
+                                       int fromDim,
+                                       int toDim)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerLoggedInEvent.html b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerLoggedInEvent.html new file mode 100644 index 0000000..7f00307 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerLoggedInEvent.html @@ -0,0 +1,284 @@ + + + + + +PlayerEvent.PlayerLoggedInEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class PlayerEvent.PlayerLoggedInEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.PlayerLoggedInEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.PlayerLoggedInEvent

        +
        public PlayerEvent.PlayerLoggedInEvent(EntityPlayer player)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerLoggedOutEvent.html b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerLoggedOutEvent.html new file mode 100644 index 0000000..a2414bd --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerLoggedOutEvent.html @@ -0,0 +1,284 @@ + + + + + +PlayerEvent.PlayerLoggedOutEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class PlayerEvent.PlayerLoggedOutEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.PlayerLoggedOutEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.PlayerLoggedOutEvent

        +
        public PlayerEvent.PlayerLoggedOutEvent(EntityPlayer player)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerRespawnEvent.html b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerRespawnEvent.html new file mode 100644 index 0000000..142d7bb --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.PlayerRespawnEvent.html @@ -0,0 +1,284 @@ + + + + + +PlayerEvent.PlayerRespawnEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class PlayerEvent.PlayerRespawnEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    PlayerEvent
    +
    +
    +
    +
    public static class PlayerEvent.PlayerRespawnEvent
+extends PlayerEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerEvent.PlayerRespawnEvent

        +
        public PlayerEvent.PlayerRespawnEvent(EntityPlayer player)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.html b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.html new file mode 100644 index 0000000..8961996 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/PlayerEvent.html @@ -0,0 +1,294 @@ + + + + + +PlayerEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class PlayerEvent

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/TickEvent.ClientTickEvent.html b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.ClientTickEvent.html new file mode 100644 index 0000000..3b7465f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.ClientTickEvent.html @@ -0,0 +1,284 @@ + + + + + +TickEvent.ClientTickEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class TickEvent.ClientTickEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TickEvent
    +
    +
    +
    +
    public static class TickEvent.ClientTickEvent
+extends TickEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TickEvent.ClientTickEvent

        +
        public TickEvent.ClientTickEvent(TickEvent.Phase phase)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/TickEvent.Phase.html b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.Phase.html new file mode 100644 index 0000000..b160f3f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.Phase.html @@ -0,0 +1,321 @@ + + + + + +TickEvent.Phase (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Enum TickEvent.Phase

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<TickEvent.Phase>
    +
    +
    +
    Enclosing class:
    +
    TickEvent
    +
    +
    +
    +
    public static enum TickEvent.Phase
+extends java.lang.Enum<TickEvent.Phase>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      END 
      START 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static TickEvent.PhasevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static TickEvent.Phase[]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 TickEvent.Phase[] 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 (TickEvent.Phase c : TickEvent.Phase.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static TickEvent.Phase 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/cpw/mods/fml/common/gameevent/TickEvent.PlayerTickEvent.html b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.PlayerTickEvent.html new file mode 100644 index 0000000..ce3eb0e --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.PlayerTickEvent.html @@ -0,0 +1,314 @@ + + + + + +TickEvent.PlayerTickEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class TickEvent.PlayerTickEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TickEvent
    +
    +
    +
    +
    public static class TickEvent.PlayerTickEvent
+extends TickEvent
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/TickEvent.RenderTickEvent.html b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.RenderTickEvent.html new file mode 100644 index 0000000..7b544f8 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.RenderTickEvent.html @@ -0,0 +1,314 @@ + + + + + +TickEvent.RenderTickEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class TickEvent.RenderTickEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TickEvent
    +
    +
    +
    +
    public static class TickEvent.RenderTickEvent
+extends TickEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        renderTickTime

        +
        public final float renderTickTime
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TickEvent.RenderTickEvent

        +
        public TickEvent.RenderTickEvent(TickEvent.Phase phase,
+                         float renderTickTime)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/TickEvent.ServerTickEvent.html b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.ServerTickEvent.html new file mode 100644 index 0000000..699fb4a --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.ServerTickEvent.html @@ -0,0 +1,284 @@ + + + + + +TickEvent.ServerTickEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class TickEvent.ServerTickEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TickEvent
    +
    +
    +
    +
    public static class TickEvent.ServerTickEvent
+extends TickEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TickEvent.ServerTickEvent

        +
        public TickEvent.ServerTickEvent(TickEvent.Phase phase)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/TickEvent.Type.html b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.Type.html new file mode 100644 index 0000000..8ddcb0b --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.Type.html @@ -0,0 +1,357 @@ + + + + + +TickEvent.Type (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Enum TickEvent.Type

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<TickEvent.Type>
    +
    +
    +
    Enclosing class:
    +
    TickEvent
    +
    +
    +
    +
    public static enum TickEvent.Type
+extends java.lang.Enum<TickEvent.Type>
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static TickEvent.TypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static TickEvent.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 TickEvent.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 (TickEvent.Type c : TickEvent.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 TickEvent.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/cpw/mods/fml/common/gameevent/TickEvent.WorldTickEvent.html b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.WorldTickEvent.html new file mode 100644 index 0000000..f3c5700 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.WorldTickEvent.html @@ -0,0 +1,316 @@ + + + + + +TickEvent.WorldTickEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class TickEvent.WorldTickEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TickEvent
    +
    +
    +
    +
    public static class TickEvent.WorldTickEvent
+extends TickEvent
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/TickEvent.html b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.html new file mode 100644 index 0000000..95cf8f3 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/TickEvent.html @@ -0,0 +1,358 @@ + + + + + +TickEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.gameevent
+

Class TickEvent

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/package-frame.html b/javadoc/cpw/mods/fml/common/gameevent/package-frame.html new file mode 100644 index 0000000..69d1b70 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/package-frame.html @@ -0,0 +1,40 @@ + + + + + +cpw.mods.fml.common.gameevent (Forge API) + + + + +

cpw.mods.fml.common.gameevent

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/gameevent/package-summary.html b/javadoc/cpw/mods/fml/common/gameevent/package-summary.html new file mode 100644 index 0000000..db792fb --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/package-summary.html @@ -0,0 +1,214 @@ + + + + + +cpw.mods.fml.common.gameevent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.gameevent

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/gameevent/package-tree.html b/javadoc/cpw/mods/fml/common/gameevent/package-tree.html new file mode 100644 index 0000000..ae2760c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/gameevent/package-tree.html @@ -0,0 +1,168 @@ + + + + + +cpw.mods.fml.common.gameevent Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.gameevent

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/launcher/FMLDeobfTweaker.html b/javadoc/cpw/mods/fml/common/launcher/FMLDeobfTweaker.html new file mode 100644 index 0000000..7cf1d21 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/launcher/FMLDeobfTweaker.html @@ -0,0 +1,320 @@ + + + + + +FMLDeobfTweaker (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.launcher
+

Class FMLDeobfTweaker

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.ITweaker
    +
    +
    +
    +
    public class FMLDeobfTweaker
+extends java.lang.Object
+implements net.minecraft.launchwrapper.ITweaker
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidacceptOptions(java.util.List<java.lang.String> args, + java.io.File gameDir, + java.io.File assetsDir, + java.lang.String profile) 
      java.lang.String[]getLaunchArguments() 
      java.lang.StringgetLaunchTarget() 
      voidinjectIntoClassLoader(net.minecraft.launchwrapper.LaunchClassLoader classLoader) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FMLDeobfTweaker

        +
        public FMLDeobfTweaker()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        acceptOptions

        +
        public void acceptOptions(java.util.List<java.lang.String> args,
+                 java.io.File gameDir,
+                 java.io.File assetsDir,
+                 java.lang.String profile)
        +
        +
        Specified by:
        +
        acceptOptions in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        injectIntoClassLoader

        +
        public void injectIntoClassLoader(net.minecraft.launchwrapper.LaunchClassLoader classLoader)
        +
        +
        Specified by:
        +
        injectIntoClassLoader in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        getLaunchTarget

        +
        public java.lang.String getLaunchTarget()
        +
        +
        Specified by:
        +
        getLaunchTarget in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        getLaunchArguments

        +
        public java.lang.String[] getLaunchArguments()
        +
        +
        Specified by:
        +
        getLaunchArguments in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/launcher/FMLInjectionAndSortingTweaker.html b/javadoc/cpw/mods/fml/common/launcher/FMLInjectionAndSortingTweaker.html new file mode 100644 index 0000000..6ec7ada --- /dev/null +++ b/javadoc/cpw/mods/fml/common/launcher/FMLInjectionAndSortingTweaker.html @@ -0,0 +1,323 @@ + + + + + +FMLInjectionAndSortingTweaker (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.launcher
+

Class FMLInjectionAndSortingTweaker

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.ITweaker
    +
    +
    +
    +
    public class FMLInjectionAndSortingTweaker
+extends java.lang.Object
+implements net.minecraft.launchwrapper.ITweaker
    +
    This class is to manage the injection of coremods as tweakers into the tweak framework. + It has to inject the coremod tweaks during construction, because that is the only time + the tweak list is writeable.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidacceptOptions(java.util.List<java.lang.String> args, + java.io.File gameDir, + java.io.File assetsDir, + java.lang.String profile) 
      java.lang.String[]getLaunchArguments() 
      java.lang.StringgetLaunchTarget() 
      voidinjectIntoClassLoader(net.minecraft.launchwrapper.LaunchClassLoader classLoader) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FMLInjectionAndSortingTweaker

        +
        public FMLInjectionAndSortingTweaker()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        acceptOptions

        +
        public void acceptOptions(java.util.List<java.lang.String> args,
+                 java.io.File gameDir,
+                 java.io.File assetsDir,
+                 java.lang.String profile)
        +
        +
        Specified by:
        +
        acceptOptions in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        injectIntoClassLoader

        +
        public void injectIntoClassLoader(net.minecraft.launchwrapper.LaunchClassLoader classLoader)
        +
        +
        Specified by:
        +
        injectIntoClassLoader in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        getLaunchTarget

        +
        public java.lang.String getLaunchTarget()
        +
        +
        Specified by:
        +
        getLaunchTarget in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        getLaunchArguments

        +
        public java.lang.String[] getLaunchArguments()
        +
        +
        Specified by:
        +
        getLaunchArguments in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/launcher/FMLServerTweaker.html b/javadoc/cpw/mods/fml/common/launcher/FMLServerTweaker.html new file mode 100644 index 0000000..237bbb3 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/launcher/FMLServerTweaker.html @@ -0,0 +1,295 @@ + + + + + +FMLServerTweaker (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.launcher
+

Class FMLServerTweaker

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.ITweaker
    +
    +
    +
    +
    public class FMLServerTweaker
+extends FMLTweaker
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLServerTweaker

        +
        public FMLServerTweaker()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLaunchTarget

        +
        public java.lang.String getLaunchTarget()
        +
        +
        Specified by:
        +
        getLaunchTarget in interface net.minecraft.launchwrapper.ITweaker
        +
        Overrides:
        +
        getLaunchTarget in class FMLTweaker
        +
        +
        • +
      + + + +
        +
      • +

        injectIntoClassLoader

        +
        public void injectIntoClassLoader(net.minecraft.launchwrapper.LaunchClassLoader classLoader)
        +
        +
        Specified by:
        +
        injectIntoClassLoader in interface net.minecraft.launchwrapper.ITweaker
        +
        Overrides:
        +
        injectIntoClassLoader in class FMLTweaker
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/launcher/FMLTweaker.html b/javadoc/cpw/mods/fml/common/launcher/FMLTweaker.html new file mode 100644 index 0000000..b88e64f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/launcher/FMLTweaker.html @@ -0,0 +1,363 @@ + + + + + +FMLTweaker (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.launcher
+

Class FMLTweaker

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.ITweaker
    +
    +
    +
    Direct Known Subclasses:
    +
    FMLServerTweaker
    +
    +
    +
    +
    public class FMLTweaker
+extends java.lang.Object
+implements net.minecraft.launchwrapper.ITweaker
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidacceptOptions(java.util.List<java.lang.String> args, + java.io.File gameDir, + java.io.File assetsDir, + java.lang.String profile) 
      java.io.FilegetGameDir() 
      static java.net.URIgetJarLocation() 
      java.lang.String[]getLaunchArguments() 
      java.lang.StringgetLaunchTarget() 
      voidinjectCascadingTweak(java.lang.String tweakClassName) 
      voidinjectIntoClassLoader(net.minecraft.launchwrapper.LaunchClassLoader classLoader) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FMLTweaker

        +
        public FMLTweaker()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        acceptOptions

        +
        public void acceptOptions(java.util.List<java.lang.String> args,
+                 java.io.File gameDir,
+                 java.io.File assetsDir,
+                 java.lang.String profile)
        +
        +
        Specified by:
        +
        acceptOptions in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        injectIntoClassLoader

        +
        public void injectIntoClassLoader(net.minecraft.launchwrapper.LaunchClassLoader classLoader)
        +
        +
        Specified by:
        +
        injectIntoClassLoader in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        getLaunchTarget

        +
        public java.lang.String getLaunchTarget()
        +
        +
        Specified by:
        +
        getLaunchTarget in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        getLaunchArguments

        +
        public java.lang.String[] getLaunchArguments()
        +
        +
        Specified by:
        +
        getLaunchArguments in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        getGameDir

        +
        public java.io.File getGameDir()
        +
        • +
      + + + +
        +
      • +

        getJarLocation

        +
        public static java.net.URI getJarLocation()
        +
        • +
      + + + +
        +
      • +

        injectCascadingTweak

        +
        public void injectCascadingTweak(java.lang.String tweakClassName)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/launcher/TerminalTweaker.html b/javadoc/cpw/mods/fml/common/launcher/TerminalTweaker.html new file mode 100644 index 0000000..ae67a44 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/launcher/TerminalTweaker.html @@ -0,0 +1,320 @@ + + + + + +TerminalTweaker (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.launcher
+

Class TerminalTweaker

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    net.minecraft.launchwrapper.ITweaker
    +
    +
    +
    +
    public final class TerminalTweaker
+extends java.lang.Object
+implements net.minecraft.launchwrapper.ITweaker
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidacceptOptions(java.util.List<java.lang.String> args, + java.io.File gameDir, + java.io.File assetsDir, + java.lang.String profile) 
      java.lang.String[]getLaunchArguments() 
      java.lang.StringgetLaunchTarget() 
      voidinjectIntoClassLoader(net.minecraft.launchwrapper.LaunchClassLoader classLoader) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TerminalTweaker

        +
        public TerminalTweaker()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        injectIntoClassLoader

        +
        public void injectIntoClassLoader(net.minecraft.launchwrapper.LaunchClassLoader classLoader)
        +
        +
        Specified by:
        +
        injectIntoClassLoader in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        getLaunchTarget

        +
        public java.lang.String getLaunchTarget()
        +
        +
        Specified by:
        +
        getLaunchTarget in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        getLaunchArguments

        +
        public java.lang.String[] getLaunchArguments()
        +
        +
        Specified by:
        +
        getLaunchArguments in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      + + + +
        +
      • +

        acceptOptions

        +
        public void acceptOptions(java.util.List<java.lang.String> args,
+                 java.io.File gameDir,
+                 java.io.File assetsDir,
+                 java.lang.String profile)
        +
        +
        Specified by:
        +
        acceptOptions in interface net.minecraft.launchwrapper.ITweaker
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/launcher/Yggdrasil.html b/javadoc/cpw/mods/fml/common/launcher/Yggdrasil.html new file mode 100644 index 0000000..d659493 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/launcher/Yggdrasil.html @@ -0,0 +1,256 @@ + + + + + +Yggdrasil (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.launcher
+

Class Yggdrasil

+
+
+ +
+
    +
  • +
    +
    +
    public class Yggdrasil
+extends java.lang.Object
    +
    Basic implementation of Mojang's 'Yggdrasil' login system, purely intended as a dev time bare bones login. + Login errors are not handled.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidlogin(java.util.Map<java.lang.String,java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Yggdrasil

        +
        public Yggdrasil()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        login

        +
        public static void login(java.util.Map<java.lang.String,java.lang.String> args)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/launcher/package-frame.html b/javadoc/cpw/mods/fml/common/launcher/package-frame.html new file mode 100644 index 0000000..a9e25ec --- /dev/null +++ b/javadoc/cpw/mods/fml/common/launcher/package-frame.html @@ -0,0 +1,24 @@ + + + + + +cpw.mods.fml.common.launcher (Forge API) + + + + +

cpw.mods.fml.common.launcher

+
+

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/launcher/package-summary.html b/javadoc/cpw/mods/fml/common/launcher/package-summary.html new file mode 100644 index 0000000..d645c06 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/launcher/package-summary.html @@ -0,0 +1,155 @@ + + + + + +cpw.mods.fml.common.launcher (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.launcher

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/launcher/package-tree.html b/javadoc/cpw/mods/fml/common/launcher/package-tree.html new file mode 100644 index 0000000..192e9a3 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/launcher/package-tree.html @@ -0,0 +1,134 @@ + + + + + +cpw.mods.fml.common.launcher Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.launcher

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/ByteBufUtils.html b/javadoc/cpw/mods/fml/common/network/ByteBufUtils.html new file mode 100644 index 0000000..52beba3 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/ByteBufUtils.html @@ -0,0 +1,461 @@ + + + + + +ByteBufUtils (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class ByteBufUtils

+
+
+ +
+
    +
  • +
    +
    +
    public class ByteBufUtils
+extends java.lang.Object
    +
    Utilities for interacting with ByteBuf.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static java.lang.StringgetContentDump(io.netty.buffer.ByteBuf buffer) 
      static ItemStackreadItemStack(io.netty.buffer.ByteBuf from) +
      Read an ItemStack from the byte buffer provided.
      +
      static NBTTagCompoundreadTag(io.netty.buffer.ByteBuf from) +
      Read an NBTTagCompound from the byte buffer.
      +
      static java.lang.StringreadUTF8String(io.netty.buffer.ByteBuf from) +
      Read a UTF8 string from the byte buffer.
      +
      static intreadVarInt(io.netty.buffer.ByteBuf buf, + int maxSize) +
      Read a varint from the supplied buffer.
      +
      static intreadVarShort(io.netty.buffer.ByteBuf buf) +
      An extended length short.
      +
      static intvarIntByteCount(int toCount) +
      The number of bytes to write the supplied int using the 7 bit varint encoding.
      +
      static voidwriteItemStack(io.netty.buffer.ByteBuf to, + ItemStack stack) +
      Write an ItemStack using minecraft compatible encoding.
      +
      static voidwriteTag(io.netty.buffer.ByteBuf to, + NBTTagCompound tag) +
      Write an NBTTagCompound to the byte buffer.
      +
      static voidwriteUTF8String(io.netty.buffer.ByteBuf to, + java.lang.String string) +
      Write a String with UTF8 byte encoding to the buffer.
      +
      static voidwriteVarInt(io.netty.buffer.ByteBuf to, + int toWrite, + int maxSize) +
      Write an integer to the buffer using variable length encoding.
      +
      static voidwriteVarShort(io.netty.buffer.ByteBuf buf, + int toWrite) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ByteBufUtils

        +
        public ByteBufUtils()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        varIntByteCount

        +
        public static int varIntByteCount(int toCount)
        +
        The number of bytes to write the supplied int using the 7 bit varint encoding.
        +
        Parameters:
        toCount - The number to analyse
        +
        Returns:
        The number of bytes it will take to write it (maximum of 5)
        +
        • +
      + + + +
        +
      • +

        readVarInt

        +
        public static int readVarInt(io.netty.buffer.ByteBuf buf,
+             int maxSize)
        +
        Read a varint from the supplied buffer.
        +
        Parameters:
        buf - The buffer to read from
        maxSize - The maximum length of bytes to read
        +
        Returns:
        The integer
        +
        • +
      + + + +
        +
      • +

        readVarShort

        +
        public static int readVarShort(io.netty.buffer.ByteBuf buf)
        +
        An extended length short. Used by custom payload packets to extend size.
        +
        Parameters:
        buf -
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        writeVarShort

        +
        public static void writeVarShort(io.netty.buffer.ByteBuf buf,
+                 int toWrite)
        +
        • +
      + + + +
        +
      • +

        writeVarInt

        +
        public static void writeVarInt(io.netty.buffer.ByteBuf to,
+               int toWrite,
+               int maxSize)
        +
        Write an integer to the buffer using variable length encoding. The maxSize constrains + how many bytes (and therefore the maximum number) that will be written.
        +
        Parameters:
        to - The buffer to write to
        toWrite - The integer to write
        maxSize - The maximum number of bytes to use
        +
        • +
      + + + +
        +
      • +

        readUTF8String

        +
        public static java.lang.String readUTF8String(io.netty.buffer.ByteBuf from)
        +
        Read a UTF8 string from the byte buffer. + It is encoded as []
        +
        Parameters:
        from - The buffer to read from
        +
        Returns:
        The string
        +
        • +
      + + + +
        +
      • +

        writeUTF8String

        +
        public static void writeUTF8String(io.netty.buffer.ByteBuf to,
+                   java.lang.String string)
        +
        Write a String with UTF8 byte encoding to the buffer. + It is encoded as []
        +
        Parameters:
        to - the buffer to write to
        string - The string to write
        +
        • +
      + + + +
        +
      • +

        writeItemStack

        +
        public static void writeItemStack(io.netty.buffer.ByteBuf to,
+                  ItemStack stack)
        +
        Write an ItemStack using minecraft compatible encoding.
        +
        Parameters:
        to - The buffer to write to
        stack - The itemstack to write
        +
        • +
      + + + +
        +
      • +

        readItemStack

        +
        public static ItemStack readItemStack(io.netty.buffer.ByteBuf from)
        +
        Read an ItemStack from the byte buffer provided. It uses the minecraft encoding.
        +
        Parameters:
        from - The buffer to read from
        +
        Returns:
        The itemstack read
        +
        • +
      + + + +
        +
      • +

        writeTag

        +
        public static void writeTag(io.netty.buffer.ByteBuf to,
+            NBTTagCompound tag)
        +
        Write an NBTTagCompound to the byte buffer. It uses the minecraft encoding.
        +
        Parameters:
        to - The buffer to write to
        tag - The tag to write
        +
        • +
      + + + +
        +
      • +

        readTag

        +
        public static NBTTagCompound readTag(io.netty.buffer.ByteBuf from)
        +
        Read an NBTTagCompound from the byte buffer. It uses the minecraft encoding.
        +
        Parameters:
        from - The buffer to read from
        +
        Returns:
        The read tag
        +
        • +
      + + + +
        +
      • +

        getContentDump

        +
        public static java.lang.String getContentDump(io.netty.buffer.ByteBuf buffer)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLEmbeddedChannel.html b/javadoc/cpw/mods/fml/common/network/FMLEmbeddedChannel.html new file mode 100644 index 0000000..cbd25bf --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLEmbeddedChannel.html @@ -0,0 +1,369 @@ + + + + + +FMLEmbeddedChannel (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLEmbeddedChannel

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.Channel, io.netty.util.AttributeMap, java.lang.Comparable<io.netty.channel.Channel>
    +
    +
    +
    +
    public class FMLEmbeddedChannel
+extends io.netty.channel.embedded.EmbeddedChannel
    +
    Utility wrapper around EmbeddedChannel. Provides some convenience methods + associated with the specific needs of FML network handling.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

        +io.netty.channel.AbstractChannel.AbstractUnsafe
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.Channel

        +io.netty.channel.Channel.Unsafe
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      FMLEmbeddedChannel(ModContainer container, + java.lang.String channelName, + Side source, + io.netty.channel.ChannelHandler... handlers) 
      FMLEmbeddedChannel(java.lang.String channelName, + Side source, + io.netty.channel.ChannelHandler... handlers) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringfindChannelHandlerNameForType(java.lang.Class<? extends io.netty.channel.ChannelHandler> type) 
      PacketgeneratePacketFrom(java.lang.Object object) +
      Utility method to generate a regular packet from a custom packet.
      +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.embedded.EmbeddedChannel

        +checkException, config, doBeginRead, doBind, doClose, doDisconnect, doRegister, doWrite, ensureOpen, finish, inboundMessages, isActive, isCompatible, isOpen, lastInboundBuffer, lastOutboundBuffer, localAddress0, metadata, newUnsafe, outboundMessages, readInbound, readOutbound, remoteAddress0, runPendingTasks, writeInbound, writeOutbound
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.AbstractChannel

        +alloc, bind, bind, checkEOF, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doDeregister, equals, eventLoop, flush, hashCode, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, toString, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.util.DefaultAttributeMap

        +attr
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface io.netty.util.AttributeMap

        +attr
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLEmbeddedChannel

        +
        public FMLEmbeddedChannel(java.lang.String channelName,
+                  Side source,
+                  io.netty.channel.ChannelHandler... handlers)
        +
        • +
      + + + +
        +
      • +

        FMLEmbeddedChannel

        +
        public FMLEmbeddedChannel(ModContainer container,
+                  java.lang.String channelName,
+                  Side source,
+                  io.netty.channel.ChannelHandler... handlers)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        generatePacketFrom

        +
        public Packet generatePacketFrom(java.lang.Object object)
        +
        Utility method to generate a regular packet from a custom packet. Basically, it writes the packet through the + outbound side which should have a message to message codec present (such as FMLIndexedMessageToMessageCodec, + transforming from mod packets to standard FMLProxyPackets. + + This is mostly useful in cases where vanilla expects a packet, such as the TileEntity getDescriptionPacket.
        +
        Parameters:
        object - The inbound packet
        +
        Returns:
        A Packet suitable for passing to vanilla network code.
        +
        • +
      + + + +
        +
      • +

        findChannelHandlerNameForType

        +
        public java.lang.String findChannelHandlerNameForType(java.lang.Class<? extends io.netty.channel.ChannelHandler> type)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLEventChannel.html b/javadoc/cpw/mods/fml/common/network/FMLEventChannel.html new file mode 100644 index 0000000..0f3303c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLEventChannel.html @@ -0,0 +1,354 @@ + + + + + +FMLEventChannel (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLEventChannel

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLEventChannel
+extends java.lang.Object
    +
    An event driven network channel, using FMLNetworkEvent.CustomPacketEvent and FMLNetworkEvent.CustomNetworkEvent + to deliver messages to an event listener. There is one "bus" for each channel, due to the + impossibility of filtering a bus for specific events. + + This event driven system completely wraps the netty code. Mod code deals with FMLProxyPackets directly. It is not + possible to enhance the netty pipeline, and I would expect highly unexpected results if it were modified reflectively. + Use a real ChannelHandler if you want to use netty.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        register

        +
        public void register(java.lang.Object object)
        +
        Register an event listener with this channel and bus. See SubscribeEvent
        +
        Parameters:
        object -
        +
        • +
      + + + +
        +
      • +

        unregister

        +
        public void unregister(java.lang.Object object)
        +
        Unregister an event listener from the bus.
        +
        Parameters:
        object -
        +
        • +
      + + + +
        +
      • +

        fireUserEvent

        +
        public void fireUserEvent(java.lang.Object evt,
+                 io.netty.channel.ChannelHandlerContext ctx)
        +
        • +
      + + + +
        +
      • +

        sendToAll

        +
        public void sendToAll(FMLProxyPacket pkt)
        +
        Send a packet to all on the server
        +
        Parameters:
        pkt -
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        sendToDimension

        +
        public void sendToDimension(FMLProxyPacket pkt,
+                   int dimensionId)
        +
        Send to all in a dimension
        +
        Parameters:
        pkt -
        dimensionId -
        +
        • +
      + + + +
        +
      • +

        sendToServer

        +
        public void sendToServer(FMLProxyPacket pkt)
        +
        Send to the server
        +
        Parameters:
        pkt -
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html b/javadoc/cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html new file mode 100644 index 0000000..13421da --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html @@ -0,0 +1,527 @@ + + + + + +FMLIndexedMessageToMessageCodec (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLIndexedMessageToMessageCodec<A>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    Direct Known Subclasses:
    +
    FMLHandshakeCodec, FMLRuntimeCodec, ForgeRuntimeCodec, SimpleIndexedCodec
    +
    +
    +
    +
    @ChannelHandler.Sharable
+public abstract class FMLIndexedMessageToMessageCodec<A>
+extends io.netty.handler.codec.MessageToMessageCodec<FMLProxyPacket,A>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static io.netty.util.AttributeKey<java.lang.ThreadLocal<java.lang.ref.WeakReference<FMLProxyPacket>>>INBOUNDPACKETTRACKER +
      Make this accessible to subclasses
      +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      FMLIndexedMessageToMessageCodec<A>addDiscriminator(int discriminator, + java.lang.Class<? extends A> type) 
      protected voiddecode(io.netty.channel.ChannelHandlerContext ctx, + FMLProxyPacket msg, + java.util.List<java.lang.Object> out) 
      abstract voiddecodeInto(io.netty.channel.ChannelHandlerContext ctx, + io.netty.buffer.ByteBuf source, + A msg) 
      protected voidencode(io.netty.channel.ChannelHandlerContext ctx, + A msg, + java.util.List<java.lang.Object> out) 
      abstract voidencodeInto(io.netty.channel.ChannelHandlerContext ctx, + A msg, + io.netty.buffer.ByteBuf target) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      voidhandlerAdded(io.netty.channel.ChannelHandlerContext ctx) 
      protected voidtestMessageValidity(FMLProxyPacket msg) +
      Called to verify the message received.
      +
      +
        +
      • + + +

        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
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        INBOUNDPACKETTRACKER

        +
        public static final io.netty.util.AttributeKey<java.lang.ThreadLocal<java.lang.ref.WeakReference<FMLProxyPacket>>> INBOUNDPACKETTRACKER
        +
        Make this accessible to subclasses
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLIndexedMessageToMessageCodec

        +
        public FMLIndexedMessageToMessageCodec()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        handlerAdded

        +
        public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
+                  throws java.lang.Exception
        +
        +
        Specified by:
        +
        handlerAdded in interface io.netty.channel.ChannelHandler
        +
        Overrides:
        +
        handlerAdded in class io.netty.channel.ChannelHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + + + + + +
        +
      • +

        encodeInto

        +
        public abstract void encodeInto(io.netty.channel.ChannelHandlerContext ctx,
+              A msg,
+              io.netty.buffer.ByteBuf target)
+                         throws java.lang.Exception
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + +
        +
      • +

        encode

        +
        protected final void encode(io.netty.channel.ChannelHandlerContext ctx,
+          A msg,
+          java.util.List<java.lang.Object> out)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        encode in class io.netty.handler.codec.MessageToMessageCodec<FMLProxyPacket,A>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + +
        +
      • +

        decodeInto

        +
        public abstract void decodeInto(io.netty.channel.ChannelHandlerContext ctx,
+              io.netty.buffer.ByteBuf source,
+              A msg)
        +
        • +
      + + + +
        +
      • +

        decode

        +
        protected final void decode(io.netty.channel.ChannelHandlerContext ctx,
+          FMLProxyPacket msg,
+          java.util.List<java.lang.Object> out)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        decode in class io.netty.handler.codec.MessageToMessageCodec<FMLProxyPacket,A>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        testMessageValidity

        +
        protected void testMessageValidity(FMLProxyPacket msg)
        +
        Called to verify the message received. This can be used to hard disconnect in case of an unexpected packet, + say due to a weird protocol mismatch. Use with caution.
        +
        Parameters:
        msg -
        +
        • +
      + + + +
        +
      • +

        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
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientConnectedToServerEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientConnectedToServerEvent.html new file mode 100644 index 0000000..b577767 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientConnectedToServerEvent.html @@ -0,0 +1,328 @@ + + + + + +FMLNetworkEvent.ClientConnectedToServerEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.ClientConnectedToServerEvent

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

      Field Detail

      + + + +
        +
      • +

        isLocal

        +
        public final boolean isLocal
        +
        • +
      + + + +
        +
      • +

        connectionType

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

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkEvent.ClientConnectedToServerEvent

        +
        public FMLNetworkEvent.ClientConnectedToServerEvent(NetworkManager manager,
+                                            java.lang.String connectionType)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientCustomPacketEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientCustomPacketEvent.html new file mode 100644 index 0000000..0426ee9 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientCustomPacketEvent.html @@ -0,0 +1,331 @@ + + + + + +FMLNetworkEvent.ClientCustomPacketEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.ClientCustomPacketEvent

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientDisconnectionFromServerEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientDisconnectionFromServerEvent.html new file mode 100644 index 0000000..030626b --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientDisconnectionFromServerEvent.html @@ -0,0 +1,285 @@ + + + + + +FMLNetworkEvent.ClientDisconnectionFromServerEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.ClientDisconnectionFromServerEvent

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

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkEvent.ClientDisconnectionFromServerEvent

        +
        public FMLNetworkEvent.ClientDisconnectionFromServerEvent(NetworkManager manager)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomNetworkEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomNetworkEvent.html new file mode 100644 index 0000000..65d0ba7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomNetworkEvent.html @@ -0,0 +1,294 @@ + + + + + +FMLNetworkEvent.CustomNetworkEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.CustomNetworkEvent

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

      Field Detail

      + + + +
        +
      • +

        wrappedEvent

        +
        public final java.lang.Object wrappedEvent
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkEvent.CustomNetworkEvent

        +
        public FMLNetworkEvent.CustomNetworkEvent(java.lang.Object wrappedEvent)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketEvent.html new file mode 100644 index 0000000..04fab7b --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketEvent.html @@ -0,0 +1,329 @@ + + + + + +FMLNetworkEvent.CustomPacketEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.CustomPacketEvent<S extends INetHandler>

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

      Field Detail

      + + + +
        +
      • +

        packet

        +
        public final FMLProxyPacket packet
        +
        The packet that generated the event
        +
        • +
      + + + +
        +
      • +

        reply

        +
        public FMLProxyPacket reply
        +
        Set this packet to reply to the originator
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        side

        +
        public abstract Side side()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketRegistrationEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketRegistrationEvent.html new file mode 100644 index 0000000..a3cd191 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketRegistrationEvent.html @@ -0,0 +1,348 @@ + + + + + +FMLNetworkEvent.CustomPacketRegistrationEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.CustomPacketRegistrationEvent<S extends INetHandler>

+
+
+ +
+
    +
  • +
    Type Parameters:
    S - The side
    +
    +
    Enclosing class:
    +
    FMLNetworkEvent<T extends INetHandler>
    +
    +
    +
    +
    public static class FMLNetworkEvent.CustomPacketRegistrationEvent<S extends INetHandler>
+extends FMLNetworkEvent<S>
    +
    Fired when the REGISTER/UNREGISTER for custom channels is received.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        registrations

        +
        public final com.google.common.collect.ImmutableSet<java.lang.String> registrations
        +
        • +
      + + + +
        +
      • +

        operation

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

        side

        +
        public final Side side
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkEvent.CustomPacketRegistrationEvent

        +
        public FMLNetworkEvent.CustomPacketRegistrationEvent(NetworkManager manager,
+                                             java.util.Set<java.lang.String> registrations,
+                                             java.lang.String operation,
+                                             Side side,
+                                             java.lang.Class<S> type)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerConnectionFromClientEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerConnectionFromClientEvent.html new file mode 100644 index 0000000..a62a67c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerConnectionFromClientEvent.html @@ -0,0 +1,313 @@ + + + + + +FMLNetworkEvent.ServerConnectionFromClientEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.ServerConnectionFromClientEvent

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

      Field Detail

      + + + +
        +
      • +

        isLocal

        +
        public final boolean isLocal
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkEvent.ServerConnectionFromClientEvent

        +
        public FMLNetworkEvent.ServerConnectionFromClientEvent(NetworkManager manager)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerCustomPacketEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerCustomPacketEvent.html new file mode 100644 index 0000000..b40f7f0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerCustomPacketEvent.html @@ -0,0 +1,331 @@ + + + + + +FMLNetworkEvent.ServerCustomPacketEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.ServerCustomPacketEvent

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerDisconnectionFromClientEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerDisconnectionFromClientEvent.html new file mode 100644 index 0000000..9b0f7a3 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerDisconnectionFromClientEvent.html @@ -0,0 +1,285 @@ + + + + + +FMLNetworkEvent.ServerDisconnectionFromClientEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.ServerDisconnectionFromClientEvent

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

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkEvent.ServerDisconnectionFromClientEvent

        +
        public FMLNetworkEvent.ServerDisconnectionFromClientEvent(NetworkManager manager)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.html new file mode 100644 index 0000000..0332371 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.html @@ -0,0 +1,331 @@ + + + + + +FMLNetworkEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent<T extends INetHandler>

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkException.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkException.html new file mode 100644 index 0000000..37b1b29 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkException.html @@ -0,0 +1,277 @@ + + + + + +FMLNetworkException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class FMLNetworkException
+extends java.lang.RuntimeException
    +
    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

      + + + +
        +
      • +

        FMLNetworkException

        +
        public FMLNetworkException(java.lang.Exception e)
        +
        • +
      + + + +
        +
      • +

        FMLNetworkException

        +
        public FMLNetworkException()
        +
        • +
      + + + +
        +
      • +

        FMLNetworkException

        +
        public FMLNetworkException(java.lang.String string)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.OutboundTarget.html b/javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.OutboundTarget.html new file mode 100644 index 0000000..3371531 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.OutboundTarget.html @@ -0,0 +1,484 @@ + + + + + +FMLOutboundHandler.OutboundTarget (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Enum FMLOutboundHandler.OutboundTarget

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

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      ALL +
      The packet is dispatched to all players connected to the server.
      +
      ALLAROUNDPOINT +
      The packet is sent to all players within range of the NetworkRegistry.TargetPoint argument supplied.
      +
      DIMENSION +
      The packet is sent to all players in the dimension identified by the integer argument.
      +
      DISPATCHER +
      The packet is sent to the NetworkDispatcher supplied as an argument.
      +
      NOWHERE +
      The packet is sent nowhere.
      +
      PLAYER +
      The packet is sent to the EntityPlayerMP supplied as an argument.
      +
      REPLY +
      The packet is sent to the originator of the packet.
      +
      TOSERVER +
      The packet is sent to the server this client is currently conversing with.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      com.google.common.collect.ImmutableSet<Side>allowed 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      abstract java.util.List<NetworkDispatcher>selectNetworks(java.lang.Object args, + io.netty.channel.ChannelHandlerContext context, + FMLProxyPacket packet) 
      abstract voidvalidateArgs(java.lang.Object args) 
      static FMLOutboundHandler.OutboundTargetvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static FMLOutboundHandler.OutboundTarget[]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
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        allowed

        +
        public final com.google.common.collect.ImmutableSet<Side> allowed
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static FMLOutboundHandler.OutboundTarget[] 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 (FMLOutboundHandler.OutboundTarget c : FMLOutboundHandler.OutboundTarget.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static FMLOutboundHandler.OutboundTarget 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
        +
        • +
      + + + +
        +
      • +

        validateArgs

        +
        public abstract void validateArgs(java.lang.Object args)
        +
        • +
      + + + +
        +
      • +

        selectNetworks

        +
        public abstract java.util.List<NetworkDispatcher> selectNetworks(java.lang.Object args,
+                                               io.netty.channel.ChannelHandlerContext context,
+                                               FMLProxyPacket packet)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.html b/javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.html new file mode 100644 index 0000000..7b034c7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.html @@ -0,0 +1,376 @@ + + + + + +FMLOutboundHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLOutboundHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class FMLOutboundHandler
+extends io.netty.channel.ChannelOutboundHandlerAdapter
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class FMLOutboundHandler.OutboundTarget 
      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidwrite(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object msg, + io.netty.channel.ChannelPromise promise) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

        +bind, close, connect, deregister, disconnect, flush, read
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +exceptionCaught, 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

        +exceptionCaught, handlerAdded, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        FML_MESSAGETARGETARGS

        +
        public static final io.netty.util.AttributeKey<java.lang.Object> FML_MESSAGETARGETARGS
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLOutboundHandler

        +
        public FMLOutboundHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        write

        +
        public void write(io.netty.channel.ChannelHandlerContext ctx,
+         java.lang.Object msg,
+         io.netty.channel.ChannelPromise promise)
+           throws java.lang.Exception
        +
        +
        Specified by:
        +
        write in interface io.netty.channel.ChannelOutboundHandler
        +
        Overrides:
        +
        write in class io.netty.channel.ChannelOutboundHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/IGuiHandler.html b/javadoc/cpw/mods/fml/common/network/IGuiHandler.html new file mode 100644 index 0000000..354b448 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/IGuiHandler.html @@ -0,0 +1,249 @@ + + + + + +IGuiHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Interface IGuiHandler

+
+
+
+
    +
  • +
    +
    +
    public interface IGuiHandler
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.ObjectgetClientGuiElement(int ID, + EntityPlayer player, + World world, + int x, + int y, + int z) +
      Returns a Container to be displayed to the user.
      +
      java.lang.ObjectgetServerGuiElement(int ID, + EntityPlayer player, + World world, + int x, + int y, + int z) +
      Returns a Server side Container to be displayed to the user.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getServerGuiElement

        +
        java.lang.Object getServerGuiElement(int ID,
+                                   EntityPlayer player,
+                                   World world,
+                                   int x,
+                                   int y,
+                                   int z)
        +
        Returns a Server side Container to be displayed to the user.
        +
        Parameters:
        ID - The Gui ID Number
        player - The player viewing the Gui
        world - The current world
        x - X Position
        y - Y Position
        z - Z Position
        +
        Returns:
        A GuiScreen/Container to be displayed to the user, null if none.
        +
        • +
      + + + +
        +
      • +

        getClientGuiElement

        +
        java.lang.Object getClientGuiElement(int ID,
+                                   EntityPlayer player,
+                                   World world,
+                                   int x,
+                                   int y,
+                                   int z)
        +
        Returns a Container to be displayed to the user. On the client side, this + needs to return a instance of GuiScreen On the server side, this needs to + return a instance of Container
        +
        Parameters:
        ID - The Gui ID Number
        player - The player viewing the Gui
        world - The current world
        x - X Position
        y - Y Position
        z - Z Position
        +
        Returns:
        A GuiScreen/Container to be displayed to the user, null if none.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/NetworkCheckHandler.html b/javadoc/cpw/mods/fml/common/network/NetworkCheckHandler.html new file mode 100644 index 0000000..686f9c4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/NetworkCheckHandler.html @@ -0,0 +1,164 @@ + + + + + +NetworkCheckHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Annotation Type NetworkCheckHandler

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface NetworkCheckHandler
    +
    A method annotated with this will be called when a remote network connection is offered. + The method should have two parameters, of types Map and Side. It should return a boolean + true indicating that the remote party is acceptable, or false if not. + +

    + When the method is invoked, the map will contain String keys and values listing all mods and their versions present. + The side represents the side of the remote party. So if you're on the server, it'll be CLIENT, and vice versa. + +

    + This method will be invoked both when querying the status of the remote server, and when connecting to the remote server. + +

    + NOTE: the server will not be setup at any point when this method is called. Do not try and interact with the server + or the client in any way, except to accept or reject the list of mods.

    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/NetworkEventFiringHandler.html b/javadoc/cpw/mods/fml/common/network/NetworkEventFiringHandler.html new file mode 100644 index 0000000..5955607 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/NetworkEventFiringHandler.html @@ -0,0 +1,342 @@ + + + + + +NetworkEventFiringHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class NetworkEventFiringHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    @ChannelHandler.Sharable
+public class NetworkEventFiringHandler
+extends io.netty.channel.SimpleChannelInboundHandler<FMLProxyPacket>
    +
    Use this handler as the only thing in your channel, to receive network events + whenever your channel receives a message. + Note: it will not forward on to other handlers.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      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, + FMLProxyPacket msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      voiduserEventTriggered(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object evt) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged
        • +
      +
        +
      • + + +

        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
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                FMLProxyPacket msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<FMLProxyPacket>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        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
        +
        • +
      + + + +
        +
      • +

        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
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/NetworkHandshakeEstablished.html b/javadoc/cpw/mods/fml/common/network/NetworkHandshakeEstablished.html new file mode 100644 index 0000000..0d0a9f7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/NetworkHandshakeEstablished.html @@ -0,0 +1,298 @@ + + + + + +NetworkHandshakeEstablished (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class NetworkHandshakeEstablished

+
+
+ +
+
    +
  • +
    +
    +
    public class NetworkHandshakeEstablished
+extends java.lang.Object
    +
    This message is sent through all channels affected by a currently occurring handshake. It is guaranteed to + be able to send a custom payload packet, however, interaction with minecraft and world state is NOT assured + as it is likely this is fired on a netty handler thread, not a world processing thread. + + If you wish to send an outbound message through your channel, bind the FMLOutboundHandler.FML_MESSAGETARGET + property of your channel to the supplied dispatcher.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/NetworkRegistry.TargetPoint.html b/javadoc/cpw/mods/fml/common/network/NetworkRegistry.TargetPoint.html new file mode 100644 index 0000000..9bd859d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/NetworkRegistry.TargetPoint.html @@ -0,0 +1,331 @@ + + + + + +NetworkRegistry.TargetPoint (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class NetworkRegistry.TargetPoint

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    NetworkRegistry
    +
    +
    +
    +
    public static class NetworkRegistry.TargetPoint
+extends java.lang.Object
    +
    Represents a target point for the ALLROUNDPOINT target.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      intdimension 
      doublerange 
      doublex 
      doubley 
      doublez 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      NetworkRegistry.TargetPoint(int dimension, + double x, + double y, + double z, + double range) +
      A target point
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        x

        +
        public final double x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final double y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final double z
        +
        • +
      + + + +
        +
      • +

        range

        +
        public final double range
        +
        • +
      + + + +
        +
      • +

        dimension

        +
        public final int dimension
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NetworkRegistry.TargetPoint

        +
        public NetworkRegistry.TargetPoint(int dimension,
+                           double x,
+                           double y,
+                           double z,
+                           double range)
        +
        A target point
        +
        Parameters:
        dimension - The dimension to target
        x - The X coordinate
        y - The Y coordinate
        z - The Z coordinate
        range - The range
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/NetworkRegistry.html b/javadoc/cpw/mods/fml/common/network/NetworkRegistry.html new file mode 100644 index 0000000..ca7f894 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/NetworkRegistry.html @@ -0,0 +1,726 @@ + + + + + +NetworkRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Enum NetworkRegistry

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

      Field Detail

      + + + +
        +
      • +

        FML_CHANNEL

        +
        public static final io.netty.util.AttributeKey<java.lang.String> FML_CHANNEL
        +
        Set in the ChannelHandlerContext
        +
        • +
      + + + +
        +
      • +

        CHANNEL_SOURCE

        +
        public static final io.netty.util.AttributeKey<Side> CHANNEL_SOURCE
        +
        • +
      + + + +
        +
      • +

        MOD_CONTAINER

        +
        public static final io.netty.util.AttributeKey<ModContainer> MOD_CONTAINER
        +
        • +
      + + + +
        +
      • +

        NET_HANDLER

        +
        public static final io.netty.util.AttributeKey<INetHandler> NET_HANDLER
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static NetworkRegistry[] 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 (NetworkRegistry c : NetworkRegistry.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static NetworkRegistry 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
        +
        • +
      + + + +
        +
      • +

        newChannel

        +
        public java.util.EnumMap<Side,FMLEmbeddedChannel> newChannel(java.lang.String name,
+                                                    io.netty.channel.ChannelHandler... handlers)
        +
        Create a new synchronous message channel pair based on netty. + + There are two preconstructed models available: +
          +
        • newSimpleChannel(String) provides SimpleNetworkWrapper, a simple implementation of a netty handler, suitable for those who don't + wish to dive too deeply into netty. +
        • #newEventChannel(String) provides FMLEventChannel an event driven implementation, with lower level + access to the network data stream, for those with advanced bitbanging needs that don't wish to poke netty too hard. +
        • Alternatively, simply use the netty features provided here and implement the full power of the netty stack. +
        + + There are two channels created : one for each logical side (considered as the source of an outbound message) + The returned map will contain a value for each logical side, though both will only be working in the + integrated server case. + + The channel expects to read and write using FMLProxyPacket. All operation is synchronous, as the + asynchronous behaviour occurs at a lower level in netty. + + The first handler in the pipeline is special and should not be removed or moved from the head - it transforms + packets from the outbound of this pipeline into custom packets, based on the current AttributeKey value + NetworkRegistry#FML_MESSAGETARGET and NetworkRegistry#FML_MESSAGETARGETARGS set on the channel. + For the client to server channel (source side : CLIENT) this is fixed as "TOSERVER". For SERVER to CLIENT packets, + several possible values exist. + + Mod Messages should be transformed using a something akin to a MessageToMessageCodec. FML provides + a utility codec, FMLIndexedMessageToMessageCodec that transforms from FMLProxyPacket to a mod + message using a message discriminator byte. This is optional, but highly recommended for use. + + Note also that the handlers supplied need to be ChannelHandler.Shareable - they are injected into two + channels.
        +
        Parameters:
        name -
        handlers -
        +
        Returns:
        +
        • +
      + + + + + + + +
        +
      • +

        newEventDrivenChannel

        +
        public FMLEventChannel newEventDrivenChannel(java.lang.String name)
        +
        Construct a new FMLEventChannel for the channel.
        +
        Parameters:
        name - The name of the channel
        +
        Returns:
        An FMLEventChannel for handling this channel
        +
        • +
      + + + +
        +
      • +

        newChannel

        +
        public java.util.EnumMap<Side,FMLEmbeddedChannel> newChannel(ModContainer container,
+                                                    java.lang.String name,
+                                                    io.netty.channel.ChannelHandler... handlers)
        +
        INTERNAL Create a new channel pair with the specified name and channel handlers. + This is used internally in forge and FML
        +
        Parameters:
        container - The container to associate the channel with
        name - The name for the channel
        handlers - Some ChannelHandler for the channel
        +
        Returns:
        an EnumMap of the pair of channels. keys are Side. There will always be two entries.
        +
        • +
      + + + + + + + +
        +
      • +

        registerGuiHandler

        +
        public void registerGuiHandler(java.lang.Object mod,
+                      IGuiHandler handler)
        +
        Register an IGuiHandler for the supplied mod object.
        +
        Parameters:
        mod - The mod to handle GUIs for
        handler - A handler for creating GUI related objects
        +
        • +
      + + + +
        +
      • +

        getRemoteGuiContainer

        +
        public Container getRemoteGuiContainer(ModContainer mc,
+                              EntityPlayerMP player,
+                              int modGuiId,
+                              World world,
+                              int x,
+                              int y,
+                              int z)
        +
        INTERNAL method for accessing the Gui registry
        +
        Parameters:
        mc - Mod Container
        player - Player
        modGuiId - guiId
        world - World
        x - X coord
        y - Y coord
        z - Z coord
        +
        Returns:
        The server side GUI object (An instance of Container)
        +
        • +
      + + + +
        +
      • +

        getLocalGuiContainer

        +
        public java.lang.Object getLocalGuiContainer(ModContainer mc,
+                                    EntityPlayer player,
+                                    int modGuiId,
+                                    World world,
+                                    int x,
+                                    int y,
+                                    int z)
        +
        INTERNAL method for accessing the Gui registry
        +
        Parameters:
        mc - Mod Container
        player - Player
        modGuiId - guiId
        world - World
        x - X coord
        y - Y coord
        z - Z coord
        +
        Returns:
        The client side GUI object (An instance of GUI)
        +
        • +
      + + + +
        +
      • +

        hasChannel

        +
        public boolean hasChannel(java.lang.String channelName,
+                 Side source)
        +
        Is there a channel with this name on this side?
        +
        Parameters:
        channelName - The name
        source - the side
        +
        Returns:
        if there's a channel
        +
        • +
      + + + +
        +
      • +

        register

        +
        public void register(ModContainer fmlModContainer,
+            java.lang.Class<?> clazz,
+            java.lang.String remoteVersionRange,
+            ASMDataTable asmHarvestedData)
        +
        INTERNAL method for registering a mod as a network capable thing
        +
        Parameters:
        fmlModContainer - The fml mod container
        clazz - a class
        remoteVersionRange - the acceptable remote range
        asmHarvestedData - internal data
        +
        • +
      + + + +
        +
      • +

        isVanillaAccepted

        +
        public boolean isVanillaAccepted(Side from)
        +
        • +
      + + + + + + + +
        +
      • +

        channelNamesFor

        +
        public java.util.Set<java.lang.String> channelNamesFor(Side side)
        +
        All the valid channel names for a side
        +
        Parameters:
        side - the side
        +
        Returns:
        the set of channel names
        +
        • +
      + + + +
        +
      • +

        fireNetworkHandshake

        +
        public void fireNetworkHandshake(NetworkDispatcher networkDispatcher,
+                        Side origin)
        +
        INTERNAL fire a handshake to all channels
        +
        Parameters:
        networkDispatcher - The dispatcher firing
        origin - which side the dispatcher is on
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/ChannelRegistrationHandler.html b/javadoc/cpw/mods/fml/common/network/handshake/ChannelRegistrationHandler.html new file mode 100644 index 0000000..641658f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/ChannelRegistrationHandler.html @@ -0,0 +1,349 @@ + + + + + +ChannelRegistrationHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class ChannelRegistrationHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class ChannelRegistrationHandler
+extends io.netty.channel.SimpleChannelInboundHandler<FMLProxyPacket>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      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, + FMLProxyPacket 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

      + + + +
        +
      • +

        ChannelRegistrationHandler

        +
        public ChannelRegistrationHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                FMLProxyPacket msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<FMLProxyPacket>
        +
        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/cpw/mods/fml/common/network/handshake/FMLHandshakeCodec.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeCodec.html new file mode 100644 index 0000000..373f6c5 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeCodec.html @@ -0,0 +1,386 @@ + + + + + +FMLHandshakeCodec (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeCodec

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class FMLHandshakeCodec
+extends FMLIndexedMessageToMessageCodec<FMLHandshakeMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecodeInto(io.netty.channel.ChannelHandlerContext ctx, + io.netty.buffer.ByteBuf source, + FMLHandshakeMessage msg) 
      voidencodeInto(io.netty.channel.ChannelHandlerContext ctx, + FMLHandshakeMessage 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/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ClientHello.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ClientHello.html new file mode 100644 index 0000000..81a4c2a --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ClientHello.html @@ -0,0 +1,319 @@ + + + + + +FMLHandshakeMessage.ClientHello (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage.ClientHello

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

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage.ClientHello

        +
        public FMLHandshakeMessage.ClientHello()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

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

        protocolVersion

        +
        public byte protocolVersion()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeAck.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeAck.html new file mode 100644 index 0000000..4fdf85e --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeAck.html @@ -0,0 +1,323 @@ + + + + + +FMLHandshakeMessage.HandshakeAck (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage.HandshakeAck

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

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage.HandshakeAck

        +
        public FMLHandshakeMessage.HandshakeAck()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeReset.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeReset.html new file mode 100644 index 0000000..06d9782 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeReset.html @@ -0,0 +1,257 @@ + + + + + +FMLHandshakeMessage.HandshakeReset (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage.HandshakeReset

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

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage.HandshakeReset

        +
        public FMLHandshakeMessage.HandshakeReset()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModIdData.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModIdData.html new file mode 100644 index 0000000..1c7a014 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModIdData.html @@ -0,0 +1,374 @@ + + + + + +FMLHandshakeMessage.ModIdData (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage.ModIdData

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

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage.ModIdData

        +
        public FMLHandshakeMessage.ModIdData()
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Method Detail

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

        dataList

        +
        public java.util.Map<java.lang.String,java.lang.Integer> dataList()
        +
        • +
      + + + +
        +
      • +

        blockSubstitutions

        +
        public java.util.Set<java.lang.String> blockSubstitutions()
        +
        • +
      + + + +
        +
      • +

        itemSubstitutions

        +
        public java.util.Set<java.lang.String> itemSubstitutions()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString(java.lang.Class<? extends java.lang.Enum<?>> side)
        +
        +
        Overrides:
        +
        toString in class FMLHandshakeMessage
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModList.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModList.html new file mode 100644 index 0000000..58ccc44 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModList.html @@ -0,0 +1,374 @@ + + + + + +FMLHandshakeMessage.ModList (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage.ModList

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

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage.ModList

        +
        public FMLHandshakeMessage.ModList()
        +
        • +
      + + + +
        +
      • +

        FMLHandshakeMessage.ModList

        +
        public FMLHandshakeMessage.ModList(java.util.List<ModContainer> modList)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

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

        modListAsString

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

        modListSize

        +
        public int modListSize()
        +
        • +
      + + + +
        +
      • +

        modList

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

        toString

        +
        public java.lang.String toString(java.lang.Class<? extends java.lang.Enum<?>> side)
        +
        +
        Overrides:
        +
        toString in class FMLHandshakeMessage
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ServerHello.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ServerHello.html new file mode 100644 index 0000000..e204958 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ServerHello.html @@ -0,0 +1,319 @@ + + + + + +FMLHandshakeMessage.ServerHello (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage.ServerHello

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

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage.ServerHello

        +
        public FMLHandshakeMessage.ServerHello()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

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

        protocolVersion

        +
        public byte protocolVersion()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.html new file mode 100644 index 0000000..833b7c7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.html @@ -0,0 +1,336 @@ + + + + + +FMLHandshakeMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage

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

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage

        +
        public FMLHandshakeMessage()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makeCustomChannelRegistration

        +
        public static FMLProxyPacket makeCustomChannelRegistration(java.util.Set<java.lang.String> channels)
        +
        • +
      + + + +
        +
      • +

        fromBytes

        +
        public void fromBytes(io.netty.buffer.ByteBuf buffer)
        +
        • +
      + + + +
        +
      • +

        toBytes

        +
        public void toBytes(io.netty.buffer.ByteBuf buffer)
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString(java.lang.Class<? extends java.lang.Enum<?>> side)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/HandshakeInjector.html b/javadoc/cpw/mods/fml/common/network/handshake/HandshakeInjector.html new file mode 100644 index 0000000..c9d6628 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/HandshakeInjector.html @@ -0,0 +1,316 @@ + + + + + +HandshakeInjector (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class HandshakeInjector

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class HandshakeInjector
+extends io.netty.channel.ChannelOutboundHandlerAdapter
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      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
      voidwrite(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object msg, + io.netty.channel.ChannelPromise promise) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

        +bind, close, connect, deregister, disconnect, flush, read
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +exceptionCaught, 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

        +exceptionCaught, handlerAdded, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HandshakeInjector

        +
        public HandshakeInjector(NetworkDispatcher networkDispatcher)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        write

        +
        public void write(io.netty.channel.ChannelHandlerContext ctx,
+         java.lang.Object msg,
+         io.netty.channel.ChannelPromise promise)
+           throws java.lang.Exception
        +
        +
        Specified by:
        +
        write in interface io.netty.channel.ChannelOutboundHandler
        +
        Overrides:
        +
        write in class io.netty.channel.ChannelOutboundHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/HandshakeMessageHandler.html b/javadoc/cpw/mods/fml/common/network/handshake/HandshakeMessageHandler.html new file mode 100644 index 0000000..f8e9e75 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/HandshakeMessageHandler.html @@ -0,0 +1,393 @@ + + + + + +HandshakeMessageHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class HandshakeMessageHandler<S extends java.lang.Enum<S> & IHandshakeState<S>>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class HandshakeMessageHandler<S extends java.lang.Enum<S> & IHandshakeState<S>>
+extends io.netty.channel.SimpleChannelInboundHandler<FMLHandshakeMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      HandshakeMessageHandler(java.lang.Class<S> stateType) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidchannelActive(io.netty.channel.ChannelHandlerContext ctx) 
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + FMLHandshakeMessage msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      voiduserEventTriggered(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object evt) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged
        • +
      +
        +
      • + + +

        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

      + + + +
        +
      • +

        HandshakeMessageHandler

        +
        public HandshakeMessageHandler(java.lang.Class<S> stateType)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                FMLHandshakeMessage msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<FMLHandshakeMessage>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        channelActive

        +
        public void channelActive(io.netty.channel.ChannelHandlerContext ctx)
+                   throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelActive in interface io.netty.channel.ChannelInboundHandler
        +
        Overrides:
        +
        channelActive in class io.netty.channel.ChannelInboundHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        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
        +
        • +
      + + + +
        +
      • +

        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/cpw/mods/fml/common/network/handshake/IHandshakeState.html b/javadoc/cpw/mods/fml/common/network/handshake/IHandshakeState.html new file mode 100644 index 0000000..86a361d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/IHandshakeState.html @@ -0,0 +1,206 @@ + + + + + +IHandshakeState (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Interface IHandshakeState<S>

+
+
+
+
    +
  • +
    +
    +
    public interface IHandshakeState<S>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Saccept(io.netty.channel.ChannelHandlerContext ctx, + FMLHandshakeMessage msg) 
      +
      • +
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/NetworkDispatcher.html b/javadoc/cpw/mods/fml/common/network/handshake/NetworkDispatcher.html new file mode 100644 index 0000000..729da41 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/NetworkDispatcher.html @@ -0,0 +1,791 @@ + + + + + +NetworkDispatcher (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class NetworkDispatcher

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class NetworkDispatcher
+extends io.netty.channel.SimpleChannelInboundHandler<Packet>
+implements io.netty.channel.ChannelOutboundHandler
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      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
      voidabortClientHandshake(java.lang.String type) 
      static NetworkDispatcherallocAndSet(NetworkManager manager) 
      static NetworkDispatcherallocAndSet(NetworkManager manager, + ServerConfigurationManager scm) 
      voidbind(io.netty.channel.ChannelHandlerContext ctx, + java.net.SocketAddress localAddress, + io.netty.channel.ChannelPromise promise) 
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + Packet msg) 
      voidclientToServerHandshake() 
      voidclose(io.netty.channel.ChannelHandlerContext ctx, + io.netty.channel.ChannelPromise promise) 
      voidcompleteClientHandshake() 
      voidcompleteHandshake(Side target) 
      voidconnect(io.netty.channel.ChannelHandlerContext ctx, + java.net.SocketAddress remoteAddress, + java.net.SocketAddress localAddress, + io.netty.channel.ChannelPromise promise) 
      voidderegister(io.netty.channel.ChannelHandlerContext ctx, + io.netty.channel.ChannelPromise promise) +
      Deprecated. 
      +
      voiddisconnect(io.netty.channel.ChannelHandlerContext ctx, + io.netty.channel.ChannelPromise promise) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      voidflush(io.netty.channel.ChannelHandlerContext ctx) 
      static NetworkDispatcherget(NetworkManager manager) 
      INetHandlergetNetHandler() 
      voidhandlerAdded(io.netty.channel.ChannelHandlerContext ctx) 
      voidread(io.netty.channel.ChannelHandlerContext ctx) 
      voidrejectHandshake(java.lang.String result) 
      voidsendProxy(FMLProxyPacket msg) 
      voidserverToClientHandshake(EntityPlayerMP player) 
      voiduserEventTriggered(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object evt) 
      voidwrite(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object msg, + io.netty.channel.ChannelPromise promise) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged
        • +
      +
        +
      • + + +

        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
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        FML_DISPATCHER

        +
        public static final io.netty.util.AttributeKey<NetworkDispatcher> FML_DISPATCHER
        +
        • +
      + + + +
        +
      • +

        IS_LOCAL

        +
        public static final io.netty.util.AttributeKey<java.lang.Boolean> IS_LOCAL
        +
        • +
      + + + + +
      • +
    + + + +
      +
    • + + +

      Method Detail

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

        serverToClientHandshake

        +
        public void serverToClientHandshake(EntityPlayerMP player)
        +
        • +
      + + + +
        +
      • +

        clientToServerHandshake

        +
        public void clientToServerHandshake()
        +
        • +
      + + + +
        +
      • +

        handlerAdded

        +
        public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
+                  throws java.lang.Exception
        +
        +
        Specified by:
        +
        handlerAdded in interface io.netty.channel.ChannelHandler
        +
        Overrides:
        +
        handlerAdded in class io.netty.channel.ChannelHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                Packet msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<Packet>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        getNetHandler

        +
        public INetHandler getNetHandler()
        +
        • +
      + + + +
        +
      • +

        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
        +
        • +
      + + + + + + + +
        +
      • +

        rejectHandshake

        +
        public void rejectHandshake(java.lang.String result)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public void bind(io.netty.channel.ChannelHandlerContext ctx,
+        java.net.SocketAddress localAddress,
+        io.netty.channel.ChannelPromise promise)
+          throws java.lang.Exception
        +
        +
        Specified by:
        +
        bind in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        connect

        +
        public void connect(io.netty.channel.ChannelHandlerContext ctx,
+           java.net.SocketAddress remoteAddress,
+           java.net.SocketAddress localAddress,
+           io.netty.channel.ChannelPromise promise)
+             throws java.lang.Exception
        +
        +
        Specified by:
        +
        connect in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        disconnect

        +
        public void disconnect(io.netty.channel.ChannelHandlerContext ctx,
+              io.netty.channel.ChannelPromise promise)
+                throws java.lang.Exception
        +
        +
        Specified by:
        +
        disconnect in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close(io.netty.channel.ChannelHandlerContext ctx,
+         io.netty.channel.ChannelPromise promise)
+           throws java.lang.Exception
        +
        +
        Specified by:
        +
        close in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        deregister

        +
        @Deprecated
+public void deregister(io.netty.channel.ChannelHandlerContext ctx,
+                         io.netty.channel.ChannelPromise promise)
+                throws java.lang.Exception
        +
        Deprecated. 
        +
        +
        Specified by:
        +
        deregister in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        read

        +
        public void read(io.netty.channel.ChannelHandlerContext ctx)
+          throws java.lang.Exception
        +
        +
        Specified by:
        +
        read in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        write

        +
        public void write(io.netty.channel.ChannelHandlerContext ctx,
+         java.lang.Object msg,
+         io.netty.channel.ChannelPromise promise)
+           throws java.lang.Exception
        +
        +
        Specified by:
        +
        write in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        flush

        +
        public void flush(io.netty.channel.ChannelHandlerContext ctx)
+           throws java.lang.Exception
        +
        +
        Specified by:
        +
        flush in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        completeHandshake

        +
        public void completeHandshake(Side target)
        +
        • +
      + + + +
        +
      • +

        completeClientHandshake

        +
        public void completeClientHandshake()
        +
        • +
      + + + +
        +
      • +

        abortClientHandshake

        +
        public void abortClientHandshake(java.lang.String type)
        +
        • +
      + + + +
        +
      • +

        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
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/package-frame.html b/javadoc/cpw/mods/fml/common/network/handshake/package-frame.html new file mode 100644 index 0000000..79ed5f2 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/package-frame.html @@ -0,0 +1,34 @@ + + + + + +cpw.mods.fml.common.network.handshake (Forge API) + + + + +

cpw.mods.fml.common.network.handshake

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/package-summary.html b/javadoc/cpw/mods/fml/common/network/handshake/package-summary.html new file mode 100644 index 0000000..10c32ab --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/package-summary.html @@ -0,0 +1,190 @@ + + + + + +cpw.mods.fml.common.network.handshake (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.network.handshake

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/package-tree.html b/javadoc/cpw/mods/fml/common/network/handshake/package-tree.html new file mode 100644 index 0000000..22e73cb --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/package-tree.html @@ -0,0 +1,172 @@ + + + + + +cpw.mods.fml.common.network.handshake Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.network.handshake

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/EntitySpawnHandler.html b/javadoc/cpw/mods/fml/common/network/internal/EntitySpawnHandler.html new file mode 100644 index 0000000..89e9bdc --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/EntitySpawnHandler.html @@ -0,0 +1,349 @@ + + + + + +EntitySpawnHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class EntitySpawnHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class EntitySpawnHandler
+extends io.netty.channel.SimpleChannelInboundHandler<FMLMessage.EntityMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + FMLMessage.EntityMessage 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

      + + + +
        +
      • +

        EntitySpawnHandler

        +
        public EntitySpawnHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                FMLMessage.EntityMessage msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<FMLMessage.EntityMessage>
        +
        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/cpw/mods/fml/common/network/internal/FMLMessage.CompleteHandshake.html b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.CompleteHandshake.html new file mode 100644 index 0000000..d6e0eda --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.CompleteHandshake.html @@ -0,0 +1,262 @@ + + + + + +FMLMessage.CompleteHandshake (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLMessage.CompleteHandshake

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FMLMessage
    +
    +
    +
    +
    public static class FMLMessage.CompleteHandshake
+extends FMLMessage
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLMessage.CompleteHandshake

        +
        public FMLMessage.CompleteHandshake()
        +
        • +
      + + + +
        +
      • +

        FMLMessage.CompleteHandshake

        +
        public FMLMessage.CompleteHandshake(Side target)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityAdjustMessage.html b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityAdjustMessage.html new file mode 100644 index 0000000..f4c314d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityAdjustMessage.html @@ -0,0 +1,273 @@ + + + + + +FMLMessage.EntityAdjustMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLMessage.EntityAdjustMessage

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

      Constructor Detail

      + + + +
        +
      • +

        FMLMessage.EntityAdjustMessage

        +
        public FMLMessage.EntityAdjustMessage()
        +
        • +
      + + + +
        +
      • +

        FMLMessage.EntityAdjustMessage

        +
        public FMLMessage.EntityAdjustMessage(Entity entity,
+                              int serverX,
+                              int serverY,
+                              int serverZ)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityMessage.html b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityMessage.html new file mode 100644 index 0000000..10b061f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityMessage.html @@ -0,0 +1,254 @@ + + + + + +FMLMessage.EntityMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLMessage.EntityMessage

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

      Constructor Detail

      + + + +
        +
      • +

        FMLMessage.EntityMessage

        +
        public FMLMessage.EntityMessage()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntitySpawnMessage.html b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntitySpawnMessage.html new file mode 100644 index 0000000..a0d8f6f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntitySpawnMessage.html @@ -0,0 +1,271 @@ + + + + + +FMLMessage.EntitySpawnMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLMessage.EntitySpawnMessage

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.OpenGui.html b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.OpenGui.html new file mode 100644 index 0000000..dcd987b --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.OpenGui.html @@ -0,0 +1,250 @@ + + + + + +FMLMessage.OpenGui (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLMessage.OpenGui

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FMLMessage
    +
    +
    +
    +
    public static class FMLMessage.OpenGui
+extends FMLMessage
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLMessage.OpenGui

        +
        public FMLMessage.OpenGui()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.html b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.html new file mode 100644 index 0000000..598e720 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.html @@ -0,0 +1,265 @@ + + + + + +FMLMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLMessage

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

      Constructor Detail

      + + + +
        +
      • +

        FMLMessage

        +
        public FMLMessage()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLNetworkHandler.html b/javadoc/cpw/mods/fml/common/network/internal/FMLNetworkHandler.html new file mode 100644 index 0000000..e91f04f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLNetworkHandler.html @@ -0,0 +1,454 @@ + + + + + +FMLNetworkHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLNetworkHandler

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

      Field Detail

      + + + +
        +
      • +

        READ_TIMEOUT

        +
        public static final int READ_TIMEOUT
        +
        • +
      + + + +
        +
      • +

        LOGIN_TIMEOUT

        +
        public static final int LOGIN_TIMEOUT
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkHandler

        +
        public FMLNetworkHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        fmlClientHandshake

        +
        public static void fmlClientHandshake(NetworkManager field_147393_d)
        +
        • +
      + + + +
        +
      • +

        openGui

        +
        public static void openGui(EntityPlayer entityPlayer,
+           java.lang.Object mod,
+           int modGuiId,
+           World world,
+           int x,
+           int y,
+           int z)
        +
        • +
      + + + +
        +
      • +

        makeEntitySpawnAdjustment

        +
        public static void makeEntitySpawnAdjustment(Entity entity,
+                             EntityPlayerMP player,
+                             int serverX,
+                             int serverY,
+                             int serverZ)
        +
        • +
      + + + +
        +
      • +

        getEntitySpawningPacket

        +
        public static Packet getEntitySpawningPacket(Entity entity)
        +
        • +
      + + + + + + + +
        +
      • +

        checkModList

        +
        public static java.lang.String checkModList(java.util.Map<java.lang.String,java.lang.String> listData,
+                            Side side)
        +
        • +
      + + + +
        +
      • +

        registerChannel

        +
        public static void registerChannel(FMLContainer container,
+                   Side side)
        +
        • +
      + + + + + + + +
        +
      • +

        enhanceStatusQuery

        +
        public static void enhanceStatusQuery(com.google.gson.JsonObject jsonobject)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLProxyPacket.html b/javadoc/cpw/mods/fml/common/network/internal/FMLProxyPacket.html new file mode 100644 index 0000000..7c88165 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLProxyPacket.html @@ -0,0 +1,464 @@ + + + + + +FMLProxyPacket (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLProxyPacket

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLProxyPacket
+extends Packet
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

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

        FMLProxyPacket

        +
        public FMLProxyPacket(io.netty.buffer.ByteBuf payload,
+              java.lang.String channel)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        readPacketData

        +
        public void readPacketData(PacketBuffer packetbuffer)
+                    throws java.io.IOException
        +
        +
        Specified by:
        +
        readPacketData in class Packet
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        writePacketData

        +
        public void writePacketData(PacketBuffer packetbuffer)
+                     throws java.io.IOException
        +
        +
        Specified by:
        +
        writePacketData in class Packet
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + + + + + +
        +
      • +

        channel

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

        payload

        +
        public io.netty.buffer.ByteBuf payload()
        +
        • +
      + + + + + + + +
        +
      • +

        toC17Packet

        +
        public Packet toC17Packet()
        +
        • +
      + + + +
        +
      • +

        toS3FPacket

        +
        public Packet toS3FPacket()
        +
        • +
      + + + +
        +
      • +

        setTarget

        +
        public void setTarget(Side target)
        +
        • +
      + + + +
        +
      • +

        setDispatcher

        +
        public void setDispatcher(NetworkDispatcher networkDispatcher)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getTarget

        +
        public Side getTarget()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLRuntimeCodec.html b/javadoc/cpw/mods/fml/common/network/internal/FMLRuntimeCodec.html new file mode 100644 index 0000000..8fdea5d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLRuntimeCodec.html @@ -0,0 +1,408 @@ + + + + + +FMLRuntimeCodec (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLRuntimeCodec

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class FMLRuntimeCodec
+extends FMLIndexedMessageToMessageCodec<FMLMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecodeInto(io.netty.channel.ChannelHandlerContext ctx, + io.netty.buffer.ByteBuf source, + FMLMessage msg) 
      voidencodeInto(io.netty.channel.ChannelHandlerContext ctx, + FMLMessage msg, + io.netty.buffer.ByteBuf target) 
      protected voidtestMessageValidity(FMLProxyPacket msg) +
      Called to verify the message received.
      +
      + +
        +
      • + + +

        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/cpw/mods/fml/common/network/internal/HandshakeCompletionHandler.html b/javadoc/cpw/mods/fml/common/network/internal/HandshakeCompletionHandler.html new file mode 100644 index 0000000..b2f6f71 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/HandshakeCompletionHandler.html @@ -0,0 +1,350 @@ + + + + + +HandshakeCompletionHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class HandshakeCompletionHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    @ChannelHandler.Sharable
+public class HandshakeCompletionHandler
+extends io.netty.channel.SimpleChannelInboundHandler<FMLMessage.CompleteHandshake>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      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, + FMLMessage.CompleteHandshake 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

      + + + +
        +
      • +

        HandshakeCompletionHandler

        +
        public HandshakeCompletionHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                FMLMessage.CompleteHandshake msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<FMLMessage.CompleteHandshake>
        +
        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/cpw/mods/fml/common/network/internal/NetworkModHolder.NetworkChecker.html b/javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.NetworkChecker.html new file mode 100644 index 0000000..c6d6dc5 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.NetworkChecker.html @@ -0,0 +1,260 @@ + + + + + +NetworkModHolder.NetworkChecker (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class NetworkModHolder.NetworkChecker

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    NetworkModHolder
    +
    +
    +
    +
    public abstract class NetworkModHolder.NetworkChecker
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      abstract booleancheck(java.util.Map<java.lang.String,java.lang.String> remoteVersions, + Side side) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        NetworkModHolder.NetworkChecker

        +
        public NetworkModHolder.NetworkChecker()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        check

        +
        public abstract boolean check(java.util.Map<java.lang.String,java.lang.String> remoteVersions,
+            Side side)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.html b/javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.html new file mode 100644 index 0000000..e0e18e0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.html @@ -0,0 +1,398 @@ + + + + + +NetworkModHolder (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class NetworkModHolder

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

      Method Detail

      + + + +
        +
      • +

        acceptVersion

        +
        public boolean acceptVersion(java.lang.String version)
        +
        • +
      + + + +
        +
      • +

        check

        +
        public boolean check(java.util.Map<java.lang.String,java.lang.String> data,
+            Side side)
        +
        • +
      + + + +
        +
      • +

        getLocalId

        +
        public int getLocalId()
        +
        • +
      + + + +
        +
      • +

        getNetworkId

        +
        public int getNetworkId()
        +
        • +
      + + + + + + + +
        +
      • +

        setNetworkId

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

        testVanillaAcceptance

        +
        public void testVanillaAcceptance()
        +
        • +
      + + + +
        +
      • +

        acceptsVanilla

        +
        public boolean acceptsVanilla(Side from)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/OpenGuiHandler.html b/javadoc/cpw/mods/fml/common/network/internal/OpenGuiHandler.html new file mode 100644 index 0000000..a1f7844 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/OpenGuiHandler.html @@ -0,0 +1,349 @@ + + + + + +OpenGuiHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class OpenGuiHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class OpenGuiHandler
+extends io.netty.channel.SimpleChannelInboundHandler<FMLMessage.OpenGui>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + FMLMessage.OpenGui 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

      + + + +
        +
      • +

        OpenGuiHandler

        +
        public OpenGuiHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                FMLMessage.OpenGui msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<FMLMessage.OpenGui>
        +
        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/cpw/mods/fml/common/network/internal/package-frame.html b/javadoc/cpw/mods/fml/common/network/internal/package-frame.html new file mode 100644 index 0000000..2b3ed40 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/package-frame.html @@ -0,0 +1,31 @@ + + + + + +cpw.mods.fml.common.network.internal (Forge API) + + + + +

cpw.mods.fml.common.network.internal

+
+

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/network/internal/package-summary.html b/javadoc/cpw/mods/fml/common/network/internal/package-summary.html new file mode 100644 index 0000000..72c52f4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/package-summary.html @@ -0,0 +1,179 @@ + + + + + +cpw.mods.fml.common.network.internal (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.network.internal

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/package-tree.html b/javadoc/cpw/mods/fml/common/network/internal/package-tree.html new file mode 100644 index 0000000..cfb7093 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/package-tree.html @@ -0,0 +1,173 @@ + + + + + +cpw.mods.fml.common.network.internal Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.network.internal

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/package-frame.html b/javadoc/cpw/mods/fml/common/network/package-frame.html new file mode 100644 index 0000000..64a33d2 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/package-frame.html @@ -0,0 +1,53 @@ + + + + + +cpw.mods.fml.common.network (Forge API) + + + + +

cpw.mods.fml.common.network

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +

Exceptions

+ +

Annotation Types

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/network/package-summary.html b/javadoc/cpw/mods/fml/common/network/package-summary.html new file mode 100644 index 0000000..891ee59 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/package-summary.html @@ -0,0 +1,295 @@ + + + + + +cpw.mods.fml.common.network (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.network

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/package-tree.html b/javadoc/cpw/mods/fml/common/network/package-tree.html new file mode 100644 index 0000000..43065f0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/package-tree.html @@ -0,0 +1,223 @@ + + + + + +cpw.mods.fml.common.network Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.network

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Annotation Type Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/IMessage.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/IMessage.html new file mode 100644 index 0000000..913c539 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/IMessage.html @@ -0,0 +1,226 @@ + + + + + +IMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.simpleimpl
+

Interface IMessage

+
+
+
+
    +
  • +
    +
    +
    public interface IMessage
    +
    Implement this interface for each message you wish to define.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidfromBytes(io.netty.buffer.ByteBuf buf) +
      Convert from the supplied buffer into your specific message type
      +
      voidtoBytes(io.netty.buffer.ByteBuf buf) +
      Deconstruct your message into the supplied byte buffer
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fromBytes

        +
        void fromBytes(io.netty.buffer.ByteBuf buf)
        +
        Convert from the supplied buffer into your specific message type
        +
        Parameters:
        buf -
        +
        • +
      + + + +
        +
      • +

        toBytes

        +
        void toBytes(io.netty.buffer.ByteBuf buf)
        +
        Deconstruct your message into the supplied byte buffer
        +
        Parameters:
        buf -
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/IMessageHandler.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/IMessageHandler.html new file mode 100644 index 0000000..58c9fb1 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/IMessageHandler.html @@ -0,0 +1,219 @@ + + + + + +IMessageHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.simpleimpl
+

Interface IMessageHandler<REQ extends IMessage,REPLY extends IMessage>

+
+
+
+
    +
  • +
    Type Parameters:
    REQ - This is the request type - it is the message you expect to receive from remote.
    REPLY - This is the reply type - it is the message you expect to send in reply. You can use IMessage as the type here + if you don't anticipate sending a reply.
    +
    +
    +
    public interface IMessageHandler<REQ extends IMessage,REPLY extends IMessage>
    +
    A message handler based on IMessage. Implement and override #onMessage(IMessage) to + process your packet. Supply the class to SimpleNetworkWrapper#registerMessage(Class, Class, byte, cpw.mods.fml.relauncher.Side) + to register both the message type and it's associated handler.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      REPLYonMessage(REQ message, + MessageContext ctx) +
      Called when a message is received of the appropriate type.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        onMessage

        +
        REPLY onMessage(REQ message,
+              MessageContext ctx)
        +
        Called when a message is received of the appropriate type. You can optionally return a reply message, or null if no reply + is needed.
        +
        Parameters:
        message - The message
        +
        Returns:
        an optional return message
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/MessageContext.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/MessageContext.html new file mode 100644 index 0000000..a4c5d2a --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/MessageContext.html @@ -0,0 +1,290 @@ + + + + + +MessageContext (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.simpleimpl
+

Class MessageContext

+
+
+ +
+
    +
  • +
    +
    +
    public class MessageContext
+extends java.lang.Object
    +
    Context for the IMessageHandler
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        netHandler

        +
        public final INetHandler netHandler
        +
        The INetHandler for this message. It could be a client or server handler, depending + on the side recieved.
        +
        • +
      + + + +
        +
      • +

        side

        +
        public final Side side
        +
        The Side this message has been received on
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleChannelHandlerWrapper.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleChannelHandlerWrapper.html new file mode 100644 index 0000000..4990219 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleChannelHandlerWrapper.html @@ -0,0 +1,371 @@ + + + + + +SimpleChannelHandlerWrapper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.simpleimpl
+

Class SimpleChannelHandlerWrapper<REQ extends IMessage,REPLY extends IMessage>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class SimpleChannelHandlerWrapper<REQ extends IMessage,REPLY extends IMessage>
+extends io.netty.channel.SimpleChannelInboundHandler<REQ>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      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, + REQ 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

      + + + +
        +
      • +

        SimpleChannelHandlerWrapper

        +
        public SimpleChannelHandlerWrapper(java.lang.Class<? extends IMessageHandler<? super REQ,? extends REPLY>> handler,
+                           Side side,
+                           java.lang.Class<REQ> requestType)
        +
        • +
      + + + +
        +
      • +

        SimpleChannelHandlerWrapper

        +
        public SimpleChannelHandlerWrapper(IMessageHandler<? super REQ,? extends REPLY> handler,
+                           Side side,
+                           java.lang.Class<REQ> requestType)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                REQ msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<REQ extends IMessage>
        +
        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/cpw/mods/fml/common/network/simpleimpl/SimpleIndexedCodec.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleIndexedCodec.html new file mode 100644 index 0000000..f976ccb --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleIndexedCodec.html @@ -0,0 +1,386 @@ + + + + + +SimpleIndexedCodec (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.simpleimpl
+

Class SimpleIndexedCodec

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class SimpleIndexedCodec
+extends FMLIndexedMessageToMessageCodec<IMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecodeInto(io.netty.channel.ChannelHandlerContext ctx, + io.netty.buffer.ByteBuf source, + IMessage msg) 
      voidencodeInto(io.netty.channel.ChannelHandlerContext ctx, + IMessage 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/cpw/mods/fml/common/network/simpleimpl/SimpleNetworkWrapper.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleNetworkWrapper.html new file mode 100644 index 0000000..1ba92e8 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleNetworkWrapper.html @@ -0,0 +1,463 @@ + + + + + +SimpleNetworkWrapper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.simpleimpl
+

Class SimpleNetworkWrapper

+
+
+ +
+
    +
  • +
    +
    +
    public class SimpleNetworkWrapper
+extends java.lang.Object
    +
    This class is a simplified netty wrapper for those not wishing to deal with the full power of netty. + It provides a simple message driven system, based on a discriminator byte over the custom packet channel. + It assumes that you have a series of unique message types with each having a unique handler. Generally, context should be + derived at message handling time. + + Usage is simple:
      +
    • construct, and store, an instance of this class. It will automatically register and configure your underlying netty channel. + +
    • Then, call #registerMessage(Class, Class, byte, Side) for each message type you want to exchange + providing an IMessageHandler implementation class as well as an IMessage implementation class. The side parameter + to that method indicates which side (server or client) the message processing will occur on. The discriminator byte + should be unique for this channelName - it is used to discriminate between different types of message that might + occur on this channel (a simple form of message channel multiplexing, if you will). +
    • To get a packet suitable for presenting to the rest of minecraft, you can call getPacketFrom(IMessage). The return result + is suitable for returning from things like TileEntity.getDescriptionPacket() for example. +
    • Finally, use the sendXXX to send unsolicited messages to various classes of recipients. +
    + + Example + + 
    +  // Request message
+  public Message1 implements IMessage {
+  // message structure
+   public fromBytes(ByteBuf buf) {
+    // build message from byte array
+   }
+   public toBytes(ByteBuf buf) {
+    // put message content into byte array
+   }
+  }
+  // Reply message
+  public Message2 implements IMessage {
+   // stuff as before
+  }
+  // Message1Handler expects input of type Message1 and returns type Message2
+  public Message1Handler implements IMessageHandler {
+   public Message2 onMessage(Message1 message, MessageContext ctx) {
+    // do something and generate reply message
+    return aMessage2Object;
+   }
+  }
+  // Message2Handler expects input of type Message2 and returns no message (IMessage)
+  public Message2Handler implements IMessageHandler {
+   public IMessage onMessage(Message2 message, MessageContext ctx) {
+    // handle the message 2 response message at the other end
+    // no reply for this message - return null
+    return null;
+   }
+  }
+
+  // Code in a FMLPreInitializationEvent or FMLInitializationEvent handler
+  SimpleNetworkWrapper wrapper = NetworkRegistry.newSimpleChannel("MYCHANNEL");
+  // Message1 is handled by the Message1Handler class, it has discriminator id 1 and it's on the client
+  wrapper.registerMessage(Message1Handler.class, Message1.class, 1, Side.CLIENT);
+  // Message2 is handled by the Message2Handler class, it has discriminator id 2 and it's on the server
+  wrapper.registerMessage(Message2Handler.class, Message2.class, 2, Side.SERVER);
+
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SimpleNetworkWrapper(java.lang.String channelName) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      PacketgetPacketFrom(IMessage message) +
      Construct a minecraft packet from the supplied message.
      +
      <REQ extends IMessage,REPLY extends IMessage> 
      void      		registerMessage(java.lang.Class<? extends IMessageHandler<REQ,REPLY>> messageHandler, + java.lang.Class<REQ> requestMessageType, + int discriminator, + Side side) +
      Register a message and it's associated handler.
      +
      <REQ extends IMessage,REPLY extends IMessage> 
      void      		registerMessage(IMessageHandler<? super REQ,? extends REPLY> messageHandler, + java.lang.Class<REQ> requestMessageType, + int discriminator, + Side side) +
      Register a message and it's associated handler.
      +
      voidsendTo(IMessage message, + EntityPlayerMP player) +
      Send this message to the specified player.
      +
      voidsendToAll(IMessage message) +
      Send this message to everyone.
      +
      voidsendToAllAround(IMessage message, + NetworkRegistry.TargetPoint point) +
      Send this message to everyone within a certain range of a point.
      +
      voidsendToDimension(IMessage message, + int dimensionId) +
      Send this message to everyone within the supplied dimension.
      +
      voidsendToServer(IMessage message) +
      Send this message to the server.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SimpleNetworkWrapper

        +
        public SimpleNetworkWrapper(java.lang.String channelName)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerMessage

        +
        public <REQ extends IMessage,REPLY extends IMessage> void registerMessage(java.lang.Class<? extends IMessageHandler<REQ,REPLY>> messageHandler,
+                                                                 java.lang.Class<REQ> requestMessageType,
+                                                                 int discriminator,
+                                                                 Side side)
        +
        Register a message and it's associated handler. The message will have the supplied discriminator byte. The message handler will + be registered on the supplied side (this is the side where you want the message to be processed and acted upon).
        +
        Parameters:
        messageHandler - the message handler type
        requestMessageType - the message type
        discriminator - a discriminator byte
        side - the side for the handler
        +
        • +
      + + + +
        +
      • +

        registerMessage

        +
        public <REQ extends IMessage,REPLY extends IMessage> void registerMessage(IMessageHandler<? super REQ,? extends REPLY> messageHandler,
+                                                                 java.lang.Class<REQ> requestMessageType,
+                                                                 int discriminator,
+                                                                 Side side)
        +
        Register a message and it's associated handler. The message will have the supplied discriminator byte. The message handler will + be registered on the supplied side (this is the side where you want the message to be processed and acted upon).
        +
        Parameters:
        messageHandler - the message handler instance
        requestMessageType - the message type
        discriminator - a discriminator byte
        side - the side for the handler
        +
        • +
      + + + +
        +
      • +

        getPacketFrom

        +
        public Packet getPacketFrom(IMessage message)
        +
        Construct a minecraft packet from the supplied message. Can be used where minecraft packets are required, such as + TileEntity.getDescriptionPacket().
        +
        Parameters:
        message - The message to translate into packet form
        +
        Returns:
        A minecraft Packet suitable for use in minecraft APIs
        +
        • +
      + + + +
        +
      • +

        sendToAll

        +
        public void sendToAll(IMessage message)
        +
        Send this message to everyone. + The IMessageHandler for this message type should be on the CLIENT side.
        +
        Parameters:
        message - The message to send
        +
        • +
      + + + +
        +
      • +

        sendTo

        +
        public void sendTo(IMessage message,
+          EntityPlayerMP player)
        +
        Send this message to the specified player. + The IMessageHandler for this message type should be on the CLIENT side.
        +
        Parameters:
        message - The message to send
        player - The player to send it to
        +
        • +
      + + + + + + + +
        +
      • +

        sendToDimension

        +
        public void sendToDimension(IMessage message,
+                   int dimensionId)
        +
        Send this message to everyone within the supplied dimension. + The IMessageHandler for this message type should be on the CLIENT side.
        +
        Parameters:
        message - The message to send
        dimensionId - The dimension id to target
        +
        • +
      + + + +
        +
      • +

        sendToServer

        +
        public void sendToServer(IMessage message)
        +
        Send this message to the server. + The IMessageHandler for this message type should be on the SERVER side.
        +
        Parameters:
        message - The message to send
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/package-frame.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/package-frame.html new file mode 100644 index 0000000..98a0059 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/package-frame.html @@ -0,0 +1,27 @@ + + + + + +cpw.mods.fml.common.network.simpleimpl (Forge API) + + + + +

cpw.mods.fml.common.network.simpleimpl

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/package-summary.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/package-summary.html new file mode 100644 index 0000000..f8d4222 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/package-summary.html @@ -0,0 +1,170 @@ + + + + + +cpw.mods.fml.common.network.simpleimpl (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.network.simpleimpl

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/package-tree.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/package-tree.html new file mode 100644 index 0000000..dd0391c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/package-tree.html @@ -0,0 +1,158 @@ + + + + + +cpw.mods.fml.common.network.simpleimpl Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.network.simpleimpl

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/package-frame.html b/javadoc/cpw/mods/fml/common/package-frame.html new file mode 100644 index 0000000..71fd945 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/package-frame.html @@ -0,0 +1,86 @@ + + + + + +cpw.mods.fml.common (Forge API) + + + + +

cpw.mods.fml.common

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +

Exceptions

+ +

Annotation Types

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/package-summary.html b/javadoc/cpw/mods/fml/common/package-summary.html new file mode 100644 index 0000000..42b7ea4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/package-summary.html @@ -0,0 +1,454 @@ + + + + + +cpw.mods.fml.common (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/package-tree.html b/javadoc/cpw/mods/fml/common/package-tree.html new file mode 100644 index 0000000..07ff4cc --- /dev/null +++ b/javadoc/cpw/mods/fml/common/package-tree.html @@ -0,0 +1,248 @@ + + + + + +cpw.mods.fml.common Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Annotation Type Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/patcher/ClassPatch.html b/javadoc/cpw/mods/fml/common/patcher/ClassPatch.html new file mode 100644 index 0000000..5e4eca7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/patcher/ClassPatch.html @@ -0,0 +1,369 @@ + + + + + +ClassPatch (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.patcher
+

Class ClassPatch

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

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ClassPatch(java.lang.String name, + java.lang.String sourceClassName, + java.lang.String targetClassName, + boolean existsAtTarget, + int inputChecksum, + byte[] patch) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        name

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

        sourceClassName

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

        targetClassName

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

        existsAtTarget

        +
        public final boolean existsAtTarget
        +
        • +
      + + + +
        +
      • +

        patch

        +
        public final byte[] patch
        +
        • +
      + + + +
        +
      • +

        inputChecksum

        +
        public final int inputChecksum
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ClassPatch

        +
        public ClassPatch(java.lang.String name,
+          java.lang.String sourceClassName,
+          java.lang.String targetClassName,
+          boolean existsAtTarget,
+          int inputChecksum,
+          byte[] patch)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/patcher/ClassPatchManager.html b/javadoc/cpw/mods/fml/common/patcher/ClassPatchManager.html new file mode 100644 index 0000000..062d503 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/patcher/ClassPatchManager.html @@ -0,0 +1,306 @@ + + + + + +ClassPatchManager (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.patcher
+

Class ClassPatchManager

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

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      byte[]applyPatch(java.lang.String name, + java.lang.String mappedName, + byte[] inputData) 
      byte[]getPatchedResource(java.lang.String name, + java.lang.String mappedName, + net.minecraft.launchwrapper.LaunchClassLoader loader) 
      voidsetup(Side side) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + + + + + +
        +
      • +

        dumpPatched

        +
        public static final boolean dumpPatched
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPatchedResource

        +
        public byte[] getPatchedResource(java.lang.String name,
+                        java.lang.String mappedName,
+                        net.minecraft.launchwrapper.LaunchClassLoader loader)
+                          throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        applyPatch

        +
        public byte[] applyPatch(java.lang.String name,
+                java.lang.String mappedName,
+                byte[] inputData)
        +
        • +
      + + + +
        +
      • +

        setup

        +
        public void setup(Side side)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/patcher/GenDiffSet.html b/javadoc/cpw/mods/fml/common/patcher/GenDiffSet.html new file mode 100644 index 0000000..ca00d71 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/patcher/GenDiffSet.html @@ -0,0 +1,257 @@ + + + + + +GenDiffSet (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.patcher
+

Class GenDiffSet

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

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidmain(java.lang.String[] args) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        GenDiffSet

        +
        public GenDiffSet()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String[] args)
+                 throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/patcher/package-frame.html b/javadoc/cpw/mods/fml/common/patcher/package-frame.html new file mode 100644 index 0000000..4e683d5 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/patcher/package-frame.html @@ -0,0 +1,21 @@ + + + + + +cpw.mods.fml.common.patcher (Forge API) + + + + +

cpw.mods.fml.common.patcher

+
+

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/patcher/package-summary.html b/javadoc/cpw/mods/fml/common/patcher/package-summary.html new file mode 100644 index 0000000..4160683 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/patcher/package-summary.html @@ -0,0 +1,139 @@ + + + + + +cpw.mods.fml.common.patcher (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.patcher

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/patcher/package-tree.html b/javadoc/cpw/mods/fml/common/patcher/package-tree.html new file mode 100644 index 0000000..5024772 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/patcher/package-tree.html @@ -0,0 +1,128 @@ + + + + + +cpw.mods.fml.common.patcher Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.patcher

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/EntityRegistry.EntityRegistration.html b/javadoc/cpw/mods/fml/common/registry/EntityRegistry.EntityRegistration.html new file mode 100644 index 0000000..bfa6541 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/EntityRegistry.EntityRegistration.html @@ -0,0 +1,405 @@ + + + + + +EntityRegistry.EntityRegistration (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Class EntityRegistry.EntityRegistration

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    EntityRegistry
    +
    +
    +
    +
    public class EntityRegistry.EntityRegistration
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntityRegistry.EntityRegistration

        +
        public EntityRegistry.EntityRegistration(ModContainer mc,
+                                 java.lang.Class<? extends Entity> entityClass,
+                                 java.lang.String entityName,
+                                 int id,
+                                 int trackingRange,
+                                 int updateFrequency,
+                                 boolean sendsVelocityUpdates)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getEntityClass

        +
        public java.lang.Class<? extends Entity> getEntityClass()
        +
        • +
      + + + + + + + +
        +
      • +

        getEntityName

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

        getModEntityId

        +
        public int getModEntityId()
        +
        • +
      + + + +
        +
      • +

        getTrackingRange

        +
        public int getTrackingRange()
        +
        • +
      + + + +
        +
      • +

        getUpdateFrequency

        +
        public int getUpdateFrequency()
        +
        • +
      + + + +
        +
      • +

        sendsVelocityUpdates

        +
        public boolean sendsVelocityUpdates()
        +
        • +
      + + + +
        +
      • +

        usesVanillaSpawning

        +
        public boolean usesVanillaSpawning()
        +
        • +
      + + + +
        +
      • +

        hasCustomSpawning

        +
        public boolean hasCustomSpawning()
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/EntityRegistry.html b/javadoc/cpw/mods/fml/common/registry/EntityRegistry.html new file mode 100644 index 0000000..a179e9d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/EntityRegistry.html @@ -0,0 +1,444 @@ + + + + + +EntityRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Class EntityRegistry

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

      Method Detail

      + + + + + + + +
        +
      • +

        registerModEntity

        +
        public static void registerModEntity(java.lang.Class<? extends Entity> entityClass,
+                     java.lang.String entityName,
+                     int id,
+                     java.lang.Object mod,
+                     int trackingRange,
+                     int updateFrequency,
+                     boolean sendsVelocityUpdates)
        +
        Register the mod entity type with FML
        +
        Parameters:
        entityClass - The entity class
        entityName - A unique name for the entity
        id - A mod specific ID for the entity
        mod - The mod
        trackingRange - The range at which MC will send tracking updates
        updateFrequency - The frequency of tracking updates
        sendsVelocityUpdates - Whether to send velocity information packets as well
        +
        • +
      + + + +
        +
      • +

        registerGlobalEntityID

        +
        public static void registerGlobalEntityID(java.lang.Class<? extends Entity> entityClass,
+                          java.lang.String entityName,
+                          int id)
        +
        • +
      + + + +
        +
      • +

        registerGlobalEntityID

        +
        public static void registerGlobalEntityID(java.lang.Class<? extends Entity> entityClass,
+                          java.lang.String entityName,
+                          int id,
+                          int backgroundEggColour,
+                          int foregroundEggColour)
        +
        • +
      + + + +
        +
      • +

        addSpawn

        +
        public static void addSpawn(java.lang.Class<? extends EntityLiving> entityClass,
+            int weightedProb,
+            int min,
+            int max,
+            EnumCreatureType typeOfCreature,
+            BiomeGenBase... biomes)
        +
        • +
      + + + +
        +
      • +

        addSpawn

        +
        public static void addSpawn(java.lang.String entityName,
+            int weightedProb,
+            int min,
+            int max,
+            EnumCreatureType spawnList,
+            BiomeGenBase... biomes)
        +
        • +
      + + + + + + + +
        +
      • +

        removeSpawn

        +
        public static void removeSpawn(java.lang.String entityName,
+               EnumCreatureType spawnList,
+               BiomeGenBase... biomes)
        +
        • +
      + + + +
        +
      • +

        findGlobalUniqueEntityId

        +
        public static int findGlobalUniqueEntityId()
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        tryTrackingEntity

        +
        public boolean tryTrackingEntity(EntityTracker entityTracker,
+                        Entity entity)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/ExistingSubstitutionException.html b/javadoc/cpw/mods/fml/common/registry/ExistingSubstitutionException.html new file mode 100644 index 0000000..a34ce23 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/ExistingSubstitutionException.html @@ -0,0 +1,250 @@ + + + + + +ExistingSubstitutionException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Class ExistingSubstitutionException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class ExistingSubstitutionException
+extends java.lang.Exception
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ExistingSubstitutionException(java.lang.String fromName, + java.lang.Object toReplace) 
      +
      • +
    + +
      +
    • + + +

      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

      + + + +
        +
      • +

        ExistingSubstitutionException

        +
        public ExistingSubstitutionException(java.lang.String fromName,
+                             java.lang.Object toReplace)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/FMLControlledNamespacedRegistry.html b/javadoc/cpw/mods/fml/common/registry/FMLControlledNamespacedRegistry.html new file mode 100644 index 0000000..a8fb1e4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/FMLControlledNamespacedRegistry.html @@ -0,0 +1,605 @@ + + + + + +FMLControlledNamespacedRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Class FMLControlledNamespacedRegistry<I>

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

      Method Detail

      + + + +
        +
      • +

        addObject

        +
        @Deprecated
+public void addObject(int id,
+                        java.lang.String name,
+                        java.lang.Object thing)
        +
        Deprecated. register through GameRegistry instead.
        +
        Add an object to the registry, trying to use the specified id.
        +
        +
        Overrides:
        +
        addObject in class RegistryNamespaced
        +
        +
        • +
      + + + +
        +
      • +

        putObject

        +
        @Deprecated
+public void putObject(java.lang.Object objName,
+                        java.lang.Object obj)
        +
        Deprecated. register through GameRegistry instead.
        +
        DANGEROUS! EVIL! DO NOT USE!
        +
        +
        Specified by:
        +
        putObject in interface IRegistry
        +
        Overrides:
        +
        putObject in class RegistrySimple
        +
        +
        • +
      + + + +
        +
      • +

        getObject

        +
        public I getObject(java.lang.String name)
        +
        Fetch the object identified by the specified name or the default object. + + For blocks the default object is the air block, for items it's null.
        +
        +
        Overrides:
        +
        getObject in class RegistryNamespaced
        +
        Parameters:
        name - Unique name identifying the object.
        +
        Returns:
        Registered object of the default object if it wasn't found-
        +
        • +
      + + + +
        +
      • +

        getObjectById

        +
        public I getObjectById(int id)
        +
        Fetch the object identified by the specified id or the default object. + + For blocks the default object is the air block, for items it's null.
        +
        +
        Overrides:
        +
        getObjectById in class RegistryNamespaced
        +
        Parameters:
        id - ID identifying the object.
        +
        Returns:
        Registered object of the default object if it wasn't found-
        +
        • +
      + + + +
        +
      • +

        get

        +
        @Deprecated
+public I get(int id)
        +
        Deprecated. use getObjectById instead
        +
        • +
      + + + +
        +
      • +

        get

        +
        @Deprecated
+public I get(java.lang.String name)
        +
        Deprecated. use getObject instead
        +
        • +
      + + + + + +
        +
      • +

        getId

        +
        public int getId(I thing)
        +
        Get the id for the specified object. + + Don't hold onto the id across the world, it's being dynamically re-mapped as needed. + + Usually the name should be used instead of the id, if using the Block/Item object itself is + not suitable for the task.
        +
        Parameters:
        thing - Block/Item object.
        +
        Returns:
        Block/Item id or -1 if it wasn't found.
        +
        • +
      + + + +
        +
      • +

        getRaw

        +
        public I getRaw(int id)
        +
        Get the object identified by the specified id.
        +
        Parameters:
        id - Block/Item id.
        +
        Returns:
        Block/Item object or null if it wasn't found.
        +
        • +
      + + + +
        +
      • +

        getRaw

        +
        public I getRaw(java.lang.String name)
        +
        Get the object identified by the specified name.
        +
        Parameters:
        name - Block/Item name.
        +
        Returns:
        Block/Item object or null if it wasn't found.
        +
        • +
      + + + +
        +
      • +

        containsKey

        +
        public boolean containsKey(java.lang.String name)
        +
        Determine if the registry has an entry for the specified name. + + Aliased names will be resolved as well.
        +
        +
        Overrides:
        +
        containsKey in class RegistryNamespaced
        +
        Parameters:
        name - Object name to check.
        +
        Returns:
        true if a matching entry was found.
        +
        • +
      + + + +
        +
      • +

        getId

        +
        public int getId(java.lang.String itemName)
        +
        Get the id for the specified object. + + Don't hold onto the id across the world, it's being dynamically re-mapped as needed. + + Usually the name should be used instead of the id, if using the Block/Item object itself is + not suitable for the task.
        +
        Parameters:
        itemName - Block/Item registry name.
        +
        Returns:
        Block/Item id or -1 if it wasn't found.
        +
        • +
      + + + +
        +
      • +

        contains

        +
        @Deprecated
+public boolean contains(java.lang.String itemName)
        +
        Deprecated. use containsKey instead
        +
        • +
      + + + +
        +
      • +

        typeSafeIterable

        +
        public java.lang.Iterable<I> typeSafeIterable()
        +
        • +
      + + + +
        +
      • +

        serializeInto

        +
        public void serializeInto(java.util.Map<java.lang.String,java.lang.Integer> idMapping)
        +
        • +
      + + + +
        +
      • +

        getAliases

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

        getDefaultValue

        +
        public I getDefaultValue()
        +
        • +
      + + + + + +
        +
      • +

        getDelegate

        +
        public RegistryDelegate<I> getDelegate(I thing,
+                              java.lang.Class<I> clazz)
        +
        • +
      + + + +
        +
      • +

        serializeSubstitutions

        +
        public void serializeSubstitutions(java.util.Set<java.lang.String> blockSubs)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/GameData.GameDataSnapshot.html b/javadoc/cpw/mods/fml/common/registry/GameData.GameDataSnapshot.html new file mode 100644 index 0000000..3a63025 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/GameData.GameDataSnapshot.html @@ -0,0 +1,296 @@ + + + + + +GameData.GameDataSnapshot (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Class GameData.GameDataSnapshot

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    GameData
    +
    +
    +
    +
    public static class GameData.GameDataSnapshot
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      java.util.Set<java.lang.String>blockSubstitutions 
      java.util.Map<java.lang.String,java.lang.Integer>idMap 
      java.util.Set<java.lang.String>itemSubstitutions 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      GameData.GameDataSnapshot(java.util.Map<java.lang.String,java.lang.Integer> idMap, + java.util.Set<java.lang.String> blockSubstitutions, + java.util.Set<java.lang.String> itemSubstitutions) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        idMap

        +
        public final java.util.Map<java.lang.String,java.lang.Integer> idMap
        +
        • +
      + + + +
        +
      • +

        blockSubstitutions

        +
        public final java.util.Set<java.lang.String> blockSubstitutions
        +
        • +
      + + + +
        +
      • +

        itemSubstitutions

        +
        public final java.util.Set<java.lang.String> itemSubstitutions
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GameData.GameDataSnapshot

        +
        public GameData.GameDataSnapshot(java.util.Map<java.lang.String,java.lang.Integer> idMap,
+                         java.util.Set<java.lang.String> blockSubstitutions,
+                         java.util.Set<java.lang.String> itemSubstitutions)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/GameData.html b/javadoc/cpw/mods/fml/common/registry/GameData.html new file mode 100644 index 0000000..3e0dd75 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/GameData.html @@ -0,0 +1,520 @@ + + + + + +GameData (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Class GameData

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

      Method Detail

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

        findModOwner

        +
        @Deprecated
+public static ModContainer findModOwner(java.lang.String string)
        +
        Deprecated. no replacement planned
        +
        • +
      + + + + + + + +
        +
      • +

        getBlockedIds

        +
        public static int[] getBlockedIds()
        +
        • +
      + + + +
        +
      • +

        dumpRegistry

        +
        public static void dumpRegistry(java.io.File minecraftDir)
        +
        • +
      + + + +
        +
      • +

        fixBrokenIds

        +
        public static void fixBrokenIds(java.util.Map<java.lang.String,java.lang.Integer> dataList,
+                java.util.Set<java.lang.Integer> blockedIds)
        +
        Fix IDs improperly allocated by early versions of the registry, best-effort. + + Items sharing the same ID with a block, but not sharing the same registry name will be + mapped to an unused id. Losing items instead of blocks should minimize the damage.
        +
        Parameters:
        dataList - List containing the IDs to fix
        +
        • +
      + + + +
        +
      • +

        injectWorldIDMap

        +
        public static java.util.List<java.lang.String> injectWorldIDMap(java.util.Map<java.lang.String,java.lang.Integer> dataList,
+                                                java.util.Set<java.lang.String> blockSubstitutions,
+                                                java.util.Set<java.lang.String> itemSubstitutions,
+                                                boolean injectFrozenData,
+                                                boolean isLocalWorld)
        +
        • +
      + + + +
        +
      • +

        injectWorldIDMap

        +
        public static java.util.List<java.lang.String> injectWorldIDMap(java.util.Map<java.lang.String,java.lang.Integer> dataList,
+                                                java.util.Set<java.lang.Integer> blockedIds,
+                                                java.util.Map<java.lang.String,java.lang.String> blockAliases,
+                                                java.util.Map<java.lang.String,java.lang.String> itemAliases,
+                                                java.util.Set<java.lang.String> blockSubstitutions,
+                                                java.util.Set<java.lang.String> itemSubstitutions,
+                                                boolean injectFrozenData,
+                                                boolean isLocalWorld)
        +
        • +
      + + + +
        +
      • +

        processIdRematches

        +
        public static java.util.List<java.lang.String> processIdRematches(java.lang.Iterable<FMLMissingMappingsEvent.MissingMapping> missedMappings,
+                                                  boolean isLocalWorld,
+                                                  GameData gameData,
+                                                  java.util.Map<java.lang.String,java.lang.Integer[]> remaps)
        +
        • +
      + + + +
        +
      • +

        freezeData

        +
        public static void freezeData()
        +
        • +
      + + + +
        +
      • +

        revertToFrozen

        +
        public static void revertToFrozen()
        +
        • +
      + + + + + + + +
        +
      • +

        getMain

        +
        protected static GameData getMain()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/GameRegistry.ObjectHolder.html b/javadoc/cpw/mods/fml/common/registry/GameRegistry.ObjectHolder.html new file mode 100644 index 0000000..cdbe8bb --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/GameRegistry.ObjectHolder.html @@ -0,0 +1,207 @@ + + + + + +GameRegistry.ObjectHolder (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Annotation Type GameRegistry.ObjectHolder

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value={TYPE,FIELD})
+public static @interface GameRegistry.ObjectHolder
    +
    This will cause runtime injection of public static final fields to occur at various points + where mod blocks and items could be subject to change. This allows for dynamic + substitution to occur.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringvalue +
      If used on a class, this represents a modid only.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        If used on a class, this represents a modid only. + If used on a field, it represents a name, which can be abbreviated or complete. + Abbreviated names derive their modid from an enclosing ObjectHolder at the class level.
        +
        Returns:
        either a modid or a name based on the rules above
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/GameRegistry.Type.html b/javadoc/cpw/mods/fml/common/registry/GameRegistry.Type.html new file mode 100644 index 0000000..8e20eb0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/GameRegistry.Type.html @@ -0,0 +1,334 @@ + + + + + +GameRegistry.Type (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Enum GameRegistry.Type

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

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      BLOCK 
      ITEM 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      abstract FMLControlledNamespacedRegistry<?>getRegistry() 
      static GameRegistry.TypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static GameRegistry.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 GameRegistry.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 (GameRegistry.Type c : GameRegistry.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 GameRegistry.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/cpw/mods/fml/common/registry/GameRegistry.UniqueIdentifier.html b/javadoc/cpw/mods/fml/common/registry/GameRegistry.UniqueIdentifier.html new file mode 100644 index 0000000..7650b6e --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/GameRegistry.UniqueIdentifier.html @@ -0,0 +1,345 @@ + + + + + +GameRegistry.UniqueIdentifier (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Class GameRegistry.UniqueIdentifier

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    GameRegistry
    +
    +
    +
    +
    public static final class GameRegistry.UniqueIdentifier
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      java.lang.StringmodId 
      java.lang.Stringname 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      inthashCode() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        modId

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

        name

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

      Constructor Detail

      + + + +
        +
      • +

        GameRegistry.UniqueIdentifier

        +
        public GameRegistry.UniqueIdentifier(java.lang.String string)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        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
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/GameRegistry.html b/javadoc/cpw/mods/fml/common/registry/GameRegistry.html new file mode 100644 index 0000000..03e8e8a --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/GameRegistry.html @@ -0,0 +1,781 @@ + + + + + +GameRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Class GameRegistry

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

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static interface GameRegistry.ObjectHolder +
      This will cause runtime injection of public static final fields to occur at various points + where mod blocks and items could be subject to change.
      +
      static class GameRegistry.Type 
      static class GameRegistry.UniqueIdentifier 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidaddRecipe(IRecipe recipe) 
      static voidaddRecipe(ItemStack output, + java.lang.Object... params) 
      static IRecipeaddShapedRecipe(ItemStack output, + java.lang.Object... params) 
      static voidaddShapelessRecipe(ItemStack output, + java.lang.Object... params) 
      static voidaddSmelting(Block input, + ItemStack output, + float xp) 
      static voidaddSmelting(Item input, + ItemStack output, + float xp) 
      static voidaddSmelting(ItemStack input, + ItemStack output, + float xp) 
      static voidaddSubstitutionAlias(java.lang.String nameToSubstitute, + GameRegistry.Type type, + java.lang.Object object) +
      Add a forced persistent substitution alias for the block or item to another block or item.
      +
      static BlockfindBlock(java.lang.String modId, + java.lang.String name) +
      Look up a mod block in the global "named item list"
      +
      static ItemfindItem(java.lang.String modId, + java.lang.String name) +
      Look up a mod item in the global "named item list"
      +
      static ItemStackfindItemStack(java.lang.String modId, + java.lang.String name, + int stackSize) +
      Lookup an itemstack based on mod and name.
      +
      static GameRegistry.UniqueIdentifierfindUniqueIdentifierFor(Block block) +
      Look up the mod identifier data for a block.
      +
      static GameRegistry.UniqueIdentifierfindUniqueIdentifierFor(Item item) +
      Look up the mod identifier data for an item.
      +
      static voidgenerateWorld(int chunkX, + int chunkZ, + World world, + IChunkProvider chunkGenerator, + IChunkProvider chunkProvider) +
      Callback hook for world gen - if your mod wishes to add extra mod related generation to the world + call this
      +
      static intgetFuelValue(ItemStack itemStack) 
      static BlockregisterBlock(Block block, + java.lang.Class<? extends ItemBlock> itemclass, + java.lang.String name) +
      Register a block with the world, with the specified item class and block name
      +
      static BlockregisterBlock(Block block, + java.lang.Class<? extends ItemBlock> itemclass, + java.lang.String name, + java.lang.Object... itemCtorArgs) +
      Register a block with the world, with the specified item class, block name and owning modId
      +
      static BlockregisterBlock(Block block, + java.lang.Class<? extends ItemBlock> itemclass, + java.lang.String name, + java.lang.String modId, + java.lang.Object... itemCtorArgs) +
      Deprecated.  +
      Use the registerBlock version without the modId parameter instead.
      +
      +
      static BlockregisterBlock(Block block, + java.lang.String name) +
      Register a block with the specified mod specific name
      +
      static voidregisterCustomItemStack(java.lang.String name, + ItemStack itemStack) +
      Manually register a custom item stack with FML for later tracking.
      +
      static voidregisterFuelHandler(IFuelHandler handler) 
      static voidregisterItem(Item item, + java.lang.String name) +
      Register an item with the item registry with a custom name : this allows for easier server->client resolution
      +
      static ItemregisterItem(Item item, + java.lang.String name, + java.lang.String modId) +
      Register the specified Item with a mod specific name : overrides the standard type based name
      +
      static voidregisterTileEntity(java.lang.Class<? extends TileEntity> tileEntityClass, + java.lang.String id) 
      static voidregisterTileEntityWithAlternatives(java.lang.Class<? extends TileEntity> tileEntityClass, + java.lang.String id, + java.lang.String... alternatives) +
      Register a tile entity, with alternative TileEntity identifiers.
      +
      static voidregisterWorldGenerator(IWorldGenerator generator, + int modGenerationWeight) +
      Register a world generator - something that inserts new block types into the world
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        GameRegistry

        +
        public GameRegistry()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerWorldGenerator

        +
        public static void registerWorldGenerator(IWorldGenerator generator,
+                          int modGenerationWeight)
        +
        Register a world generator - something that inserts new block types into the world
        +
        Parameters:
        generator - the generator
        modGenerationWeight - a weight to assign to this generator. Heavy weights tend to sink to the bottom of + list of world generators (i.e. they run later)
        +
        • +
      + + + +
        +
      • +

        generateWorld

        +
        public static void generateWorld(int chunkX,
+                 int chunkZ,
+                 World world,
+                 IChunkProvider chunkGenerator,
+                 IChunkProvider chunkProvider)
        +
        Callback hook for world gen - if your mod wishes to add extra mod related generation to the world + call this
        +
        Parameters:
        chunkX -
        chunkZ -
        world -
        chunkGenerator -
        chunkProvider -
        +
        • +
      + + + +
        +
      • +

        registerItem

        +
        public static void registerItem(Item item,
+                java.lang.String name)
        +
        Register an item with the item registry with a custom name : this allows for easier server->client resolution
        +
        Parameters:
        item - The item to register
        name - The mod-unique name of the item
        +
        • +
      + + + +
        +
      • +

        registerItem

        +
        public static Item registerItem(Item item,
+                java.lang.String name,
+                java.lang.String modId)
        +
        Register the specified Item with a mod specific name : overrides the standard type based name
        +
        Parameters:
        item - The item to register
        name - The mod-unique name to register it as - null will remove a custom name
        modId - deprecated, unused + where one mod should "own" all the blocks of all the mods, null defaults to the active mod
        +
        • +
      + + + +
        +
      • +

        addSubstitutionAlias

        +
        public static void addSubstitutionAlias(java.lang.String nameToSubstitute,
+                        GameRegistry.Type type,
+                        java.lang.Object object)
+                                 throws ExistingSubstitutionException
        +
        Add a forced persistent substitution alias for the block or item to another block or item. This will have + the effect of using the substituted block or item instead of the original, where ever it is + referenced.
        +
        Parameters:
        nameToSubstitute - The name to link to (this is the NEW block or item)
        type - The type (Block or Item)
        object - a NEW instance that is type compatible with the existing instance
        +
        Throws:
        +
        ExistingSubstitutionException - if someone else has already registered an alias either from or to one of the names
        +
        IncompatibleSubstitutionException - if the substitution is incompatible
        +
        • +
      + + + +
        +
      • +

        registerBlock

        +
        public static Block registerBlock(Block block,
+                  java.lang.String name)
        +
        Register a block with the specified mod specific name
        +
        Parameters:
        block - The block to register
        name - The mod-unique name to register it as, will get prefixed by your modid.
        +
        • +
      + + + +
        +
      • +

        registerBlock

        +
        public static Block registerBlock(Block block,
+                  java.lang.Class<? extends ItemBlock> itemclass,
+                  java.lang.String name)
        +
        Register a block with the world, with the specified item class and block name
        +
        Parameters:
        block - The block to register
        itemclass - The item type to register with it : null registers a block without associated item.
        name - The mod-unique name to register it as, will get prefixed by your modid.
        +
        • +
      + + + +
        +
      • +

        registerBlock

        +
        @Deprecated
+public static Block registerBlock(Block block,
+                             java.lang.Class<? extends ItemBlock> itemclass,
+                             java.lang.String name,
+                             java.lang.String modId,
+                             java.lang.Object... itemCtorArgs)
        +
        Deprecated. Use the registerBlock version without the modId parameter instead.
        +
        • +
      + + + +
        +
      • +

        registerBlock

        +
        public static Block registerBlock(Block block,
+                  java.lang.Class<? extends ItemBlock> itemclass,
+                  java.lang.String name,
+                  java.lang.Object... itemCtorArgs)
        +
        Register a block with the world, with the specified item class, block name and owning modId
        +
        Parameters:
        block - The block to register
        itemclass - The item type to register with it : null registers a block without associated item.
        name - The mod-unique name to register it as, will get prefixed by your modid.
        itemCtorArgs - Arguments to pass to the ItemBlock constructor (optional).
        +
        • +
      + + + +
        +
      • +

        addRecipe

        +
        public static void addRecipe(ItemStack output,
+             java.lang.Object... params)
        +
        • +
      + + + +
        +
      • +

        addShapedRecipe

        +
        public static IRecipe addShapedRecipe(ItemStack output,
+                      java.lang.Object... params)
        +
        • +
      + + + +
        +
      • +

        addShapelessRecipe

        +
        public static void addShapelessRecipe(ItemStack output,
+                      java.lang.Object... params)
        +
        • +
      + + + +
        +
      • +

        addRecipe

        +
        public static void addRecipe(IRecipe recipe)
        +
        • +
      + + + +
        +
      • +

        addSmelting

        +
        public static void addSmelting(Block input,
+               ItemStack output,
+               float xp)
        +
        • +
      + + + +
        +
      • +

        addSmelting

        +
        public static void addSmelting(Item input,
+               ItemStack output,
+               float xp)
        +
        • +
      + + + +
        +
      • +

        addSmelting

        +
        public static void addSmelting(ItemStack input,
+               ItemStack output,
+               float xp)
        +
        • +
      + + + +
        +
      • +

        registerTileEntity

        +
        public static void registerTileEntity(java.lang.Class<? extends TileEntity> tileEntityClass,
+                      java.lang.String id)
        +
        • +
      + + + +
        +
      • +

        registerTileEntityWithAlternatives

        +
        public static void registerTileEntityWithAlternatives(java.lang.Class<? extends TileEntity> tileEntityClass,
+                                      java.lang.String id,
+                                      java.lang.String... alternatives)
        +
        Register a tile entity, with alternative TileEntity identifiers. Use with caution! + This method allows for you to "rename" the 'id' of the tile entity.
        +
        Parameters:
        tileEntityClass - The tileEntity class to register
        id - The primary ID, this will be the ID that the tileentity saves as
        alternatives - A list of alternative IDs that will also map to this class. These will never save, but they will load
        +
        • +
      + + + +
        +
      • +

        registerFuelHandler

        +
        public static void registerFuelHandler(IFuelHandler handler)
        +
        • +
      + + + +
        +
      • +

        getFuelValue

        +
        public static int getFuelValue(ItemStack itemStack)
        +
        • +
      + + + +
        +
      • +

        findBlock

        +
        public static Block findBlock(java.lang.String modId,
+              java.lang.String name)
        +
        Look up a mod block in the global "named item list"
        +
        Parameters:
        modId - The modid owning the block
        name - The name of the block itself
        +
        Returns:
        The block or null if not found
        +
        • +
      + + + +
        +
      • +

        findItem

        +
        public static Item findItem(java.lang.String modId,
+            java.lang.String name)
        +
        Look up a mod item in the global "named item list"
        +
        Parameters:
        modId - The modid owning the item
        name - The name of the item itself
        +
        Returns:
        The item or null if not found
        +
        • +
      + + + +
        +
      • +

        registerCustomItemStack

        +
        public static void registerCustomItemStack(java.lang.String name,
+                           ItemStack itemStack)
        +
        Manually register a custom item stack with FML for later tracking. It is automatically scoped with the active modid
        +
        Parameters:
        name - The name to register it under
        itemStack - The itemstack to register
        +
        • +
      + + + +
        +
      • +

        findItemStack

        +
        public static ItemStack findItemStack(java.lang.String modId,
+                      java.lang.String name,
+                      int stackSize)
        +
        Lookup an itemstack based on mod and name. It will create "default" itemstacks from blocks and items if no + explicit itemstack is found. + + If it is built from a block, the metadata is by default the "wildcard" value. + + Custom itemstacks can be dumped from minecraft by setting the system property fml.dumpRegistry to true + (-Dfml.dumpRegistry=true on the command line will work)
        +
        Parameters:
        modId - The modid of the stack owner
        name - The name of the stack
        stackSize - The size of the stack returned
        +
        Returns:
        The custom itemstack or null if no such itemstack was found
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/IEntityAdditionalSpawnData.html b/javadoc/cpw/mods/fml/common/registry/IEntityAdditionalSpawnData.html new file mode 100644 index 0000000..5c947c2 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/IEntityAdditionalSpawnData.html @@ -0,0 +1,229 @@ + + + + + +IEntityAdditionalSpawnData (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Interface IEntityAdditionalSpawnData

+
+
+
+
    +
  • +
    +
    +
    public interface IEntityAdditionalSpawnData
    +
    A interface for Entities that need extra information to be communicated + between the server and client when they are spawned.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidreadSpawnData(io.netty.buffer.ByteBuf additionalData) +
      Called by the client when it receives a Entity spawn packet.
      +
      voidwriteSpawnData(io.netty.buffer.ByteBuf buffer) +
      Called by the server when constructing the spawn packet.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        writeSpawnData

        +
        void writeSpawnData(io.netty.buffer.ByteBuf buffer)
        +
        Called by the server when constructing the spawn packet. + Data should be added to the provided stream.
        +
        Parameters:
        buffer - The packet data stream
        +
        • +
      + + + +
        +
      • +

        readSpawnData

        +
        void readSpawnData(io.netty.buffer.ByteBuf additionalData)
        +
        Called by the client when it receives a Entity spawn packet. + Data should be read out of the stream in the same way as it was written.
        +
        Parameters:
        data - The packet data stream
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/IThrowableEntity.html b/javadoc/cpw/mods/fml/common/registry/IThrowableEntity.html new file mode 100644 index 0000000..f7a191f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/IThrowableEntity.html @@ -0,0 +1,227 @@ + + + + + +IThrowableEntity (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Interface IThrowableEntity

+
+
+
+
    +
  • +
    +
    +
    public interface IThrowableEntity
    +
    This interface should be implemented by an Entity that can be 'thrown', like snowballs. + This was created to mimic ModLoaderMP's 'owner' functionality.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      EntitygetThrower() +
      Gets the entity that threw/created this entity.
      +
      voidsetThrower(Entity entity) +
      Sets the entity that threw/created this entity.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getThrower

        +
        Entity getThrower()
        +
        Gets the entity that threw/created this entity.
        +
        Returns:
        The owner instance, Null if none.
        +
        • +
      + + + +
        +
      • +

        setThrower

        +
        void setThrower(Entity entity)
        +
        Sets the entity that threw/created this entity.
        +
        Parameters:
        entity - The new thrower/creator.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/IncompatibleSubstitutionException.html b/javadoc/cpw/mods/fml/common/registry/IncompatibleSubstitutionException.html new file mode 100644 index 0000000..af182e0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/IncompatibleSubstitutionException.html @@ -0,0 +1,257 @@ + + + + + +IncompatibleSubstitutionException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Class IncompatibleSubstitutionException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class IncompatibleSubstitutionException
+extends java.lang.RuntimeException
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      IncompatibleSubstitutionException(java.lang.String fromName, + java.lang.Object replacement, + java.lang.Object original) 
      +
      • +
    + +
      +
    • + + +

      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

      + + + +
        +
      • +

        IncompatibleSubstitutionException

        +
        public IncompatibleSubstitutionException(java.lang.String fromName,
+                                 java.lang.Object replacement,
+                                 java.lang.Object original)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/LanguageRegistry.html b/javadoc/cpw/mods/fml/common/registry/LanguageRegistry.html new file mode 100644 index 0000000..ab631ff --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/LanguageRegistry.html @@ -0,0 +1,498 @@ + + + + + +LanguageRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Class LanguageRegistry

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

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidaddName(java.lang.Object objectToName, + java.lang.String name) +
      Deprecated. 
      +
      voidaddNameForObject(java.lang.Object objectToName, + java.lang.String lang, + java.lang.String name) +
      Deprecated. 
      +
      voidaddStringLocalization(java.util.Properties langPackAdditions) +
      Deprecated. 
      +
      voidaddStringLocalization(java.util.Properties langPackAdditions, + java.lang.String lang) +
      Deprecated. 
      +
      voidaddStringLocalization(java.lang.String key, + java.lang.String value) +
      Deprecated. 
      +
      voidaddStringLocalization(java.lang.String key, + java.lang.String lang, + java.lang.String value) +
      Deprecated. 
      +
      java.lang.StringgetStringLocalization(java.lang.String key) 
      java.lang.StringgetStringLocalization(java.lang.String key, + java.lang.String lang) 
      voidinjectLanguage(java.lang.String language, + java.util.HashMap<java.lang.String,java.lang.String> parsedLangFile) 
      static LanguageRegistryinstance() 
      voidloadLanguagesFor(ModContainer container, + Side side) 
      voidloadLocalization(java.lang.String localizationFile, + java.lang.String lang, + boolean isXML) +
      Deprecated. 
      +
      voidloadLocalization(java.net.URL localizationFile, + java.lang.String lang, + boolean isXML) +
      Deprecated. 
      +
      voidmergeLanguageTable(java.util.Map field_135032_a, + java.lang.String lang) +
      Deprecated. 
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        LanguageRegistry

        +
        public LanguageRegistry()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getStringLocalization

        +
        public java.lang.String getStringLocalization(java.lang.String key)
        +
        • +
      + + + +
        +
      • +

        getStringLocalization

        +
        public java.lang.String getStringLocalization(java.lang.String key,
+                                     java.lang.String lang)
        +
        • +
      + + + +
        +
      • +

        addStringLocalization

        +
        @Deprecated
+public void addStringLocalization(java.lang.String key,
+                                    java.lang.String value)
        +
        Deprecated. 
        +
        Deprecated for removal in 1.8. Use the assets lang system
        +
        • +
      + + + +
        +
      • +

        addStringLocalization

        +
        @Deprecated
+public void addStringLocalization(java.lang.String key,
+                                    java.lang.String lang,
+                                    java.lang.String value)
        +
        Deprecated. 
        +
        Deprecated for removal in 1.8. Use the assets lang system
        +
        • +
      + + + +
        +
      • +

        addStringLocalization

        +
        @Deprecated
+public void addStringLocalization(java.util.Properties langPackAdditions)
        +
        Deprecated. 
        +
        Deprecated for removal in 1.8. Use the assets lang system
        +
        • +
      + + + +
        +
      • +

        addStringLocalization

        +
        @Deprecated
+public void addStringLocalization(java.util.Properties langPackAdditions,
+                                    java.lang.String lang)
        +
        Deprecated. 
        +
        Deprecated for removal in 1.8. Use the assets lang system
        +
        • +
      + + + +
        +
      • +

        addNameForObject

        +
        @Deprecated
+public void addNameForObject(java.lang.Object objectToName,
+                               java.lang.String lang,
+                               java.lang.String name)
        +
        Deprecated. 
        +
        Deprecated for removal in 1.8. Use the assets lang system
        +
        • +
      + + + +
        +
      • +

        addName

        +
        @Deprecated
+public static void addName(java.lang.Object objectToName,
+                      java.lang.String name)
        +
        Deprecated. 
        +
        Deprecated for removal in 1.8. Use the assets lang system
        +
        • +
      + + + +
        +
      • +

        mergeLanguageTable

        +
        @Deprecated
+public void mergeLanguageTable(java.util.Map field_135032_a,
+                                 java.lang.String lang)
        +
        Deprecated. 
        +
        Deprecated for removal in 1.8. Use the assets lang system
        +
        • +
      + + + +
        +
      • +

        loadLocalization

        +
        @Deprecated
+public void loadLocalization(java.lang.String localizationFile,
+                               java.lang.String lang,
+                               boolean isXML)
        +
        Deprecated. 
        +
        Deprecated for removal in 1.8. Use the assets lang system
        +
        • +
      + + + +
        +
      • +

        loadLocalization

        +
        @Deprecated
+public void loadLocalization(java.net.URL localizationFile,
+                               java.lang.String lang,
+                               boolean isXML)
        +
        Deprecated. 
        +
        Deprecated for removal in 1.8. Use the assets lang system
        +
        • +
      + + + +
        +
      • +

        injectLanguage

        +
        public void injectLanguage(java.lang.String language,
+                  java.util.HashMap<java.lang.String,java.lang.String> parsedLangFile)
        +
        • +
      + + + +
        +
      • +

        loadLanguagesFor

        +
        public void loadLanguagesFor(ModContainer container,
+                    Side side)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/ObjectHolderRegistry.html b/javadoc/cpw/mods/fml/common/registry/ObjectHolderRegistry.html new file mode 100644 index 0000000..32131ac --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/ObjectHolderRegistry.html @@ -0,0 +1,332 @@ + + + + + +ObjectHolderRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Enum ObjectHolderRegistry

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

      Enum Constant Summary

      + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      INSTANCE 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidapplyObjectHolders() 
      voidfindObjectHolders(ASMDataTable table) 
      static ObjectHolderRegistryvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ObjectHolderRegistry[]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 ObjectHolderRegistry[] 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 (ObjectHolderRegistry c : ObjectHolderRegistry.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ObjectHolderRegistry 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
        +
        • +
      + + + +
        +
      • +

        findObjectHolders

        +
        public void findObjectHolders(ASMDataTable table)
        +
        • +
      + + + +
        +
      • +

        applyObjectHolders

        +
        public void applyObjectHolders()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/RegistryDelegate.Delegate.html b/javadoc/cpw/mods/fml/common/registry/RegistryDelegate.Delegate.html new file mode 100644 index 0000000..1a34fab --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/RegistryDelegate.Delegate.html @@ -0,0 +1,368 @@ + + + + + +RegistryDelegate.Delegate (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Class RegistryDelegate.Delegate<T>

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

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      RegistryDelegate.Delegate(T referant, + java.lang.Class<T> type) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      Tget() +
      Get the referent pointed at by this delegate.
      +
      inthashCode() 
      java.lang.Stringname() +
      Get the name of this delegate.
      +
      java.lang.Class<T>type() +
      Get the delegate type.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + + + +
        +
      • +

        RegistryDelegate.Delegate

        +
        public RegistryDelegate.Delegate(T referant,
+                         java.lang.Class<T> type)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        public T get()
        +
        Description copied from interface: RegistryDelegate
        +
        Get the referent pointed at by this delegate. This will be the currently active item or block, and will change + as world saves come and go. Note that item.delegate.get() may NOT be the same object as item, due to item and + block substitution.
        +
        +
        Specified by:
        +
        get in interface RegistryDelegate<T>
        +
        Returns:
        The referred object
        +
        • +
      + + + +
        +
      • +

        name

        +
        public java.lang.String name()
        +
        Description copied from interface: RegistryDelegate
        +
        Get the name of this delegate. This is completely static after registration has completed and will never change.
        +
        +
        Specified by:
        +
        name in interface RegistryDelegate<T>
        +
        Returns:
        The name
        +
        • +
      + + + +
        +
      • +

        type

        +
        public java.lang.Class<T> type()
        +
        Description copied from interface: RegistryDelegate
        +
        Get the delegate type. It will be Item or Block.
        +
        +
        Specified by:
        +
        type in interface RegistryDelegate<T>
        +
        Returns:
        The type of delegate
        +
        • +
      + + + +
        +
      • +

        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
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/RegistryDelegate.html b/javadoc/cpw/mods/fml/common/registry/RegistryDelegate.html new file mode 100644 index 0000000..0ca12ec --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/RegistryDelegate.html @@ -0,0 +1,271 @@ + + + + + +RegistryDelegate (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Interface RegistryDelegate<T>

+
+
+
+
    +
  • +
    Type Parameters:
    T - the type of thing we're holding onto
    +
    +
    All Known Implementing Classes:
    +
    RegistryDelegate.Delegate
    +
    +
    +
    +
    public interface RegistryDelegate<T>
    +
    A registry delegate for holding references to items or blocks + These should be safe to use in things like lists though aliased items and blocks will not + have object identity with respect to their delegate.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeInterface and Description
      static class RegistryDelegate.Delegate<T> 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Tget() +
      Get the referent pointed at by this delegate.
      +
      java.lang.Stringname() +
      Get the name of this delegate.
      +
      java.lang.Class<T>type() +
      Get the delegate type.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        T get()
        +
        Get the referent pointed at by this delegate. This will be the currently active item or block, and will change + as world saves come and go. Note that item.delegate.get() may NOT be the same object as item, due to item and + block substitution.
        +
        Returns:
        The referred object
        +
        • +
      + + + +
        +
      • +

        name

        +
        java.lang.String name()
        +
        Get the name of this delegate. This is completely static after registration has completed and will never change.
        +
        Returns:
        The name
        +
        • +
      + + + +
        +
      • +

        type

        +
        java.lang.Class<T> type()
        +
        Get the delegate type. It will be Item or Block.
        +
        Returns:
        The type of delegate
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/VillagerRegistry.IVillageCreationHandler.html b/javadoc/cpw/mods/fml/common/registry/VillagerRegistry.IVillageCreationHandler.html new file mode 100644 index 0000000..02d3bbe --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/VillagerRegistry.IVillageCreationHandler.html @@ -0,0 +1,265 @@ + + + + + +VillagerRegistry.IVillageCreationHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Interface VillagerRegistry.IVillageCreationHandler

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    VillagerRegistry
    +
    +
    +
    +
    public static interface VillagerRegistry.IVillageCreationHandler
    +
    Allow access to the StructureVillagePieces array controlling new village + creation so you can insert your own new village pieces
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getComponentClass

        +
        java.lang.Class<?> getComponentClass()
        +
        The class of the root structure component to add to the village
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/VillagerRegistry.IVillageTradeHandler.html b/javadoc/cpw/mods/fml/common/registry/VillagerRegistry.IVillageTradeHandler.html new file mode 100644 index 0000000..7df54e0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/VillagerRegistry.IVillageTradeHandler.html @@ -0,0 +1,219 @@ + + + + + +VillagerRegistry.IVillageTradeHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Interface VillagerRegistry.IVillageTradeHandler

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    VillagerRegistry
    +
    +
    +
    +
    public static interface VillagerRegistry.IVillageTradeHandler
    +
    Allow access to the MerchantRecipeList for a villager type for manipulation
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        manipulateTradesForVillager

        +
        void manipulateTradesForVillager(EntityVillager villager,
+                               MerchantRecipeList recipeList,
+                               java.util.Random random)
        +
        Called to allow changing the content of the MerchantRecipeList for the villager + supplied during creation
        +
        Parameters:
        villager -
        recipeList -
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/VillagerRegistry.html b/javadoc/cpw/mods/fml/common/registry/VillagerRegistry.html new file mode 100644 index 0000000..2ae95e0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/VillagerRegistry.html @@ -0,0 +1,525 @@ + + + + + +VillagerRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.registry
+

Class VillagerRegistry

+
+
+ +
+
    +
  • +
    +
    +
    public class VillagerRegistry
+extends java.lang.Object
    +
    Registry for villager trading control
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        VillagerRegistry

        +
        public VillagerRegistry()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        registerVillagerId

        +
        public void registerVillagerId(int id)
        +
        Register your villager id
        +
        Parameters:
        id -
        +
        • +
      + + + +
        +
      • +

        registerVillagerSkin

        +
        public void registerVillagerSkin(int villagerId,
+                        ResourceLocation villagerSkin)
        +
        Register a new skin for a villager type
        +
        Parameters:
        villagerId -
        villagerSkin -
        +
        • +
      + + + + + + + +
        +
      • +

        registerVillageTradeHandler

        +
        public void registerVillageTradeHandler(int villagerId,
+                               VillagerRegistry.IVillageTradeHandler handler)
        +
        Register a new villager trading handler for the specified villager type
        +
        Parameters:
        villagerId -
        handler -
        +
        • +
      + + + +
        +
      • +

        getVillagerSkin

        +
        public static ResourceLocation getVillagerSkin(int villagerType,
+                               ResourceLocation defaultSkin)
        +
        Callback to setup new villager types
        +
        Parameters:
        villagerType -
        defaultSkin -
        +
        • +
      + + + +
        +
      • +

        getRegisteredVillagers

        +
        public static java.util.Collection<java.lang.Integer> getRegisteredVillagers()
        +
        Returns a list of all added villager types
        +
        Returns:
        newVillagerIds
        +
        • +
      + + + +
        +
      • +

        manageVillagerTrades

        +
        public static void manageVillagerTrades(MerchantRecipeList recipeList,
+                        EntityVillager villager,
+                        int villagerType,
+                        java.util.Random random)
        +
        Callback to handle trade setup for villagers
        +
        Parameters:
        recipeList -
        villager -
        villagerType -
        random -
        +
        • +
      + + + +
        +
      • +

        addExtraVillageComponents

        +
        public static void addExtraVillageComponents(java.util.ArrayList components,
+                             java.util.Random random,
+                             int i)
        +
        • +
      + + + + + + + +
        +
      • +

        addEmeraldBuyRecipe

        +
        public static void addEmeraldBuyRecipe(EntityVillager villager,
+                       MerchantRecipeList list,
+                       java.util.Random random,
+                       Item item,
+                       float chance,
+                       int min,
+                       int max)
        +
        • +
      + + + +
        +
      • +

        addEmeraldSellRecipe

        +
        public static void addEmeraldSellRecipe(EntityVillager villager,
+                        MerchantRecipeList list,
+                        java.util.Random random,
+                        Item item,
+                        float chance,
+                        int min,
+                        int max)
        +
        • +
      + + + +
        +
      • +

        applyRandomTrade

        +
        public static void applyRandomTrade(EntityVillager villager,
+                    java.util.Random rand)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/package-frame.html b/javadoc/cpw/mods/fml/common/registry/package-frame.html new file mode 100644 index 0000000..21a5bc6 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/package-frame.html @@ -0,0 +1,49 @@ + + + + + +cpw.mods.fml.common.registry (Forge API) + + + + +

cpw.mods.fml.common.registry

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +

Exceptions

+ +

Annotation Types

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/registry/package-summary.html b/javadoc/cpw/mods/fml/common/registry/package-summary.html new file mode 100644 index 0000000..4b15115 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/package-summary.html @@ -0,0 +1,268 @@ + + + + + +cpw.mods.fml.common.registry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.registry

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/registry/package-tree.html b/javadoc/cpw/mods/fml/common/registry/package-tree.html new file mode 100644 index 0000000..6b23ed2 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/registry/package-tree.html @@ -0,0 +1,182 @@ + + + + + +cpw.mods.fml.common.registry Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.registry

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Annotation Type Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/toposort/ModSorter.html b/javadoc/cpw/mods/fml/common/toposort/ModSorter.html new file mode 100644 index 0000000..6e7021d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/toposort/ModSorter.html @@ -0,0 +1,256 @@ + + + + + +ModSorter (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.toposort
+

Class ModSorter

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

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ModSorter(java.util.List<ModContainer> modList, + java.util.Map<java.lang.String,ModContainer> nameLookup) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.util.List<ModContainer>sort() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModSorter

        +
        public ModSorter(java.util.List<ModContainer> modList,
+         java.util.Map<java.lang.String,ModContainer> nameLookup)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/toposort/ModSortingException.SortingExceptionData.html b/javadoc/cpw/mods/fml/common/toposort/ModSortingException.SortingExceptionData.html new file mode 100644 index 0000000..35a40a9 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/toposort/ModSortingException.SortingExceptionData.html @@ -0,0 +1,275 @@ + + + + + +ModSortingException.SortingExceptionData (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.toposort
+

Class ModSortingException.SortingExceptionData<T>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ModSortingException
    +
    +
    +
    +
    public class ModSortingException.SortingExceptionData<T>
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      TgetFirstBadNode() 
      java.util.Set<T>getVisitedNodes() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + + + +
        +
      • +

        ModSortingException.SortingExceptionData

        +
        public ModSortingException.SortingExceptionData(T node,
+                                        java.util.Set<T> visitedNodes)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFirstBadNode

        +
        public T getFirstBadNode()
        +
        • +
      + + + +
        +
      • +

        getVisitedNodes

        +
        public java.util.Set<T> getVisitedNodes()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/toposort/ModSortingException.html b/javadoc/cpw/mods/fml/common/toposort/ModSortingException.html new file mode 100644 index 0000000..5e73a84 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/toposort/ModSortingException.html @@ -0,0 +1,306 @@ + + + + + +ModSortingException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.toposort
+

Class ModSortingException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class ModSortingException
+extends java.lang.RuntimeException
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ModSortingException(java.lang.String string, + T node, + java.util.Set<T> visitedNodes) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <T> ModSortingException.SortingExceptionData<T>getExceptionData() 
      +
        +
      • + + +

        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

      + + + + + +
        +
      • +

        ModSortingException

        +
        public ModSortingException(java.lang.String string,
+                   T node,
+                   java.util.Set<T> visitedNodes)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/toposort/TopologicalSort.DirectedGraph.html b/javadoc/cpw/mods/fml/common/toposort/TopologicalSort.DirectedGraph.html new file mode 100644 index 0000000..dd883ac --- /dev/null +++ b/javadoc/cpw/mods/fml/common/toposort/TopologicalSort.DirectedGraph.html @@ -0,0 +1,391 @@ + + + + + +TopologicalSort.DirectedGraph (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.toposort
+

Class TopologicalSort.DirectedGraph<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<T>
    +
    +
    +
    Enclosing class:
    +
    TopologicalSort
    +
    +
    +
    +
    public static class TopologicalSort.DirectedGraph<T>
+extends java.lang.Object
+implements java.lang.Iterable<T>
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddEdge(T from, + T to) 
      booleanaddNode(T node) 
      booleanedgeExists(T from, + T to) 
      java.util.Set<T>edgesFrom(T from) 
      booleanisEmpty() 
      java.util.Iterator<T>iterator() 
      voidremoveEdge(T from, + T to) 
      intsize() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TopologicalSort.DirectedGraph

        +
        public TopologicalSort.DirectedGraph()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        addNode

        +
        public boolean addNode(T node)
        +
        • +
      + + + + + +
        +
      • +

        addEdge

        +
        public void addEdge(T from,
+           T to)
        +
        • +
      + + + + + +
        +
      • +

        removeEdge

        +
        public void removeEdge(T from,
+              T to)
        +
        • +
      + + + + + +
        +
      • +

        edgeExists

        +
        public boolean edgeExists(T from,
+                 T to)
        +
        • +
      + + + + + +
        +
      • +

        edgesFrom

        +
        public java.util.Set<T> edgesFrom(T from)
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<T> iterator()
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<T>
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/toposort/TopologicalSort.html b/javadoc/cpw/mods/fml/common/toposort/TopologicalSort.html new file mode 100644 index 0000000..27519c3 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/toposort/TopologicalSort.html @@ -0,0 +1,321 @@ + + + + + +TopologicalSort (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.toposort
+

Class TopologicalSort

+
+
+ +
+
    +
  • +
    +
    +
    public class TopologicalSort
+extends java.lang.Object
    +
    Topological sort for mod loading + + Based on a variety of sources, including http://keithschwarz.com/interesting/code/?dir=topological-sort
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TopologicalSort

        +
        public TopologicalSort()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/toposort/package-frame.html b/javadoc/cpw/mods/fml/common/toposort/package-frame.html new file mode 100644 index 0000000..a6fd1f8 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/toposort/package-frame.html @@ -0,0 +1,25 @@ + + + + + +cpw.mods.fml.common.toposort (Forge API) + + + + +

cpw.mods.fml.common.toposort

+
+

Classes

+ +

Exceptions

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/toposort/package-summary.html b/javadoc/cpw/mods/fml/common/toposort/package-summary.html new file mode 100644 index 0000000..215f949 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/toposort/package-summary.html @@ -0,0 +1,158 @@ + + + + + +cpw.mods.fml.common.toposort (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.toposort

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/toposort/package-tree.html b/javadoc/cpw/mods/fml/common/toposort/package-tree.html new file mode 100644 index 0000000..0ba4b4e --- /dev/null +++ b/javadoc/cpw/mods/fml/common/toposort/package-tree.html @@ -0,0 +1,142 @@ + + + + + +cpw.mods.fml.common.toposort Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.toposort

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/versioning/ArtifactVersion.html b/javadoc/cpw/mods/fml/common/versioning/ArtifactVersion.html new file mode 100644 index 0000000..97c41f7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/versioning/ArtifactVersion.html @@ -0,0 +1,261 @@ + + + + + +ArtifactVersion (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.versioning
+

Interface ArtifactVersion

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.Comparable<ArtifactVersion>
    +
    +
    +
    All Known Implementing Classes:
    +
    DefaultArtifactVersion
    +
    +
    +
    +
    public interface ArtifactVersion
+extends java.lang.Comparable<ArtifactVersion>
    +
    Describes an artifact version in terms of its components, converts it to/from a string and + compares two versions.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLabel

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

        getVersionString

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

        getRangeString

        +
        java.lang.String getRangeString()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/versioning/ComparableVersion.html b/javadoc/cpw/mods/fml/common/versioning/ComparableVersion.html new file mode 100644 index 0000000..e3461ae --- /dev/null +++ b/javadoc/cpw/mods/fml/common/versioning/ComparableVersion.html @@ -0,0 +1,351 @@ + + + + + +ComparableVersion (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.versioning
+

Class ComparableVersion

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<ComparableVersion>
    +
    +
    +
    +
    public class ComparableVersion
+extends java.lang.Object
+implements java.lang.Comparable<ComparableVersion>
    +
    Generic implementation of version comparison. + +

    Features: +

      +
    • mixing of '-' (dash) and '.' (dot) separators,
      • +
    • transition between characters and digits also constitutes a separator: + 1.0alpha1 => [1, 0, alpha, 1]
      • +
    • unlimited number of version components,
      • +
    • version components in the text can be digits or strings,
      • +
    • strings are checked for well-known qualifiers and the qualifier ordering is used for version ordering. + Well-known qualifiers (case insensitive) are:
        +
      • snapshot
        • +
      • alpha or a
        • +
      • beta or b
        • +
      • milestone or m
        • +
      • rc or cr
        • +
      • (the empty string) or ga or final
        • +
      • sp
        • +
      + Unknown qualifiers are considered after known qualifiers, with lexical order (always case insensitive), +
      • +
    • a dash usually precedes a qualifier, and is always less important than something preceded with a dot.
      • +

    +
    See Also:
    "Versioning" on Maven Wiki
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ComparableVersion(java.lang.String version) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intcompareTo(ComparableVersion o) 
      booleanequals(java.lang.Object o) 
      inthashCode() 
      voidparseVersion(java.lang.String version) 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ComparableVersion

        +
        public ComparableVersion(java.lang.String version)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parseVersion

        +
        public final void parseVersion(java.lang.String version)
        +
        • +
      + + + + + + + +
        +
      • +

        toString

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

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/versioning/DefaultArtifactVersion.html b/javadoc/cpw/mods/fml/common/versioning/DefaultArtifactVersion.html new file mode 100644 index 0000000..8e4308f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/versioning/DefaultArtifactVersion.html @@ -0,0 +1,420 @@ + + + + + +DefaultArtifactVersion (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.versioning
+

Class DefaultArtifactVersion

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

      Constructor Detail

      + + + +
        +
      • +

        DefaultArtifactVersion

        +
        public DefaultArtifactVersion(java.lang.String versionNumber)
        +
        • +
      + + + +
        +
      • +

        DefaultArtifactVersion

        +
        public DefaultArtifactVersion(java.lang.String label,
+                      VersionRange range)
        +
        • +
      + + + +
        +
      • +

        DefaultArtifactVersion

        +
        public DefaultArtifactVersion(java.lang.String label,
+                      java.lang.String version)
        +
        • +
      + + + +
        +
      • +

        DefaultArtifactVersion

        +
        public DefaultArtifactVersion(java.lang.String string,
+                      boolean unbounded)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/versioning/InvalidVersionSpecificationException.html b/javadoc/cpw/mods/fml/common/versioning/InvalidVersionSpecificationException.html new file mode 100644 index 0000000..4b82336 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/versioning/InvalidVersionSpecificationException.html @@ -0,0 +1,249 @@ + + + + + +InvalidVersionSpecificationException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.versioning
+

Class InvalidVersionSpecificationException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class InvalidVersionSpecificationException
+extends java.lang.Exception
    +
    Occurs when a version is invalid.
    +
    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

      + + + +
        +
      • +

        InvalidVersionSpecificationException

        +
        public InvalidVersionSpecificationException(java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/versioning/Restriction.html b/javadoc/cpw/mods/fml/common/versioning/Restriction.html new file mode 100644 index 0000000..808a953 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/versioning/Restriction.html @@ -0,0 +1,400 @@ + + + + + +Restriction (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.versioning
+

Class Restriction

+
+
+ +
+
    +
  • +
    +
    +
    public class Restriction
+extends java.lang.Object
    +
    Describes a restriction in versioning.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        EVERYTHING

        +
        public static final Restriction EVERYTHING
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Restriction

        +
        public Restriction(ArtifactVersion lowerBound,
+           boolean lowerBoundInclusive,
+           ArtifactVersion upperBound,
+           boolean upperBoundInclusive)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        isLowerBoundInclusive

        +
        public boolean isLowerBoundInclusive()
        +
        • +
      + + + + + + + +
        +
      • +

        isUpperBoundInclusive

        +
        public boolean isUpperBoundInclusive()
        +
        • +
      + + + +
        +
      • +

        containsVersion

        +
        public boolean containsVersion(ArtifactVersion version)
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/versioning/VersionParser.html b/javadoc/cpw/mods/fml/common/versioning/VersionParser.html new file mode 100644 index 0000000..1abf5a8 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/versioning/VersionParser.html @@ -0,0 +1,289 @@ + + + + + +VersionParser (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.versioning
+

Class VersionParser

+
+
+ +
+
    +
  • +
    +
    +
    public class VersionParser
+extends java.lang.Object
    +
    Parses version strings according to the specification here: + http://docs.codehaus.org/display/MAVEN/Versioning + and allows for comparison of versions based on that document. + Bounded version specifications are defined as + http://maven.apache.org/plugins/maven-enforcer-plugin/rules/versionRanges.html + + Borrows heavily from maven version range management code
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        VersionParser

        +
        public VersionParser()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/versioning/VersionRange.html b/javadoc/cpw/mods/fml/common/versioning/VersionRange.html new file mode 100644 index 0000000..c6600c1 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/versioning/VersionRange.html @@ -0,0 +1,479 @@ + + + + + +VersionRange (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.versioning
+

Class VersionRange

+
+
+ +
+
    +
  • +
    +
    +
    public class VersionRange
+extends java.lang.Object
    +
    Construct a version range from a specification.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRecommendedVersion

        +
        public ArtifactVersion getRecommendedVersion()
        +
        • +
      + + + +
        +
      • +

        getRestrictions

        +
        public java.util.List<Restriction> getRestrictions()
        +
        • +
      + + + + + + + +
        +
      • +

        newRange

        +
        public static VersionRange newRange(ArtifactVersion version,
+                    java.util.List<Restriction> restrictions)
        +
        Factory method, for custom versioning schemes
        +
        Parameters:
        version - version
        restrictions - restriction list
        +
        Returns:
        a new version range
        +
        • +
      + + + +
        +
      • +

        createFromVersionSpec

        +
        public static VersionRange createFromVersionSpec(java.lang.String spec)
+                                          throws InvalidVersionSpecificationException
        +
        Create a version range from a string representation +

        + Some spec examples are +

          +
        • 1.0 Version 1.0
          • +
        • [1.0,2.0) Versions 1.0 (included) to 2.0 (not included)
          • +
        • [1.0,2.0] Versions 1.0 to 2.0 (both included)
          • +
        • [1.5,) Versions 1.5 and higher
          • +
        • (,1.0],[1.2,) Versions up to 1.0 (included) and 1.2 or higher
          • +
        +
        Parameters:
        spec - string representation of a version or version range
        +
        Returns:
        a new VersionRange object that represents the spec
        +
        Throws:
        +
        InvalidVersionSpecificationException
        +
        • +
      + + + + + + + +
        +
      • +

        restrict

        +
        public VersionRange restrict(VersionRange restriction)
        +
        Creates and returns a new VersionRange that is a restriction of this + version range and the specified version range. +

        + Note: Precedence is given to the recommended version from this version range over the + recommended version from the specified version range. +

        +
        Parameters:
        restriction - the VersionRange that will be used to restrict this version + range.
        +
        Returns:
        the VersionRange that is a restriction of this version range and the + specified version range. +

        + The restrictions of the returned version range will be an intersection of the restrictions + of this version range and the specified version range if both version ranges have + restrictions. Otherwise, the restrictions on the returned range will be empty. +

        +

        + The recommended version of the returned version range will be the recommended version of + this version range, provided that ranges falls within the intersected restrictions. If + the restrictions are empty, this version range's recommended version is used if it is not + null. If it is null, the specified version range's recommended + version is used (provided it is non-null). If no recommended version can be + obtained, the returned version range's recommended version is set to null. +

        +
        Throws:
        +
        java.lang.NullPointerException - if the specified VersionRange is + null.
        +
        • +
      + + + +
        +
      • +

        toString

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

        containsVersion

        +
        public boolean containsVersion(ArtifactVersion version)
        +
        • +
      + + + +
        +
      • +

        hasRestrictions

        +
        public boolean hasRestrictions()
        +
        • +
      + + + +
        +
      • +

        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
        +
        +
        • +
      + + + +
        +
      • +

        isUnboundedAbove

        +
        public boolean isUnboundedAbove()
        +
        • +
      + + + +
        +
      • +

        getLowerBoundString

        +
        public java.lang.String getLowerBoundString()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/versioning/package-frame.html b/javadoc/cpw/mods/fml/common/versioning/package-frame.html new file mode 100644 index 0000000..521070d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/versioning/package-frame.html @@ -0,0 +1,31 @@ + + + + + +cpw.mods.fml.common.versioning (Forge API) + + + + +

cpw.mods.fml.common.versioning

+
+

Interfaces

+ +

Classes

+ +

Exceptions

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/versioning/package-summary.html b/javadoc/cpw/mods/fml/common/versioning/package-summary.html new file mode 100644 index 0000000..08d3e40 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/versioning/package-summary.html @@ -0,0 +1,192 @@ + + + + + +cpw.mods.fml.common.versioning (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.versioning

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/versioning/package-tree.html b/javadoc/cpw/mods/fml/common/versioning/package-tree.html new file mode 100644 index 0000000..aaaf832 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/versioning/package-tree.html @@ -0,0 +1,147 @@ + + + + + +cpw.mods.fml.common.versioning Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.versioning

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/CoreModManager.html b/javadoc/cpw/mods/fml/relauncher/CoreModManager.html new file mode 100644 index 0000000..4c898e9 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/CoreModManager.html @@ -0,0 +1,336 @@ + + + + + +CoreModManager (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class CoreModManager

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

      Constructor Summary

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

      Constructor Detail

      + + + +
        +
      • +

        CoreModManager

        +
        public CoreModManager()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        handleLaunch

        +
        public static void handleLaunch(java.io.File mcDir,
+                net.minecraft.launchwrapper.LaunchClassLoader classLoader,
+                FMLTweaker tweaker)
        +
        • +
      + + + +
        +
      • +

        getLoadedCoremods

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

        getReparseableCoremods

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

        injectTransformers

        +
        public static void injectTransformers(net.minecraft.launchwrapper.LaunchClassLoader classLoader)
        +
        • +
      + + + + + + + +
        +
      • +

        sortTweakList

        +
        public static void sortTweakList()
        +
        • +
      + + + +
        +
      • +

        getAccessTransformers

        +
        public static java.util.List<java.lang.String> getAccessTransformers()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/FMLCorePlugin.html b/javadoc/cpw/mods/fml/relauncher/FMLCorePlugin.html new file mode 100644 index 0000000..37c2300 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/FMLCorePlugin.html @@ -0,0 +1,389 @@ + + + + + +FMLCorePlugin (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class FMLCorePlugin

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

      Constructor Summary

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

      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
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLCorePlugin

        +
        public FMLCorePlugin()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      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
        +
        • +
      + + + +
        +
      • +

        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
        +
        • +
      + + + +
        +
      • +

        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
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/FMLInjectionData.html b/javadoc/cpw/mods/fml/relauncher/FMLInjectionData.html new file mode 100644 index 0000000..14f2f24 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/FMLInjectionData.html @@ -0,0 +1,290 @@ + + + + + +FMLInjectionData (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class FMLInjectionData

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

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.util.List<java.lang.String>containers 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static java.lang.Object[]data() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        containers

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

      Constructor Detail

      + + + +
        +
      • +

        FMLInjectionData

        +
        public FMLInjectionData()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        data

        +
        public static java.lang.Object[] data()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/FMLLaunchHandler.html b/javadoc/cpw/mods/fml/relauncher/FMLLaunchHandler.html new file mode 100644 index 0000000..74cda67 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/FMLLaunchHandler.html @@ -0,0 +1,263 @@ + + + + + +FMLLaunchHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class FMLLaunchHandler

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidappendCoreMods() 
      static voidconfigureForClientLaunch(net.minecraft.launchwrapper.LaunchClassLoader loader, + FMLTweaker tweaker) 
      static voidconfigureForServerLaunch(net.minecraft.launchwrapper.LaunchClassLoader loader, + FMLTweaker tweaker) 
      static Sideside() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        configureForClientLaunch

        +
        public static void configureForClientLaunch(net.minecraft.launchwrapper.LaunchClassLoader loader,
+                            FMLTweaker tweaker)
        +
        • +
      + + + +
        +
      • +

        configureForServerLaunch

        +
        public static void configureForServerLaunch(net.minecraft.launchwrapper.LaunchClassLoader loader,
+                            FMLTweaker tweaker)
        +
        • +
      + + + +
        +
      • +

        side

        +
        public static Side side()
        +
        • +
      + + + +
        +
      • +

        appendCoreMods

        +
        public static void appendCoreMods()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/FMLRelaunchLog.html b/javadoc/cpw/mods/fml/relauncher/FMLRelaunchLog.html new file mode 100644 index 0000000..8991319 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/FMLRelaunchLog.html @@ -0,0 +1,411 @@ + + + + + +FMLRelaunchLog (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class FMLRelaunchLog

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

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static FMLRelaunchLoglog +
      Our special logger for logging issues to.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidfine(java.lang.String format, + java.lang.Object... data) 
      static voidfiner(java.lang.String format, + java.lang.Object... data) 
      org.apache.logging.log4j.LoggergetLogger() 
      static voidinfo(java.lang.String format, + java.lang.Object... data) 
      static voidlog(org.apache.logging.log4j.Level level, + java.lang.String format, + java.lang.Object... data) 
      static voidlog(org.apache.logging.log4j.Level level, + java.lang.Throwable ex, + java.lang.String format, + java.lang.Object... data) 
      static voidlog(java.lang.String targetLog, + org.apache.logging.log4j.Level level, + java.lang.String format, + java.lang.Object... data) 
      static voidlog(java.lang.String targetLog, + org.apache.logging.log4j.Level level, + java.lang.Throwable ex, + java.lang.String format, + java.lang.Object... data) 
      static voidsevere(java.lang.String format, + java.lang.Object... data) 
      static voidwarning(java.lang.String format, + java.lang.Object... data) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        log

        +
        public static FMLRelaunchLog log
        +
        Our special logger for logging issues to. We copy various assets from the + Minecraft logger to achieve a similar appearance.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        log

        +
        public static void log(java.lang.String targetLog,
+       org.apache.logging.log4j.Level level,
+       java.lang.String format,
+       java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        log

        +
        public static void log(org.apache.logging.log4j.Level level,
+       java.lang.String format,
+       java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        log

        +
        public static void log(java.lang.String targetLog,
+       org.apache.logging.log4j.Level level,
+       java.lang.Throwable ex,
+       java.lang.String format,
+       java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        log

        +
        public static void log(org.apache.logging.log4j.Level level,
+       java.lang.Throwable ex,
+       java.lang.String format,
+       java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        severe

        +
        public static void severe(java.lang.String format,
+          java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        warning

        +
        public static void warning(java.lang.String format,
+           java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        info

        +
        public static void info(java.lang.String format,
+        java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        fine

        +
        public static void fine(java.lang.String format,
+        java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        finer

        +
        public static void finer(java.lang.String format,
+         java.lang.Object... data)
        +
        • +
      + + + +
        +
      • +

        getLogger

        +
        public org.apache.logging.log4j.Logger getLogger()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/FMLSecurityManager.ExitTrappedException.html b/javadoc/cpw/mods/fml/relauncher/FMLSecurityManager.ExitTrappedException.html new file mode 100644 index 0000000..f55157b --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/FMLSecurityManager.ExitTrappedException.html @@ -0,0 +1,262 @@ + + + + + +FMLSecurityManager.ExitTrappedException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class FMLSecurityManager.ExitTrappedException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Enclosing class:
    +
    FMLSecurityManager
    +
    +
    +
    +
    public static class FMLSecurityManager.ExitTrappedException
+extends java.lang.SecurityException
    +
    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

      + + + +
        +
      • +

        FMLSecurityManager.ExitTrappedException

        +
        public FMLSecurityManager.ExitTrappedException()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/FMLSecurityManager.html b/javadoc/cpw/mods/fml/relauncher/FMLSecurityManager.html new file mode 100644 index 0000000..91c9b17 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/FMLSecurityManager.html @@ -0,0 +1,306 @@ + + + + + +FMLSecurityManager (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class FMLSecurityManager

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLSecurityManager
+extends java.lang.SecurityManager
    +
    A custom security manager stopping certain events from happening + unexpectedly.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class java.lang.SecurityManager

        +inCheck
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidcheckPermission(java.security.Permission perm) 
      +
        +
      • + + +

        Methods inherited from class java.lang.SecurityManager

        +checkAccept, checkAccess, checkAccess, checkAwtEventQueueAccess, checkConnect, checkConnect, checkCreateClassLoader, checkDelete, checkExec, checkExit, checkLink, checkListen, checkMemberAccess, checkMulticast, checkMulticast, checkPackageAccess, checkPackageDefinition, checkPermission, checkPrintJobAccess, checkPropertiesAccess, checkPropertyAccess, checkRead, checkRead, checkRead, checkSecurityAccess, checkSetFactory, checkSystemClipboardAccess, checkTopLevelWindow, checkWrite, checkWrite, classDepth, classLoaderDepth, currentClassLoader, currentLoadedClass, getClassContext, getInCheck, getSecurityContext, getThreadGroup, inClass, inClassLoader
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FMLSecurityManager

        +
        public FMLSecurityManager()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        checkPermission

        +
        public void checkPermission(java.security.Permission perm)
        +
        +
        Overrides:
        +
        checkPermission in class java.lang.SecurityManager
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/FileListHelper.html b/javadoc/cpw/mods/fml/relauncher/FileListHelper.html new file mode 100644 index 0000000..9fdf6a1 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/FileListHelper.html @@ -0,0 +1,269 @@ + + + + + +FileListHelper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class FileListHelper

+
+
+ +
+
    +
  • +
    +
    +
    public final class FileListHelper
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static java.io.File[]sortFileList(java.io.File[] files) 
      static java.io.File[]sortFileList(java.io.File dir, + java.io.FilenameFilter filter) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FileListHelper

        +
        public FileListHelper()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sortFileList

        +
        public static java.io.File[] sortFileList(java.io.File[] files)
        +
        • +
      + + + +
        +
      • +

        sortFileList

        +
        public static java.io.File[] sortFileList(java.io.File dir,
+                          java.io.FilenameFilter filter)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/IFMLCallHook.html b/javadoc/cpw/mods/fml/relauncher/IFMLCallHook.html new file mode 100644 index 0000000..b9c31ca --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/IFMLCallHook.html @@ -0,0 +1,229 @@ + + + + + +IFMLCallHook (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Interface IFMLCallHook

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.util.concurrent.Callable<java.lang.Void>
    +
    +
    +
    All Known Implementing Classes:
    +
    FMLSanityChecker
    +
    +
    +
    +
    public interface IFMLCallHook
+extends java.util.concurrent.Callable<java.lang.Void>
    +
    This call hook allows for code to execute at the very early stages of + minecraft initialization. FML uses it to validate that there is a + safe environment for further loading of FML.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidinjectData(java.util.Map<java.lang.String,java.lang.Object> data) +
      Injected with data from the FML environment: + "classLoader" : The FML Class Loader
      +
      +
        +
      • + + +

        Methods inherited from interface java.util.concurrent.Callable

        +call
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        injectData

        +
        void injectData(java.util.Map<java.lang.String,java.lang.Object> data)
        +
        Injected with data from the FML environment: + "classLoader" : The FML Class Loader
        +
        Parameters:
        data -
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.DependsOn.html b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.DependsOn.html new file mode 100644 index 0000000..257ae81 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.DependsOn.html @@ -0,0 +1,202 @@ + + + + + +IFMLLoadingPlugin.DependsOn (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Annotation Type IFMLLoadingPlugin.DependsOn

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=TYPE)
+public static @interface IFMLLoadingPlugin.DependsOn
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.String[]value 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.MCVersion.html b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.MCVersion.html new file mode 100644 index 0000000..dade56e --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.MCVersion.html @@ -0,0 +1,204 @@ + + + + + +IFMLLoadingPlugin.MCVersion (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Annotation Type IFMLLoadingPlugin.MCVersion

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=TYPE)
+public static @interface IFMLLoadingPlugin.MCVersion
    +
    Use this to target a specific minecraft version for your coremod. It will refuse to load with an error if + minecraft is not this exact version.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Stringvalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.Name.html b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.Name.html new file mode 100644 index 0000000..3f4e1e6 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.Name.html @@ -0,0 +1,203 @@ + + + + + +IFMLLoadingPlugin.Name (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Annotation Type IFMLLoadingPlugin.Name

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=TYPE)
+public static @interface IFMLLoadingPlugin.Name
    +
    Name this coremod something other than the "short class name"
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Stringvalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.SortingIndex.html b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.SortingIndex.html new file mode 100644 index 0000000..36e0967 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.SortingIndex.html @@ -0,0 +1,203 @@ + + + + + +IFMLLoadingPlugin.SortingIndex (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Annotation Type IFMLLoadingPlugin.SortingIndex

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=TYPE)
+public static @interface IFMLLoadingPlugin.SortingIndex
    +
    A simple sorting index, interleaved with other tweakers from other sources, as well as FML
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      intvalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract int value
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.TransformerExclusions.html b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.TransformerExclusions.html new file mode 100644 index 0000000..7c43c88 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.TransformerExclusions.html @@ -0,0 +1,208 @@ + + + + + +IFMLLoadingPlugin.TransformerExclusions (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Annotation Type IFMLLoadingPlugin.TransformerExclusions

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=TYPE)
+public static @interface IFMLLoadingPlugin.TransformerExclusions
    +
    Annotate your load plugin with a list of package prefixes that will *not* be + processed by the ASM transformation stack. + + Your plugin, and any transformers should *definitely* be in this list, because + otherwise you can face problems with the classloader trying to transform classes + with your transformer, whilst it is *loading* your transformer. Not pretty.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.String[]value 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.html b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.html new file mode 100644 index 0000000..e889f61 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.html @@ -0,0 +1,346 @@ + + + + + +IFMLLoadingPlugin (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Interface IFMLLoadingPlugin

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    FMLCorePlugin, FMLForgePlugin
    +
    +
    +
    +
    public interface IFMLLoadingPlugin
    +
    The base plugin that provides class name meta information to FML to + enhance the classloading lifecycle for mods in FML
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      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,
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getASMTransformerClass

        +
        java.lang.String[] getASMTransformerClass()
        +
        Return a list of classes that implements the IClassTransformer interface
        +
        Returns:
        a list of classes that implements the IClassTransformer interface
        +
        • +
      + + + +
        +
      • +

        getModContainerClass

        +
        java.lang.String getModContainerClass()
        +
        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
        +
        • +
      + + + +
        +
      • +

        getSetupClass

        +
        java.lang.String getSetupClass()
        +
        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 ;) )
        +
        • +
      + + + +
        +
      • +

        injectData

        +
        void injectData(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,
        +
        • +
      + + + +
        +
      • +

        getAccessTransformerClass

        +
        java.lang.String getAccessTransformerClass()
        +
        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.
        +
        Returns:
        the name of an access transformer class or null if none is provided
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/ModListHelper.JsonModList.html b/javadoc/cpw/mods/fml/relauncher/ModListHelper.JsonModList.html new file mode 100644 index 0000000..5713787 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/ModListHelper.JsonModList.html @@ -0,0 +1,292 @@ + + + + + +ModListHelper.JsonModList (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class ModListHelper.JsonModList

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ModListHelper
    +
    +
    +
    +
    public static class ModListHelper.JsonModList
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      java.util.List<java.lang.String>modRef 
      java.lang.StringparentList 
      java.lang.StringrepositoryRoot 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        repositoryRoot

        +
        public java.lang.String repositoryRoot
        +
        • +
      + + + +
        +
      • +

        modRef

        +
        public java.util.List<java.lang.String> modRef
        +
        • +
      + + + +
        +
      • +

        parentList

        +
        public java.lang.String parentList
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ModListHelper.JsonModList

        +
        public ModListHelper.JsonModList()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/ModListHelper.html b/javadoc/cpw/mods/fml/relauncher/ModListHelper.html new file mode 100644 index 0000000..be42dac --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/ModListHelper.html @@ -0,0 +1,281 @@ + + + + + +ModListHelper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class ModListHelper

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

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class ModListHelper.JsonModList 
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.util.Map<java.lang.String,java.io.File>additionalMods 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        additionalMods

        +
        public static final java.util.Map<java.lang.String,java.io.File> additionalMods
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ModListHelper

        +
        public ModListHelper()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToAccessFieldException.html b/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToAccessFieldException.html new file mode 100644 index 0000000..e024f2f --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToAccessFieldException.html @@ -0,0 +1,259 @@ + + + + + +ReflectionHelper.UnableToAccessFieldException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class ReflectionHelper.UnableToAccessFieldException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Enclosing class:
    +
    ReflectionHelper
    +
    +
    +
    +
    public static class ReflectionHelper.UnableToAccessFieldException
+extends java.lang.RuntimeException
    +
    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

      + + + +
        +
      • +

        ReflectionHelper.UnableToAccessFieldException

        +
        public ReflectionHelper.UnableToAccessFieldException(java.lang.String[] fieldNames,
+                                             java.lang.Exception e)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToFindClassException.html b/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToFindClassException.html new file mode 100644 index 0000000..1d7ae1d --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToFindClassException.html @@ -0,0 +1,259 @@ + + + + + +ReflectionHelper.UnableToFindClassException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class ReflectionHelper.UnableToFindClassException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Enclosing class:
    +
    ReflectionHelper
    +
    +
    +
    +
    public static class ReflectionHelper.UnableToFindClassException
+extends java.lang.RuntimeException
    +
    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

      + + + +
        +
      • +

        ReflectionHelper.UnableToFindClassException

        +
        public ReflectionHelper.UnableToFindClassException(java.lang.String[] classNames,
+                                           java.lang.Exception err)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToFindFieldException.html b/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToFindFieldException.html new file mode 100644 index 0000000..248bd06 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToFindFieldException.html @@ -0,0 +1,259 @@ + + + + + +ReflectionHelper.UnableToFindFieldException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class ReflectionHelper.UnableToFindFieldException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Enclosing class:
    +
    ReflectionHelper
    +
    +
    +
    +
    public static class ReflectionHelper.UnableToFindFieldException
+extends java.lang.RuntimeException
    +
    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

      + + + +
        +
      • +

        ReflectionHelper.UnableToFindFieldException

        +
        public ReflectionHelper.UnableToFindFieldException(java.lang.String[] fieldNameList,
+                                           java.lang.Exception e)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToFindMethodException.html b/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToFindMethodException.html new file mode 100644 index 0000000..f206bb9 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.UnableToFindMethodException.html @@ -0,0 +1,259 @@ + + + + + +ReflectionHelper.UnableToFindMethodException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class ReflectionHelper.UnableToFindMethodException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Enclosing class:
    +
    ReflectionHelper
    +
    +
    +
    +
    public static class ReflectionHelper.UnableToFindMethodException
+extends java.lang.RuntimeException
    +
    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

      + + + +
        +
      • +

        ReflectionHelper.UnableToFindMethodException

        +
        public ReflectionHelper.UnableToFindMethodException(java.lang.String[] methodNames,
+                                            java.lang.Exception failed)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.html b/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.html new file mode 100644 index 0000000..7f9c052 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/ReflectionHelper.html @@ -0,0 +1,404 @@ + + + + + +ReflectionHelper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class ReflectionHelper

+
+
+ +
+
    +
  • +
    +
    +
    public class ReflectionHelper
+extends java.lang.Object
    +
    Some reflection helper code.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static java.lang.reflect.FieldfindField(java.lang.Class<?> clazz, + java.lang.String... fieldNames) 
      static <E> java.lang.reflect.MethodfindMethod(java.lang.Class<? super E> clazz, + E instance, + java.lang.String[] methodNames, + java.lang.Class<?>... methodTypes) 
      static java.lang.Class<? super java.lang.Object>getClass(java.lang.ClassLoader loader, + java.lang.String... classNames) 
      static <T,E> TgetPrivateValue(java.lang.Class<? super E> classToAccess, + E instance, + int fieldIndex) 
      static <T,E> TgetPrivateValue(java.lang.Class<? super E> classToAccess, + E instance, + java.lang.String... fieldNames) 
      static <T,E> voidsetPrivateValue(java.lang.Class<? super T> classToAccess, + T instance, + E value, + int fieldIndex) 
      static <T,E> voidsetPrivateValue(java.lang.Class<? super T> classToAccess, + T instance, + E value, + java.lang.String... fieldNames) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ReflectionHelper

        +
        public ReflectionHelper()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        findField

        +
        public static java.lang.reflect.Field findField(java.lang.Class<?> clazz,
+                                java.lang.String... fieldNames)
        +
        • +
      + + + + + +
        +
      • +

        getPrivateValue

        +
        public static <T,E> T getPrivateValue(java.lang.Class<? super E> classToAccess,
+                      E instance,
+                      int fieldIndex)
        +
        • +
      + + + + + +
        +
      • +

        getPrivateValue

        +
        public static <T,E> T getPrivateValue(java.lang.Class<? super E> classToAccess,
+                      E instance,
+                      java.lang.String... fieldNames)
        +
        • +
      + + + + + +
        +
      • +

        setPrivateValue

        +
        public static <T,E> void setPrivateValue(java.lang.Class<? super T> classToAccess,
+                         T instance,
+                         E value,
+                         int fieldIndex)
        +
        • +
      + + + + + +
        +
      • +

        setPrivateValue

        +
        public static <T,E> void setPrivateValue(java.lang.Class<? super T> classToAccess,
+                         T instance,
+                         E value,
+                         java.lang.String... fieldNames)
        +
        • +
      + + + +
        +
      • +

        getClass

        +
        public static java.lang.Class<? super java.lang.Object> getClass(java.lang.ClassLoader loader,
+                                                 java.lang.String... classNames)
        +
        • +
      + + + + + +
        +
      • +

        findMethod

        +
        public static <E> java.lang.reflect.Method findMethod(java.lang.Class<? super E> clazz,
+                                      E instance,
+                                      java.lang.String[] methodNames,
+                                      java.lang.Class<?>... methodTypes)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/ServerLaunchWrapper.html b/javadoc/cpw/mods/fml/relauncher/ServerLaunchWrapper.html new file mode 100644 index 0000000..9dae5f0 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/ServerLaunchWrapper.html @@ -0,0 +1,221 @@ + + + + + +ServerLaunchWrapper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Class ServerLaunchWrapper

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidmain(java.lang.String[] args) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String[] args)
        +
        Parameters:
        args -
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/Side.html b/javadoc/cpw/mods/fml/relauncher/Side.html new file mode 100644 index 0000000..f58793c --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/Side.html @@ -0,0 +1,353 @@ + + + + + +Side (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Enum Side

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

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      CLIENT +
      The client side.
      +
      SERVER +
      The server side.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanisClient() 
      booleanisServer() 
      static SidevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Side[]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

      + + + +
        +
      • +

        CLIENT

        +
        public static final Side CLIENT
        +
        The client side. Specifically, an environment where rendering capability exists. + Usually in the game client.
        +
        • +
      + + + +
        +
      • +

        SERVER

        +
        public static final Side SERVER
        +
        The server side. Specifically, an environment where NO rendering capability exists. + Usually on the dedicated server.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Side[] 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 (Side c : Side.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Side 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
        +
        • +
      + + + +
        +
      • +

        isServer

        +
        public boolean isServer()
        +
        Returns:
        If this is the server environment
        +
        • +
      + + + +
        +
      • +

        isClient

        +
        public boolean isClient()
        +
        Returns:
        if this is the Client environment
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/SideOnly.html b/javadoc/cpw/mods/fml/relauncher/SideOnly.html new file mode 100644 index 0000000..724bd8c --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/SideOnly.html @@ -0,0 +1,206 @@ + + + + + +SideOnly (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.relauncher
+

Annotation Type SideOnly

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value={TYPE,FIELD,METHOD,CONSTRUCTOR})
+public @interface SideOnly
    +
    Marks the associated element as being only available on a certain Side. This is + generally meant for internal Forge and FML use only and should only be used on mod classes + when other more common mechanisms, such as using a SidedProxy fail to work. + + Note, this will only apply to the direct element marked. This code: + @SideOnly public MyField field = new MyField(); will not work, as the initializer + is a separate piece of code to the actual field declaration, and will not be able to find + it's field on the wrong side.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      Sidevalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract Side value
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/package-frame.html b/javadoc/cpw/mods/fml/relauncher/package-frame.html new file mode 100644 index 0000000..a526440 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/package-frame.html @@ -0,0 +1,55 @@ + + + + + +cpw.mods.fml.relauncher (Forge API) + + + + +

cpw.mods.fml.relauncher

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +

Exceptions

+ +

Annotation Types

+ +
+ + diff --git a/javadoc/cpw/mods/fml/relauncher/package-summary.html b/javadoc/cpw/mods/fml/relauncher/package-summary.html new file mode 100644 index 0000000..0334149 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/package-summary.html @@ -0,0 +1,293 @@ + + + + + +cpw.mods.fml.relauncher (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.relauncher

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/relauncher/package-tree.html b/javadoc/cpw/mods/fml/relauncher/package-tree.html new file mode 100644 index 0000000..e1312cc --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/package-tree.html @@ -0,0 +1,191 @@ + + + + + +cpw.mods.fml.relauncher Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.relauncher

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Annotation Type Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/ByteBufferSeekableSource.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/ByteBufferSeekableSource.html new file mode 100644 index 0000000..cfbd982 --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/ByteBufferSeekableSource.html @@ -0,0 +1,356 @@ + + + + + +ByteBufferSeekableSource (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.repackage.com.nothome.delta
+

Class ByteBufferSeekableSource

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    SeekableSource, java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    +
    public class ByteBufferSeekableSource
+extends java.lang.Object
+implements SeekableSource
    +
    Wraps a byte buffer as a source
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ByteBufferSeekableSource(byte[] source) +
      Constructs a new ByteArraySeekableSource.
      +
      ByteBufferSeekableSource(java.nio.ByteBuffer bb) +
      Constructs a new ByteArraySeekableSource.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      intread(java.nio.ByteBuffer dest) +
      Reads up to Buffer.remaining() bytes from the source, + returning the number of bytes read, or -1 if no bytes were read + and EOF was reached.
      +
      voidseek(long pos) +
      Sets the position for the next SeekableSource.read(ByteBuffer).
      +
      java.lang.StringtoString() +
      Returns a debug String.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ByteBufferSeekableSource

        +
        public ByteBufferSeekableSource(byte[] source)
        +
        Constructs a new ByteArraySeekableSource.
        +
        • +
      + + + +
        +
      • +

        ByteBufferSeekableSource

        +
        public ByteBufferSeekableSource(java.nio.ByteBuffer bb)
        +
        Constructs a new ByteArraySeekableSource.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        read

        +
        public int read(java.nio.ByteBuffer dest)
+         throws java.io.IOException
        +
        Description copied from interface: SeekableSource
        +
        Reads up to Buffer.remaining() bytes from the source, + returning the number of bytes read, or -1 if no bytes were read + and EOF was reached.
        +
        +
        Specified by:
        +
        read in interface SeekableSource
        +
        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
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns a debug String.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/Checksum.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/Checksum.html new file mode 100644 index 0000000..e0f3318 --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/Checksum.html @@ -0,0 +1,346 @@ + + + + + +Checksum (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.repackage.com.nothome.delta
+

Class Checksum

+
+
+ +
+
    +
  • +
    +
    +
    public class Checksum
+extends java.lang.Object
    +
    Checksum computation class.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Checksum(SeekableSource source, + int chunkSize) +
      Initialize checksums for source.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intfindChecksumIndex(long hashf) +
      Finds the index of a checksum.
      +
      static char[]getSingleHash() +
      256 random hash values.
      +
      static longincrementChecksum(long checksum, + byte out, + byte in, + int chunkSize) +
      Increments a checksum.
      +
      static longqueryChecksum(java.nio.ByteBuffer bb, + int len) +
      Finds the checksum computed from the buffer.
      +
      java.lang.StringtoString() +
      Returns a debug String.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Checksum

        +
        public Checksum(SeekableSource source,
+        int chunkSize)
+         throws java.io.IOException
        +
        Initialize checksums for source. The checksum for the chunkSize bytes at offset + chunkSize * i is inserted into a hash map.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        queryChecksum

        +
        public static long queryChecksum(java.nio.ByteBuffer bb,
+                 int len)
        +
        Finds the checksum computed from the buffer. + Marks, gets, then resets the buffer.
        +
        • +
      + + + +
        +
      • +

        incrementChecksum

        +
        public static long incrementChecksum(long checksum,
+                     byte out,
+                     byte in,
+                     int chunkSize)
        +
        Increments a checksum.
        +
        Parameters:
        checksum - initial checksum
        out - byte leaving view
        in - byte entering view
        chunkSize - size of chunks
        +
        Returns:
        new checksum
        +
        • +
      + + + +
        +
      • +

        getSingleHash

        +
        public static char[] getSingleHash()
        +
        256 random hash values.
        +
        • +
      + + + +
        +
      • +

        findChecksumIndex

        +
        public int findChecksumIndex(long hashf)
        +
        Finds the index of a checksum.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns a debug String.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/DebugDiffWriter.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/DebugDiffWriter.html new file mode 100644 index 0000000..4685a23 --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/DebugDiffWriter.html @@ -0,0 +1,350 @@ + + + + + +DebugDiffWriter (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.repackage.com.nothome.delta
+

Class DebugDiffWriter

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    DiffWriter, java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    +
    public class DebugDiffWriter
+extends java.lang.Object
+implements DiffWriter
    +
    For debugging patch generation.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DebugDiffWriter() +
      Constructs a new DebugDiffWriter.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddCopy(long offset, + int length) +
      Add a GDIFF copy instruction.
      +
      voidaddData(byte b) +
      Add a GDIFF data instruction.
      +
      voidclose() +
      Closes this stream.
      +
      voidflush() +
      Flushes to output, e.g.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DebugDiffWriter

        +
        public DebugDiffWriter()
        +
        Constructs a new DebugDiffWriter.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addCopy

        +
        public void addCopy(long offset,
+           int length)
+             throws java.io.IOException
        +
        Description copied from interface: DiffWriter
        +
        Add a GDIFF copy instruction.
        +
        +
        Specified by:
        +
        addCopy in interface DiffWriter
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        addData

        +
        public void addData(byte b)
+             throws java.io.IOException
        +
        Description copied from interface: DiffWriter
        +
        Add a GDIFF data instruction. + Implementors should buffer the data.
        +
        +
        Specified by:
        +
        addData in interface DiffWriter
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        flush

        +
        public void flush()
+           throws java.io.IOException
        +
        Description copied from interface: DiffWriter
        +
        Flushes to output, e.g. any data added.
        +
        +
        Specified by:
        +
        flush in interface DiffWriter
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws java.io.IOException
        +
        Description copied from interface: DiffWriter
        +
        Closes this stream. + Note that DiffWriter will invoke this method at the end.
        +
        +
        Specified by:
        +
        close in interface DiffWriter
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/Delta.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/Delta.html new file mode 100644 index 0000000..2d4bb80 --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/Delta.html @@ -0,0 +1,451 @@ + + + + + +Delta (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.repackage.com.nothome.delta
+

Class Delta

+
+
+ +
+
    +
  • +
    +
    +
    public class Delta
+extends java.lang.Object
    +
    Class for computing deltas against a source. + The source file is read by blocks and a hash is computed per block. + Then the target is scanned for matching blocks. +

    + This class is not thread safe. Use one instance per thread. +

    + This class should support files over 4GB in length, although you must + use a larger checksum size, such as 1K, as all checksums use "int" indexing. + Newer versions may eventually support paging in/out of checksums.

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

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static intDEFAULT_CHUNK_SIZE +
      Default size of 16.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Delta() +
      Constructs a new Delta.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      byte[]compute(byte[] source, + byte[] target) +
      Compares the source bytes with target bytes, returning output.
      +
      voidcompute(byte[] source, + byte[] target, + java.io.OutputStream output) +
      Compares the source bytes with target bytes, writing to output.
      +
      voidcompute(byte[] sourceBytes, + java.io.InputStream inputStream, + DiffWriter diffWriter) +
      Compares the source bytes with target input, writing to output.
      +
      voidcompute(java.io.File sourceFile, + java.io.File targetFile, + DiffWriter output) +
      Compares the source file with a target file, writing to output.
      +
      voidcompute(SeekableSource seekSource, + java.io.InputStream targetIS, + DiffWriter output) +
      Compares the source with a target, writing to output.
      +
      static voidmain(java.lang.String[] argv) +
      Creates a patch using file names.
      +
      voidsetChunkSize(int size) +
      Sets the chunk size used.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        DEFAULT_CHUNK_SIZE

        +
        public static final int DEFAULT_CHUNK_SIZE
        +
        Default size of 16. + For "Lorem ipsum" text files (see the tests) the ideal size is about 14. + Any smaller and the patch size becomes actually be larger. +

        + Use a size like 64 or 128 for large files.

        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Delta

        +
        public Delta()
        +
        Constructs a new Delta. + In the future, additional constructor arguments will set the algorithm details.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setChunkSize

        +
        public void setChunkSize(int size)
        +
        Sets the chunk size used. + Larger chunks are faster and use less memory, but create larger patches + as well.
        +
        Parameters:
        size -
        +
        • +
      + + + +
        +
      • +

        compute

        +
        public void compute(byte[] source,
+           byte[] target,
+           java.io.OutputStream output)
+             throws java.io.IOException
        +
        Compares the source bytes with target bytes, writing to output.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        compute

        +
        public byte[] compute(byte[] source,
+             byte[] target)
+               throws java.io.IOException
        +
        Compares the source bytes with target bytes, returning output.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        compute

        +
        public void compute(byte[] sourceBytes,
+           java.io.InputStream inputStream,
+           DiffWriter diffWriter)
+             throws java.io.IOException
        +
        Compares the source bytes with target input, writing to output.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        compute

        +
        public void compute(java.io.File sourceFile,
+           java.io.File targetFile,
+           DiffWriter output)
+             throws java.io.IOException
        +
        Compares the source file with a target file, writing to output.
        +
        Parameters:
        output - will be closed
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        compute

        +
        public void compute(SeekableSource seekSource,
+           java.io.InputStream targetIS,
+           DiffWriter output)
+             throws java.io.IOException
        +
        Compares the source with a target, writing to output.
        +
        Parameters:
        output - will be closed
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String[] argv)
+                 throws java.lang.Exception
        +
        Creates a patch using file names.
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/DiffWriter.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/DiffWriter.html new file mode 100644 index 0000000..88e6728 --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/DiffWriter.html @@ -0,0 +1,286 @@ + + + + + +DiffWriter (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.repackage.com.nothome.delta
+

Interface DiffWriter

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.AutoCloseable, java.io.Closeable
    +
    +
    +
    All Known Implementing Classes:
    +
    DebugDiffWriter, GDiffWriter
    +
    +
    +
    +
    public interface DiffWriter
+extends java.io.Closeable
    +
    Interface for DIFF writers.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddCopy(long offset, + int length) +
      Add a GDIFF copy instruction.
      +
      voidaddData(byte b) +
      Add a GDIFF data instruction.
      +
      voidclose() +
      Closes this stream.
      +
      voidflush() +
      Flushes to output, e.g.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addCopy

        +
        void addCopy(long offset,
+           int length)
+             throws java.io.IOException
        +
        Add a GDIFF copy instruction.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        addData

        +
        void addData(byte b)
+             throws java.io.IOException
        +
        Add a GDIFF data instruction. + Implementors should buffer the data.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        flush

        +
        void flush()
+           throws java.io.IOException
        +
        Flushes to output, e.g. any data added.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        close

        +
        void close()
+           throws java.io.IOException
        +
        Closes this stream. + Note that DiffWriter will invoke this method at the end.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/GDiffPatcher.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/GDiffPatcher.html new file mode 100644 index 0000000..fbe65ba --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/GDiffPatcher.html @@ -0,0 +1,355 @@ + + + + + +GDiffPatcher (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.repackage.com.nothome.delta
+

Class GDiffPatcher

+
+
+ +
+
    +
  • +
    +
    +
    public class GDiffPatcher
+extends java.lang.Object
    +
    This class patches an input file with a GDIFF patch file. + + The patch file follows the GDIFF file specification available at + + http://www.w3.org/TR/NOTE-gdiff-19970901.html.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      GDiffPatcher() +
      Constructs a new GDiffPatcher.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidmain(java.lang.String[] argv) +
      Simple command line tool to patch a file.
      +
      byte[]patch(byte[] source, + byte[] patch) +
      Patches in memory, returning the patch result.
      +
      voidpatch(byte[] source, + java.io.InputStream patch, + java.io.OutputStream output) +
      Patches to an output stream.
      +
      voidpatch(java.io.File sourceFile, + java.io.File patchFile, + java.io.File outputFile) +
      Patches to an output file.
      +
      voidpatch(SeekableSource source, + java.io.InputStream patch, + java.io.OutputStream out) +
      Patches to an output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        GDiffPatcher

        +
        public GDiffPatcher()
        +
        Constructs a new GDiffPatcher.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        patch

        +
        public void patch(java.io.File sourceFile,
+         java.io.File patchFile,
+         java.io.File outputFile)
+           throws java.io.IOException
        +
        Patches to an output file.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        patch

        +
        public void patch(byte[] source,
+         java.io.InputStream patch,
+         java.io.OutputStream output)
+           throws java.io.IOException
        +
        Patches to an output stream.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        patch

        +
        public byte[] patch(byte[] source,
+           byte[] patch)
+             throws java.io.IOException
        +
        Patches in memory, returning the patch result.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        patch

        +
        public void patch(SeekableSource source,
+         java.io.InputStream patch,
+         java.io.OutputStream out)
+           throws java.io.IOException
        +
        Patches to an output stream.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String[] argv)
        +
        Simple command line tool to patch a file.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/GDiffWriter.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/GDiffWriter.html new file mode 100644 index 0000000..8761670 --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/GDiffWriter.html @@ -0,0 +1,564 @@ + + + + + +GDiffWriter (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.repackage.com.nothome.delta
+

Class GDiffWriter

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    DiffWriter, java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    +
    public class GDiffWriter
+extends java.lang.Object
+implements DiffWriter
    +
    Outputs a diff following the GDIFF file specification available at + http://www.w3.org/TR/NOTE-gdiff-19970901.html.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      GDiffWriter(java.io.DataOutputStream os) +
      Constructs a new GDiffWriter.
      +
      GDiffWriter(java.io.OutputStream output) +
      Constructs a new GDiffWriter.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddCopy(long offset, + int length) +
      Add a GDIFF copy instruction.
      +
      voidaddData(byte b) +
      Adds a data byte.
      +
      voidclose() +
      Writes the final EOF byte, closes the underlying stream.
      +
      voidflush() +
      Flushes accumulated data bytes, if any.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        GDiffWriter

        +
        public GDiffWriter(java.io.DataOutputStream os)
+            throws java.io.IOException
        +
        Constructs a new GDiffWriter.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        GDiffWriter

        +
        public GDiffWriter(java.io.OutputStream output)
+            throws java.io.IOException
        +
        Constructs a new GDiffWriter.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addCopy

        +
        public void addCopy(long offset,
+           int length)
+             throws java.io.IOException
        +
        Description copied from interface: DiffWriter
        +
        Add a GDIFF copy instruction.
        +
        +
        Specified by:
        +
        addCopy in interface DiffWriter
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        addData

        +
        public void addData(byte b)
+             throws java.io.IOException
        +
        Adds a data byte.
        +
        +
        Specified by:
        +
        addData in interface DiffWriter
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        flush

        +
        public void flush()
+           throws java.io.IOException
        +
        Flushes accumulated data bytes, if any.
        +
        +
        Specified by:
        +
        flush in interface DiffWriter
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws java.io.IOException
        +
        Writes the final EOF byte, closes the underlying stream.
        +
        +
        Specified by:
        +
        close in interface DiffWriter
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/PatchException.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/PatchException.html new file mode 100644 index 0000000..46e4ffb --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/PatchException.html @@ -0,0 +1,273 @@ + + + + + +PatchException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.repackage.com.nothome.delta
+

Class PatchException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class PatchException
+extends java.io.IOException
    +
    Thrown when a patch is invalid.
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PatchException() +
      Creates a new instance of PatchException without detail message.
      +
      PatchException(java.lang.String msg) +
      Constructs an instance of PatchException with the specified detail message.
      +
      +
      • +
    + +
      +
    • + + +

      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

      + + + +
        +
      • +

        PatchException

        +
        public PatchException()
        +
        Creates a new instance of PatchException without detail message.
        +
        • +
      + + + +
        +
      • +

        PatchException

        +
        public PatchException(java.lang.String msg)
        +
        Constructs an instance of PatchException with the specified detail message.
        +
        Parameters:
        msg - the detail message.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/RandomAccessFileSeekableSource.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/RandomAccessFileSeekableSource.html new file mode 100644 index 0000000..e60aa30 --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/RandomAccessFileSeekableSource.html @@ -0,0 +1,358 @@ + + + + + +RandomAccessFileSeekableSource (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.repackage.com.nothome.delta
+

Class RandomAccessFileSeekableSource

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    SeekableSource, java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    +
    public class RandomAccessFileSeekableSource
+extends java.lang.Object
+implements SeekableSource
    +
    Wraps a random access file.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      RandomAccessFileSeekableSource(java.io.RandomAccessFile raf) +
      Constructs a new RandomAccessFileSeekableSource.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      longlength() 
      intread(byte[] b, + int off, + int len) 
      intread(java.nio.ByteBuffer bb) +
      Reads up to Buffer.remaining() bytes from the source, + returning the number of bytes read, or -1 if no bytes were read + and EOF was reached.
      +
      voidseek(long pos) +
      Sets the position for the next SeekableSource.read(ByteBuffer).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        RandomAccessFileSeekableSource

        +
        public RandomAccessFileSeekableSource(java.io.RandomAccessFile raf)
        +
        Constructs a new RandomAccessFileSeekableSource.
        +
        Parameters:
        raf -
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        read

        +
        public int read(byte[] b,
+       int off,
+       int len)
+         throws java.io.IOException
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        length

        +
        public long length()
+            throws java.io.IOException
        +
        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
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        read

        +
        public int read(java.nio.ByteBuffer bb)
+         throws java.io.IOException
        +
        Description copied from interface: SeekableSource
        +
        Reads up to Buffer.remaining() bytes from the source, + returning the number of bytes read, or -1 if no bytes were read + and EOF was reached.
        +
        +
        Specified by:
        +
        read in interface SeekableSource
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/SeekableSource.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/SeekableSource.html new file mode 100644 index 0000000..b7c3fe4 --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/SeekableSource.html @@ -0,0 +1,250 @@ + + + + + +SeekableSource (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.repackage.com.nothome.delta
+

Interface SeekableSource

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.AutoCloseable, java.io.Closeable
    +
    +
    +
    All Known Implementing Classes:
    +
    ByteBufferSeekableSource, RandomAccessFileSeekableSource
    +
    +
    +
    +
    public interface SeekableSource
+extends java.io.Closeable
    +
    For sources of random-access data, such as RandomAccessFile.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intread(java.nio.ByteBuffer bb) +
      Reads up to Buffer.remaining() bytes from the source, + returning the number of bytes read, or -1 if no bytes were read + and EOF was reached.
      +
      voidseek(long pos) +
      Sets the position for the next read(ByteBuffer).
      +
      +
        +
      • + + +

        Methods inherited from interface java.io.Closeable

        +close
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        seek

        +
        void seek(long pos)
+          throws java.io.IOException
        +
        Sets the position for the next read(ByteBuffer).
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        read

        +
        int read(java.nio.ByteBuffer bb)
+         throws java.io.IOException
        +
        Reads up to Buffer.remaining() bytes from the source, + returning the number of bytes read, or -1 if no bytes were read + and EOF was reached.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/package-frame.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/package-frame.html new file mode 100644 index 0000000..6080744 --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/package-frame.html @@ -0,0 +1,34 @@ + + + + + +cpw.mods.fml.repackage.com.nothome.delta (Forge API) + + + + +

cpw.mods.fml.repackage.com.nothome.delta

+
+

Interfaces

+ +

Classes

+ +

Exceptions

+ +
+ + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/package-summary.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/package-summary.html new file mode 100644 index 0000000..e72f335 --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/package-summary.html @@ -0,0 +1,210 @@ + + + + + +cpw.mods.fml.repackage.com.nothome.delta (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.repackage.com.nothome.delta

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/repackage/com/nothome/delta/package-tree.html b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/package-tree.html new file mode 100644 index 0000000..45ab23b --- /dev/null +++ b/javadoc/cpw/mods/fml/repackage/com/nothome/delta/package-tree.html @@ -0,0 +1,158 @@ + + + + + +cpw.mods.fml.repackage.com.nothome.delta Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.repackage.com.nothome.delta

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/server/FMLServerHandler.html b/javadoc/cpw/mods/fml/server/FMLServerHandler.html new file mode 100644 index 0000000..09fc806 --- /dev/null +++ b/javadoc/cpw/mods/fml/server/FMLServerHandler.html @@ -0,0 +1,586 @@ + + + + + +FMLServerHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.server
+

Class FMLServerHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IFMLSidedHandler
    +
    +
    +
    +
    public class FMLServerHandler
+extends java.lang.Object
+implements IFMLSidedHandler
    +
    Handles primary communication from hooked code into the system + + The FML entry point is beginServerLoading(MinecraftServer) called from + DedicatedServer + + Obfuscated code should focus on this class and other members of the "server" + (or "client") code + + The actual mod loading is handled at arms length by Loader + + It is expected that a similar class will exist for each target environment: + Bukkit and Client side. + + It should not be directly modified.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/server/package-frame.html b/javadoc/cpw/mods/fml/server/package-frame.html new file mode 100644 index 0000000..6ad94d4 --- /dev/null +++ b/javadoc/cpw/mods/fml/server/package-frame.html @@ -0,0 +1,19 @@ + + + + + +cpw.mods.fml.server (Forge API) + + + + +

cpw.mods.fml.server

+
+

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/server/package-summary.html b/javadoc/cpw/mods/fml/server/package-summary.html new file mode 100644 index 0000000..7889236 --- /dev/null +++ b/javadoc/cpw/mods/fml/server/package-summary.html @@ -0,0 +1,144 @@ + + + + + +cpw.mods.fml.server (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.server

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/server/package-tree.html b/javadoc/cpw/mods/fml/server/package-tree.html new file mode 100644 index 0000000..4868545 --- /dev/null +++ b/javadoc/cpw/mods/fml/server/package-tree.html @@ -0,0 +1,126 @@ + + + + + +cpw.mods.fml.server Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.server

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3