提供: Minecraft Modding Wiki
移動先: 案内検索
(MessageSample)
(サーバー起動時エラーの修正とついでにクラスを役割ごとに分離)
25行目: 25行目:
 
     public static void init() {
 
     public static void init() {
  
         /*IMesssageHandlerクラスとMessageクラスの登録。今回同じクラスにしているが、別々でもよい。
+
         /*IMesssageHandlerクラスとMessageクラスの登録。
 
         *第三引数:MessageクラスのMOD内での登録ID。256個登録できる
 
         *第三引数:MessageクラスのMOD内での登録ID。256個登録できる
 
         *第四引数:送り先指定。クライアントかサーバーか、Side.CLIENT Side.SERVER*/
 
         *第四引数:送り先指定。クライアントかサーバーか、Side.CLIENT Side.SERVER*/
         INSTANCE.registerMessage(MessageSample.class, MessageSample.class, 0, Side.SERVER);
+
         INSTANCE.registerMessage(MessageSampleHandler.class, MessageSample.class, 0, Side.SERVER);
 
     }
 
     }
 
}</source>
 
}</source>
36行目: 36行目:
 
package mods.samplepacketmod;
 
package mods.samplepacketmod;
  
import cpw.mods.fml.client.FMLClientHandler;
 
import cpw.mods.fml.common.FMLCommonHandler;
 
 
import cpw.mods.fml.common.network.simpleimpl.IMessage;
 
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;
 
import io.netty.buffer.ByteBuf;
  
public class MessageSample implements IMessage, IMessageHandler<MessageSample, IMessage> {
+
public class MessageSample implements IMessage {
  
     private byte data;
+
     public byte data;
  
 
     public MessageSample(){}
 
     public MessageSample(){}
62行目: 58行目:
 
         buf.writeByte(this.data);
 
         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 MessageSample implements IMessageHandler<MessageSample, IMessage> {
  
 
     @Override//IMessageHandlerのメソッド
 
     @Override//IMessageHandlerのメソッド
 
     public IMessage onMessage(MessageSample message, MessageContext ctx) {
 
     public IMessage onMessage(MessageSample message, MessageContext ctx) {
         //クライアントへ送った際に、Worldインスタンスはこのように取れる。
+
         //クライアントへ送った際に、EntityPlayerインスタンスはこのように取れる。
         //FMLClientHandler.instance().getClient().theWorld
+
         //EntityPlayer player = SamplePacketMod.proxy.getEntityPlayerInstance();
 
         //サーバーへ送った際に、EntityPlayerインスタンス(EntityPlayerMPインスタンス)はこのように取れる。
 
         //サーバーへ送った際に、EntityPlayerインスタンス(EntityPlayerMPインスタンス)はこのように取れる。
 
         //EntityPlayer entityPlayer = ctx.getServerHandler().playerEntity;
 
         //EntityPlayer entityPlayer = ctx.getServerHandler().playerEntity;
 
         //Do something.
 
         //Do something.
 
         return null;//本来は返答用IMessageインスタンスを返すのだが、旧来のパケットの使い方をするなら必要ない。
 
         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;
 
     }
 
     }
 
}
 
}
86行目: 121行目:
 
@Mod.Instance("SamplePacketMod")
 
@Mod.Instance("SamplePacketMod")
 
public static SamplePacketMod instance;
 
public static SamplePacketMod instance;
 +
    @SidedProxy(clientSide = "mods.samplepacketmod.ClientProxy", serverSide = "mods.samplepacketmod.CommonProxy")
 +
    public static CommonProxy proxy;
 
@Mod.EventHandler
 
@Mod.EventHandler
 
public void preInit(FMLPreInitializationEvent event)
 
public void preInit(FMLPreInitializationEvent event)
93行目: 130行目:
 
}
 
}
 
</source>
 
</source>
 +
 
===パケットを送る際の記述===
 
===パケットを送る際の記述===
 
<source lang = "java">
 
<source lang = "java">

2014年8月1日 (金) 20:34時点における版

この記事は"Minecraft Forge Universal 10.12.1.1090~"を前提MODとしています。

この記事の古いバージョン(Minecraft Forge Universal 10.12.1.1089以前)はここより見ることができます。

パケットについて

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

ソースコード

PacketHander

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の利用を推奨。
    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);
    }
}

MessageSample

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);
    }
}


MessageSampleHandler

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 MessageSample 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インスタンスを返すのだが、旧来のパケットの使い方をするなら必要ない。
    }
}

CommonProxy(クライアントにMessageを飛ばした際にEntityPlayerを必要とする場合)

package mods.samplepacketmod;

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

ClientProxy(クライアントにMessageを飛ばした際にEntityPlayerを必要とする場合)

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;
    }
}

@Modクラス内の記述

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();
	}
}

パケットを送る際の記述

PacketHandler.INSTANCE.sendToServer(new MessageSample(data));

解説

Nettyを利用していることには変わりないので、パケット(Message)の書き方が1.6とは大分違ったものとなっている。
ソース内に必要なコメントは載せているので、パケットの流れを解説する。

PacketHandler.INSTANCE.sendToServer

IMessageのtoBytesメソッド

サーバーorクライアントへ

IMessageのfromBytesメソッド

IMessageHandlerのonMessageメソッド
IMessageクラスに引数を指定したコンストラクタを用意する必要はないが、例のように、用意したほうが利便性は高い。