me.dpohvar.powernbt.api

Class NBTManager

java.lang.Object

me.dpohvar.powernbt.api.NBTManager

public class NBTManager
extends Object

PowerNBT API.
This class has methods to read and write NBT tags.
NBTCompound is used to work with NBTTagCompound,
NBTList is used to work with NBTTagList,
String is used to work with NBTTagString,
all other NBT tags represents by primitive values.

Since:

0.7.1

Field Summary

Fields

Modifier and Type	Field and Description
static NBTManager	nbtManager

Method Summary

Modifier and Type	Method and Description
org.bukkit.inventory.ItemStack	asCraftItemStack(org.bukkit.inventory.ItemStack itemStack) Convert bukkit ItemStack to CraftItemStack.
org.bukkit.inventory.ItemStack	createCraftItemStack(NBTCompound compound) Create CraftItemStack from nbt value
static NBTManager	getInstance() Get single instance of NBTManager.
File	getPlayerFile(org.bukkit.OfflinePlayer player) Get OfflinePlayer file with stored nbt data.
Object	parseMojangson(String value) Parse mojangson string.
NBTCompound	read(org.bukkit.block.Block block) Read nbt data of tile entity at block.
NBTCompound	read(org.bukkit.Chunk chunk) Read nbt tag of Chunk.
Object	read(DataInput dataInput) Read nbt data from dataInput and convert to java object.
NBTCompound	read(org.bukkit.entity.Entity entity) Read NBT tag of bukkit entity.
Object	read(File file) Read raw nbt data from file and convert to java object.
Object	read(InputStream inputStream) Read raw NBT data from input stream and convert to java object.
NBTList	read(org.bukkit.inventory.Inventory inventory) Read items as nbt values from inventory
NBTCompound	read(org.bukkit.inventory.ItemStack item) Read nbt tag of ItemStack.
NBTCompound	readCompressed(File file) Read compressed nbt data from file and convert to java object.
NBTCompound	readCompressed(InputStream inputStream) Read compressed nbt compound.
NBTCompound	readForgeData(org.bukkit.entity.Entity entity) Read extra nbt data of entity.
NBTCompound	readOfflinePlayer(org.bukkit.OfflinePlayer player) Read offline player's .dat file.
NBTCompound	readOfflinePlayer(String player) Read offline player's .dat file.
org.bukkit.entity.Entity	spawnEntity(NBTCompound compound, org.bukkit.World world) Spawn entity in world by nbt compound.
void	write(org.bukkit.block.Block block, NBTCompound compound) Save nbt data to tile entity at block.
void	write(org.bukkit.Chunk chunk, NBTCompound compound) Store nbt tag to selected chunk.
void	write(DataOutput dataOutput, Object value) Convert value to nbt and write to dataOutput.
void	write(org.bukkit.entity.Entity entity, NBTCompound compound) Store nbt data to entity.
void	write(File file, Object value) Write to file value converted to nbt tag.
void	write(org.bukkit.inventory.Inventory inventory, NBTList value) Store items from nbt data to inventory
void	write(org.bukkit.inventory.ItemStack item, NBTCompound compound) Save nbt tag to item stack.
void	write(OutputStream outputStream, Object value) Convert java object to nbt and write to outputStream.
void	writeCompressed(File file, NBTCompound value) Convert value to nbt and write to file with compression.
void	writeCompressed(OutputStream outputStream, NBTCompound value) Compress nbt compound and write to outputStream.
void	writeForgeData(org.bukkit.entity.Entity entity, NBTCompound compound) Store extra nbt data to entity.
boolean	writeOfflinePlayer(org.bukkit.OfflinePlayer player, NBTCompound value) Write nbt data to player's .dat file.
boolean	writeOfflinePlayer(String player, NBTCompound value) Write nbt data to player's .dat file.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nbtManager

public static final NBTManager nbtManager

Method Detail

getInstance

public static NBTManager getInstance()

Get single instance of NBTManager.

Returns:

NBTManager

read

public NBTCompound read(org.bukkit.entity.Entity entity)

Read NBT tag of bukkit entity.

Parameters:

entity - Entity to read

Returns:

Nbt tag of bukkit entity

write

public void write(org.bukkit.entity.Entity entity,
                  NBTCompound compound)

Store nbt data to entity.

Parameters:

entity - Entity to modify

compound - Nbt data to be stored

readForgeData

public NBTCompound readForgeData(org.bukkit.entity.Entity entity)

Read extra nbt data of entity.
Works with forge only.

Parameters:

entity - Entity to read

Returns:

Extra nbt data. null if no forge

writeForgeData

public void writeForgeData(org.bukkit.entity.Entity entity,
                           NBTCompound compound)

Store extra nbt data to entity. Works with forge only

Parameters:

entity - entity

compound - extra nbt data

read

public NBTCompound read(org.bukkit.inventory.ItemStack item)

Read nbt tag of ItemStack.

Parameters:

item - Bukkit ItemStack

Returns:

Nbt data. null if item has no nbt and no meta

read

public NBTCompound read(org.bukkit.Chunk chunk)

Read nbt tag of Chunk.

Parameters:

chunk - Bukkit chunk

Returns:

Nbt data of chunk

Since:

0.8.1

write

public void write(org.bukkit.Chunk chunk,
                  NBTCompound compound)

Store nbt tag to selected chunk.

Parameters:

chunk - Chunk to be changed

compound - Nbt data

Since:

0.8.1

write

public void write(org.bukkit.inventory.ItemStack item,
                  NBTCompound compound)

Save nbt tag to item stack.
You can save any data to CraftItemStack.
You can save to ItemStack only data allowed by ItemMeta.

Parameters:

item - bukkit item stack

compound - tag

read

public NBTCompound read(org.bukkit.block.Block block)

Read nbt data of tile entity at block.

Parameters:

block - Block with tile entity

Returns:

Nbt data of tile entity or empty compound if no data

write

public void write(org.bukkit.block.Block block,
                  NBTCompound compound)

Save nbt data to tile entity at block.

Parameters:

block - Block with tile entity

compound - Tag to be saved

read

public Object read(InputStream inputStream)
            throws IOException

Read raw NBT data from input stream and convert to java object.

Parameters:

inputStream - InputStream to read

Returns:

Read object

Throws:

IOException - it happens sometimes

write

public void write(OutputStream outputStream,
                  Object value)
           throws IOException

Convert java object to nbt and write to outputStream.
Allowed all primitive types, collections and maps.

Parameters:

outputStream - outputStream to write

value - value to be written

Throws:

IOException - it happens sometimes

readCompressed

public NBTCompound readCompressed(InputStream inputStream)

Read compressed nbt compound.

Parameters:

inputStream - InputStream to read

Returns:

Nbt rag

writeCompressed

public void writeCompressed(OutputStream outputStream,
                            NBTCompound value)

Compress nbt compound and write to outputStream.

Parameters:

outputStream - outputStream to write

value - value

read

public Object read(DataInput dataInput)
            throws IOException

Read nbt data from dataInput and convert to java object.

Parameters:

dataInput - dataInput to read

Returns:

nbt data converted to java object

Throws:

IOException - it happens

write

public void write(DataOutput dataOutput,
                  Object value)
           throws IOException

Convert value to nbt and write to dataOutput.

Parameters:

dataOutput - dataOutput to save

value - value to be written

Throws:

IOException - it happens sometimes

read

public Object read(File file)
            throws IOException

Read raw nbt data from file and convert to java object.

Parameters:

file - file to read

Returns:

nbt data converted to java types

Throws:

IOException - it happens

write

public void write(File file,
                  Object value)
           throws IOException

Write to file value converted to nbt tag.

Parameters:

file - file to write

value - value to be written

Throws:

IOException - it happens

read

public NBTList read(org.bukkit.inventory.Inventory inventory)

Read items as nbt values from inventory

Parameters:

inventory - an inventory

Returns:

NBTList with items

write

public void write(org.bukkit.inventory.Inventory inventory,
                  NBTList value)

Store items from nbt data to inventory

Parameters:

inventory - an inventory to change

value - nbt array with items

readCompressed

public NBTCompound readCompressed(File file)
                           throws FileNotFoundException

Read compressed nbt data from file and convert to java object.

Parameters:

file - file to read

Returns:

nbt data converted to java types

Throws:

FileNotFoundException - if file not found

writeCompressed

public void writeCompressed(File file,
                            NBTCompound value)
                     throws FileNotFoundException

Convert value to nbt and write to file with compression.

Parameters:

file - file to write

value - value to be written

Throws:

FileNotFoundException - check your file

readOfflinePlayer

public NBTCompound readOfflinePlayer(org.bukkit.OfflinePlayer player)

Read offline player's .dat file.

Parameters:

player - player to read

Returns:

nbt data read from a file

readOfflinePlayer

public NBTCompound readOfflinePlayer(String player)

Read offline player's .dat file.

Parameters:

player - player name

Returns:

nbt data read from a file

writeOfflinePlayer

public boolean writeOfflinePlayer(org.bukkit.OfflinePlayer player,
                                  NBTCompound value)

Write nbt data to player's .dat file.

Parameters:

player - offline player

value - value to be written

Returns:

true on success, false otherwise

writeOfflinePlayer

public boolean writeOfflinePlayer(String player,
                                  NBTCompound value)

Write nbt data to player's .dat file.

Parameters:

player - player name

value - value to be written

Returns:

true on success, false otherwise

getPlayerFile

public File getPlayerFile(org.bukkit.OfflinePlayer player)

Get OfflinePlayer file with stored nbt data.

Parameters:

player - offline player

Returns:

player's file

parseMojangson

public Object parseMojangson(String value)

Parse mojangson string.
This method can return:
byte, short, int, long, float, double, byte[], String, int[],
NBTList or NBTCompound
Examples:

     manager.parseMojangson("12s\\"); // 12 short
     manager.parseMojangson("{foo:bar}"); // NBTCompound
 

Parameters:

value - String in Mojangson format

Returns:

Parse result

Since:

0.8.2

spawnEntity

public org.bukkit.entity.Entity spawnEntity(NBTCompound compound,
                                            org.bukkit.World world)

Spawn entity in world by nbt compound.
Entity location must be stored in "Pos" tag.

Parameters:

compound - Entity data

world - World where to spawn entity

Returns:

Spawned entity

Since:

0.8.2

asCraftItemStack

public org.bukkit.inventory.ItemStack asCraftItemStack(org.bukkit.inventory.ItemStack itemStack)

Convert bukkit ItemStack to CraftItemStack.

Parameters:

itemStack - Bukkit ItemStack

Returns:

CraftItemStack with nms item

createCraftItemStack

public org.bukkit.inventory.ItemStack createCraftItemStack(NBTCompound compound)

Create CraftItemStack from nbt value

Parameters:

compound - nbt data of item: Slot, Count, Damage, id, tag

Returns:

new CraftItemStack