提供: Minecraft Modding Wiki
移動先: 案内、 検索
(ModLoaderAPI解説と同様に表で概要を作成)
(→‎一覧: 表にしてみた)
 
(5人の利用者による、間の36版が非表示)
1行目: 1行目:
−
<!--
+
{{Warning}}現在編集中であり、古い情報が多く含まれています。
−
Minecraft Forgeとは、ＭＯＤ作成において要求頻度の高い様々な拡張機能を総合的に補助する前提ＭＯＤ。<br />
+
==概要==
−
SpriteIDの消費抑制や、ModLoaderだけでは出来ないような複雑で細かなシステムの作成ができる。 <br />
+
Minecraft Forgeとは、Mod間の互換性を保ちつつMinecraftを拡張するために作られたAPIである。<br>
−
使用するには、先にModloaderを導入する必要があったが、version 3.3.7より不必要となり、ModLoaderの機能をMinecraft Forgeが代替するようになった。 <br />
+
1.8以前はForgeModLoaderが基本部分を担っていたが、統合された。
  
−
[http://minecraftforge.net/wiki/Main_Page Minecraft Forge公式wiki]
+
===開発環境でのインストール方法===
 +
[[MinecraftForge導入手順]]を参照。
  
−
[[Minecraft Forge公式wiki翻訳]]
+
===関連リンク===
 +
*[//mcforge.readthedocs.org MinecraftForge Documentation (English)]
 +
*[http://www.minecraftforge.net/forum/ Minecraft Forge Forum]
 +
*[http://files.minecraftforge.net/ Minecraft Forge Downloads]
 +
<div class="mw-collapsible mw-collapsed">
 +
====古いリンク====
 +
<div class="mw-collapsible-content">
 +
*[http://forum.minecraftuser.jp/viewtopic.php?f=21&t=2558 【API解説】Minecraft Forge(1.3.0)]
 +
*[[Minecraft Forge公式wiki翻訳]]
 +
*[http://www4.atwiki.jp/reginn666/ reginn666@ウィキ]
 +
</div>
 +
</div>
  
−
== ソースコードの例 ==
+
==ForgeModLoader API==
 +
1.8の統合後は<code>net.minecraftforge.fml</code>下、統合前は<code>cpw.mods.fml</code>下に存在するAPI群。<br>
 +
ローダー部分や基本的なイベント、フックはこちらに含まれている。<br>
 +
現在は統合されているため、特にMinecraft Forgeと区別する必要はない。
 +
*net.minecraftforge.fml
 +
**client
 +
**:クライアントサイドのAPI群
 +
**:*config
 +
**:*:コンフィグGUI向けのコンポーネント群
 +
**:*event
 +
**:*:クライアントサイド基本イベント
 +
**:*:*[[ConfigChangedEvent]]
 +
**:*registry
 +
**:*:クライアントサイドレジストリ
 +
**:*:*[[ClientRegistry]]
 +
**:*:*<s>[[KeyBindingRegistry]]</s> <u>[[ClientRegistry]]</u> (1.3のUniversal化に伴い移動された)
 +
**:*:*[[RenderingRegistry]]
 +
**:*[[FMLClientHandler]]
 +
**:*[[IModGuiFactory]]
 +
**common
 +
**:クライアント/サーバー共通のAPI群
 +
**:*asm
 +
**:*:FML内部のASM利用クラス
 +
**:*discovery
 +
**:*:Mod探知機能群
 +
**:*:*[[ASMDataTable]]
 +
**:*event
 +
**:*:EventHandlerアノテーションで購読できるイベント群
 +
**:*:*[[1.6の基本コーティング|FMLStateEvent]]
 +
**:*eventhandler
 +
**:*:Event関連の基本クラス
 +
**:*:*[[Event]]
 +
**:*:*[[Event|SubscribeEvent]]
 +
**:*functions
 +
**:*:UtilのFunction群
 +
**:*gameevent
 +
**:*:基本的なゲーム内イベント群
 +
**:*:*[[InputEvent]]
 +
**:*:*[[FMLPlayerEvent|PlayerEvent]]
 +
**:*:*[[TickEvent]]
 +
**:*launcher
 +
**:*:FML自体をMinecraftに仕込むためのクラス群
 +
**:*network
 +
**:*:サーバーとクライアントを橋渡しするためのクラス群
 +
**:*:*handshake
 +
**:*:*:橋渡しの内部処理
 +
**:*:*internal
 +
**:*:*:FML自体が用いているメッセージング処理
 +
**:*:*simpleimpl
 +
**:*:*:単純実装群
 +
**:*:*:関連チュートリアル: [[1.7のパケットについて]]
 +
**:*:*[[FMLNetworkEvent]]
 +
**:*:*[[IGuiHandler]]
 +
**:*:*[[NetworkCheckHandler]]
 +
**:*:*[[NetworkRegistry]]
 +
**:*patcher
 +
**:*:MinecraftにFML変更部分をパッチするためのクラス群
 +
**:*registry
 +
**:*:基本レジストリ群
 +
**:*:*[[EntityRegistry]]
 +
**:*:*[[GameRegistry]]
 +
**:*:**<s>[[ICraftingHandler]]</s> <u>[[FMLPlayerEvent|PlayerEvent]]</u> (1.3のUniversal化に伴いEventとなった)
 +
**:*:**[[IFuelHandler]]
 +
**:*:**<s>[[IPickupNotifier]]</s> <u>[[FMLPlayerEvent|PlayerEvent]]</u> (1.3のUniversal化に伴いEventとなった)
 +
**:*:**<s>[[IPlayerTracker]]</s> <u>[[FMLPlayerEvent|PlayerEvent]]</u> (1.3のUniversal化に伴いEventとなった)
 +
**:*:**[[IWorldGeneretor]]
 +
**:*:*[[IEntityAdditionalSpawnData]]
 +
**:*:*[[IThrowableEntity]]
 +
**:*:*<s>[[LanguageRegistry]]</s> <u>[[TickEvent]]</u> (1.3のUniversal化に伴いEventとなった)
 +
**:*:*[[RegistryBuilder]]
 +
**:*:*<s>[[TickRegistry]]</s> <u>[[ClientRegistry]]</u> (1.3のUniversal化に伴い移動された)
 +
**:*:*[[VillagerRegistry]]
 +
**:*toposort
 +
**:*:Modのソートに使用されるTopologicalSortの実装
 +
**:*versioning
 +
**:*:バージョン表記のパーサー群
 +
**relancher
 +
**:ローダー周りのUtil、API群
 +
**:*[[IFMLCallHook]]
 +
**:*[[Coremodsの基礎|IFMLLoadingPlugin]]
 +
**:*[[SideOnly]]
 +
**repackage
 +
**:FML内部で使われているサードパーティー製Util群
 +
**server
 +
**:サーバーサイドのAPI群
 +
**:*[[FMLServerHandler]]
  
 +
==Minecraft Forge API==
 +
===追加メソッド===
  
−
'''以降の情報は、古いバージョンのForgeに対しての物である可能性があります。'''  
+
===基礎===
 +
*;[[AchievementPage]]
 +
:実績ページの追加を担うAPI
 +
*;[[BiomeManager]]
 +
:村や遺跡などが生成されるバイオームを管理するAPI
 +
*;<s>[[ChestGenHooks]]</s>
 +
:ダンジョンや遺跡, 廃坑などに生成されるチェストの中身へのフックを担うAPI
 +
:'''1.9でLootTableが実装されたため廃止された。'''
 +
*;[[Configuration]]
 +
:Forge式コンフィグファイルの生成を担うユーティリティ
 +
*;[[DimensionManager]]
 +
:Dimension関連のAPI
 +
*;[[EnumHelper]]
 +
:動的にEnum定数を追加するユーティリティ
 +
*;[[MinecraftForge]]
 +
:イベントの登録や様々なフックを担うAPI
  
 +
*;[[EnumPlantType]]
 +
:植物に関するEnum定数
 +
*;<s>[[ForgeDirection]]</s>
 +
:方向に関するEnum定数
 +
:'''1.8以降バニラにEnumDirectionができたので廃止された。'''
  
−
以下にもっとも単純な自作Modクラスを示します。
+
*;[[IPlantable]]
 +
:植物インタフェース
 +
*;[[IShearable]]
 +
:ハサミインタフェース
 +
*;[[ISpecialArmor]]
 +
:特殊な防具用のインタフェース
 +
:;関連クラス
 +
:*[[ArmorProperties]]
  
−
このソースコードは、Forgeの無限スプライト機能を利用した新規鉱石とインゴットを追加するサンプルになります。<br />
+
===イベント===
−
1部の機能はModLoaderの使い方と似ているので、ModLoaderの使い方を知っているとある程度楽に利用できる。<br />
+
*;[[Event]]
 +
:イベント概略
 +
*;[[通常イベント]]
 +
:EVENT_BUSに登録するイベント
 +
*;[[地形生成イベント]]
 +
:TERRAIN_GEN_BUSに登録するイベント
 +
*;[[鉱石生成イベント]]
 +
:ORE_GEN_BUSに登録するイベント
 +
==== 一覧 ====
 +
整備中。
  
−
<source lang="java">
+
{| class="mw-collapsible mw-collapsed wikitable"
−
package net.minecraft.src;
+
|+イベント一覧
−
 
+
|-
−
/**
+
! colspan="5" | Event名
−
* 自作Modクラス
+
|-
−
* BaseModクラスを継承している
+
| rowspan="272" | Event (net.minecraftforge.fml.common.eventhandler)
−
*/
+
|
−
 
+
|
−
public class mod_CamelOre extends BaseMod
+
|
−
{
+
|
−
      /*
+
|-
−
        *自作の追加鉱石の設定を行う。
+
| AnvilUpdateEvent (net.minecraftforge.event)
−
        *ここで鉱石の名前と、画像ファイルの位置、鉱石の硬さ、鉱石の抵抗？、鉱石の上を歩いた時の音、鉱石の名前を設定している。
+
|
−
        */
+
|
−
        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");
+
| BabyEntitySpawnEvent (net.minecraftforge.event.entity.living)
−
 
+
|
−
        public static final Item ingotTitanium =
+
|
−
              (new CamelOreItem(127)).setIconIndex(ModLoader.addOverride("/gui/items.png", "/CamelMod/CamelOre/gui/items/titaniumingot.png"))
+
|
−
              .setItemName("ingotTitanium");
+
|-
−
 
+
| rowspan="7" | BiomeEvent (net.minecraftforge.event.terraingen)
−
        /*
+
|
−
        *自作MODのコンストラクタ
+
|
−
        *Modで使う変数の初期化はここで行われる
+
|
−
        */
+
|-
−
        public mod_CamelOre()
+
| rowspan="4" | BiomeColor in BiomeEvent (net.minecraftforge.event.terraingen)
−
        {
+
|
−
 
+
|
−
        }
+
|-
−
       
+
| GetFoliageColor in BiomeEvent (net.minecraftforge.event.terraingen)
−
        /**
+
|
−
        * 自作ModがModLoaderによって読み込まれる際に呼ばれる
+
|-
−
        * ここでアイテムやブロックの定義、レシピの追加などを行う
+
| GetGrassColor in BiomeEvent (net.minecraftforge.event.terraingen)
−
        */
+
|
−
        public void load()
+
|-
−
        {
+
| GetWaterColor in BiomeEvent (net.minecraftforge.event.terraingen)
−
                ModLoader.RegisterBlock(oreTitanium);
+
|
−
                ModLoader.AddName(oreTitanium, "Titanium Ore");
+
|-
−
                ModLoader.AddName(ingotTitanium, "Titanium Ingot");
+
| CreateDecorator in BiomeEvent (net.minecraftforge.event.terraingen)
−
        }
+
|
−
       
+
|
−
        /**
+
|-
−
        * 自作Modのバージョンを定義する
+
| GetVillageBlockID in BiomeEvent (net.minecraftforge.event.terraingen)
−
        * MinecraftやModLoaderのバージョンと同じである必要はないが、わかりやすいものがよい
+
|
−
        */
+
|
−
        public String getVersion()
+
|-
−
        {
+
| rowspan="13" | BlockEvent (net.minecraftforge.event.world)
−
                return "1.0.0";
+
|
−
        }
+
|
−
}
+
|
−
 
+
|-
−
</source>
+
| BreakEvent in BlockEvent (net.minecraftforge.event.world)
−
 
+
|
−
== メソッド一覧 ==
+
|
−
 
+
|-
−
 
+
| CreateFluidSourceEvent in BlockEvent (net.minecraftforge.event.world)
−
<table class="wikitable">
+
|
−
    <tr>
+
|
−
        <th>メソッド名</th><th>説明</th>
+
|-
−
    </tr>
+
| rowspan="3" | CropGrowEvent in BlockEvent (net.minecraftforge.event.world)
−
 
+
|
−
</table>
+
|
−
-->
+
|-
−
 
+
| Post in CropGrowEvent in BlockEvent (net.minecraftforge.event.world)
−
==概要==
+
|
−
<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が大きく異なるためである.
+
| Pre in CropGrowEvent in BlockEvent (net.minecraftforge.event.world)
−
</p>
+
|
−
===開発環境でのインストール方法===
+
|-
−
<p>
+
| HarvestDropsEvent in BlockEvent (net.minecraftforge.event.world)
−
　[[MinecraftForge導入手順（MCP)]]にある通り, Forge ForumないしForge Downloadsからrecommended(推奨版)またはlatest(最新版)をダウンロードし, 解凍後任意のディレクトリで同梱の'''install.bat'''または'''install.sh'''を実行すれば開発環境が構築される.
+
|
−
</p>
+
|
−
 
+
|-
−
===関連リンク===
+
| NeighborNotifyEvent in BlockEvent (net.minecraftforge.event.world)
−
*[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]
+
| rowspan="3" | NoteBlockEvent (net.minecraftforge.event.world)
−
 
+
|
−
===ForgeModLoaderについて===
+
|
−
<p>
+
|-
−
　ForgeModLoader(以下FML)はForge用に作られた新しいModLoaderである. ModLoaderとは互換性があり, ModLoaderで作られたModでもFMLで動作することがある. 1.3以降時にForgeが担っていたネットワーク関連のAPIがFMLに委譲されており, Forge前提でもFMLのAPIを利用することが多いためこのページではまとめて扱う.
+
| Change in NoteBlockEvent (net.minecraftforge.event.world)
−
</p>
+
|
−
 
+
|-
−
==ForgeModLoader API==
+
| Play in NoteBlockEvent (net.minecraftforge.event.world)
−
===基礎===
+
|
−
{|class="wikitable" style="border-width:1px 1px 1px 1px; border-color:black; border-style:solid; "
+
|-
−
|+ style="background:#ddd;text-align:center;padding:0 0 0 2px;"|GameRegistry
+
| rowspan="2" | PlaceEvent in BlockEvent (net.minecraftforge.event.world)
−
!メソッド名
+
|
−
!概要
+
|
−
!補足
+
|-
 +
| MultiPlaceEvent in BlockEvent (net.minecraftforge.event.world)
 +
|
 +
|-
 +
| rowspan="7" | ChunkGeneratorEvent (net.minecraftforge.event.terraingen)
 +
|
 +
|
 +
|
 +
|-
 +
| InitNoiseField in ChunkGeneratorEvent (net.minecraftforge.event.terraingen)
 +
|
 +
|
 +
|-
 +
| rowspan="4" | 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)
 +
|
 +
|
 +
|-
 +
| rowspan="3" | 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)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="3" | 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)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="4" | 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)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="90" | 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)
 +
|
 +
|
 +
|-
 +
| rowspan="3" | ItemEvent (net.minecraftforge.event.entity.item)
 +
|
 +
|
 +
|-
 +
| ItemExpireEvent (net.minecraftforge.event.entity.item)
 +
|
 +
|-
 +
| ItemTossEvent (net.minecraftforge.event.entity.item)
 +
|
 +
|-
 +
| rowspan="71" | LivingEvent (net.minecraftforge.event.entity.living)
 +
|
 +
|
 +
|-
 +
| EnderTeleportEvent (net.minecraftforge.event.entity.living)
 +
|
 +
|-
 +
| LivingAttackEvent (net.minecraftforge.event.entity.living)
 +
|
 +
|-
 +
| LivingDeathEvent (net.minecraftforge.event.entity.living)
 +
|
 +
|-
 +
| rowspan="2" | LivingDropsEvent (net.minecraftforge.event.entity.living)
 +
|
 +
|-
 +
| PlayerDropsEvent (net.minecraftforge.event.entity.player)
 +
|-
 +
| rowspan="5" | 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)
 +
|
 +
|-
 +
| rowspan="4" | 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)
 +
|
 +
|-
 +
| rowspan="46" | 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)
 +
|-
 +
| rowspan="4" | 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)
 +
|
 +
|
 +
|-
 +
| rowspan="2" | ZombieEvent (net.minecraftforge.event.entity.living)
 +
|
 +
|
 +
|-
 +
| SummonAidEvent in ZombieEvent (net.minecraftforge.event.entity.living)
 +
|
 +
|-
 +
| EntitySelectorEvent (net.minecraftforge.event)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="6" | 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)
 +
|
 +
|
 +
|-
 +
| rowspan="3" | ExplosionEvent (net.minecraftforge.event.world)
 +
|
 +
|
 +
|
 +
|-
 +
| Detonate in ExplosionEvent (net.minecraftforge.event.world)
 +
|
 +
|
 +
|-
 +
| Start in ExplosionEvent (net.minecraftforge.event.world)
 +
|
 +
|
 +
|-
 +
| rowspan="5" | 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)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="9" | FMLNetworkEvent (net.minecraftforge.fml.common.network)
 +
|
 +
|
 +
|
 +
|-
 +
| ClientConnectedToServerEvent in FMLNetworkEvent (net.minecraftforge.fml.common.network)
 +
|
 +
|
 +
|-
 +
| ClientDisconnectionFromServerEvent in FMLNetworkEvent (net.minecraftforge.fml.common.network)
 +
|
 +
|
 +
|-
 +
| rowspan="3" | 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)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="8" | GenericEvent (net.minecraftforge.fml.common.eventhandler)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="5" | 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)
 +
|
 +
|-
 +
| rowspan="2" | RegistryEvent (net.minecraftforge.event)
 +
|
 +
|
 +
|-
 +
| Register in RegistryEvent (net.minecraftforge.event)
 +
|
 +
|-
 +
| GuiOpenEvent (net.minecraftforge.client.event)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="18" | GuiScreenEvent (net.minecraftforge.client.event)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="3" | 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)
 +
|
 +
|
 +
|-
 +
| rowspan="3" | 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)
 +
|
 +
|-
 +
| rowspan="3" | 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)
 +
|
 +
|-
 +
| rowspan="3" | 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)
 +
|
 +
|-
 +
| rowspan="3" | 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)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="3" | 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)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="4" | 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)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="8" | 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)
 +
|
 +
|
 +
|-
 +
| rowspan="3" | PotionBrewEvent (net.minecraftforge.event.brewing)
 +
|
 +
|
 +
|
 +
|-
 +
| Post in PotionBrewEvent (net.minecraftforge.event.brewing)
 +
|
 +
|
 +
|-
 +
| Pre in PotionBrewEvent (net.minecraftforge.event.brewing)
 +
|
 +
|
 +
|-
 +
| RenderBlockOverlayEvent (net.minecraftforge.client.event)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="6" | RenderGameOverlayEvent (net.minecraftforge.client.event)
 +
|
 +
|
 +
|
 +
|-
 +
| Post in RenderGameOverlayEvent (net.minecraftforge.client.event)
 +
|
 +
|
 +
|-
 +
| rowspan="4" | 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)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="6" | RenderLivingEvent (net.minecraftforge.client.event)
 +
|
 +
|
 +
|
 +
|-
 +
| Post in RenderLivingEvent (net.minecraftforge.client.event)
 +
|
 +
|
 +
|-
 +
| Pre in RenderLivingEvent (net.minecraftforge.client.event)
 +
|
 +
|
 +
|-
 +
| rowspan="3" | 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)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="5" | RenderTooltipEvent (net.minecraftforge.client.event)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="3" | 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)
 +
|
 +
|
 +
|
 +
|-
 +
| rowspan="7" | SoundEvent (net.minecraftforge.client.event.sound)
 +
|
 +
|
 +
|
 +
|-
 +
| PlaySoundEvent (net.minecraftforge.client.event.sound)
 +
|
 +
|
 +
|-
 +
| SoundLoadEvent (net.minecraftforge.client.event.sound)
 +
|
 +
|
 +
|-
 +
| SoundSetupEvent (net.minecraftforge.client.event.sound)
 +
|
 +
|
 +
|-
 +
| rowspan="3" | SoundSourceEvent in SoundEvent (net.minecraftforge.client.event.sound)
 +
|
 +
|
 +
|-
 +
| PlaySoundSourceEvent (net.minecraftforge.client.event.sound)
 +
|
 +
|-
 +
| PlayStreamingSourceEvent (net.minecraftforge.client.event.sound)
 +
|
 +
|-
 +
| rowspan="3" | TextureStitchEvent (net.minecraftforge.client.event)
 +
|
 +
|
 +
|
 +
|-
 +
| Post in TextureStitchEvent (net.minecraftforge.client.event)
 +
|
 +
|
 +
|-
 +
| Pre in TextureStitchEvent (net.minecraftforge.client.event)
 +
|
 +
|
 +
|-
 +
| rowspan="6" | 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)
 +
|
 +
|
 
|-
 
|-
−
|public static void registerBlock(Block block)
+
| ServerTickEvent in TickEvent (net.minecraftforge.fml.common.gameevent)
−
|Blockの登録, ModLoader.registerBlockと同等
+
|  
−
|非推奨
+
|  
 
|-
 
|-
−
|public static void registerBlock(Block block, String name)
+
| WorldTickEvent in TickEvent (net.minecraftforge.fml.common.gameevent)
−
|Blockの登録
+
|  
−
|nameは後述のfindBlockを利用するときに使われる
+
|  
 
|-
 
|-
−
|public static void registerBlock(Block block, Class<? extends ItemBlock> itemclass)
+
| UnforceChunkEvent in ForgeChunkManager (net.minecraftforge.common)
−
|ItemBlockの登録, ModLoader.registerBlockと同等
+
|  
−
|非推奨
+
|  
 +
|
 
|-
 
|-
−
|public static void registerBlock(Block block, Class<? extends ItemBlock> itemclass, String name)
+
| rowspan="15" | WorldEvent (net.minecraftforge.event.world)
−
|ItemBlockの登録
+
|  
−
|nameは後述のfindBlockを利用するときに使われる
+
|  
 +
|
 
|-
 
|-
−
|public static void registerBlock(Block block, Class<? extends ItemBlock> itemclass, String name, String modId)
+
| rowspan="6" | ChunkEvent (net.minecraftforge.event.world)
−
|Block, ItemBlockの登録. 上記のメソッドでこのメソッドを呼んでいるので直接叩く機会はほぼない
+
|  
−
|上記のメソッドを利用した場合, modIdはnullとして登録される
+
|  
 
|-
 
|-
−
|public static void registerItem(net.minecraft.item.Item item, String name)
+
| rowspan="3" | ChunkDataEvent (net.minecraftforge.event.world)
−
|Itemの登録
+
|  
−
|後述のfindItemを利用する場合登録する
 
 
|-
 
|-
−
|public static void registerItem(net.minecraft.item.Item item, String name, String modId)
+
| Load in ChunkDataEvent (net.minecraftforge.event.world)
−
|Itemの登録
 
−
|後述のfindItemを利用する場合登録する
 
 
|-
 
|-
−
|public static Block findBlock(String modId, String name)
+
| Save in ChunkDataEvent (net.minecraftforge.event.world)
−
|modIdとnameからBlockを取得
 
−
|modIdとnameが適切に登録されている必要がある
 
 
|-
 
|-
−
|public static Item findItem(String modId, String name)
+
| Load in ChunkEvent (net.minecraftforge.event.world)
−
|modIdとnameからItemを取得
+
|  
−
|modIdとnameを適切に登録されている必要がある
 
 
|-
 
|-
−
|public static void addRecipe(ItemStack output, Object... params)
+
| Unload in ChunkEvent (net.minecraftforge.event.world)
−
|レシピの追加, ModLoader.addRecipeと同等
+
|  
−
|
 
 
|-
 
|-
−
|public static void addShapelessRecipe(ItemStack output, Object... params)
+
| CreateSpawnPosition in WorldEvent (net.minecraftforge.event.world)
−
|非定形レシピの追加, ModLoader.addShapelessRecipeと同等
+
|  
−
|
+
|  
 
|-
 
|-
−
|public static void addRecipe(IRecipe recipe)
+
| GetCollisionBoxesEvent (net.minecraftforge.event.world)
−
|レシピの追加, IRecipeを実装したクラスを渡すタイプ
+
|  
−
|鉱石辞書を利用したレシピ追加で利用
+
|  
 
|-
 
|-
−
|public static void addSmelting(int input, ItemStack output, float xp)
+
| InitNoiseGensEvent (net.minecraftforge.event.terraingen)
−
|精錬レシピの追加
+
|  
−
|メタデータを利用したアイテムの精錬レシピはこれではできないことに注意
+
|  
 
|-
 
|-
−
|public static void registerTileEntity(Class<? extends TileEntity> tileEntityClass, String id)
+
| Load in WorldEvent (net.minecraftforge.event.world)
−
|TileEntityの登録, idは固有の文字列
+
|  
−
|
+
|  
 
|-
 
|-
−
|public static void addBiome(BiomeGenBase biome)
+
| PotentialSpawns in WorldEvent (net.minecraftforge.event.world)
−
|バイオームの追加
+
|  
−
|
+
|  
 
|-
 
|-
−
|public static void removeBiome(BiomeGenBase biome)
+
| SaplingGrowTreeEvent (net.minecraftforge.event.terraingen)
−
|バイオームの削除
+
|  
−
|
+
|  
 
|-
 
|-
−
|public static void registerFuelHandler(IFuelHandler handler)
+
| Save in WorldEvent (net.minecraftforge.event.world)
−
|IFuelHandlerインタフェースの登録
+
|  
−
|
+
|  
 
|-
 
|-
−
|public static void registerCraftingHandler(ICraftingHandler handler)
+
| Unload in WorldEvent (net.minecraftforge.event.world)
−
|ICraftingHandlerインタフェースの登録
+
|  
−
|
+
|  
 
|-
 
|-
−
|public static void registerPickupHandler(IPickupNotifier handler)
+
| rowspan="3" | WorldTypeEvent (net.minecraftforge.event.terraingen)
−
|IPickupNotifierインタフェースの登録
+
|  
−
|
+
|
 +
|  
 
|-
 
|-
−
|public static void registerPlayerTracker(IPlayerTracker tracker)
+
| BiomeSize in WorldTypeEvent (net.minecraftforge.event.terraingen)
−
|IPlayerTrackerインタフェースの登録
+
|  
−
|
+
|  
 
|-
 
|-
−
|public static void registerWorldGenerator(IWorldGenerator generator)
+
| InitBiomeGens in WorldTypeEvent (net.minecraftforge.event.terraingen)
−
|IWorldGeneratorインタフェースの登録
+
|  
−
|
+
|  
 
|}
 
|}
−
*LanguageRegistry
 
−
表示名やローカライズを登録するAPI
 
−
*EntityRegistry
 
−
Entityを登録するAPI
 
−
*RenderingRegistry
 
−
描画関連のクラスを登録するAPI
 
−
 
−
*インタフェース
 
−
**ICraftingHandler
 
−
**IFuelHandler
 
−
**ITickHandler
 
−
**IWorldGeneretor
 
−
**IEntityAdditonalSpawnData
 
−
**IThorwableEntity
 
−
**IConnectionHandler
 
−
**IGuiHandler
 
−
**IPacketHandler
 
−
 
−
===coremods向け===
 
−
*API
 
−
*インタフェース
 
−
 
−
==Minecraft Forge API==
 
−
===追加メソッド===
 
−
 
−
===基礎===
 
−
 
−
===イベント===
 
  
−
===液体API===
+
===流体API===
−
*API
+
*;<s>[[FluidContainerRegistry]]</s> <u>Capabilityシステムの導入に伴い廃止</u>
−
*インタフェース
+
:流体の容器の登録API
  
 
===鉱石辞書===
 
===鉱石辞書===
−
*API
+
*;[[OreDictionary]]
 +
:鉱石辞書本体, 鉱石辞書への登録, 参照を担うAPI
 +
*;[[ShapedOreRecipe]]
 +
:鉱石辞書を利用した定形レシピを追加するためのクラス
 +
*;[[ShapelessOreRecipe]]
 +
:鉱石辞書を利用した不定形レシピを追加するためのクラス

2017年3月25日 (土) 14:07時点における最新版

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

概要[編集]

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

開発環境でのインストール方法[編集]

MinecraftForge導入手順を参照。

関連リンク[編集]

古いリンク[編集]

ForgeModLoader API[編集]

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

Minecraft Forge API[編集]

追加メソッド[編集]

基礎[編集]

実績ページの追加を担うAPI
村や遺跡などが生成されるバイオームを管理するAPI
ダンジョンや遺跡, 廃坑などに生成されるチェストの中身へのフックを担うAPI
1.9でLootTableが実装されたため廃止された。
Forge式コンフィグファイルの生成を担うユーティリティ
Dimension関連のAPI
動的にEnum定数を追加するユーティリティ
イベントの登録や様々なフックを担うAPI
植物に関するEnum定数
方向に関するEnum定数
1.8以降バニラにEnumDirectionができたので廃止された。
植物インタフェース
ハサミインタフェース
特殊な防具用のインタフェース
関連クラス

イベント[編集]

イベント概略
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[編集]

流体の容器の登録API

鉱石辞書[編集]

鉱石辞書本体, 鉱石辞書への登録, 参照を担うAPI
鉱石辞書を利用した定形レシピを追加するためのクラス
鉱石辞書を利用した不定形レシピを追加するためのクラス
「https://mcmodding.jp/modding/index.php?title=Minecraft_Forge_API&oldid=3384」から取得