NbtLib2012  0.3.4
A continuation of libnbt project, originally by Erik Davidson (aphistic). A C# library for reading and writing Named Binary Tag (NBT) format files.
 All Classes Namespaces Files Functions Enumerations Properties
Package LibNbt

Classes

class  NbtFile
 Represents a complete NBT file. More...
 
class  NbtFormatException
 Exception thrown when a format violation is detected while parsing or saving an NBT file. More...
 
class  NbtByte
 A tag containing a single byte. More...
 
class  NbtByteArray
 A tag containing an array of bytes. More...
 
class  NbtCompound
 A tag containing a set of other named tags. Order is not guaranteed. More...
 
class  NbtDouble
 A tag containing a double-precision floating point number. More...
 
class  NbtFloat
 A tag containing a single-precision floating point number. More...
 
class  NbtInt
 A tag containing a single signed 32-bit integer. More...
 
class  NbtIntArray
 A tag containing an array of signed 32-bit integers. More...
 
class  NbtList
 A tag containing a list of unnamed tags, all of the same kind. More...
 
class  NbtLong
 A tag containing a single signed 64-bit integer. More...
 
class  NbtShort
 A tag containing a single signed 16-bit integer. More...
 
class  NbtString
 A tag containing a single string. String is stored in UTF-8 encoding. More...
 
class  NbtTag
 Base class for different kinds of named binary tags. More...
 

Enumerations

enum  NbtCompression { AutoDetect, None, GZip, ZLib }
 Compression method used for loading/saving NBT files. More...
 
enum  NbtTagType {
  Unknown = 0xff, End = 0x00, Byte = 0x01, Short = 0x02,
  Int = 0x03, Long = 0x04, Float = 0x05, Double = 0x06,
  ByteArray = 0x07, String = 0x08, List = 0x09, Compound = 0x0a,
  IntArray = 0x0b
}
 Enumeration of named binary tag types, and their corresponding codes. More...
 

Functions

delegate bool TagSelector ([NotNull] NbtTag tag)
 Delegate used to skip loading certain tags of an NBT stream/file. The callback should return "true" for any tag that should be read,and "false" for any tag that should be skipped.
 

Enumeration Type Documentation

Compression method used for loading/saving NBT files.

Enumerator:
AutoDetect 

Automatically detect file compression. Not a valid format for saving.

None 

No compression.

GZip 

Compressed, with GZip header (default).

ZLib 

Compressed, with ZLib header (RFC-1950).

Enumeration of named binary tag types, and their corresponding codes.

Enumerator:
Unknown 

Placeholder TagType used to indicate unknown/undefined tag type in NbtList.

End 

TAG_End: This unnamed tag serves no purpose but to signify the end of an open TAG_Compound.

Byte 

TAG_Byte: A single byte.

Short 

TAG_Short: A single signed 16-bit integer.

Int 

TAG_Int: A single signed 32-bit integer.

Long 

TAG_Long: A single signed 64-bit integer.

Float 

TAG_Float: A single IEEE-754 single-precision floating point number.

Double 

TAG_Double: A single IEEE-754 double-precision floating point number.

ByteArray 

TAG_Byte_Array: A length-prefixed array of bytes.

String 

TAG_String: A length-prefixed UTF-8 string.

List 

TAG_List: A list of nameless tags, all of the same type.

Compound 

TAG_Compound: A set of named tags.

IntArray 

TAG_Byte_Array: A length-prefixed array of signed 32-bit integers.

Function Documentation

delegate bool LibNbt.TagSelector ( [NotNull] NbtTag  tag)

Delegate used to skip loading certain tags of an NBT stream/file. The callback should return "true" for any tag that should be read,and "false" for any tag that should be skipped.

Parameters
tagTag that is being read. Tag's type and name are available, but the value has not yet been read at this time. Guaranteed to never be null.