Skip to content

Class PassthroughArgumentType

Namespace: Void.Minecraft.Commands.Brigadier.ArgumentTypes
Assembly: Void.Minecraft.dll

Associates protocol-version serializer mappings with a passthrough argument value.

public record PassthroughArgumentType : IArgumentType, IAnyArgumentType, IEquatable<PassthroughArgumentType>

Inheritance

objectPassthroughArgumentType

Implements

IArgumentType, IAnyArgumentType, IEquatable<PassthroughArgumentType>

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

PassthroughArgumentType(ArgumentSerializerMapping, IPassthroughArgumentValue)

Associates protocol-version serializer mappings with a passthrough argument value.

public PassthroughArgumentType(ArgumentSerializerMapping Mappings, IPassthroughArgumentValue Value)

Parameters

Mappings ArgumentSerializerMapping

The serializers selected by protocol version.

Value IPassthroughArgumentValue

The protocol-only argument properties.

Properties

Examples

Always throws because passthrough arguments do not expose parsing examples.

public IEnumerable<string> Examples { get; }

Property Value

IEnumerable<string>

Exceptions

NotSupportedException

Always thrown.

Mappings

The serializers selected by protocol version.

public ArgumentSerializerMapping Mappings { get; init; }

Property Value

ArgumentSerializerMapping

Value

The protocol-only argument properties.

public IPassthroughArgumentValue Value { get; init; }

Property Value

IPassthroughArgumentValue

Methods

Parse(StringReader)

Always throws because passthrough arguments do not parse command input.

public IArgumentValue Parse(StringReader reader)

Parameters

reader StringReader

The unused reader.

Returns

IArgumentValue

This method does not return.

Exceptions

NotSupportedException

Always thrown.