Package dev.polv.taleapi.command.argument

Class FloatArgumentType

java.lang.Object
dev.polv.taleapi.command.argument.FloatArgumentType
All Implemented Interfaces:
ArgumentType<Float>
public class FloatArgumentType extends Object implements ArgumentType<Float>
Argument type for float values with optional bounds.

Example Usage


 // Any float
 Command.argument("value", FloatArgumentType.floatArg())

 // Float >= 0.0f
 Command.argument("amount", FloatArgumentType.floatArg(0.0f))

 // Float between 0.0f and 1.0f
 Command.argument("percent", FloatArgumentType.floatArg(0.0f, 1.0f))

  • Method Details

    • floatArg

      public static FloatArgumentType floatArg()
      Creates a float argument type with no bounds.
      Returns:
      a new float argument type

    • floatArg

      public static FloatArgumentType floatArg(float min)
      Creates a float argument type with a minimum bound.
      Parameters:
      min - the minimum value (inclusive)
      Returns:
      a new float argument type

    • floatArg

      public static FloatArgumentType floatArg(float min, float max)
      Creates a float argument type with both bounds.
      Parameters:
      min - the minimum value (inclusive)
      max - the maximum value (inclusive)
      Returns:
      a new float argument type

    • getMinimum

      public float getMinimum()
      Returns the minimum value.
      Returns:
      the minimum bound

    • getMaximum

      public float getMaximum()
      Returns the maximum value.
      Returns:
      the maximum bound

    • parse

      public Float parse(StringReader reader) throws CommandException
      Description copied from interface: ArgumentType
      Parses the argument from the input string.
      Specified by:
      parse in interface ArgumentType<Float>
      Parameters:
      reader - the string reader positioned at the argument
      Returns:
      the parsed value
      Throws:
      CommandException - if the argument cannot be parsed

    • listSuggestions

      public CompletableFuture<Suggestions> listSuggestions(CommandContext context, SuggestionsBuilder builder)
      Description copied from interface: ArgumentType
      Provides suggestions for this argument.

      Default implementation returns no suggestions.

      Specified by:
      listSuggestions in interface ArgumentType<Float>
      Parameters:
      context - the current command context (may have partial arguments)
      builder - the suggestions builder
      Returns:
      a future that completes with suggestions

    • getResultType

      public Class<Float> getResultType()
      Description copied from interface: ArgumentType
      Returns the Java type this argument parses to.
      Specified by:
      getResultType in interface ArgumentType<Float>
      Returns:
      the result type class

    • getTypeName

      public String getTypeName()
      Description copied from interface: ArgumentType
      Returns a human-readable name for this argument type.

      Used in error messages and help text.

      Specified by:
      getTypeName in interface ArgumentType<Float>
      Returns:
      the type name (e.g., "integer", "string", "player")

    • getExamples

      public String[] getExamples()
      Description copied from interface: ArgumentType
      Returns example values for this argument type.

      Used for documentation and error messages.

      Specified by:
      getExamples in interface ArgumentType<Float>
      Returns:
      an array of example values