提供: Minecraft Modding Wiki
|
この記事は"Minecraft Forge Universal 9.10.0.xxx～"を前提MODとしています。 |
| この記事は執筆中です。加筆してくださる人を募集しています。 |
目次
プレイヤーへのカスタムデータの追加[編集]
各プレイヤーにカスタムデータを追加する。 方法としては、EntityクラスのgetEntityDataメソッドの利用か、ForgeのIExtendedEntityPropertiesインターフェースの利用の二通りある。
このチュートリアルでは、IExtendedEntityPropertiesによる実装方法を解説する。
ソースコード[編集]
SampleModクラス[編集]
package sampleMod;
import java.util.HashMap;
import java.util.Map;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.nbt.NBTTagCompound;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.ForgeSubscribe;
import net.minecraftforge.event.entity.EntityEvent;
import net.minecraftforge.event.entity.EntityJoinWorldEvent;
import net.minecraftforge.event.entity.living.LivingDeathEvent;
import net.minecraftforge.event.entity.living.LivingEvent.LivingUpdateEvent;
import cpw.mods.fml.common.Mod;
import cpw.mods.fml.common.Mod.EventHandler;
import cpw.mods.fml.common.event.FMLInitializationEvent;
import cpw.mods.fml.common.network.NetworkMod;
@Mod(modid = "SampleMod", name = "SampleMod", version = "1.0", dependencies = "required-after:Forge@[9.11.1.965,)", useMetadata = true)
@NetworkMod(clientSideRequired = true, serverSideRequired = false, channels = { "samplemod" }, packetHandler = PacketHandler.class)
public class SampleMod {
//Player毎のIExtendedEntityPropertiesを保存するMap。ダイヤモンド演算子はJava7以降なので注意。
private static final Map<String, NBTTagCompound> extendedEntityData = new HashMap<>();
@EventHandler
public void init(FMLInitializationEvent event) {
MinecraftForge.EVENT_BUS.register(this);
}
@ForgeSubscribe
/*IExtendedEntityPropertiesを登録する処理を呼び出す*/
public void onEntityConstructing(EntityEvent.EntityConstructing event) {
if (event.entity instanceof EntityPlayer) {
ExtendedPlayerProperties.register((EntityPlayer)event.entity);
}
}
@ForgeSubscribe
/*死亡時に呼ばれるイベント。ここで、IExtendedEntityPropertiesを保存する処理を呼び出す*/
public void onLivingDeathEvent(LivingDeathEvent event) {
if (event.entityLiving instanceof EntityPlayer && !event.entity.worldObj.isRemote) {
NBTTagCompound playerData = new NBTTagCompound();
(event.entity.getExtendedProperties(ExtendedPlayerProperties.EXT_PROP_NAME)).saveNBTData(playerData);
storeEntityData(event.entity.getEntityName(), playerData);
}
}
@ForgeSubscribe
/*ワールドに入った時に呼ばれるイベント。ここでIExtendedEntityPropertiesを読み込む処理を呼び出す*/
public void onEntityJoinWorld(EntityJoinWorldEvent event) {
if (!event.entity.worldObj.isRemote && event.entity instanceof EntityPlayer) {
NBTTagCompound playerData = getEntityData(event.entity.getEntityName());
if (playerData != null) {
(event.entity.getExtendedProperties(ExtendedPlayerProperties.EXT_PROP_NAME)).loadNBTData(playerData);
}
((ExtendedPlayerProperties)(event.entity.getExtendedProperties(ExtendedPlayerProperties.EXT_PROP_NAME))).loadProxyData((EntityPlayer)event.entity);
}
}
/*テストコード。プレイヤーの最高高度を記録し、一定間隔で、チャット画面に出力*/
@ForgeSubscribe
public void onLivingUpdate(LivingUpdateEvent event) {
if (event.entityLiving instanceof EntityPlayer) {
EntityPlayer player = (EntityPlayer) event.entityLiving;
int savedHieght = ExtendedPlayerProperties.get(player).getSampleInt();
if (savedHieght < player.posY) savedHieght = (int)player.posY;
ExtendedPlayerProperties.get(player).setSampleInt(savedHieght);
if (player.worldObj.getTotalWorldTime() % 100L == 0L) {
String cs = (player.worldObj.isRemote)?"Client":"Server";
player.addChatMessage(String.format("You reached %d m in %s", savedHieght, cs));
}
}
}
/*PlayerのIExtendedEntityPropertiesをMapに保存*/
public static void storeEntityData(String name, NBTTagCompound compound) {
extendedEntityData.put(name, compound);
}
/*PlayerのIExtendedEntityPropertiesをMapから読み込み*/
public static NBTTagCompound getEntityData(String name) {
return extendedEntityData.remove(name);
}
}
ExtendedPlayerPropertiesクラス[編集]
package sampleMod;
import net.minecraft.block.Block;
import net.minecraft.entity.Entity;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.item.ItemStack;
import net.minecraft.nbt.NBTTagCompound;
import net.minecraft.nbt.NBTTagList;
import net.minecraft.world.World;
import net.minecraftforge.common.IExtendedEntityProperties;
import cpw.mods.fml.common.network.PacketDispatcher;
import cpw.mods.fml.common.network.Player;
public class ExtendedPlayerProperties implements IExtendedEntityProperties {
/* MOD固有の文字列。EntityPlayerに登録時に使用。
MOD内で複数のIExtendedEntityPropertiesを使う場合は、別の文字列をそれぞれ割り当てること。*/
public final static String EXT_PROP_NAME = "samplePlayerData";
private int sampleInt;
private double sampleDouble;
private boolean sampleBoolean;
private String sampleString = "sample";
private ItemStack sampleItemStack = new ItemStack(Block.dirt);
private ItemStack[] sampleItemStacks = new ItemStack[10];
private NBTTagCompound sampleNBTTagCompound = new NBTTagCompound();
/*EntityPlayerインスタンスから外部保存時の固有文字列を返す
*1.7ではusername変数が使えないので、コマンド送信時の名前で代用 */
private static String getSaveKey(EntityPlayer player) {
return player.username + ":" + EXT_PROP_NAME;
}
/*EntityPlayerにIExtendedEntityPropertiesを登録。登録文字列はMOD固有のものを割り当てること*/
public static void register(EntityPlayer player) {
player.registerExtendedProperties(EXT_PROP_NAME, new ExtendedPlayerProperties());
}
/*IExtendedEntityPropertiesをEntityPlayerインスタンスから取得する*/
public static ExtendedPlayerProperties get(EntityPlayer player) {
return (ExtendedPlayerProperties)player.getExtendedProperties(EXT_PROP_NAME);
}
@Override
public void saveNBTData(NBTTagCompound compound) {
NBTTagCompound nbt = new NBTTagCompound();
nbt.setInteger("sampleInt", this.sampleInt);
nbt.setDouble("sampleDouble", this.sampleDouble);
nbt.setBoolean("sampleBoolean", this.sampleBoolean);
nbt.setString("sampleString", this.sampleString);
nbt.setTag("sampleTag", this.sampleNBTTagCompound);
//ItemStackの保存
NBTTagCompound itemNBT = new NBTTagCompound();
this.sampleItemStack.writeToNBT(itemNBT);
nbt.setTag("sampleItemStack", itemNBT);
//ItemStackの配列の保存
NBTTagList itemsTagList = new NBTTagList();
for (int i = 0; i < this.sampleItemStacks.length; ++i)
{
if (this.sampleItemStacks[i] != null)
{
NBTTagCompound var4 = new NBTTagCompound();
var4.setByte("Slot", (byte)i);
this.sampleItemStacks[i].writeToNBT(var4);
itemsTagList.appendTag(var4);
}
}
nbt.setTag("Items", itemsTagList);
compound.setTag(EXT_PROP_NAME, nbt);
}
@Override
public void loadNBTData(NBTTagCompound compound) {
NBTTagCompound nbt = (NBTTagCompound)compound.getTag(EXT_PROP_NAME);
this.sampleInt = nbt.getInteger("sampleInt");
this.sampleDouble = nbt.getDouble("sampleDouble");
this.sampleBoolean = nbt.getBoolean("sampleBoolean");
this.sampleString = nbt.getString("sampleString");
this.sampleNBTTagCompound = nbt.getCompoundTag("sampleTag");
//ItemStackの読み込み
this.sampleItemStack = ItemStack.loadItemStackFromNBT(nbt.getCompoundTag("sampleItemStack"));
//ItemStackの配列の読み込み
NBTTagList itemsTagList = nbt.getTagList("Items");
this.sampleItemStacks = new ItemStack[10];
for (int i = 0; i < itemsTagList.tagCount(); ++i)
{
NBTTagCompound var4 = (NBTTagCompound) itemsTagList.tagAt(i);
int slot = var4.getByte("Slot") & 255;
if (slot >= 0 && slot < this.sampleItemStacks.length)
{
this.sampleItemStacks[slot] = ItemStack.loadItemStackFromNBT(var4);
}
}
}
@Override
/*初期化メソッド。今のところ使う必要はない。*/
public void init(Entity entity, World world) {}
/*ServerのIExtendedEntityPropertiesを読み込んで、Clientに送信するメソッド*/
public void loadProxyData(EntityPlayer player) {
ExtendedPlayerProperties playerData = ExtendedPlayerProperties.get(player);
NBTTagCompound savedData = SampleMod.getEntityData(getSaveKey(player));
if (savedData != null) { playerData.loadNBTData(savedData); }
PacketDispatcher.sendPacketToPlayer(new PacketPlayerProperties(player), (Player) player);
}
/*以降、各変数のGetterおよびSetter。
* 使い方としては、EntityPlayerのインスタンスが取得できるメソッド内で、
* ExtendedPlayerProperties.get(playerインスタンス).setSampleInt(sample)
* と呼び出す。*/
public int getSampleInt() {
return sampleInt;
}
public void setSampleInt(int sampleInt) {
this.sampleInt = sampleInt;
}
public double getSampleDouble() {
return sampleDouble;
}
public void setSampleDouble(double sampleDouble) {
this.sampleDouble = sampleDouble;
}
public boolean isSampleBoolean() {
return sampleBoolean;
}
public void setSampleBoolean(boolean sampleBoolean) {
this.sampleBoolean = sampleBoolean;
}
public String getSampleString() {
return sampleString;
}
public void setSampleString(String sampleString) {
this.sampleString = sampleString;
}
public ItemStack getSampleItemStack() {
return sampleItemStack;
}
public void setSampleItemStack(ItemStack sampleItemStack) {
this.sampleItemStack = sampleItemStack;
}
public ItemStack[] getSampleItemStacks() {
return sampleItemStacks;
}
public void setSampleItemStacks(ItemStack[] sampleItemStacks) {
this.sampleItemStacks = sampleItemStacks;
}
public NBTTagCompound getSampleNBTTagCompound() {
return sampleNBTTagCompound;
}
public void setSampleNBTTagCompound(NBTTagCompound sampleNBTTagCompound) {
this.sampleNBTTagCompound = sampleNBTTagCompound;
}
}
PacketHandlerクラス[編集]
package sampleMod;
import java.io.IOException;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.nbt.NBTTagCompound;
import net.minecraft.network.INetworkManager;
import net.minecraft.network.packet.Packet;
import net.minecraft.network.packet.Packet250CustomPayload;
import com.google.common.io.ByteArrayDataInput;
import com.google.common.io.ByteStreams;
import cpw.mods.fml.common.network.IPacketHandler;
import cpw.mods.fml.common.network.Player;
public class PacketHandler implements IPacketHandler{
@Override
public void onPacketData(INetworkManager manager, Packet250CustomPayload packet, Player player) {
if (packet.channel.equals("samplemod")) {
ByteArrayDataInput data = ByteStreams.newDataInput(packet.data);
EntityPlayer entityPlayer = (EntityPlayer) player;
try {
NBTTagCompound playerCompound = Packet.readNBTTagCompound(data);
ExtendedPlayerProperties.get(entityPlayer).loadNBTData(playerCompound);
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
PacketPlayerProperties[編集]
package sampleMod;
import java.io.ByteArrayOutputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.nbt.NBTTagCompound;
import net.minecraft.network.packet.Packet;
import net.minecraft.network.packet.Packet250CustomPayload;
public class PacketPlayerProperties extends Packet250CustomPayload {
public PacketPlayerProperties() {}
public PacketPlayerProperties(EntityPlayer player) {
NBTTagCompound playerNbtTagCompound = new NBTTagCompound();
//EntityPlayerからIExtendedEntityPropertiesを取得。
ExtendedPlayerProperties.get(player).saveNBTData(playerNbtTagCompound);
ByteArrayOutputStream bos = new ByteArrayOutputStream();
DataOutputStream dos = new DataOutputStream(bos);
try {
//NBTTagCompoundをDataOutputStreamに書き込む。
Packet.writeNBTTagCompound(playerNbtTagCompound, dos);
} catch (IOException e) {
e.printStackTrace();
}
this.data = bos.toByteArray();
this.channel = "samplemod";
this.length = bos.size();
}
}
解説[編集]
細かい説明はソースコード内に付記したので、そちらを参照のこと。
使用の流れを簡単に書くと、
EntityEvent.EntityConstructingにて、IExtendedEntityPropertiesを登録。
ExtendedPlayerProperties.get(playerインスタンス).getSampleInt()という形でデータを呼び出す。
ExtendedPlayerProperties.get(playerインスタンス).setSampleInt(sample)という形でデータを書き込む。
死亡時等でクライアント側のNBTデータが初期化されるので、LivingDeathEventでデータを保存し、EntityJoinWorldEventで、保存したデータを復帰させる。