提供: Minecraft Modding Wiki
細 (→様々なイベントを受け取る: 改善) |
細 (→次にやった方がいいこと: リンク化) |
||
(3人の利用者による、間の5版が非表示) | |||
5行目: | 5行目: | ||
== 必要最低限のコード == | == 必要最低限のコード == | ||
− | + | MODであるというマークとなる@Modアノテーションが付いたクラスのみがある状態です。何の処理も行えないのですがMod一覧には表示されます。 | |
<source lang="java"> | <source lang="java"> | ||
18行目: | 18行目: | ||
== 初期化イベントを受け取る == | == 初期化イベントを受け取る == | ||
− | @ | + | @EventHandlerアノテーションをメソッドにつけると、とあるタイミング(この場合はMODが読み込まれるとき)にそのメソッドが呼ばれるためその中で様々な処理を行えます。ただし、その引数はある特定のイベントを表すクラス一つのみでなければなりません。 |
<source lang="java"> | <source lang="java"> | ||
25行目: | 25行目: | ||
import net.minecraftforge.fml.common.Mod; | import net.minecraftforge.fml.common.Mod; | ||
import net.minecraftforge.fml.common.Mod.EventHandler; | import net.minecraftforge.fml.common.Mod.EventHandler; | ||
− | import net.minecraftforge.fml.common.event. | + | import net.minecraftforge.fml.common.event.FMLInitializationEvent; |
− | import net.minecraftforge.fml.common.event. | + | import net.minecraftforge.fml.common.event.FMLPostInitializationEvent; |
− | import net.minecraftforge.fml.common.event. | + | import net.minecraftforge.fml.common.event.FMLPreInitializationEvent; |
@Mod(modid = "samplemod") | @Mod(modid = "samplemod") | ||
public class Sample { | public class Sample { | ||
@EventHandler | @EventHandler | ||
− | public preInit( | + | public void preInit(FMLPreInitializationEvent event) { |
// ... | // ... | ||
} | } | ||
@EventHandler | @EventHandler | ||
− | public init( | + | public void init(FMLInitializationEvent event) { |
// ... | // ... | ||
} | } | ||
@EventHandler | @EventHandler | ||
− | public postInit( | + | public void postInit(FMLPostInitializationEvent event) { |
// ... | // ... | ||
} | } | ||
54行目: | 54行目: | ||
== 様々なイベントを受け取る == | == 様々なイベントを受け取る == | ||
− | @ | + | @EventBusSubscriberアノテーションをクラスにつけるとさらに別のタイミングでメソッドが呼び出されるようにすることができます。呼び出されるようにしたいメソッドには@SubscribeEventアノテーションを'''static'''メソッドにつけてください。 |
<source lang="java"> | <source lang="java"> | ||
62行目: | 62行目: | ||
import net.minecraftforge.fml.common.Mod.EventHandler; | import net.minecraftforge.fml.common.Mod.EventHandler; | ||
import net.minecraftforge.fml.common.Mod.EventBusSubscriber; | import net.minecraftforge.fml.common.Mod.EventBusSubscriber; | ||
− | import net.minecraftforge.fml.common.event. | + | import net.minecraftforge.fml.common.event.FMLInitializationEvent; |
− | import net.minecraftforge.fml.common.event. | + | import net.minecraftforge.fml.common.event.FMLPostInitializationEvent; |
− | import net.minecraftforge.fml.common.event. | + | import net.minecraftforge.fml.common.event.FMLPreInitializationEvent; |
@Mod(modid = "samplemod") | @Mod(modid = "samplemod") | ||
70行目: | 70行目: | ||
public class Sample { | public class Sample { | ||
@EventHandler | @EventHandler | ||
− | public preInit( | + | public void preInit(FMLPreInitializationEvent event) { |
// ... | // ... | ||
} | } | ||
@EventHandler | @EventHandler | ||
− | public init( | + | public void init(FMLInitializationEvent event) { |
// ... | // ... | ||
} | } | ||
@EventHandler | @EventHandler | ||
− | public postInit( | + | public void postInit(FMLPostInitializationEvent event) { |
// ... | // ... | ||
} | } | ||
@SubscribeEvent | @SubscribeEvent | ||
− | public static registerItem(RegistryEvent.Register<Item> event) { | + | public static void registerItem(RegistryEvent.Register<Item> event) { |
// ... | // ... | ||
} | } | ||
} | } | ||
</source> | </source> | ||
+ | |||
+ | == 次にやった方がいいこと == | ||
+ | |||
+ | * @Modアノテーションの変数の設定 | ||
+ | * [[mcmod.infoの設定]] |
2019年7月4日 (木) 08:28時点における版
ここではMODのメインクラスの作り方を解説します。
必要最低限のコード
MODであるというマークとなる@Modアノテーションが付いたクラスのみがある状態です。何の処理も行えないのですがMod一覧には表示されます。
package info.minecraftjp; import net.minecraftforge.fml.common.Mod; @Mod(modid = "samplemod") public class Sample {}
初期化イベントを受け取る
@EventHandlerアノテーションをメソッドにつけると、とあるタイミング(この場合はMODが読み込まれるとき)にそのメソッドが呼ばれるためその中で様々な処理を行えます。ただし、その引数はある特定のイベントを表すクラス一つのみでなければなりません。
package info.minecraftjp; import net.minecraftforge.fml.common.Mod; import net.minecraftforge.fml.common.Mod.EventHandler; import net.minecraftforge.fml.common.event.FMLInitializationEvent; import net.minecraftforge.fml.common.event.FMLPostInitializationEvent; import net.minecraftforge.fml.common.event.FMLPreInitializationEvent; @Mod(modid = "samplemod") public class Sample { @EventHandler public void preInit(FMLPreInitializationEvent event) { // ... } @EventHandler public void init(FMLInitializationEvent event) { // ... } @EventHandler public void postInit(FMLPostInitializationEvent event) { // ... } }
これが定番です。ただし、@EventHandlerアノテーションがついてさえいればメソッドの名前や引数の名前は自由で、「ある特定のイベントを表すクラス」というのもこれだけではありません。
様々なイベントを受け取る
@EventBusSubscriberアノテーションをクラスにつけるとさらに別のタイミングでメソッドが呼び出されるようにすることができます。呼び出されるようにしたいメソッドには@SubscribeEventアノテーションをstaticメソッドにつけてください。
package info.minecraftjp; import net.minecraftforge.fml.common.Mod; import net.minecraftforge.fml.common.Mod.EventHandler; import net.minecraftforge.fml.common.Mod.EventBusSubscriber; import net.minecraftforge.fml.common.event.FMLInitializationEvent; import net.minecraftforge.fml.common.event.FMLPostInitializationEvent; import net.minecraftforge.fml.common.event.FMLPreInitializationEvent; @Mod(modid = "samplemod") @EventBusSubscriber public class Sample { @EventHandler public void preInit(FMLPreInitializationEvent event) { // ... } @EventHandler public void init(FMLInitializationEvent event) { // ... } @EventHandler public void postInit(FMLPostInitializationEvent event) { // ... } @SubscribeEvent public static void registerItem(RegistryEvent.Register<Item> event) { // ... } }
次にやった方がいいこと
- @Modアノテーションの変数の設定
- mcmod.infoの設定