「独自Packetを追加する」を編集中

ModLoaderMpで使用できるCustumPacketsの設定方法を記載します。{{前提MOD|reqmod="ModLoaderMp"}}<br/>

==カスタムパケットの基本==
===送付できるPacketの種類===
1.int型<br/>
2.float型<br/>
3.String型<br/>

Ex:以下のように設定します。<br/>
<source lang="java">
float[] dataFloat = new float[numberOfFloats];
dataFloat[0] = xxxx;
dataFloat[1] = yyyy;
....

int[] dataInt = new int[numberOfInts];
dataInt[0] = zzzz;
dataInt[1] = bbbb;
....

String[] dataString = new loat[numberOfStrings];
dataString[0] = aaaa;
dataString[1] = cccc;
....
</source>

===インターフェイスを実装する===
ISpawnableインターフェイスを実装します。<br/>
Ex:
<source lang="java">
public class ClassName extends Entity implements ISpawnable {
</source>
上記はClassNameクラスにEntityクラスを継承してISpawnableインターフェイスを実装しています。<br/>
<br/>
ISpawnableインターフェイスを実装した後、<br/>
Server側でgetSpawnPacketメソッドを追加した場合の例
<source lang="java">
public Packet230ModLoader getSpawnPacket()
{
    Packet230ModLoader packet = new Packet230ModLoader();
　　packet.packetType = 0;    
    packet.dataInt = new int[1];
    packet.dataInt[0] = entityColor;
    packet.dataFloat = new float[2];
    packet.dataFloat[0] = (float)posX;
    packet.dataFloat[1] = posY;
    packet.dataString = new String;
    packet.dataString[0] = dataString;
    return packet;
}
</source>
packetType = 0:アップデートフラグとして<br/>
packetType = 1:送信フラグとして<br/>
※言葉が書きづらい・・・。もっとわかりやすく書ける方お願いします。<br/>

==Packetの送信方法==
===ModLoaderMp.SendPacket===
使用方法は基本同じなので、まとめてあります。<br/>
1.ModLoaderMp.SendPacket<br/>
　クライアントからサーバー側へデータを送るために使用するメソッドです。<br/>
　ModloaderMp.SendPacket(this, packet)　<br/>
　　　this：送付データ　<br/>
　　　packet：送付時に使用するclass　<br/>
<br/>
2.ModLoaderMp.SendPacketTo<br/>
　サーバーからクライアント側へデータを送るために使用するメソッドです。<br/>
　ModLoaderMp.SendPacketTo(this, player, packet)　<br/>
　　　this:送付データ　<br/>
　　　player:送付先のEntity　<br/>
　　　packet:送付時に使用するclass　<br/>
<br/>
3.ModLoaderMp.SendPacketAll<br/>
　サーバーからクライアント側へデータを送るために使用するメソッドです。<br/>
　ModLoderMp.SendPacketAll(this, packet)　<br/>
　　　this:送付データ　<br/>
　　　packet：送付時に使用するclass　<br/>
<br/>
使用例
<source lang="java">
public void sendInthoge(EntityPlayerMP entityPlayerMp, int inthoge)
{
   if(entityPlayerMp.ridingEntity instanceof Entity)
   {
      int[] dataInt = new int[1];
      dataInt[0] = inthoge;
                    
      Packet230ModLoader packet = new Packet230ModLoader();
      packet.packetType = 0;
      packet.dataInt = dataInt;
      ModLoaderMp.SendPacketTo(this, entityPlayerMp, packet);
   }
}
</source>
上記では、sendInthogeメソッドが呼び出された場合、<br/>
entityPlayerMp.ridingEntityがEntityをクラスを実装していればTrueとして（←ここは特に関係ない）<br/>
dataInt[0]にinthogeを格納し、ModLoaderMp.SendPacketToにてデータを対象クライアントに送付してます。<br/>

やっぱり書きづらい。もっとわかりやすく書ける方お願いします。<br/>

===HandlePacket===
Packetを受信した際の処理を行わせるためのメソッドです。<br/>
サンプルを以下に書いておきます。<br/>

クライアント側
<source lang="java">
public void HandlePacket(Packet230ModLoader packet)
{
   switch(packet.packetType)
   {
      case 0:
      {
          //ここに処理内容を書く
　　　　　//packet.dataint[0]とか
      }
   }
}
</source>

サーバー側
<source lang="java">
public void HandlePacket(Packet230ModLoader packet, EntityPlayerMp player)
{
   switch(packet.packetType)
   {
      case 0:
      {
          //ここに処理内容を書く
　　　　　//packet.dataint[0]とか、playerに対する処理とか
      }
   }
}
</source>

===SendKey===
キーボード入力をサーバー側に送信したいときに使うメソッドです。
<source lang="java">
ModLoaderMp.SendKey(instance, key);
</source>
instance:クラスファイルでの静的インスタンス<br/>
key:キーコードリストを参照してください。<br/>
　URL：http://lwjgl.org/javadoc/constant-values.html#org.lwjgl.input.Keyboard.EVENT_SIZE

使用例
<source lang="java">
package net.minecraft.src;

public class mod_hogehoge extends BaseModMp{
	public static mod_hogehoge instance;
	@Override
	public String getVersion() {
		return "";
	}
	@Override
	public void load() {
		ModLoaderMp.SendKey(instance, 210);
	}
}
</source>
ただの適当に作ったサンプルですが、<br/>
mod_hogehogeをINSERTキー（210がInsertキー)入力時にパケット送信します。<br/>

別として以下のように<br/>
<source lang="java">
import org.lwjgl.input.Keyboard;
</source>
JavaのKeyboardクラスを呼び出して
<source lang="java">
Keyboard.KEY_....
</source>
で使用も可能です。<br/>

サーバー側の受信はHandleSendKeyメソッドを使用します。
<source lang="java">
public void HandleSendKey(EntityPlayerMp entityplayermp, int key)
{
}
</source>
entityplayermpはkeyを押したプレイヤーです。<br/>

'''注意'''<br/>
このSendKeyメソッドを使う場合は、ユーザーのMinecraftでのキーコンフィグに出て来ませんので<br/>
（キー設定変更がユーザーにできないので）注意してください。<br/>


===コマンドによるPacket送信処理===

ModLoaderMpにはOPコマンドやサーバーコンソールコマンドを追加する機能が含まれています。<br/>
Server側のmod_***クラスに２つメソッドを追加します。<br/>
ちなみに筆者は「これを使って作ったことはありません」ので間違ってた場合修正願います。<br/>

1.getCommandInfo<br/>
　利用可能なコンソールをクライアントのログに記載します。

<source lang="java">
public void GetCommandInfo(ICommandListener icommandlistener) 
{ 
   icommandlistener.log("MpUtils : Op only commands");
   icommandlistener.log("   i <id> [num] [meta]       gives you [num] of <id> with damage [meta]");
   icommandlistener.log("   heal                      heals you to full health");
   icommandlistener.log("   warp <x> <y> <z>              moves you to x,y,z");
}
</source>
上記メソッドを呼び出した場合、<br/>
クライアント側にlog("")で設定したテキストが書き出されます。<br/>

2.HandleCommand
　サーバーに送信されるコマンドを制御します。

<source lang="java">
 public boolean HandleCommand(String command, String username, Logger logger, boolean isOp) 
 { 
 { 
 }
</source>
command：入力されるコマンド文字列（上記GetCommandInfoの例でいうと　heal）最初の"/"は除かれるので注意<br/>
username：其名の通りユーザーの名前（またはコンソール）<br/>
Logger:使用されたコマンドのメッセージを他のプレイヤーに伝える文章<br/>
isOp：Op権限を有してるかどうか判定<br/>

送られたコマンドを検出・処理する方法として
<source lang="java">
if(command.toLowerCase().startsWith("command "))
{
</source>
で判定しifの中に処理内容を書くといいと思います。

また、ほとんどのコマンドが複数の引数を取るので、<br/>
コマンドの文字列を分割する必要があります。<br/>
下記サンプルではスペースで分割し長さを判定します。<br/>
コマンドが間違ってた場合Falseを返す形になります。<br/>
<source lang="java">
String commandSplit[] = command.split(" ");
   if(commandSplit.length != 2)
   {
      return false;
   }
</source>
1行目でスペース分割<br/>
2行目のifで分割した文字列の長さを判定<br/>
おかしかったら return false<br/>

次に文字列配列のcomandSplit[]を使用します。<br/>
コマンドはエラーが発生した場合、下記メソッドを使用する必要があります。
<source lang="java">
logger.fine((new StringBuilder()).append("There's no item with id ").append(itemID).toString());
</source>
StringBuilderは"There's no item with id "を受け取り、<br/>
(commandSplitから取得した）ItemIDをつけて送ります。<br/>
toString()を末尾に忘れると、文字列にならないので注意<br/>

正常にコマンドが実行された場合はTrueを返してOPに通知させます。
<source lang="java">
ModLoaderMp.sendChatToOps(username, (new StringBuilder()).append("Giving ").append(player.username).append(" some ").append(itemID).toString());
</source>
上記はGiveコマンドを想定したOPへの通知内容です。<br/>

また、コマンド作成に使えると思われるメソッドが<br/>
hasClientSide()
です。
<source lang="java">
public boolean hasClientSide()
{
   return false;
}
</source>

参考：http://www.minecraftforum.net/topic/352121-smp-mods-modloadermp-modding-310511/

<comments />
----
* sendkeyのかわりにマウスのクリックを送信するにはどうすればいいでしょうか？ --[[特別:投稿記録/221.170.40.37|221.170.40.37]] 2012年4月11日 (水) 00:27 (JST)