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
LibNbt.NbtByteArray Class Reference

A tag containing an array of bytes. More...

Inheritance diagram for LibNbt.NbtByteArray:
Collaboration diagram for LibNbt.NbtByteArray:

Public Member Functions

 NbtByteArray ()
 Creates an unnamed NbtByte tag, containing an empty array of bytes.
 
 NbtByteArray ([NotNull] byte[] value)
 Creates an unnamed NbtByte tag, containing the given array of bytes.
 
 NbtByteArray ([CanBeNull] string tagName)
 Creates an NbtByte tag with the given name, containing an empty array of bytes.
 
 NbtByteArray ([CanBeNull] string tagName,[NotNull] byte[] value)
 Creates an NbtByte tag with the given name, containing the given array of bytes.
 
override string ToString ()
 Returns a String that represents the current NbtByteArray object. Format: TAG_Byte_Array("Name"): [N bytes]
 
- Public Member Functions inherited from LibNbt.NbtTag
string ToString ([NotNull] string indentString)
 Prints contents of this tag, and any child tags, to a string. Indents the string using multiples of the given indentation string.
 

Properties

override NbtTagType TagType [get]
 Type of this tag (ByteArray).
 
byte[] Value [get, set]
 Value/payload of this tag (an array of bytes). May not be null.
 
new byte this[int tagIndex] [get, set]
 Gets or sets a byte at the given index.
 
- Properties inherited from LibNbt.NbtTag
NbtTag Parent [get, set]
 Parent compound tag, either NbtList or NbtCompound, if any.
 
virtual NbtTagType TagType [get]
 Type of this tag.
 
string Name [get, set]
 Name of this tag. Immutable, and set by the constructor. May be null.
 
string Path [get]
 Gets the full name of this tag, including all parent tag names, separated by dots. Unnamed tags show up as empty strings.
 
virtual NbtTag this[string tagName] [get, set]
 Gets or sets the tag with the specified name. May return null.
 
virtual NbtTag this[int tagIndex] [get, set]
 Gets or sets the tag at the specified index.
 
byte ByteValue [get]
 Returns the value of this tag, cast as a byte. Only supported by NbtByte tags.
 
short ShortValue [get]
 Returns the value of this tag, cast as a short (16-bit signed integer). Only supported by NbtByte and NbtShort.
 
int IntValue [get]
 Returns the value of this tag, cast as an int (32-bit signed integer). Only supported by NbtByte, NbtShort, and NbtInt.
 
long LongValue [get]
 Returns the value of this tag, cast as a long (64-bit signed integer). Only supported by NbtByte, NbtShort, NbtInt, and NbtLong.
 
float FloatValue [get]
 Returns the value of this tag, cast as a long (64-bit signed integer). Only supported by NbtFloat and, with loss of precision, by NbtDouble, NbtByte, NbtShort, NbtInt, and NbtLong.
 
double DoubleValue [get]
 Returns the value of this tag, cast as a long (64-bit signed integer). Only supported by NbtFloat, NbtDouble, and, with loss of precision, by NbtByte, NbtShort, NbtInt, and NbtLong.
 
byte[] ByteArrayValue [get]
 Returns the value of this tag, cast as a byte array. Only supported by NbtByteArray tags.
 
int[] IntArrayValue [get]
 Returns the value of this tag, cast as an int array. Only supported by NbtIntArray tags.
 
string StringValue [get]
 Returns the value of this tag, cast as a string. Returns exact value for NbtString, and stringified (using InvariantCulture) value for NbtByte, NbtDouble, NbtFloat, NbtInt, NbtLong, and NbtShort. Not supported by NbtCompound, NbtList, NbtByteArray, or NbtIntArray.
 

Additional Inherited Members

- Static Public Member Functions inherited from LibNbt.NbtTag
static string GetCanonicalTagName (NbtTagType type)
 Returns a canonical (Notchy) name for the given NbtTagType, e.g. "TAG_Byte_Array" for NbtTagType.ByteArray
 

Detailed Description

A tag containing an array of bytes.

Constructor & Destructor Documentation

LibNbt.NbtByteArray.NbtByteArray ( )

Creates an unnamed NbtByte tag, containing an empty array of bytes.

LibNbt.NbtByteArray.NbtByteArray ( [NotNull] byte[]  value)

Creates an unnamed NbtByte tag, containing the given array of bytes.

Parameters
valueByte array to assign to this tag's Value. May not be null.
Exceptions
ArgumentNullExceptionvalue is null.
LibNbt.NbtByteArray.NbtByteArray ( [CanBeNull] string  tagName)

Creates an NbtByte tag with the given name, containing an empty array of bytes.

Parameters
tagNameName to assign to this tag. May be null.
LibNbt.NbtByteArray.NbtByteArray ( [CanBeNull] string  tagName,
[NotNull] byte[]  value 
)

Creates an NbtByte tag with the given name, containing the given array of bytes.

Parameters
tagNameName to assign to this tag. May be null.
valueByte array to assign to this tag's Value. May not be null.
Exceptions
ArgumentNullExceptionvalue is null.

Member Function Documentation

override string LibNbt.NbtByteArray.ToString ( )

Returns a String that represents the current NbtByteArray object. Format: TAG_Byte_Array("Name"): [N bytes]

Returns
A String that represents the current NbtByteArray object.

Property Documentation

override NbtTagType LibNbt.NbtByteArray.TagType
get

Type of this tag (ByteArray).

new byte LibNbt.NbtByteArray.this[int tagIndex]
getset

Gets or sets a byte at the given index.

Parameters
tagIndexThe zero-based index of the element to get or set.
Returns
The byte at the specified index.
Exceptions
IndexOutOfRangeExceptiontagIndex is outside the array bounds.
byte [] LibNbt.NbtByteArray.Value
getset

Value/payload of this tag (an array of bytes). May not be null.

Exceptions
ArgumentNullExceptionvalue is null.

The documentation for this class was generated from the following file: