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

Class ArgumentItemStack

java.lang.Object

net.minestom.server.command.builder.arguments.Argument<ItemStack>

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

public class ArgumentItemStack
extends Argument<ItemStack>

Argument which can be used to retrieve an ItemStack from its material and with NBT data.

It is the same type as the one used in the /give command.

Example: diamond_sword{display:{Name:"{\"text\":\"Sword of Power\"}"}}

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INVALID_COMPONENT
static final int	INVALID_MATERIAL
static final int	INVALID_NBT
static final int	NO_MATERIAL

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

allowSpace, suggestionType, useRemaining

Constructor Summary

Constructors

Constructor	Description
ArgumentItemStack(String id)

Method Summary

Modifier and Type	Method	Description
@NotNull ItemStack	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()
static ItemStack	staticParse(@NotNull String input)	Deprecated. use Argument.parse(CommandSender, Argument)
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

NO_MATERIAL

public static final int NO_MATERIAL

See Also:

• Constant Field Values

INVALID_NBT

public static final int INVALID_NBT

See Also:

• Constant Field Values

INVALID_MATERIAL

public static final int INVALID_MATERIAL

See Also:

• Constant Field Values

INVALID_COMPONENT

public static final int INVALID_COMPONENT

See Also:

• Constant Field Values

Constructor Details

ArgumentItemStack

public ArgumentItemStack(String id)

Method Details

parse

@NotNull
public @NotNull ItemStack 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<ItemStack>

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<ItemStack>

staticParse

@Deprecated
public static ItemStack staticParse(@NotNull
 @NotNull String input)
                             throws ArgumentSyntaxException

Deprecated.

use Argument.parse(CommandSender, Argument)

Throws:

ArgumentSyntaxException

toString

public String toString()

Overrides:

toString in class Object