ArgumentType (CommandCore 2.1.0 API)

Type Parameters:

T - The type of the argument

All Known Subinterfaces:

SimpleArgumentType<T>

All Known Implementing Classes:

ArgumentType.EnumArgumentType, ArgumentType.FilteredEnumArgumentType
```
public interface ArgumentType<T>
```
Represents an argument type

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ArgumentType.EnumArgumentType<T extends Enum<T>>` Represents a custom `ArgumentType` that parses to an enum value
`static class`	`ArgumentType.FilteredEnumArgumentType<T extends Enum<T>>` Represents a custom `ArgumentType` that parses to a filtered enum

Field Summary

Fields
Modifier and Type	Field and Description
`static ArgumentType<org.bukkit.Material>`	`BLOCK` `ArgumentType` that represents a material where `Material.isBlock()` is `true`
`static ArgumentType<Boolean>`	`BOOLEAN` `ArgumentType` that represents a boolean
`static ArgumentType<Command>`	`COMMAND` `ArgumentType` that represents a `CommandCore` command
`static ArgumentType<Double>`	`DOUBLE` `ArgumentType` that represents a double
`static ArgumentType<org.bukkit.entity.EntityType>`	`ENTITY` `ArgumentType` that represents an entity
`static ArgumentType<Integer>`	`INTEGER` `ArgumentType` that represents an integer
`static ArgumentType<org.bukkit.Material>`	`ITEM` `ArgumentType` that represents a material where `Material.isItem()` is `true`
`static ArgumentType<org.bukkit.entity.EntityType>`	`LIVING_ENTITY` `ArgumentType` that represents an entity that is living
`static ArgumentType<org.bukkit.loot.LootTable>`	`LOOT_TABLE` `ArgumentType` that represents a loot table
`static ArgumentType<org.bukkit.Material>`	`MATERIAL` `ArgumentType` that represents a material
`static ArgumentType<String>`	`NAME` `ArgumentType` that represents the name of something.
`static ArgumentType<Integer>`	`NATURAL_NUMBER` `ArgumentType` that represents an integer that is no smaller than 1
`static ArgumentType<org.bukkit.entity.Player>`	`PLAYER` `ArgumentType` that represents a player
`static ArgumentType<org.bukkit.entity.EntityType>`	`SPAWNABLE_ENTITY` `ArgumentType` that represents an entity that can be spawned using `RegionAccessor.spawnEntity(Location, EntityType)`.
`static ArgumentType<UUID>`	`UUID` `ArgumentType` that represents a UUID
`static ArgumentType<org.bukkit.util.Vector>`	`VECTOR` `ArgumentType` that represents a vector
`static ArgumentType<String>`	`WORD` `ArgumentType` that is just a single word
`static ArgumentType<org.bukkit.World>`	`WORLD` `ArgumentType` that represents a loaded world

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default @NotNull List<String>`	`getTabComplete(@NotNull CommandContext context)` Gets the tabcomplete for this `ArgumentType`
`@NotNull com.datasiqn.resultapi.Result<T,String>`	`parse(@NotNull ArgumentReader reader)` Attempts to parse an `ArgumentReader`.
`static @NotNull ArgumentType<Integer>`	`rangedInt(int min)` Creates an `ArgumentType` that represents an integer with a minimum value (inclusive)
`static @NotNull ArgumentType<Integer>`	`rangedInt(int min, int max)` Creates an `ArgumentType` that represents an integer with a minimum (inclusive) and maximum (inclusive) value

- Field Detail
  - WORD
```
static final ArgumentType<String> WORD
```
    ArgumentType that is just a single word
  - NAME
```
static final ArgumentType<String> NAME
```
    ArgumentType that represents the name of something. Can have multiple spaces in the name
  - INTEGER
```
static final ArgumentType<Integer> INTEGER
```
    ArgumentType that represents an integer
  - NATURAL_NUMBER
```
static final ArgumentType<Integer> NATURAL_NUMBER
```
    ArgumentType that represents an integer that is no smaller than 1
  - DOUBLE
```
static final ArgumentType<Double> DOUBLE
```
    ArgumentType that represents a double
  - BOOLEAN
```
static final ArgumentType<Boolean> BOOLEAN
```
    ArgumentType that represents a boolean
  - UUID
```
static final ArgumentType<UUID> UUID
```
    ArgumentType that represents a UUID
  - VECTOR
```
static final ArgumentType<org.bukkit.util.Vector> VECTOR
```
    ArgumentType that represents a vector
  - WORLD
```
static final ArgumentType<org.bukkit.World> WORLD
```
    ArgumentType that represents a loaded world
  - ENTITY
```
static final ArgumentType<org.bukkit.entity.EntityType> ENTITY
```
    ArgumentType that represents an entity
  - LIVING_ENTITY
```
static final ArgumentType<org.bukkit.entity.EntityType> LIVING_ENTITY
```
    ArgumentType that represents an entity that is living
  - SPAWNABLE_ENTITY
```
static final ArgumentType<org.bukkit.entity.EntityType> SPAWNABLE_ENTITY
```
    ArgumentType that represents an entity that can be spawned using RegionAccessor.spawnEntity(Location, EntityType).
    This is the same as the ENTITY argument type, except that this omits the Player entity type
  - LOOT_TABLE
```
static final ArgumentType<org.bukkit.loot.LootTable> LOOT_TABLE
```
    ArgumentType that represents a loot table
  - MATERIAL
```
static final ArgumentType<org.bukkit.Material> MATERIAL
```
    ArgumentType that represents a material
  - BLOCK
```
static final ArgumentType<org.bukkit.Material> BLOCK
```
    ArgumentType that represents a material where Material.isBlock() is true
  - ITEM
```
static final ArgumentType<org.bukkit.Material> ITEM
```
    ArgumentType that represents a material where Material.isItem() is true
  - PLAYER
```
static final ArgumentType<org.bukkit.entity.Player> PLAYER
```
    ArgumentType that represents a player
  - COMMAND
```
static final ArgumentType<Command> COMMAND
```
    ArgumentType that represents a CommandCore command
- Method Detail
  - rangedInt
```
@Contract(value="_ -> new")
 @NotNull
static @NotNull ArgumentType<Integer> rangedInt(int min)
```
    Creates an ArgumentType that represents an integer with a minimum value (inclusive)
    
    Parameters:
    
    min - The inclusive minimum value
    
    Returns:
    
    The newly created ArgumentType
  - rangedInt
```
@Contract(value="_, _ -> new")
 @NotNull
static @NotNull ArgumentType<Integer> rangedInt(int min,
                                                                                           int max)
```
    Creates an ArgumentType that represents an integer with a minimum (inclusive) and maximum (inclusive) value
    
    Parameters:
    
    min - The inclusive minimum value
    
    max - The inclusive maximum value
    
    Returns:
    
    The newly created ArgumentType
  - parse
```
@NotNull
@NotNull com.datasiqn.resultapi.Result<T,String> parse(@NotNull
                                                                 @NotNull ArgumentReader reader)
```
    Attempts to parse an ArgumentReader. After parsing, the reader will always be on the space of the next argument, or the end of the reader
    
    Parameters:
    
    reader - The reader to parse
    
    Returns:
    
    The result of parsing
  - getTabComplete
```
@NotNull
default @NotNull List<String> getTabComplete(@NotNull
                                                       @NotNull CommandContext context)
```
    Gets the tabcomplete for this ArgumentType
    
    Parameters:
    
    context - The command context
    
    Returns:
    
    The tabcomplete

Interface ArgumentType<T>

Nested Class Summary

Field Summary

Method Summary

Field Detail

WORD

NAME

INTEGER

NATURAL_NUMBER

DOUBLE

BOOLEAN

UUID

VECTOR

WORLD

ENTITY

LIVING_ENTITY

SPAWNABLE_ENTITY

LOOT_TABLE

MATERIAL

BLOCK

ITEM

PLAYER

COMMAND

Method Detail

rangedInt

rangedInt

parse

getTabComplete