「1.7のパケットについて」を編集中

{{前提MOD|reqmod="Minecraft Forge Universal 10.12.1.1090～"}}
{{過去リンク|version=Minecraft Forge Universal 10.12.1.1089|url=http://minecraftjp.info/modding/index.php?title=1.7%E3%81%AE%E3%83%91%E3%82%B1%E3%83%83%E3%83%88%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6&oldid=2070}}

==パケットについて==
<p>1.7.2でパケット関連のシステムが大幅に変更され、nettyと呼ばれるオープンプロジェクトのシステムを利用したHandshake方式になりました。<br>
以前ここで解説したパケットシステムはメモリリークを誘発するので、こちらの方法が推奨されています。</p>

==ソースコード==
===PacketHander===
<source lang = "java">

package mods.samplepacketmod;

import cpw.mods.fml.common.network.NetworkRegistry;
import cpw.mods.fml.common.network.simpleimpl.SimpleNetworkWrapper;
import cpw.mods.fml.relauncher.Side;


public class PacketHandler {

    //このMOD用のSimpleNetworkWrapperを生成。チャンネルの文字列は固有であれば何でも良い。MODIDの利用を推奨。
    //チャンネル名は20文字以内の文字数制限があるので注意。
    public static final SimpleNetworkWrapper INSTANCE = NetworkRegistry.INSTANCE.newSimpleChannel("SamplePacketMod");


    public static void init() {

        /*IMesssageHandlerクラスとMessageクラスの登録。
        *第三引数：MessageクラスのMOD内での登録ID。256個登録できる
        *第四引数：送り先指定。クライアントかサーバーか、Side.CLIENT Side.SERVER*/
        INSTANCE.registerMessage(MessageSampleHandler.class, MessageSample.class, 0, Side.SERVER);
    }
}</source>

===MessageSample===
<source lang = "java">
package mods.samplepacketmod;

import cpw.mods.fml.common.network.simpleimpl.IMessage;
import io.netty.buffer.ByteBuf;

public class MessageSample implements IMessage {

    public byte data;

    public MessageSample(){}

    public MessageSample(byte par1) {
        this.data= par1;
    }

    @Override//IMessageのメソッド。ByteBufからデータを読み取る。
    public void fromBytes(ByteBuf buf) {
        this.data= buf.readByte();
    }

    @Override//IMessageのメソッド。ByteBufにデータを書き込む。
    public void toBytes(ByteBuf buf) {
        buf.writeByte(this.data);
    }
}
</source>


===MessageSampleHandler===
<source lang = "java">
package mods.samplepacketmod;

import cpw.mods.fml.common.network.simpleimpl.IMessage;
import cpw.mods.fml.common.network.simpleimpl.IMessageHandler;
import cpw.mods.fml.common.network.simpleimpl.MessageContext;
import io.netty.buffer.ByteBuf;

public class MessageSampleHandler implements IMessageHandler<MessageSample, IMessage> {

    @Override//IMessageHandlerのメソッド
    public IMessage onMessage(MessageSample message, MessageContext ctx) {
        //クライアントへ送った際に、EntityPlayerインスタンスはこのように取れる。
        //EntityPlayer player = SamplePacketMod.proxy.getEntityPlayerInstance();
        //サーバーへ送った際に、EntityPlayerインスタンス（EntityPlayerMPインスタンス）はこのように取れる。
        //EntityPlayer entityPlayer = ctx.getServerHandler().playerEntity;
        //Do something.
        return null;//本来は返答用IMessageインスタンスを返すのだが、旧来のパケットの使い方をするなら必要ない。
    }
}
</source>

===CommonProxy（クライアントにMessageを飛ばした際にEntityPlayerを必要とする場合）===
<source lang = "java">
package mods.samplepacketmod;

import net.minecraft.entity.player.EntityPlayer;
public class CommonProxy {
    public EntityPlayer getEntityPlayerInstance() {return null;}
}
</source>

===ClientProxy（クライアントにMessageを飛ばした際にEntityPlayerを必要とする場合）===
<source lang = "java">
package mods.samplepacketmod;

import net.minecraft.client.Minecraft;
import net.minecraft.entity.player.EntityPlayer;

public class ClientProxy extends CommonProxy {
    @Override
    public EntityPlayer getEntityPlayerInstance() {
        return Minecraft.getMinecraft().thePlayer;
    }
}
</source>

===@Modクラス内の記述===
<source lang = "java">
package mods.samplepacketmod;

import cpw.mods.fml.common.Mod;
import cpw.mods.fml.common.event.FMLPreInitializationEvent;

@Mod(modid="SamplePacketMod", name="SamplePacketMod", version="1.0.0",dependencies="required-after:Forge@[10.12.1.1090,)")
public class SamplePacketMod {
	@Mod.Instance("SamplePacketMod")
	public static SamplePacketMod instance;
    @SidedProxy(clientSide = "mods.samplepacketmod.ClientProxy", serverSide = "mods.samplepacketmod.CommonProxy")
    public static CommonProxy proxy;
	@Mod.EventHandler
	public void preInit(FMLPreInitializationEvent event)
	{
        PacketHandler.init();
	}
}
</source>

===パケットを送る際の記述===
<source lang = "java">
PacketHandler.INSTANCE.sendToServer(new MessageSample(data));
</source>
==解説==
Nettyを利用していることには変わりないので、パケット(Message)の書き方が1.6とは大分違ったものとなっている。<br>
ソース内に必要なコメントは載せているので、パケットの流れを解説する。<br>

PacketHandler.INSTANCE.sendToServer<br>
↓<br>
IMessageのtoBytesメソッド<br>
↓<br>
サーバーorクライアントへ<br>
↓<br>
IMessageのfromBytesメソッド<br>
↓<br>
IMessageHandlerのonMessageメソッド<br>
IMessageクラスに引数を指定したコンストラクタを用意する必要はないが、例のように、用意したほうが利便性は高い。