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に登録するイベント

一覧

整備中。

流体API

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

流体の容器の登録API

鉱石辞書

• OreDictionary

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

• ShapedOreRecipe

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

• ShapelessOreRecipe

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