Class PassthroughArgumentBuilder

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

Builds an argument node that preserves opaque protocol parser properties.

public record PassthroughArgumentBuilder : ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>, IEquatable<ArgumentBuilder>, IArgumentBuilder<ArgumentCommandNode>, IEquatable<ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>>, IEquatable<PassthroughArgumentBuilder>

Inheritance

object ← ArgumentBuilder ← ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode> ← PassthroughArgumentBuilder

Implements

IEquatable<ArgumentBuilder>, IArgumentBuilder<ArgumentCommandNode>, IEquatable<ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>>, IEquatable<PassthroughArgumentBuilder>

Inherited Members

ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>.Then<TChildNode>(IArgumentBuilder<TChildNode>), ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>.Then<TChildNode>(CommandNode), ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>.Then<TChildNode>(Func<IArgumentContext, IArgumentBuilder<TChildNode>>), ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>.Executes(CommandExecutor?), ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>.Executes(CommandExecutorSync?), ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>.Requires(CommandRequirement?), ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>.Redirect(CommandNode), ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>.Redirect(CommandNode, SingleRedirectModifier), ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>.Fork(CommandNode, RedirectModifier), ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>.Forward(CommandNode?, RedirectModifier?, bool), ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>.Suggests(SuggestionProvider?), ArgumentBuilder<PassthroughArgumentBuilder, ArgumentCommandNode>.Build(), ArgumentBuilder._arguments, ArgumentBuilder.Executor, ArgumentBuilder.RedirectModifier, ArgumentBuilder.RedirectTarget, ArgumentBuilder.IsForks, ArgumentBuilder.Requirement, ArgumentBuilder.Arguments, ArgumentBuilder.Build(), ArgumentBuilder.Executes(CommandExecutor?), ArgumentBuilder.Executes(CommandExecutorSync?), ArgumentBuilder.Requires(CommandRequirement?), ArgumentBuilder.Redirect(CommandNode), ArgumentBuilder.Redirect(CommandNode, SingleRedirectModifier), ArgumentBuilder.Fork(CommandNode, RedirectModifier), ArgumentBuilder.Forward(CommandNode?, RedirectModifier?, bool), ArgumentBuilder.Suggests(SuggestionProvider?), ArgumentBuilder.AddChild(CommandNode), object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

PassthroughArgumentBuilder(ArgumentSerializerMapping, string, IPassthroughArgumentValue)

Builds an argument node that preserves opaque protocol parser properties.

public PassthroughArgumentBuilder(ArgumentSerializerMapping Identifier, string Name, IPassthroughArgumentValue Result)

Parameters

Identifier ArgumentSerializerMapping

The parser identifier mapping.

Name string

The argument name.

Result IPassthroughArgumentValue

The passthrough property value.

Properties

Identifier

The parser identifier mapping.

public ArgumentSerializerMapping Identifier { get; init; }

Property Value

ArgumentSerializerMapping

Name

The argument name.

public string Name { get; init; }

Property Value

string

Result

The passthrough property value.

public IPassthroughArgumentValue Result { get; init; }

Property Value

IPassthroughArgumentValue

SuggestionProvider

Gets the custom suggestion provider.

public SuggestionProvider? SuggestionProvider { get; }

Property Value

SuggestionProvider?

Methods

Build()

Creates the configured command node.

public override ArgumentCommandNode Build()

Returns

ArgumentCommandNode

The built node.

Suggests(SuggestionProvider?)

Sets a suggestion provider when supported and returns the concrete builder type.

public override PassthroughArgumentBuilder Suggests(SuggestionProvider? provider)

Parameters

provider SuggestionProvider?

The provider.

Returns

PassthroughArgumentBuilder

This builder.