Class RequiredArgumentBuilder

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

Builds a named, parsed argument command node.

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

Inheritance

object ← ArgumentBuilder ← ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode> ← RequiredArgumentBuilder

Implements

IEquatable<ArgumentBuilder>, IArgumentBuilder<ArgumentCommandNode>, IEquatable<ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode>>, IEquatable<RequiredArgumentBuilder>

Inherited Members

ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode>.Then<TChildNode>(IArgumentBuilder<TChildNode>), ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode>.Then<TChildNode>(CommandNode), ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode>.Then<TChildNode>(Func<IArgumentContext, IArgumentBuilder<TChildNode>>), ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode>.Executes(CommandExecutor?), ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode>.Executes(CommandExecutorSync?), ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode>.Requires(CommandRequirement?), ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode>.Redirect(CommandNode), ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode>.Redirect(CommandNode, SingleRedirectModifier), ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode>.Fork(CommandNode, RedirectModifier), ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode>.Forward(CommandNode?, RedirectModifier?, bool), ArgumentBuilder<RequiredArgumentBuilder, ArgumentCommandNode>.Suggests(SuggestionProvider?), ArgumentBuilder<RequiredArgumentBuilder, 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

RequiredArgumentBuilder(string, IArgumentType)

Builds a named, parsed argument command node.

public RequiredArgumentBuilder(string Name, IArgumentType Type)

Parameters

Name string

The argument name.

Type IArgumentType

The parser and completion behavior.

Properties

Name

The argument name.

public string Name { get; init; }

Property Value

string

SuggestionProvider

Gets the custom suggestion provider, or null to use the argument type.

public SuggestionProvider? SuggestionProvider { get; }

Property Value

SuggestionProvider?

Type

The parser and completion behavior.

public IArgumentType Type { get; init; }

Property Value

IArgumentType

Methods

Build()

Creates the configured command node.

public override ArgumentCommandNode Build()

Returns

ArgumentCommandNode

The built node.

Create(string, IArgumentType)

Creates a required-argument builder.

public static RequiredArgumentBuilder Create(string name, IArgumentType type)

Parameters

name string

The argument name.

type IArgumentType

The argument type.

Returns

RequiredArgumentBuilder

The builder.

Suggests(SuggestionProvider?)

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

public override RequiredArgumentBuilder Suggests(SuggestionProvider? provider)

Parameters

provider SuggestionProvider?

The provider.

Returns

RequiredArgumentBuilder

This builder.

Suggests(SuggestionProviderSync?)

Wraps and sets a synchronous suggestion provider.

public RequiredArgumentBuilder Suggests(SuggestionProviderSync? provider)

Parameters

provider SuggestionProviderSync?

The provider; null leaves the current provider unchanged.

Returns

RequiredArgumentBuilder

This builder.