Minecraft Forge API

Warning:現在編集中であり、古い情報が多く含まれています。

概要

Minecraft Forgeとは、Mod間の互換性を保ちつつMinecraftを拡張するために作られたAPIである。
1.8以前はForgeModLoaderが基本部分を担っていたが、統合された。

開発環境でのインストール方法

MinecraftForge導入手順を参照。

関連リンク

• MinecraftForge Documentation (English)
• Minecraft Forge Forum
• Minecraft Forge Downloads

古いリンク

• 【API解説】Minecraft Forge(1.3.0)
• Minecraft Forge公式wiki翻訳
• reginn666@ウィキ

ForgeModLoader API

1.8の統合後はnet.minecraftforge.fml下、統合前はcpw.mods.fml下に存在するAPI群。
ローダー部分や基本的なイベント、フックはこちらに含まれている。
現在は統合されているため、特にMinecraft Forgeと区別する必要はない。

• net.minecraftforge.fml
  • client

    クライアントサイドのAPI群

    • config

      コンフィグGUI向けのコンポーネント群

    • event

      クライアントサイド基本イベント

      • ConfigChangedEvent

    • registry

      クライアントサイドレジストリ

      • ClientRegistry
      • KeyBindingRegistry ClientRegistry (1.3のUniversal化に伴い移動された)
      • RenderingRegistry

    • FMLClientHandler
    • IModGuiFactory

  • common

    クライアント/サーバー共通のAPI群

    • asm

      FML内部のASM利用クラス

    • discovery

      Mod探知機能群

      • ASMDataTable

    • event

      EventHandlerアノテーションで購読できるイベント群

      • FMLStateEvent

    • eventhandler

      Event関連の基本クラス

      • Event
      • SubscribeEvent

    • functions

      UtilのFunction群

    • gameevent

      基本的なゲーム内イベント群

      • InputEvent
      • PlayerEvent
      • TickEvent

    • launcher

      FML自体をMinecraftに仕込むためのクラス群

    • network

      サーバーとクライアントを橋渡しするためのクラス群

      • handshake

        橋渡しの内部処理

      • internal

        FML自体が用いているメッセージング処理

      • simpleimpl

        単純実装群

        関連チュートリアル: 1.7のパケットについて

      • FMLNetworkEvent
      • IGuiHandler
      • NetworkCheckHandler
      • NetworkRegistry

    • patcher

      MinecraftにFML変更部分をパッチするためのクラス群

    • registry

      基本レジストリ群

      • EntityRegistry
      • GameRegistry
        • ICraftingHandler PlayerEvent (1.3のUniversal化に伴いEventとなった)
        • IFuelHandler
        • IPickupNotifier PlayerEvent (1.3のUniversal化に伴いEventとなった)
        • IPlayerTracker PlayerEvent (1.3のUniversal化に伴いEventとなった)
        • IWorldGeneretor
      • IEntityAdditionalSpawnData
      • IThrowableEntity
      • LanguageRegistry TickEvent (1.3のUniversal化に伴いEventとなった)
      • RegistryBuilder
      • TickRegistry ClientRegistry (1.3のUniversal化に伴い移動された)
      • VillagerRegistry

    • toposort

      Modのソートに使用されるTopologicalSortの実装

    • versioning

      バージョン表記のパーサー群

  • relancher

    ローダー周りのUtil、API群

    • IFMLCallHook
    • IFMLLoadingPlugin
    • SideOnly

  • repackage

    FML内部で使われているサードパーティー製Util群

  • server

    サーバーサイドのAPI群

    • FMLServerHandler

Minecraft Forge API

基礎

• AchievementPage

実績ページの追加を担うAPI

• BiomeManager

村や遺跡などが生成されるバイオームを管理するAPI

• ChestGenHooks

ダンジョンや遺跡, 廃坑などに生成されるチェストの中身へのフックを担うAPI

1.9でLootTableが実装されたため廃止された。

• Configuration

Forge式コンフィグファイルの生成を担うユーティリティ

• DimensionManager

Dimension関連のAPI

• EnumHelper

動的にEnum定数を追加するユーティリティ

• MinecraftForge

イベントの登録や様々なフックを担うAPI

• EnumPlantType

植物に関するEnum定数

• ForgeDirection

方向に関するEnum定数

1.8以降バニラにEnumDirectionができたので廃止された。

• IPlantable

植物インタフェース

• IShearable

ハサミインタフェース

• ISpecialArmor

特殊な防具用のインタフェース

関連クラス

• ArmorProperties

イベント

• Event

イベント概略

• 通常イベント

EVENT_BUSに登録するイベント

• 地形生成イベント

TERRAIN_GEN_BUSに登録するイベント

• 鉱石生成イベント

ORE_GEN_BUSに登録するイベント

一覧

整備中。

イベント一覧

Event名
Event (net.minecraftforge.fml.common.eventhandler)
	AnvilUpdateEvent (net.minecraftforge.event)
	BabyEntitySpawnEvent (net.minecraftforge.event.entity.living)
	BiomeEvent (net.minecraftforge.event.terraingen)
		BiomeColor in BiomeEvent (net.minecraftforge.event.terraingen)
			GetFoliageColor in BiomeEvent (net.minecraftforge.event.terraingen)
			GetGrassColor in BiomeEvent (net.minecraftforge.event.terraingen)
			GetWaterColor in BiomeEvent (net.minecraftforge.event.terraingen)
		CreateDecorator in BiomeEvent (net.minecraftforge.event.terraingen)
		GetVillageBlockID in BiomeEvent (net.minecraftforge.event.terraingen)
	BlockEvent (net.minecraftforge.event.world)
		BreakEvent in BlockEvent (net.minecraftforge.event.world)
		CreateFluidSourceEvent in BlockEvent (net.minecraftforge.event.world)
		CropGrowEvent in BlockEvent (net.minecraftforge.event.world)
			Post in CropGrowEvent in BlockEvent (net.minecraftforge.event.world)
			Pre in CropGrowEvent in BlockEvent (net.minecraftforge.event.world)
		HarvestDropsEvent in BlockEvent (net.minecraftforge.event.world)
		NeighborNotifyEvent in BlockEvent (net.minecraftforge.event.world)
		NoteBlockEvent (net.minecraftforge.event.world)
			Change in NoteBlockEvent (net.minecraftforge.event.world)
			Play in NoteBlockEvent (net.minecraftforge.event.world)
		PlaceEvent in BlockEvent (net.minecraftforge.event.world)
			MultiPlaceEvent in BlockEvent (net.minecraftforge.event.world)
	ChunkGeneratorEvent (net.minecraftforge.event.terraingen)
		InitNoiseField in ChunkGeneratorEvent (net.minecraftforge.event.terraingen)
		PopulateChunkEvent (net.minecraftforge.event.terraingen)
			Populate in PopulateChunkEvent (net.minecraftforge.event.terraingen)
			Post in PopulateChunkEvent (net.minecraftforge.event.terraingen)
			Pre in PopulateChunkEvent (net.minecraftforge.event.terraingen)
		ReplaceBiomeBlocks in ChunkGeneratorEvent (net.minecraftforge.event.terraingen)
	ChunkWatchEvent (net.minecraftforge.event.world)
		UnWatch in ChunkWatchEvent (net.minecraftforge.event.world)
		Watch in ChunkWatchEvent (net.minecraftforge.event.world)
	ClientChatReceivedEvent (net.minecraftforge.client.event)
	CommandEvent (net.minecraftforge.event)
	ConfigChangedEvent (net.minecraftforge.fml.client.event)
		OnConfigChangedEvent in ConfigChangedEvent (net.minecraftforge.fml.client.event)
		PostConfigChangedEvent in ConfigChangedEvent (net.minecraftforge.fml.client.event)
	CustomNetworkEvent in FMLNetworkEvent (net.minecraftforge.fml.common.network)
	DecorateBiomeEvent (net.minecraftforge.event.terraingen)
		Decorate in DecorateBiomeEvent (net.minecraftforge.event.terraingen)
		Post in DecorateBiomeEvent (net.minecraftforge.event.terraingen)
		Pre in DecorateBiomeEvent (net.minecraftforge.event.terraingen)
	DrawBlockHighlightEvent (net.minecraftforge.client.event)
	EntityEvent (net.minecraftforge.event.entity)
		CanUpdate in EntityEvent (net.minecraftforge.event.entity)
		EnteringChunk in EntityEvent (net.minecraftforge.event.entity)
		EntityConstructing in EntityEvent (net.minecraftforge.event.entity)
		EntityJoinWorldEvent (net.minecraftforge.event.entity)
		EntityMountEvent (net.minecraftforge.event.entity)
		EntityStruckByLightningEvent (net.minecraftforge.event.entity)
		EntityTravelToDimensionEvent (net.minecraftforge.event.entity)
		ItemEvent (net.minecraftforge.event.entity.item)
			ItemExpireEvent (net.minecraftforge.event.entity.item)
			ItemTossEvent (net.minecraftforge.event.entity.item)
		LivingEvent (net.minecraftforge.event.entity.living)
			EnderTeleportEvent (net.minecraftforge.event.entity.living)
			LivingAttackEvent (net.minecraftforge.event.entity.living)
			LivingDeathEvent (net.minecraftforge.event.entity.living)
			LivingDropsEvent (net.minecraftforge.event.entity.living)
				PlayerDropsEvent (net.minecraftforge.event.entity.player)
			LivingEntityUseItemEvent (net.minecraftforge.event.entity.living)
				Finish in LivingEntityUseItemEvent (net.minecraftforge.event.entity.living)
				Start in LivingEntityUseItemEvent (net.minecraftforge.event.entity.living)
Stop in LivingEntityUseItemEvent (net.minecraftforge.event.entity.living)
Tick in LivingEntityUseItemEvent (net.minecraftforge.event.entity.living)
LivingEquipmentChangeEvent (net.minecraftforge.event.entity.living)
LivingExperienceDropEvent (net.minecraftforge.event.entity.living)
LivingFallEvent (net.minecraftforge.event.entity.living)
LivingHealEvent (net.minecraftforge.event.entity.living)
LivingHurtEvent (net.minecraftforge.event.entity.living)
LivingJumpEvent in LivingEvent (net.minecraftforge.event.entity.living)
LivingPackSizeEvent (net.minecraftforge.event.entity.living)
LivingSetAttackTargetEvent (net.minecraftforge.event.entity.living)
LivingSpawnEvent (net.minecraftforge.event.entity.living)
			AllowDespawn in LivingSpawnEvent (net.minecraftforge.event.entity.living)
			CheckSpawn in LivingSpawnEvent (net.minecraftforge.event.entity.living)
			SpecialSpawn in LivingSpawnEvent (net.minecraftforge.event.entity.living)
LivingUpdateEvent in LivingEvent (net.minecraftforge.event.entity.living)
LootingLevelEvent (net.minecraftforge.event.entity.living)
PlayerEvent (net.minecraftforge.event.entity.player)
			AchievementEvent (net.minecraftforge.event.entity.player)
			AnvilRepairEvent (net.minecraftforge.event.entity.player)
			ArrowLooseEvent (net.minecraftforge.event.entity.player)
			ArrowNockEvent (net.minecraftforge.event.entity.player)
			AttackEntityEvent (net.minecraftforge.event.entity.player)
			BonemealEvent (net.minecraftforge.event.entity.player)
			BreakSpeed in PlayerEvent (net.minecraftforge.event.entity.player)
			Clone in PlayerEvent (net.minecraftforge.event.entity.player)
			EntityItemPickupEvent (net.minecraftforge.event.entity.player)
			FillBucketEvent (net.minecraftforge.event.entity.player)
			HarvestCheck in PlayerEvent (net.minecraftforge.event.entity.player)
			ItemTooltipEvent (net.minecraftforge.event.entity.player)
			LoadFromFile in PlayerEvent (net.minecraftforge.event.entity.player)
			NameFormat in PlayerEvent (net.minecraftforge.event.entity.player)
			PlayerBrewedPotionEvent (net.minecraftforge.event.brewing)
			PlayerContainerEvent (net.minecraftforge.event.entity.player)
			PlayerDestroyItemEvent (net.minecraftforge.event.entity.player)
			PlayerFlyableFallEvent (net.minecraftforge.event.entity.player)
			PlayerInteractEvent (net.minecraftforge.event.entity.player)
	PlayerPickupXpEvent (net.minecraftforge.event.entity.player)
	PlayerSetSpawnEvent (net.minecraftforge.event.entity.player)
	PlayerSleepInBedEvent (net.minecraftforge.event.entity.player)
	PlayerWakeUpEvent (net.minecraftforge.event.entity.player)
	RenderPlayerEvent (net.minecraftforge.client.event)
	SaveToFile in PlayerEvent (net.minecraftforge.event.entity.player)
	SleepingLocationCheckEvent (net.minecraftforge.event.entity.player)
	StartTracking in PlayerEvent (net.minecraftforge.event.entity.player)
	StopTracking in PlayerEvent (net.minecraftforge.event.entity.player)
	UseHoeEvent (net.minecraftforge.event.entity.player)
	Visibility in PlayerEvent (net.minecraftforge.event.entity.player)
MinecartEvent (net.minecraftforge.event.entity.minecart)
	MinecartCollisionEvent (net.minecraftforge.event.entity.minecart)
	MinecartInteractEvent (net.minecraftforge.event.entity.minecart)
	MinecartUpdateEvent (net.minecraftforge.event.entity.minecart)
PlaySoundAtEntityEvent (net.minecraftforge.event.entity)
ThrowableImpactEvent (net.minecraftforge.event.entity)
ZombieEvent (net.minecraftforge.event.entity.living)
	SummonAidEvent in ZombieEvent (net.minecraftforge.event.entity.living)
EntitySelectorEvent (net.minecraftforge.event)
EntityViewRenderEvent (net.minecraftforge.client.event)
	CameraSetup in EntityViewRenderEvent (net.minecraftforge.client.event)
	FogColors in EntityViewRenderEvent (net.minecraftforge.client.event)
	FogDensity in EntityViewRenderEvent (net.minecraftforge.client.event)
	FOVModifier in EntityViewRenderEvent (net.minecraftforge.client.event)
	RenderFogEvent in EntityViewRenderEvent (net.minecraftforge.client.event)
ExplosionEvent (net.minecraftforge.event.world)
	Detonate in ExplosionEvent (net.minecraftforge.event.world)
	Start in ExplosionEvent (net.minecraftforge.event.world)
FluidEvent (net.minecraftforge.fluids)
	FluidDrainingEvent in FluidEvent (net.minecraftforge.fluids)
	FluidFillingEvent in FluidEvent (net.minecraftforge.fluids)
	FluidMotionEvent in FluidEvent (net.minecraftforge.fluids)
	FluidSpilledEvent in FluidEvent (net.minecraftforge.fluids)
FluidRegisterEvent in FluidRegistry (net.minecraftforge.fluids)
FMLNetworkEvent (net.minecraftforge.fml.common.network)
	ClientConnectedToServerEvent in FMLNetworkEvent (net.minecraftforge.fml.common.network)
	ClientDisconnectionFromServerEvent in FMLNetworkEvent (net.minecraftforge.fml.common.network)
	CustomPacketEvent in FMLNetworkEvent (net.minecraftforge.fml.common.network)
		ClientCustomPacketEvent in FMLNetworkEvent (net.minecraftforge.fml.common.network)
		ServerCustomPacketEvent in FMLNetworkEvent (net.minecraftforge.fml.common.network)
	CustomPacketRegistrationEvent in FMLNetworkEvent (net.minecraftforge.fml.common.network)
	ServerConnectionFromClientEvent in FMLNetworkEvent (net.minecraftforge.fml.common.network)
	ServerDisconnectionFromClientEvent in FMLNetworkEvent (net.minecraftforge.fml.common.network)
ForceChunkEvent in ForgeChunkManager (net.minecraftforge.common)
FOVUpdateEvent (net.minecraftforge.client.event)
GenericEvent (net.minecraftforge.fml.common.eventhandler)
	AttachCapabilitiesEvent (net.minecraftforge.event)
		Entity in AttachCapabilitiesEvent (net.minecraftforge.event)
		Item in AttachCapabilitiesEvent (net.minecraftforge.event)
		TileEntity in AttachCapabilitiesEvent (net.minecraftforge.event)
		World in AttachCapabilitiesEvent (net.minecraftforge.event)
	RegistryEvent (net.minecraftforge.event)
		Register in RegistryEvent (net.minecraftforge.event)
GuiOpenEvent (net.minecraftforge.client.event)
GuiScreenEvent (net.minecraftforge.client.event)
	ActionPerformedEvent in GuiScreenEvent (net.minecraftforge.client.event)
		Post in ActionPerformedEvent in GuiScreenEvent (net.minecraftforge.client.event)
		Pre in ActionPerformedEvent in GuiScreenEvent (net.minecraftforge.client.event)
	BackgroundDrawnEvent in GuiScreenEvent (net.minecraftforge.client.event)
	DrawScreenEvent in GuiScreenEvent (net.minecraftforge.client.event)
		Post in DrawScreenEvent in GuiScreenEvent (net.minecraftforge.client.event)
		Pre in DrawScreenEvent in GuiScreenEvent (net.minecraftforge.client.event)
	InitGuiEvent in GuiScreenEvent (net.minecraftforge.client.event)
		Post in InitGuiEvent in GuiScreenEvent (net.minecraftforge.client.event)
		Pre in InitGuiEvent in GuiScreenEvent (net.minecraftforge.client.event)
	KeyboardInputEvent in GuiScreenEvent (net.minecraftforge.client.event)
		Post in KeyboardInputEvent in GuiScreenEvent (net.minecraftforge.client.event)
		Pre in KeyboardInputEvent in GuiScreenEvent (net.minecraftforge.client.event)
	MouseInputEvent in GuiScreenEvent (net.minecraftforge.client.event)
		Post in MouseInputEvent in GuiScreenEvent (net.minecraftforge.client.event)
		Pre in MouseInputEvent in GuiScreenEvent (net.minecraftforge.client.event)
	PotionShiftEvent in GuiScreenEvent (net.minecraftforge.client.event)
InitMapGenEvent (net.minecraftforge.event.terraingen)
InputEvent (net.minecraftforge.fml.common.gameevent)
	KeyInputEvent in InputEvent (net.minecraftforge.fml.common.gameevent)
	MouseInputEvent in InputEvent (net.minecraftforge.fml.common.gameevent)
LootTableLoadEvent (net.minecraftforge.event)
ModelBakeEvent (net.minecraftforge.client.event)
ModelRegistryEvent (net.minecraftforge.client.event)
MouseEvent (net.minecraftforge.client.event)
NewRegistry in RegistryEvent (net.minecraftforge.event)
OreGenEvent (net.minecraftforge.event.terraingen)
	GenerateMinable in OreGenEvent (net.minecraftforge.event.terraingen)
	Post in OreGenEvent (net.minecraftforge.event.terraingen)
	Pre in OreGenEvent (net.minecraftforge.event.terraingen)
OreRegisterEvent in OreDictionary (net.minecraftforge.oredict)
PlayerEvent (net.minecraftforge.fml.common.gameevent)
	ItemCraftedEvent in PlayerEvent (net.minecraftforge.fml.common.gameevent)
	ItemPickupEvent in PlayerEvent (net.minecraftforge.fml.common.gameevent)
	ItemSmeltedEvent in PlayerEvent (net.minecraftforge.fml.common.gameevent)
	PlayerChangedDimensionEvent in PlayerEvent (net.minecraftforge.fml.common.gameevent)
	PlayerLoggedInEvent in PlayerEvent (net.minecraftforge.fml.common.gameevent)
	PlayerLoggedOutEvent in PlayerEvent (net.minecraftforge.fml.common.gameevent)
	PlayerRespawnEvent in PlayerEvent (net.minecraftforge.fml.common.gameevent)
PotionBrewEvent (net.minecraftforge.event.brewing)
	Post in PotionBrewEvent (net.minecraftforge.event.brewing)
	Pre in PotionBrewEvent (net.minecraftforge.event.brewing)
RenderBlockOverlayEvent (net.minecraftforge.client.event)
RenderGameOverlayEvent (net.minecraftforge.client.event)
	Post in RenderGameOverlayEvent (net.minecraftforge.client.event)
	Pre in RenderGameOverlayEvent (net.minecraftforge.client.event)
		BossInfo in RenderGameOverlayEvent (net.minecraftforge.client.event)
		Chat in RenderGameOverlayEvent (net.minecraftforge.client.event)
		Text in RenderGameOverlayEvent (net.minecraftforge.client.event)
RenderHandEvent (net.minecraftforge.client.event)
RenderItemInFrameEvent (net.minecraftforge.client.event)
RenderLivingEvent (net.minecraftforge.client.event)
	Post in RenderLivingEvent (net.minecraftforge.client.event)
	Pre in RenderLivingEvent (net.minecraftforge.client.event)
	Specials in RenderLivingEvent (net.minecraftforge.client.event)
		Post in Specials in RenderLivingEvent (net.minecraftforge.client.event)
		Pre in Specials in RenderLivingEvent (net.minecraftforge.client.event)
RenderSpecificHandEvent (net.minecraftforge.client.event)
RenderTooltipEvent (net.minecraftforge.client.event)
	Post in RenderTooltipEvent (net.minecraftforge.client.event)
		PostBackground in RenderTooltipEvent (net.minecraftforge.client.event)
		PostText in RenderTooltipEvent (net.minecraftforge.client.event)
	Pre in RenderTooltipEvent (net.minecraftforge.client.event)
RenderWorldLastEvent (net.minecraftforge.client.event)
ScreenshotEvent (net.minecraftforge.client.event)
ServerChatEvent (net.minecraftforge.event)
SoundEvent (net.minecraftforge.client.event.sound)
	PlaySoundEvent (net.minecraftforge.client.event.sound)
	SoundLoadEvent (net.minecraftforge.client.event.sound)
	SoundSetupEvent (net.minecraftforge.client.event.sound)
	SoundSourceEvent in SoundEvent (net.minecraftforge.client.event.sound)
		PlaySoundSourceEvent (net.minecraftforge.client.event.sound)
		PlayStreamingSourceEvent (net.minecraftforge.client.event.sound)
TextureStitchEvent (net.minecraftforge.client.event)
	Post in TextureStitchEvent (net.minecraftforge.client.event)
	Pre in TextureStitchEvent (net.minecraftforge.client.event)
TickEvent (net.minecraftforge.fml.common.gameevent)
	ClientTickEvent in TickEvent (net.minecraftforge.fml.common.gameevent)
	PlayerTickEvent in TickEvent (net.minecraftforge.fml.common.gameevent)
	RenderTickEvent in TickEvent (net.minecraftforge.fml.common.gameevent)
	ServerTickEvent in TickEvent (net.minecraftforge.fml.common.gameevent)
	WorldTickEvent in TickEvent (net.minecraftforge.fml.common.gameevent)
UnforceChunkEvent in ForgeChunkManager (net.minecraftforge.common)
WorldEvent (net.minecraftforge.event.world)
	ChunkEvent (net.minecraftforge.event.world)
		ChunkDataEvent (net.minecraftforge.event.world)
			Load in ChunkDataEvent (net.minecraftforge.event.world)
			Save in ChunkDataEvent (net.minecraftforge.event.world)
		Load in ChunkEvent (net.minecraftforge.event.world)
		Unload in ChunkEvent (net.minecraftforge.event.world)
	CreateSpawnPosition in WorldEvent (net.minecraftforge.event.world)
	GetCollisionBoxesEvent (net.minecraftforge.event.world)
	InitNoiseGensEvent (net.minecraftforge.event.terraingen)
	Load in WorldEvent (net.minecraftforge.event.world)
	PotentialSpawns in WorldEvent (net.minecraftforge.event.world)
	SaplingGrowTreeEvent (net.minecraftforge.event.terraingen)
	Save in WorldEvent (net.minecraftforge.event.world)
	Unload in WorldEvent (net.minecraftforge.event.world)
WorldTypeEvent (net.minecraftforge.event.terraingen)
	BiomeSize in WorldTypeEvent (net.minecraftforge.event.terraingen)
	InitBiomeGens in WorldTypeEvent (net.minecraftforge.event.terraingen)

流体API

• FluidContainerRegistry Capabilityシステムの導入に伴い廃止

流体の容器の登録API

鉱石辞書

• OreDictionary

鉱石辞書本体, 鉱石辞書への登録, 参照を担うAPI

• ShapedOreRecipe

鉱石辞書を利用した定形レシピを追加するためのクラス

• ShapelessOreRecipe

鉱石辞書を利用した不定形レシピを追加するためのクラス