Package net.minestom.server.command.builder.arguments.minecraft

Class ArgumentNbtTag

java.lang.Object

net.minestom.server.command.builder.arguments.Argument<net.kyori.adventure.nbt.BinaryTag>

net.minestom.server.command.builder.arguments.minecraft.ArgumentNbtTag

public class ArgumentNbtTag
extends Argument<net.kyori.adventure.nbt.BinaryTag>

Argument used to retrieve a BinaryTag based object, can be any kind of tag like CompoundBinaryTag, ListBinaryTag, IntBinaryTag, etc...

Example: {display:{Name:"{\"text\":\"Sword of Power\"}"}} or [{display:{Name:"{\"text\":\"Sword of Power\"}"}}]

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INVALID_NBT

Fields inherited from class net.minestom.server.command.builder.arguments.Argument

allowSpace, suggestionType, useRemaining

Constructor Summary

Constructors

Constructor	Description
ArgumentNbtTag(String id)

Method Summary

Modifier and Type	Method	Description
@NotNull net.kyori.adventure.nbt.BinaryTag	parse(@NotNull CommandSender sender, @NotNull String input)	Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T
ArgumentParserType	parser()
String	toString()

Methods inherited from class net.minestom.server.command.builder.arguments.Argument

allowSpace, equals, filter, getCallback, getDefaultValue, getId, getSuggestionCallback, hasErrorCallback, hashCode, hasSuggestion, isOptional, map, map, nodeProperties, parse, setCallback, setDefaultValue, setDefaultValue, setDefaultValue, setSuggestionCallback, suggestionType, useRemaining

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INVALID_NBT

public static final int INVALID_NBT

See Also:

• Constant Field Values

Constructor Details

ArgumentNbtTag

public ArgumentNbtTag(String id)

Method Details

parse

@NotNull
public @NotNull net.kyori.adventure.nbt.BinaryTag parse(@NotNull
 @NotNull CommandSender sender,
 @NotNull
 @NotNull String input)
                                                 throws ArgumentSyntaxException

Description copied from class: Argument

Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T

Specified by:

parse in class Argument<net.kyori.adventure.nbt.BinaryTag>

Parameters:

input - the argument to parse

Returns:

the parsed argument

Throws:

ArgumentSyntaxException - if value is not valid

parser

public ArgumentParserType parser()

Specified by:

parser in class Argument<net.kyori.adventure.nbt.BinaryTag>

toString

public String toString()

Overrides:

toString in class Object