「Minecraft Forge API」を編集中

<!--
Minecraft Forgeとは、ＭＯＤ作成において要求頻度の高い様々な拡張機能を総合的に補助する前提ＭＯＤ。<br />
SpriteIDの消費抑制や、ModLoaderだけでは出来ないような複雑で細かなシステムの作成ができる。 <br />
使用するには、先にModloaderを導入する必要があったが、version 3.3.7より不必要となり、ModLoaderの機能をMinecraft Forgeが代替するようになった。 <br />

[http://minecraftforge.net/wiki/Main_Page Minecraft Forge公式wiki]

[[Minecraft Forge公式wiki翻訳]]

== ソースコードの例 ==


'''以降の情報は、古いバージョンのForgeに対しての物である可能性があります。''' 


以下にもっとも単純な自作Modクラスを示します。

このソースコードは、Forgeの無限スプライト機能を利用した新規鉱石とインゴットを追加するサンプルになります。<br />
1部の機能はModLoaderの使い方と似ているので、ModLoaderの使い方を知っているとある程度楽に利用できる。<br />

<source lang="java">
 package net.minecraft.src;

 /**
 * 自作Modクラス
 * BaseModクラスを継承している
 */

public class mod_CamelOre extends BaseMod
{
       /*
        *自作の追加鉱石の設定を行う。
        *ここで鉱石の名前と、画像ファイルの位置、鉱石の硬さ、鉱石の抵抗？、鉱石の上を歩いた時の音、鉱石の名前を設定している。
        */
        public static final Block oreTitanium = 
              new CamelOreBlockOre(123, ModLoader.addOverride("/terrain.png", "/CamelMod/CamelOre/terrain/titaniumore.png")).
              setHardness(3F).setResistance(5F).setStepSound(Block.soundStoneFootstep).setBlockName("oreTitanium");

        public static final Item ingotTitanium =
              (new CamelOreItem(127)).setIconIndex(ModLoader.addOverride("/gui/items.png", "/CamelMod/CamelOre/gui/items/titaniumingot.png"))
               .setItemName("ingotTitanium");

        /*
         *自作MODのコンストラクタ
         *Modで使う変数の初期化はここで行われる
         */
        public mod_CamelOre()
        {

        }
        
        /**
        * 自作ModがModLoaderによって読み込まれる際に呼ばれる
        * ここでアイテムやブロックの定義、レシピの追加などを行う
        */
        public void load()
        {
                ModLoader.RegisterBlock(oreTitanium);
                ModLoader.AddName(oreTitanium, "Titanium Ore");
                ModLoader.AddName(ingotTitanium, "Titanium Ingot");
        }
        
        /**
        * 自作Modのバージョンを定義する
        * MinecraftやModLoaderのバージョンと同じである必要はないが、わかりやすいものがよい
        */
        public String getVersion()
        {
                return "1.0.0";
        }
}

</source>

== メソッド一覧 ==


<table class="wikitable">
    <tr>
        <th>メソッド名</th><th>説明</th>
    </tr>
   
</table>
-->

==概要==
<p>
　Minecraft ForgeとはMod作成に作成において要求頻度の高い様々な拡張機能を総合的に補助する前提Mod(拡張API)である. ver1.2.5まではModLoader, ModLoaderMP, Forgeと3つ導入する必要があったが, 1.3以降はForge用に調整されたForgeModLoaderが同梱されたので, Forgeのみ導入すればよくなった. なお, 1.2.5用の解説はここに記載しないので注意. 1.2.5と1.3ではForgeでもAPIが大きく異なるためである.
</p>
===開発環境でのインストール方法===
<p>
　[[MinecraftForge導入手順（MCP)]]にある通り, Forge ForumないしForge Downloadsからrecommended(推奨版)またはlatest(最新版)をダウンロードし, 解凍後任意のディレクトリで同梱の'''install.bat'''または'''install.sh'''を実行すれば開発環境が構築される.
</p>

===関連リンク===
*[http://minecraftforge.net/wiki/Main_Page Minecraft Forge公式wiki]
*[[Minecraft Forge公式wiki翻訳]]
*[http://minecraftforge.net/forum/ Minecraft Forge Forum]
*[http://files.minecraftforge.net/ Minecraft Forge Downloads]

===ForgeModLoaderについて===
<p>
　ForgeModLoader(以下FML)はForge用に作られた新しいModLoaderである. ModLoaderとは互換性があり, ModLoaderで作られたModでもFMLで動作することがある. 1.3以降時にForgeが担っていたネットワーク関連のAPIがFMLに委譲されており, Forge前提でもFMLのAPIを利用することが多いためこのページではまとめて扱う.
</p>

==ForgeModLoader API==
===基礎===
*;[[GameRegistry]]
:ブロックの登録やレシピの追加などを行うAPI<br>
:;関連インタフェース
:*[[ICraftingHandler]]
:*[[IFuelHandler]]
:*[[IIPickupNotifier]]
:*[[IPlayerTracker]]
:*[[IWorldGeneretor]]

*;[[LanguageRegistry]]
:表示名やローカライズを行うAPI

*;[[EntityRegistry]]
:Entityの登録を行うAPI
:;関連インタフェース
:*IEntityAdditonalSpawnData
:*IThorwableEntity

*;[[TickRegistry]]
:Tick処理の登録を行うAPI
:;関連インタフェース
:*ISceduledTickHandler
:*ITickHandler

*;[[VillagerRegistry]]
:村, 村人に関連した処理を担うAPI

*;[[ClientRegistry]]
:TileEntitySpecialRendererの登録を行うAPI, クライアント側のみ

*;[[KeyBindingRegistry]]
:キーバインドの登録を行うAPI, クライアント側のみ

*;[[RenderingRegistry]]
:描画関連の登録を行うAPI, クライアント側のみ

*;[[NetworkRegistry]]
:ネットワーク関連の登録を行うAPI
:;関連インタフェース
:*IConnectionHandler
:*IGuiHandler
:*IPacketHandler

===coremods向け===
*API
*インタフェース

==Minecraft Forge API==
===追加メソッド===

===基礎===
*;[[AchievementPage]]
:実績の追加を担うAPI
*;[[BiomeManager]]
:村や遺跡などが生成されるバイオームを管理するAPI
*;[[ChestGenHooks]]
:ダンジョンや遺跡, 廃坑などに生成されるチェストの中身へのフックを担うAPI
*;[[Configuration]]
:Forge式コンフィグファイルの生成を担うAPI
*;[[DimensionManager]]
:Dimension関連のAPI
*;[[EnumHelper]]
:動的にEnum定数を追加するAPI
*;[[MinecraftForge]]
:イベントの登録や様々なフックを担うAPI

*;[[EnumPlantType]]
:植物に関するEnum定数
*;[[ForgeDirection]]
:方向に関するEnum定数

*;[[IArmorTextureProvider]]
:追加する防具のテクスチャ参照用インタフェース
*;[[IMinecartCollisionHandler]]
:Minecartの衝突に関するインタフェース
*;[[IPlantable]]
:植物インタフェース
*;[[IShearable]]
:大挟インタフェース
*;[[ISpecialArmor]]
:特殊な防具用のインタフェース

===イベント===
*;[[Event]]
:イベント概略
*;[[通常イベント]]
:EVENT_BUSに登録するイベント
*;[[地形生成イベント]]
:TERRAIN_GEN_BUSに登録するイベント
*;[[鉱石生成イベント]]
:ORE_GEN_BUSに登録するイベント

===液体API===
*;[[LiquidContainerRegistry]]
:液体の登録API
*;[[LiquidDictionary]]
:液体辞書

===鉱石辞書===
*;[[OreDictionary]]
:鉱石辞書本体, 鉱石辞書への登録, 参照を担うAPI
*;[[ShapedOreRecipe]]
:鉱石辞書を利用した定形レシピを追加するためのクラス
*;[[ShapelessOreRecipe]]
:鉱石辞書を利用した不定形レシピを追加するためのクラス