Package cloud.commandframework.bukkit.parsers.location

Class LocationArgument<C>

java.lang.Object
cloud.commandframework.arguments.CommandArgument<C,org.bukkit.Location>
cloud.commandframework.bukkit.parsers.location.LocationArgument<C>
Type Parameters:
C - Command sender type
All Implemented Interfaces:
cloud.commandframework.keys.CloudKeyHolder<org.bukkit.Location>, Comparable<cloud.commandframework.arguments.CommandArgument<?,?>>
public final class LocationArgument<C> extends cloud.commandframework.arguments.CommandArgument<C,org.bukkit.Location>
Argument parser that parses Location from three doubles. This will use the command senders world when it exists, or else it'll use the first loaded Bukkit world
Since:
1.1.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    LocationArgument.Builder<C>
     
    static final class 
    LocationArgument.LocationParser<C>
     

    Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument

    cloud.commandframework.arguments.CommandArgument.TypedBuilder<C extends Object,T extends Object,B extends cloud.commandframework.arguments.CommandArgument.Builder<C,T>>

  • Method Summary

    Modifier and Type
    Method
    Description
    static <C> @NonNull LocationArgument.Builder<C>
    builder(@NonNull String name)
    Create a new LocationArgument.Builder.
    static <C> @NonNull LocationArgument.Builder<C>
    newBuilder(@NonNull String name)
    Deprecated.
    prefer builder(String)
    static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,org.bukkit.Location>
    of(@NonNull String name)
    Create a new required argument
    static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,org.bukkit.Location>
    optional(@NonNull String name)
    Create a new optional argument

    Methods inherited from class cloud.commandframework.arguments.CommandArgument

    addPreprocessor, compareTo, copy, equals, getDefaultDescription, getDefaultValue, getKey, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • builder

      @API(status=STABLE, since="1.8.0") public static <C> @NonNull LocationArgument.Builder<C> builder(@NonNull String name)
      Create a new LocationArgument.Builder.
      Type Parameters:
      C - sender type
      Parameters:
      name - argument name
      Returns:
      new LocationArgument.Builder
      Since:
      1.8.0

    • newBuilder

      @API(status=DEPRECATED, since="1.8.0") @Deprecated public static <C> @NonNull LocationArgument.Builder<C> newBuilder(@NonNull String name)
      Deprecated.
      prefer builder(String)
      Create a new builder
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Name of the argument
      Returns:
      Created builder

    • of

      public static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,org.bukkit.Location> of(@NonNull String name)
      Create a new required argument
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Argument name
      Returns:
      Constructed argument

    • optional

      public static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,org.bukkit.Location> optional(@NonNull String name)
      Create a new optional argument
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Argument name
      Returns:
      Constructed argument