MinecraftArgumentType (bukkit 4.0.0-beta.19 API)

java.lang.Object
- java.lang.Enum<MinecraftArgumentType>
- - revxrsal.commands.bukkit.brigadier.MinecraftArgumentType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MinecraftArgumentType>
```
public enum MinecraftArgumentType
extends java.lang.Enum<MinecraftArgumentType>
```
An enumeration for containing Minecraft's built-in ArgumentTypes.
This is for older versions from 1.13 to 1.19.2.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ANGLE` Represents an angle.
`BLOCK_POS` A location, represented as 3 numbers (which must be integers).
`BLOCK_PREDICATE` A block, or a block tag.
`BLOCK_STATE` A block state, optionally including NBT and state information.
`COLOR` A chat color.
`COLUMN_POS` A column location, represented as 3 numbers (which must be integers).
`COMPONENT` A JSON Chat component.
`DIMENSION` Represents a dimension.
`ENCHANTMENT` Represents a item enchantment.
`ENTITY` A selector, player name, or UUID.
`ENTITY_ANCHOR` The entity anchor related to the facing argument in the teleport command, is feet or eyes.
`ENTITY_SUMMON` Represents an entity summon.
`FLOAT_RANGE` A floating-point range of values with a min and a max.
`FUNCTION` A function.
`GAME_PROFILE` A player, online or not.
`INT_RANGE` An integer range of values with a min and a max.
`ITEM_PREDICATE` An item, or an item tag.
`ITEM_SLOT` A name for an inventory slot.
`ITEM_STACK` An item, optionally including NBT.
`MESSAGE` A regular message, potentially including selectors.
`NBT` An NBT value, parsed using JSON-NBT rules.
`NBT_PATH` A path within an NBT value, allowing for array and member accesses.
`NBT_TAG` Represents a partial NBT tag, usable in data modify command.
`OBJECTIVE_CRITERIA` A single score criterion.
`OPERATION` A scoreboard operator.
`PARTICLE` A particle effect (an identifier with extra information following it for specific particles, mirroring the Particle packet)
`POTION_EFFECT` A potion effect.
`RESOURCE_LOCATION` An Identifier.
`ROTATION` An angle, represented as 2 numbers (which may have a decimal point, but will be moved to the center of a block if none is specified).
`SCORE_HOLDER` Something that can join a team.
`SCOREBOARD_OBJECTIVE` A scoreboard objective.
`SCOREBOARD_SLOT` A scoreboard operator.
`SWIZZLE` A collection of up to 3 axes.
`TEAM` The name of a team.
`TEMPLATE_MIRROR` Template mirror
`TEMPLATE_ROTATION` Template rotation
`TIME` Represents a time duration.
`UUID` Represents a UUID value.
`VECTOR_2` A location, represented as 2 numbers (which may have a decimal point, but will be moved to the center of a block if none is specified).
`VECTOR_3` A location, represented as 3 numbers (which may have a decimal point, but will be moved to the center of a block if none is specified).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> @NotNull com.mojang.brigadier.arguments.ArgumentType<T>`	`create(java.lang.Object... arguments)` Creates an instance of this argument type
`<T> @NotNull java.util.Optional<com.mojang.brigadier.arguments.ArgumentType<T>>`	`createIfPresent(java.lang.Object... arguments)` Creates an instance of this argument type, wrapped in an optional.
`<T> @NotNull com.mojang.brigadier.arguments.ArgumentType<T>`	`get()` Returns the argument type represented by this enum value, otherwise throws an exception
`<T> @NotNull java.util.Optional<com.mojang.brigadier.arguments.ArgumentType<T>>`	`getIfPresent()` Returns the argument type represented by this enum value, wrapped inside an `Optional`
`boolean`	`isSupported()` Checks if this argument type is supported in this Minecraft version
`boolean`	`requiresParameters()` Checks if this argument type requires parameters
`static MinecraftArgumentType`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static MinecraftArgumentType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ENTITY
```
public static final MinecraftArgumentType ENTITY
```
    A selector, player name, or UUID.
    Parameters: - boolean single - boolean playerOnly
  - GAME_PROFILE
```
public static final MinecraftArgumentType GAME_PROFILE
```
    A player, online or not. Can also use a selector, which may match one or more players (but not entities).
  - COLOR
```
public static final MinecraftArgumentType COLOR
```
    A chat color. One of the names from colors, or reset. Case-insensitive.
  - COMPONENT
```
public static final MinecraftArgumentType COMPONENT
```
    A JSON Chat component.
  - MESSAGE
```
public static final MinecraftArgumentType MESSAGE
```
    A regular message, potentially including selectors.
  - NBT
```
public static final MinecraftArgumentType NBT
```
    An NBT value, parsed using JSON-NBT rules. This represents a full NBT tag.
  - NBT_TAG
```
public static final MinecraftArgumentType NBT_TAG
```
    Represents a partial NBT tag, usable in data modify command.
  - NBT_PATH
```
public static final MinecraftArgumentType NBT_PATH
```
    A path within an NBT value, allowing for array and member accesses.
  - SCOREBOARD_OBJECTIVE
```
public static final MinecraftArgumentType SCOREBOARD_OBJECTIVE
```
    A scoreboard objective.
  - OBJECTIVE_CRITERIA
```
public static final MinecraftArgumentType OBJECTIVE_CRITERIA
```
    A single score criterion.
  - SCOREBOARD_SLOT
```
public static final MinecraftArgumentType SCOREBOARD_SLOT
```
    A scoreboard operator.
  - SCORE_HOLDER
```
public static final MinecraftArgumentType SCORE_HOLDER
```
    Something that can join a team. Allows selectors and *.
  - TEAM
```
public static final MinecraftArgumentType TEAM
```
    The name of a team. Parsed as an unquoted string.
  - OPERATION
```
public static final MinecraftArgumentType OPERATION
```
    A scoreboard operator.
  - PARTICLE
```
public static final MinecraftArgumentType PARTICLE
```
    A particle effect (an identifier with extra information following it for specific particles, mirroring the Particle packet)
  - ANGLE
```
public static final MinecraftArgumentType ANGLE
```
    Represents an angle.
  - ITEM_SLOT
```
public static final MinecraftArgumentType ITEM_SLOT
```
    A name for an inventory slot.
  - RESOURCE_LOCATION
```
public static final MinecraftArgumentType RESOURCE_LOCATION
```
    An Identifier.
  - POTION_EFFECT
```
public static final MinecraftArgumentType POTION_EFFECT
```
    A potion effect.
  - ENCHANTMENT
```
public static final MinecraftArgumentType ENCHANTMENT
```
    Represents a item enchantment.
  - ENTITY_SUMMON
```
public static final MinecraftArgumentType ENTITY_SUMMON
```
    Represents an entity summon.
  - DIMENSION
```
public static final MinecraftArgumentType DIMENSION
```
    Represents a dimension.
  - TIME
```
public static final MinecraftArgumentType TIME
```
    Represents a time duration.
  - UUID
```
public static final MinecraftArgumentType UUID
```
    Represents a UUID value.
    
    Since:
    
    Minecraft 1.16
  - BLOCK_POS
```
public static final MinecraftArgumentType BLOCK_POS
```
    A location, represented as 3 numbers (which must be integers). May use relative locations with ~
  - COLUMN_POS
```
public static final MinecraftArgumentType COLUMN_POS
```
    A column location, represented as 3 numbers (which must be integers). May use relative locations with ~.
  - VECTOR_3
```
public static final MinecraftArgumentType VECTOR_3
```
    A location, represented as 3 numbers (which may have a decimal point, but will be moved to the center of a block if none is specified). May use relative locations with ~.
  - VECTOR_2
```
public static final MinecraftArgumentType VECTOR_2
```
    A location, represented as 2 numbers (which may have a decimal point, but will be moved to the center of a block if none is specified). May use relative locations with ~.
  - ROTATION
```
public static final MinecraftArgumentType ROTATION
```
    An angle, represented as 2 numbers (which may have a decimal point, but will be moved to the center of a block if none is specified). May use relative locations with ~.
  - SWIZZLE
```
public static final MinecraftArgumentType SWIZZLE
```
    A collection of up to 3 axes.
  - BLOCK_STATE
```
public static final MinecraftArgumentType BLOCK_STATE
```
    A block state, optionally including NBT and state information.
  - BLOCK_PREDICATE
```
public static final MinecraftArgumentType BLOCK_PREDICATE
```
    A block, or a block tag.
  - ITEM_STACK
```
public static final MinecraftArgumentType ITEM_STACK
```
    An item, optionally including NBT.
  - ITEM_PREDICATE
```
public static final MinecraftArgumentType ITEM_PREDICATE
```
    An item, or an item tag.
  - FUNCTION
```
public static final MinecraftArgumentType FUNCTION
```
    A function.
  - ENTITY_ANCHOR
```
public static final MinecraftArgumentType ENTITY_ANCHOR
```
    The entity anchor related to the facing argument in the teleport command, is feet or eyes.
  - INT_RANGE
```
public static final MinecraftArgumentType INT_RANGE
```
    An integer range of values with a min and a max.
  - FLOAT_RANGE
```
public static final MinecraftArgumentType FLOAT_RANGE
```
    A floating-point range of values with a min and a max.
  - TEMPLATE_MIRROR
```
public static final MinecraftArgumentType TEMPLATE_MIRROR
```
    Template mirror
    
    Since:
    
    Minecraft 1.19
  - TEMPLATE_ROTATION
```
public static final MinecraftArgumentType TEMPLATE_ROTATION
```
    Template rotation
    
    Since:
    
    Minecraft 1.19
- Method Detail
  - values
```
public static MinecraftArgumentType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (MinecraftArgumentType c : MinecraftArgumentType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MinecraftArgumentType valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - isSupported
```
public boolean isSupported()
```
    Checks if this argument type is supported in this Minecraft version
    
    Returns:
    
    If this is supported
  - requiresParameters
```
public boolean requiresParameters()
```
    Checks if this argument type requires parameters
    
    Returns:
    
    If this requires parameters
  - get
```
@NotNull
public <T> @NotNull com.mojang.brigadier.arguments.ArgumentType<T> get()
```
    Returns the argument type represented by this enum value, otherwise throws an exception
    
    Type Parameters:
    
    T - The argument type
    
    Returns:
    
    The argument type
    
    Throws:
    
    java.lang.IllegalArgumentException - if not supported in this version
    
    java.lang.IllegalArgumentException - if this argument requires arguments. See create(Object...)
  - create
```
@NotNull
public <T> @NotNull com.mojang.brigadier.arguments.ArgumentType<T> create(java.lang.Object... arguments)
```
    Creates an instance of this argument type
    
    Type Parameters:
    
    T - The argument ttype
    
    Parameters:
    
    arguments - Arguments to construct the argument type with
    
    Returns:
    
    The created argument type.
    
    Throws:
    
    java.lang.IllegalArgumentException - if not supported in this version
  - getIfPresent
```
@NotNull
public <T> @NotNull java.util.Optional<com.mojang.brigadier.arguments.ArgumentType<T>> getIfPresent()
```
    Returns the argument type represented by this enum value, wrapped inside an Optional
    
    Type Parameters:
    
    T - The argument type
    
    Returns:
    
    The argument type optional
    
    Throws:
    
    java.lang.IllegalArgumentException - if this argument requires arguments. See createIfPresent(Object...)
  - createIfPresent
```
@NotNull
public <T> @NotNull java.util.Optional<com.mojang.brigadier.arguments.ArgumentType<T>> createIfPresent(java.lang.Object... arguments)
```
    Creates an instance of this argument type, wrapped in an optional.
    
    Type Parameters:
    
    T - The argument ttype
    
    Parameters:
    
    arguments - Arguments to construct the argument type with
    
    Returns:
    
    The created argument type optional.

Enum MinecraftArgumentType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ENTITY

GAME_PROFILE

COLOR

COMPONENT

MESSAGE

NBT

NBT_TAG

NBT_PATH

SCOREBOARD_OBJECTIVE

OBJECTIVE_CRITERIA

SCOREBOARD_SLOT

SCORE_HOLDER

TEAM

OPERATION

PARTICLE

ANGLE

ITEM_SLOT

RESOURCE_LOCATION

POTION_EFFECT

ENCHANTMENT

ENTITY_SUMMON

DIMENSION

TIME

UUID

BLOCK_POS

COLUMN_POS

VECTOR_3

VECTOR_2

ROTATION

SWIZZLE

BLOCK_STATE

BLOCK_PREDICATE

ITEM_STACK

ITEM_PREDICATE

FUNCTION

ENTITY_ANCHOR

INT_RANGE

FLOAT_RANGE

TEMPLATE_MIRROR

TEMPLATE_ROTATION

Method Detail

values

valueOf

isSupported

requiresParameters

get

create

getIfPresent

createIfPresent