Class ParticleArgument

java.lang.Object

net.minecraft.commands.arguments.ParticleArgument

All Implemented Interfaces:

com.mojang.brigadier.arguments.ArgumentType<ParticleOptions>

public class ParticleArgument
extends Object
implements com.mojang.brigadier.arguments.ArgumentType<ParticleOptions>

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.brigadier.exceptions.DynamicCommandExceptionType	ERROR_INVALID_OPTIONS
static final com.mojang.brigadier.exceptions.DynamicCommandExceptionType	ERROR_UNKNOWN_PARTICLE
private static final Collection<String>	EXAMPLES
private final HolderLookup.Provider	registries
private static final TagParser<?>	VALUE_PARSER

Constructor Summary

Constructors

Constructor	Description
ParticleArgument(CommandBuildContext context)

Method Summary

Modifier and Type	Method	Description
Collection<String>	getExamples()
static ParticleOptions	getParticle(com.mojang.brigadier.context.CommandContext<CommandSourceStack> context, String name)
<S> CompletableFuture<com.mojang.brigadier.suggestion.Suggestions>	listSuggestions(com.mojang.brigadier.context.CommandContext<S> context, com.mojang.brigadier.suggestion.SuggestionsBuilder builder)
ParticleOptions	parse(com.mojang.brigadier.StringReader reader)
static ParticleArgument	particle(CommandBuildContext context)
static ParticleOptions	readParticle(com.mojang.brigadier.StringReader reader, HolderLookup.Provider registries)
private static <T extends ParticleOptions, O> T	readParticle(TagParser<O> parser, com.mojang.brigadier.StringReader reader, ParticleType<T> type, HolderLookup.Provider registries)
private static ParticleType<?>	readParticleType(com.mojang.brigadier.StringReader reader, HolderLookup<ParticleType<?>> particles)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.mojang.brigadier.arguments.ArgumentType

parse

Field Details

EXAMPLES

private static final Collection<String> EXAMPLES

ERROR_UNKNOWN_PARTICLE

public static final com.mojang.brigadier.exceptions.DynamicCommandExceptionType ERROR_UNKNOWN_PARTICLE

ERROR_INVALID_OPTIONS

public static final com.mojang.brigadier.exceptions.DynamicCommandExceptionType ERROR_INVALID_OPTIONS

registries

private final HolderLookup.Provider registries

VALUE_PARSER

private static final TagParser<?> VALUE_PARSER

Constructor Details

ParticleArgument

public ParticleArgument(CommandBuildContext context)

Method Details

particle

public static ParticleArgument particle(CommandBuildContext context)

getParticle

public static ParticleOptions getParticle(com.mojang.brigadier.context.CommandContext<CommandSourceStack> context,
 String name)

parse

public ParticleOptions parse(com.mojang.brigadier.StringReader reader)
                      throws com.mojang.brigadier.exceptions.CommandSyntaxException

Specified by:

parse in interface com.mojang.brigadier.arguments.ArgumentType<ParticleOptions>

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

getExamples

public Collection<String> getExamples()

Specified by:

getExamples in interface com.mojang.brigadier.arguments.ArgumentType<ParticleOptions>

readParticle

public static ParticleOptions readParticle(com.mojang.brigadier.StringReader reader,
 HolderLookup.Provider registries)
                                    throws com.mojang.brigadier.exceptions.CommandSyntaxException

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

readParticleType

private static ParticleType<?> readParticleType(com.mojang.brigadier.StringReader reader,
 HolderLookup<ParticleType<?>> particles)
                                         throws com.mojang.brigadier.exceptions.CommandSyntaxException

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

readParticle

private static <T extends ParticleOptions, O> T readParticle(TagParser<O> parser,
 com.mojang.brigadier.StringReader reader,
 ParticleType<T> type,
 HolderLookup.Provider registries)
                                                      throws com.mojang.brigadier.exceptions.CommandSyntaxException

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

listSuggestions

public <S>
CompletableFuture<com.mojang.brigadier.suggestion.Suggestions> listSuggestions(com.mojang.brigadier.context.CommandContext<S> context,
 com.mojang.brigadier.suggestion.SuggestionsBuilder builder)

Specified by:

listSuggestions in interface com.mojang.brigadier.arguments.ArgumentType<ParticleOptions>