提供: Minecraft Modding Wiki
移動先: 案内検索
(新しく作成して本当に最低限のコードだけ追加)
 
(「初期化イベントを受け取る」wo)
5行目: 5行目:
 
== 必要最低限のコード ==
 
== 必要最低限のコード ==
  
MODのエントリポイントとなる@Modアノテーションが付いたクラスのみがある状態であり、何の処理も行えないのですがMod一覧には表示されます。
+
MODのエントリポイントとなる@Modアノテーションが付いたクラスのみがある状態です。何の処理も行えないのですがMod一覧には表示されます。
  
 
<source lang="java">
 
<source lang="java">
15行目: 15行目:
 
public class Sample {}
 
public class Sample {}
 
</source>
 
</source>
 +
 +
== 初期化イベントを受け取る ==
 +
 +
@Mod.EventHandlerアノテーションをメソッドにつけると、MODが読み込まれる時にそのメソッドが呼ばれるためその中で様々な処理を行えます。ただし、その引数はある特定のイベントを表すクラス一つのみでなければなりません。
 +
 +
<source lang="java">
 +
package info.minecraftjp;
 +
 +
import net.minecraftforge.fml.common.Mod;
 +
import net.minecraftforge.fml.common.event.PreInitializationEvent;
 +
import net.minecraftforge.fml.common.event.InitializationEvent;
 +
import net.minecraftforge.fml.common.event.PostInitializationEvent;
 +
 +
@Mod(modid = "samplemod")
 +
public class Sample {
 +
    public preInit(PreInitializationEvent event) {
 +
        // ...
 +
    }
 +
 +
    public init(InitializationEvent event) {
 +
        // ...
 +
    }
 +
 +
    public postInit(PostInitializationEvent event) {
 +
        // ...
 +
    }
 +
}
 +
</source>
 +
 +
これが定番です。ただし、@Mod.EventHandlerアノテーションがついてさえいればメソッドの名前や引数の名前は自由で、「ある特定のイベントを表すクラス」というのもこれだけではありません。
 +
 +
* [https://github.com/MinecraftForge/MinecraftForge/blob/b15269fde504dbe8837a540202a0947c1a5b3e62/src/main/java/net/minecraftforge/fml/common/Mod.java#L278-L303 公式ドキュメント(2017/12/13時点)]

2017年12月23日 (土) 18:26時点における版

ここではMODのメインクラスの作り方を解説します。

必要最低限のコード

MODのエントリポイントとなる@Modアノテーションが付いたクラスのみがある状態です。何の処理も行えないのですがMod一覧には表示されます。

package info.minecraftjp;

import net.minecraftforge.fml.common.Mod;

@Mod(modid = "samplemod")
public class Sample {}

初期化イベントを受け取る

@Mod.EventHandlerアノテーションをメソッドにつけると、MODが読み込まれる時にそのメソッドが呼ばれるためその中で様々な処理を行えます。ただし、その引数はある特定のイベントを表すクラス一つのみでなければなりません。

package info.minecraftjp;

import net.minecraftforge.fml.common.Mod;
import net.minecraftforge.fml.common.event.PreInitializationEvent;
import net.minecraftforge.fml.common.event.InitializationEvent;
import net.minecraftforge.fml.common.event.PostInitializationEvent;

@Mod(modid = "samplemod")
public class Sample {
    public preInit(PreInitializationEvent event) {
        // ...
    }

    public init(InitializationEvent event) {
        // ...
    }

    public postInit(PostInitializationEvent event) {
        // ...
    }
}

これが定番です。ただし、@Mod.EventHandlerアノテーションがついてさえいればメソッドの名前や引数の名前は自由で、「ある特定のイベントを表すクラス」というのもこれだけではありません。