java.lang.Object

net.minecraft.commands.arguments.EntityArgument

All Implemented Interfaces:: ArgumentType<EntitySelector>

public class EntityArgument extends Object implements ArgumentType<EntitySelector>

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

EntityArgument.Info
Field Summary

Fields

Modifier and Type

Field

Description

static final SimpleCommandExceptionType

ERROR_NOT_SINGLE_ENTITY

static final SimpleCommandExceptionType

ERROR_NOT_SINGLE_PLAYER

static final SimpleCommandExceptionType

ERROR_ONLY_PLAYERS_ALLOWED

static final SimpleCommandExceptionType

ERROR_SELECTORS_NOT_ALLOWED

private static final Collection<String>

EXAMPLES

static final SimpleCommandExceptionType

NO_ENTITIES_FOUND

static final SimpleCommandExceptionType

NO_PLAYERS_FOUND

private final boolean

playersOnly

private final boolean

single
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

EntityArgument(boolean single, boolean playersOnly)
Method Summary

Modifier and Type

Method

Description

static EntityArgument

entities()

static EntityArgument

entity()

static Collection<? extends Entity>

getEntities(CommandContext<CommandSourceStack> context, String name)

static Entity

getEntity(CommandContext<CommandSourceStack> context, String name)

Collection<String>

getExamples()

static Collection<? extends Entity>

getOptionalEntities(CommandContext<CommandSourceStack> context, String name)

static Collection<ServerPlayer>

getOptionalPlayers(CommandContext<CommandSourceStack> context, String name)

static ServerPlayer

getPlayer(CommandContext<CommandSourceStack> context, String name)

static Collection<ServerPlayer>

getPlayers(CommandContext<CommandSourceStack> context, String name)

<S> CompletableFuture<Suggestions>

listSuggestions(CommandContext<S> contextBuilder, SuggestionsBuilder builder)

EntitySelector

parse(StringReader reader)

private EntitySelector

parse(StringReader reader, boolean allowSelectors)

<S> EntitySelector

parse(StringReader reader, S source)

static EntityArgument

player()

static EntityArgument

players()

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- EXAMPLES
  
  private static final Collection<String> EXAMPLES
- ERROR_NOT_SINGLE_ENTITY
  
  public static final SimpleCommandExceptionType ERROR_NOT_SINGLE_ENTITY
- ERROR_NOT_SINGLE_PLAYER
  
  public static final SimpleCommandExceptionType ERROR_NOT_SINGLE_PLAYER
- ERROR_ONLY_PLAYERS_ALLOWED
  
  public static final SimpleCommandExceptionType ERROR_ONLY_PLAYERS_ALLOWED
- NO_ENTITIES_FOUND
  
  public static final SimpleCommandExceptionType NO_ENTITIES_FOUND
- NO_PLAYERS_FOUND
  
  public static final SimpleCommandExceptionType NO_PLAYERS_FOUND
- ERROR_SELECTORS_NOT_ALLOWED
  
  public static final SimpleCommandExceptionType ERROR_SELECTORS_NOT_ALLOWED
- single
  
  private final boolean single
- playersOnly
  
  private final boolean playersOnly
Constructor Details
- EntityArgument
  
  protected EntityArgument(boolean single, boolean playersOnly)
Method Details
- entity
  
  public static EntityArgument entity()
- getEntity
  
  public static Entity getEntity(CommandContext<CommandSourceStack> context, String name) throws CommandSyntaxException
  
  Throws:
  
  CommandSyntaxException
- entities
  
  public static EntityArgument entities()
- getEntities
  
  public static Collection<? extends Entity> getEntities(CommandContext<CommandSourceStack> context, String name) throws CommandSyntaxException
  
  Throws:
  
  CommandSyntaxException
- getOptionalEntities
  
  public static Collection<? extends Entity> getOptionalEntities(CommandContext<CommandSourceStack> context, String name) throws CommandSyntaxException
  
  Throws:
  
  CommandSyntaxException
- getOptionalPlayers
  
  public static Collection<ServerPlayer> getOptionalPlayers(CommandContext<CommandSourceStack> context, String name) throws CommandSyntaxException
  
  Throws:
  
  CommandSyntaxException
- player
  
  public static EntityArgument player()
- getPlayer
  
  public static ServerPlayer getPlayer(CommandContext<CommandSourceStack> context, String name) throws CommandSyntaxException
  
  Throws:
  
  CommandSyntaxException
- players
  
  public static EntityArgument players()
- getPlayers
  
  public static Collection<ServerPlayer> getPlayers(CommandContext<CommandSourceStack> context, String name) throws CommandSyntaxException
  
  Throws:
  
  CommandSyntaxException
- parse
  
  public EntitySelector parse(StringReader reader) throws CommandSyntaxException
  
  Specified by:
  
  parse in interface ArgumentType<EntitySelector>
  
  Throws:
  
  CommandSyntaxException
- parse
  
  public <S> EntitySelector parse(StringReader reader, S source) throws CommandSyntaxException
  
  Specified by:
  
  parse in interface ArgumentType<EntitySelector>
  
  Throws:
  
  CommandSyntaxException
- parse
  
  private EntitySelector parse(StringReader reader, boolean allowSelectors) throws CommandSyntaxException
  
  Throws:
  
  CommandSyntaxException
- listSuggestions
  
  public <S> CompletableFuture<Suggestions> listSuggestions(CommandContext<S> contextBuilder, SuggestionsBuilder builder)
  
  Specified by:
  
  listSuggestions in interface ArgumentType<EntitySelector>
- getExamples
  
  public Collection<String> getExamples()
  
  Specified by:
  
  getExamples in interface ArgumentType<EntitySelector>

Class EntityArgument

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Details

EXAMPLES

ERROR_NOT_SINGLE_ENTITY

ERROR_NOT_SINGLE_PLAYER

ERROR_ONLY_PLAYERS_ALLOWED

NO_ENTITIES_FOUND

NO_PLAYERS_FOUND

ERROR_SELECTORS_NOT_ALLOWED

single

playersOnly

Constructor Details

EntityArgument

Method Details

entity

getEntity

entities

getEntities

getOptionalEntities

getOptionalPlayers

player

getPlayer

players

getPlayers

parse

parse

parse

listSuggestions

getExamples