LibNbt.NbtString Class Reference

A tag containing a single string. String is stored in UTF-8 encoding. More...

Inheritance diagram for LibNbt.NbtString:

Collaboration diagram for LibNbt.NbtString:

Public Member Functions
	NbtString ()
	Creates an unnamed NbtString tag with the default value (empty string).
	NbtString ([NotNull] string value)
	Creates an unnamed NbtString tag with the given value.
	NbtString ([CanBeNull] string tagName,[NotNull] string value)
	Creates an NbtString tag with the given name and value.
override string	ToString ()
	Returns a String that represents the current NbtString object. Format: TAG_String("Name"): Value
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 (String).
string	Value [get, set]
	Value/payload of this tag (a single string). May not be null.
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 a single string. String is stored in UTF-8 encoding.

Constructor & Destructor Documentation

LibNbt.NbtString.NbtString

(

)

Creates an unnamed NbtString tag with the default value (empty string).

LibNbt.NbtString.NbtString

(

[NotNull] string

value

)

Creates an unnamed NbtString tag with the given value.

Parameters

value

String value to assign to this tag. May not be null.

Exceptions

ArgumentNullException

value is null.

LibNbt.NbtString.NbtString	(	[CanBeNull] string	tagName,
		[NotNull] string	value
	)

Creates an NbtString tag with the given name and value.

Parameters

tagName	Name to assign to this tag. May be null.
value	String value to assign to this tag. May not be null.

Exceptions

ArgumentNullException

value is null.

Member Function Documentation

override string LibNbt.NbtString.ToString

(

)

Returns a String that represents the current NbtString object. Format: TAG_String("Name"): Value

Returns

A String that represents the current NbtString object.

Property Documentation

override NbtTagType LibNbt.NbtString.TagType

get

Type of this tag (String).

string LibNbt.NbtString.Value

getset

Value/payload of this tag (a single string). May not be null.

---

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

• C:/Users/fragmer/Desktop/Minecraft/libnbt/LibNbt/Tags/NbtString.cs