Skip to content

Class TagHandledEventArgs

Namespace: Void.Minecraft.Nbt
Assembly: Void.Minecraft.dll

Arguments supplied when an event that can be handled by an event subscriber.

public class TagHandledEventArgs : HandledEventArgs

Inheritance

objectEventArgsHandledEventArgsTagHandledEventArgs

Inherited Members

HandledEventArgs.Handled, EventArgs.Empty, object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

TagHandledEventArgs(TagType, bool, Stream)

Creates a new instance of the class.

public TagHandledEventArgs(TagType type, bool isNamed, Stream stream)

Parameters

type TagType

A constant describing the basic NBT type of the tag.

isNamed bool

Flag indicating if this tag is named, only false when a tag is a direct child of a .

stream Stream

The stream being read from, positioned at the beginning of the tag payload.

Exceptions

ArgumentNullException

Thrown when stream is null.

Properties

IsNamed

Gets flag indicating if this tag is named, only false when a tag is a direct child of a .

public bool IsNamed { get; }

Property Value

bool

Result

Gets or sets the resulting tag from this event being handled.

public Tag? Result { get; set; }

Property Value

Tag?

Remarks

This property must set to a non-null value when is true.

Stream

Gets the stream being read from, positioned at the beginning of the tag payload.

When handling this event, the stream position must be moved to the end of the payload, ready for the next tag to be parsed.

public Stream Stream { get; }

Property Value

Stream

Type

Gets a constant describing the basic NBT type of the tag.

public TagType Type { get; }

Property Value

TagType