「固有情報を持つアイテムを追加する」を編集中

{{前提MOD|reqmod="ModLoader"}}
ItemStack（アイテムを管理している部分）にエンチャント等の情報を保存するためにNBTを使用するメソッドがあります。<br />
今回はそれを使用してTNTを遠隔で着火するアイテムを追加します。<br />
なお、MOD部のソースコードは省略しています。<br />

==ソースコード==
<source lang="java">
package net.minecraft.src;

import java.util.List;

public class ItemTNTRemote extends Item {
	public int posx,posy,posz;

	ItemHoge(int id){
		super(id);
		//スタック不可能にする。
		maxStackSize = 1;
	}

	//ブロックを右クリックした時に呼ばれます。
	//1.3.x以降で使用する場合は引数を(ItemStack itemstack, EntityPlayer entityplayer, World world, int x, int y, int z, int side, float p, float q, float r)に変えて下さい。
	//1.3.xのみメソッド名がtryPlaceIntoWorldなので注意
	@Override
	public boolean onItemUse(ItemStack itemstack, EntityPlayer entityplayer, World world, int x, int y, int z, int side){
		if(!world.isRemote){
			//NBTタグを取得します。
			NBTTagCompound nbt = itemstack.getTagCompound();
			if(nbt == null){
				nbt = new NBTTagCompound();
				itemstack.setTagCompound(nbt);
			}
			//対象ブロックがTNTの場合は位置を記録し、それ以外の場合は着火処理を行う。
			if(world.getBlockId(x, y, z) == Block.tnt.blockID){
				nbt.setInteger("PosX", x);
				nbt.setInteger("PosY", y);
				nbt.setInteger("PosZ", z);
			}else{
				onItemRightClick(itemstack, world, entityplayer);
			}
		}
		return true;
	}

	//空中を右クリックした場合に呼ばれます。
	@Override
	public ItemStack onItemRightClick(ItemStack itemstack, World world, EntityPlayer entityplayer){
		if(!world.isRemote){
			NBTTagCompound nbt = itemstack.getTagCompound();
			if(nbt == null)
				return itemstack;
			posx = nbt.getInteger("PosX");
			posy = nbt.getInteger("PosY");
			posz = nbt.getInteger("PosZ");
			if(world.getBlockId(posx, posy, posz) == Block.tnt.blockID){
				Block.tnt.onBlockDestroyedByPlayer(world, posx, posy, posz, 1);
				world.setBlockWithNotify(posx, posy, posz, 0);
			}
		}
		return itemstack;
	}

	//アイテム名の表示の下に記録された位置を表示させます。
	@Override
	public void addInformation(ItemStack itemstack, List list)
    {
		NBTTagCompound nbt = itemstack.getTagCompound();
		if(nbt == null)
			return;
		int posx,posy,posz;
		posx = nbt.getInteger("PosX");
		posy = nbt.getInteger("PosY");
		posz = nbt.getInteger("PosZ");
		list.add("[" + posx + "," + posy + "," + posz + "]");
    }

}
</source>

==ソースの解説==
===onItemUse===
<source lang="java">
NBTTagCompound nbt = itemstack.getTagCompound();
if(nbt == null){
	nbt = new NBTTagCompound();
	itemstack.setTagCompound(nbt);
}
</source>
*ここでアイテムからNBTタグを取得します。
**getTagCompoundはアイテムにNBTタグが存在しない場合nullを返すようになっており、そのままではNullPointerExceptionが発生します。
**なのでnullが返ってきた場合は、新しくNBTタグを作成し、アイテムに登録します。
<source lang="java">
if(world.getBlockId(x, y, z) == Block.tnt.blockID){
	nbt.setInteger("PosX", x);
	nbt.setInteger("PosY", y);
	nbt.setInteger("PosZ", z);
}else{
	onItemRightClick(itemstack, world, entityplayer);
}
</source>
*ここでは右クリックしたブロックがTNTの場合NBTに座標情報を記録し、そうでない場合は、onItemRightClickを呼び出しています。
===onItemRightClick===
<source lang="java">
NBTTagCompound nbt = itemstack.getTagCompound();
NBTTagCompound nbt = itemstack.getTagCompound();
if(nbt == null)
	return itemstack;
posx = nbt.getInteger("PosX");
posy = nbt.getInteger("PosY");
posz = nbt.getInteger("PosZ");
if(world.getBlockId(posx, posy, posz) == Block.tnt.blockID){
	Block.tnt.onBlockDestroyedByPlayer(world, posx, posy, posz, 1);
	world.setBlockWithNotify(posx, posy, posz, 0);
}
</source>
*ここでは、NBTタグから座標情報を読み出し、その位置にTNTが存在すればTNTの着火処理メソッドを呼び出します。
===addInformation===
<source lang = "java">
NBTTagCompound nbt = itemstack.getTagCompound();
if(nbt == null)
	return;
int posx,posy,posz;
posx = nbt.getInteger("PosX");
posy = nbt.getInteger("PosY");
posz = nbt.getInteger("PosZ");
list.add("[" + posx + "," + posy + "," + posz + "]");
</source>
*ここでは、NBTタグから座標情報を読み出し、表示情報リストに追加しています。
==メソッド解説==
*ItemやItemStack内には大量にメソッドがあるので今回は、直接関係のあるメソッドだけ紹介します。
===Item===
<table class="wikitable">
	<tr>
		<th>メソッド名</th><th>説明</th>
	</tr>
	<tr>
		<td>boolean onItemUse(ItemStack par1ItemStack, EntityPlayer par2EntityPlayer, World par3World, int i, int j, int k, int l)</td><td>ブロックを右クリックした時に呼ばれる</td>
	</tr>
	<tr>
		<td>ItemStack onItemRightClick(ItemStack par1ItemStack, World par2World, EntityPlayer par3EntityPlayer)</td><td>（onItemUseがfalseを返している時に）何も起きないブロックを右クリックした時やブロックにカーソルが合わさっていない場合に右クリックした時呼ばれる。</td>
	</tr>
	<tr>
		<td>void addInformation(ItemStack itemstack, List list)</td><td>アイテムの表示に独自情報（例：エンチャント）を追加するときに使う</td>
</table>
===ItemStack===
<table class="wikitable">
	<tr>
		<th>メソッド名</th><th>説明</th>
	</tr>
	<tr>
		<td>NBTTagCompound getTagCompound()</td><td>アイテムのNBTタグを取得する</td>
	</tr>
	<tr>
		<td>void setTagCompound(NBTTagCompound par1NBTTagCompound)</td><td>アイテムにNBTタグを登録する</td>
	</tr>
	<tr>
		<td>List getItemNameandInformation()</td><td>アイテムにカーソルを合わせた時に表示される情報のリストを取得する。<br />先述したaddInformationはここから呼ばれている</td>
	</tr>
</table>
===NBTTagCompound===
<table class="wikitable">
	<tr>
		<th>メソッド名</th><th>説明</th>
	</tr>
	<tr>
		<td>void setByte(String par1Str, byte par2)</td><td>Byte型の変数を記録する。</td>
	</tr>
	<tr>
		<td>void setShort(String par1Str, short par2)</td><td>Short型の変数を記録する。</td>
	</tr>
	<tr>
		<td>void setInteger(String par1Str, int par2)</td><td>Integer型の変数を記録する。</td>
	</tr>
	<tr>
		<td>void setLong(String par1Str, long par2)</td><td>Long型の変数を記録する。</td>
	</tr>
	<tr>
		<td>void setFloat(String par1Str, float par2)</td><td>Float型の変数を記録する。</td>
	</tr>
	<tr>
		<td>void setDouble(String par1Str, double par2)</td><td>Double型の変数を記録する。</td>
	</tr>
	<tr>
		<td>void setString(String par1Str, String par2Str)</td><td>String型の変数を記録する。</td>
	</tr>
	<tr>
		<td>void setByteArray(String par1Str, byte par2ArrayOfByte[])</td><td>Byte型の配列を記録する。</td>
	</tr>
	<tr>
		<td>void setIntArray(String par1Str, int par2ArrayOfInteger[])</td><td>Int型の配列を記録する。</td>
	</tr>
	<tr>
		<td>void setBoolean(String par1Str, boolean par2)</td><td>Boolean型の変数を記録する。</td>
	</tr>
	<tr>
		<td>byte getByte(String par1Str)</td><td>Byte型の変数を取得する。</td>
	</tr>
	<tr>
		<td>short getShort(String par1Str)</td><td>Short型の変数を取得する。</td>
	</tr>
	<tr>
		<td>int getInteger(String par1Str)</td><td>Integer型の変数を取得する。</td>
	</tr>
	<tr>
		<td>long getLong(String par1Str)</td><td>Long型の変数を取得する。</td>
	</tr>
	<tr>
		<td>float getFloat(String par1Str)</td><td>Float型の変数を取得する。</td>
	</tr>
	<tr>
		<td>double getDouble(String par1Str)</td><td>Double型の変数を取得する。</td>
	</tr>
	<tr>
		<td>String getString(String par1Str)</td><td>String型の変数を取得する。</td>
	</tr>
	<tr>
		<td>byte[] getByteArray(String par1Str)</td><td>Byte型の配列を取得する。</td>
	</tr>
	<tr>
		<td>int[] getIntArray(String par1Str)</td><td>Integer型の配列を取得する。</td>
	</tr>
	<tr>
		<td>boolean getBoolean(String par1Str)</td><td>Boolean型の変数を取得する。</td>
	</tr>
</table>
*<b style="color:red;">NBTタグの変数の型を後から変更するとエラーが発生し、最悪の場合ワールドデータが破損します。十分注意して下さい。</b>