「本体ver1.3以降でのmod作成の注意点」を編集中

''編注: このページの内容は近代的なバージョンでは適用できないため、他のページを参照してください。''

本体ver1.3以降より、通常のクライアント版でもサーバ版と同様の構成に変わりました。<br />
ここではmod作成時に注意すべき点を記述します。

==本体プログラムの構成について==

minecraft本体は、実際のワールド情報を保持するサーバと、それらの情報を受け取って<br />
画面に表示するクライアントに分離されています。<br />
よってクライアント側のワールドをいくら操作しても、サーバ側は変化しません。<br />
あっという間に元通りになってしまいます。<br />
クライアント側のプレイヤーの周りに経験値オーブを大量発生させても、次の瞬間には消えていることでしょう。<br />

ではクライアント側ワールドはmodに不必要なのか、というとそうではありません。<br />
ブロックやアイテム（経験値オーブ含む）、他のプレイヤーやmobなどの状態を取得することに使用します。<br />
なぜクライアント側ワールドでそれを取得するのか？サーバ側ワールドで情報取得をすれば良いのではないか？<br />
実は後者で情報取得すると、クライアント側ワールドに未だ表示されていない情報が取得できてしまいます。<br />
こうなると、見えない経験値オーブを取得した音がなった！とかいきなりmobがワープしてきた！という怪奇現象につながりかねません。<br />

現在のワールドの情報を取得するときはクライアント側、実際にワールドの情報を書き換える場合はサーバ側とおぼえましょう。<br />

もう一つ重要な点として、サーバ側とクライアント側のワールドは別々のスレッドで動いていることが挙げられます。<br />
SMP であれば、スレッドどころかプロセスが異なります。プロセスが動いているマシンごと異なっていることもあります。<br />
ModLoaderのmodはクライアント側ワールドを担当するスレッドで動きます。サーバ側ワールドは別のスレッドが担当しています。<br />
ですので、サーバ側ワールドへの変更を、直接modからやってしまうとマルチスレッドでの不具合が発生します。<br />
ではどうするのか、以下次章。

==サーバ側スレッド、もしくはサーバプロセスで動くために==

mod はクライアントスレッドで動いています。サーバスレッド、もしくはサーバプロセスで動くためには何かしらきっかけ、イベント、メッセージが必要です。<br />
以前、パケットクラスを継承してそれを投げれば、と書いたのですがそれはシングルプレイのみで有効な方法でした。<br />
パケットクラスは厳重に管理されており、本体を直接改造する以外で新たなパケットを正当に登録することは至難の業です。<br />
SMP も視野に入れる、本来の正当な形のパケットメッセージを投げるには、Packet250CustomPayload クラスを使います。<br />
Packet250CustomPayload はビルトインのパケットクラスで、クライアント側からもサーバ側からも投げることができます。<br />
ModLoader はこれを扱う方法を用意しています。それが ModLoader.registerPacketChannel メソッドです。<br />
mod のインスタンスをチャネル名（15文字以下）とともに登録することで、そのチャネル名を持つ Packet250CustomPayload クラスのインスタンスが届いた時に<br />
mod インスタンスの clientCustomPayload, serverCustomPayload メソッドを呼んでくれます。<br />
サーバ側からクライアントへ投げた場合は前者が、クライアントから接続先サーバへ投げた場合は後者のメソッドが呼ばれます。<br />
Packet250CustomPayload はチャネル名の他に 32kb までのバイト配列をもたせられますので、必要な情報をここに乗せて投げれば目的を達成できます。<br />



==シングルプレイ用modを作るときは==

この章は無視してください！Packet250CustomPayload クラスを使いましょう！<br />

前章でも記述したとおり、ModLoaderで動作するmodはクライアント側ワールド担当のスレッドで動きます。<br />
サーバ側ワールドを改変するにはなんとかしてそれを担当するスレッドで動かなくてはなりません。<br />
サーバ側ワールド担当スレッドでプログラムを動かすには、net.minecraft.src.Packet を継承したパケットを<br />
クライアント側ワールドの送信キューに入れれば良いのです。<br />

<source lang="java">
 public static class Packet_mod_CutAll extends Packet {
 	public int _x = 0;
 	public int _y = 0;
 	public int _z = 0;
 	public int blockID = 0;
 	public int metadata = 0;
 	public String playerName = "";

 	public Packet_mod_CutAll(String playerName) {
 		this.playerName = playerName;
 	}

 	@Override
 	public void readPacketData(DataInputStream var1) throws IOException {
 		this._x = var1.readInt();
 		this._y = var1.readInt();
 		this._z = var1.readInt();
 		this.blockID = var1.readInt();
 		this.metadata = var1.readInt();
 		this.playerName = var1.readUTF();
 	}

 	@Override
 	public void writePacketData(DataOutputStream var1) throws IOException {
 		var1.writeInt(this._x);
 		var1.writeInt(this._y);
 		var1.writeInt(this._z);
 		var1.writeInt(this.blockID);
 		var1.writeInt(this.metadata);
 		var1.writeUTF(this.playerName);
 	}

 	@Override
 	public void processPacket(NetHandler nh) {
 		// ここにサーバ側ワールドを改変するソースを書く。
 	}

 	@Override
 	public int getPacketSize() {
 		ByteArrayOutputStream baos = new ByteArrayOutputStream();
 		DataOutputStream dos = new DataOutputStream(baos);
 		try {
 			this.writePacketData(dos);
 		} catch (IOException e) {
 		} finally {
 			try {
 				dos.close();
 			} catch (IOException e) {
 			}
 		}
 		return baos.toByteArray().length;
 	}

 	@Override
 	public String toString() {
 		return String.format("Packet_mod_DigAll (%d, %d, %d) => (blockid=%d, metadata=%d)"
 				, this._x, this._y, this._z, this.blockID, this.metadata);
 	}

 	@Override
 	public boolean isRealPacket() {
 		return false;
 	}

 	@Override
 	public boolean isWritePacket() {
 		return false;
 	}
 }
</source>

readPacketData, writePacketData を除けばほぼそのまま上記のソースは使えると思います。<br />
isRealPacket で true を返すと、SMP で使用出来る mod になる、と思われます。<br />
具体的には TcpConnection クラスで使用可能になります。<br />
もちろんサーバ側の minecraft にも ModLoader、同一 mod が入っていないと<br />
未知のパケットとしてドロップされてしまいますが。<br />
SMP で使用を許可しない場合は isRealPacket で false を返せばシングルプレイ専用になります。<br />
isWritePacket は false を返してください。これでサーバ側ワールド担当スレッドがこのパケットの processPacket メソッドを<br />
呼んでくれるようになります。true だと通信用スレッドで呼ばれちゃう、んだと思う…。<br />

このパケットをキューに入れるには以下のようにします。<br />

<source lang="java">
 Minecraft minecraft = ModLoader.getMinecraftInstance();
 minecraft.getSendQueue().addToSendQueue(
 	new Packet_mod_CutAll(minecraft.thePlayer.getEntityName()));
</source>


くれぐれもスレッドの違いに気をつけてください。<br />
あ、サーバ側ワールドのインスタンスを取得する方法を書いてないや。<br />

<source lang="java">
 public static Object[] getServerWorldAndPlayer(String playerName) {
 	final Minecraft minecraft = ModLoader.getMinecraftInstance();
 	World world = minecraft.theWorld;
 	EntityPlayer player = minecraft.thePlayer;
 	if (null == minecraft.getIntegratedServer()) {
 		// ver1.3 以降はありえないはずだが…。クライアント状態のみ。
 	} else if (null == minecraft.getIntegratedServer().theWorldServer || minecraft.getIntegratedServer().theWorldServer.length <= 0) {
 		// えー、これもないはず…。ワールドが無いとかありえん。
 		//ModLoader.getLogger().info("onTickInGame no WorldServers.");
 	} else {
 		// サーバワールド側のプレイヤーを取得。
 		player = minecraft.getIntegratedServer().getConfigurationManager().getPlayerForUsername(playerName);
 		// クライアント世界側のエンティティに対応する、サーバ世界側のエンティティを取得。
 		world = minecraft.getIntegratedServer().worldServerForDimension(player.dimension);
 	}
 	return new Object[] { world, player };
 }
</source>

Objectの配列の 0 番目にサーバ側ワールドのインスタンス、1 番目にプレイヤーのインスタンスが入ります。<br />
@@ 123行目: / 123行目: @@
 readPacketData, writePacketData を除けばほぼそのまま上記のソースは使えると思います。<br />
-isRealPacket で true を返すと、<span style="text-decoration: line-through;">SMP で使用出来る mod になる、と思われます。</span><br />
+isRealPacket で true を返すと、SMP で使用出来る mod になる、と思われます。<br />
-<span style="text-decoration: line-through;">具体的には TcpConnection クラスで使用可能になります。</span><br />
+具体的には TcpConnection クラスで使用可能になります。<br />
-間違いでした。TcpConnection クラスでも MemoryConnection クラスでも、isRealPacket() の戻り値にかかわらずパケットは送信されます。<br />
+もちろんサーバ側の minecraft にも ModLoader、同一 mod が入っていないと<br />
-isRealPacket() で true を返した場合、そのパケットクラスでは containsSameEntityIDAs() にて同値のパケットかどうかを判定されます。<br />
+未知のパケットとしてドロップされてしまいますが。<br />
-同値のパケットだと返した場合、後のパケットだけが送信され、前のパケットは破棄されます。<br />
+SMP で使用を許可しない場合は isRealPacket で false を返せばシングルプレイ専用になります。<br />
-複数の同値のパケットを一つにまとめて投げるための機構と思われます。なので、自作パケットにはほとんど関係ありません。<br />
-isRealPacket() は常に false を返して OK です。<br />
-<span style="text-decoration: line-through;">もちろんサーバ側の minecraft にも ModLoader、同一 mod が入っていないと</span><br />
-<span style="text-decoration: line-through;">未知のパケットとしてドロップされてしまいますが。</span><br />
-<span style="text-decoration: line-through;">SMP で使用を許可しない場合は isRealPacket で false を返せばシングルプレイ専用になります。</span><br />
-SMP 対応する場合はさらに別の方法になります。後日書きます。<br />
 isWritePacket は false を返してください。これでサーバ側ワールド担当スレッドがこのパケットの processPacket メソッドを<br />
 呼んでくれるようになります。true だと通信用スレッドで呼ばれちゃう、んだと思う…。<br />