com.mojang.brigadier.arguments.FloatArgumentType Class Reference

An ArgumentType that parses floats. More...

Inheritance diagram for com.mojang.brigadier.arguments.FloatArgumentType:

Public Member Functions
float	getMinimum ()
	The minimum value an argument is allowed to be (inclusive). More...
float	getMaximum ()
	The maximal value an argument is allowed to be (inclusive). More...
Float	parse (final StringReader reader) throws CommandSyntaxException
boolean	equals (final Object o)
int	hashCode ()
String	toString ()
Collection< String >	getExamples ()
default< S > CompletableFuture< Suggestions >	listSuggestions (final CommandContext< S > context, final SuggestionsBuilder builder)
	Gets suggestions for a parsed input string on what comes next. More...

Static Public Member Functions
static FloatArgumentType	floatArg ()
	A factory method as a simple way to get an instance. More...
static FloatArgumentType	floatArg (final float min)
	A factory method as a simple way to get an instance of this class with an enforced minimum value. More...
static FloatArgumentType	floatArg (final float min, final float max)
	A factory method as a simple way to get an instance of this class with an enforced minimum and maximum value. More...
static float	getFloat (final CommandContext<?> context, final String name)
	Retrieves the argument with the given name from the context and casts it to a float. More...

Detailed Description

An ArgumentType that parses floats.

Allows for numbers like the following:

• 1.2
• 0
• .5
• -.5
• -1
• -132323.4242

Member Function Documentation

floatArg() [1/3]

static FloatArgumentType com.mojang.brigadier.arguments.FloatArgumentType.floatArg ( )

static

A factory method as a simple way to get an instance.

It is recommended to statically import this method to provide an interface similar to:
argument("name", floatArg())

Returns

an instance of this argument type

floatArg() [2/3]

static FloatArgumentType com.mojang.brigadier.arguments.FloatArgumentType.floatArg ( final float  min )

static

A factory method as a simple way to get an instance of this class with an enforced minimum value.

It is recommended to statically import this method to provide an interface similar to:
argument("name", floatArg(0))

Parameters

min	the minimal value it needs to be in order to be a valid argument. Inclusive

Returns

an instance of this argument type

floatArg() [3/3]

static FloatArgumentType com.mojang.brigadier.arguments.FloatArgumentType.floatArg ( final float  min, final float  max  )

static

A factory method as a simple way to get an instance of this class with an enforced minimum and maximum value.

If you want to only define a maximum value, use -Float.MAX_VALUE as minimum.

It is recommended to statically import this method to provide an interface similar to:
argument("name", floatArg(0, 100))

Parameters

min	the minimal value it needs to be in order to be a valid argument. Inclusive
max	the maximal value it needs to be in order to be a valid argument. Inclusive

Returns

an instance of this argument type

getFloat()

static float com.mojang.brigadier.arguments.FloatArgumentType.getFloat ( final CommandContext<?>  context, final String  name  )

static

Retrieves the argument with the given name from the context and casts it to a float.

Parameters

context	the context to get the argument from, calls CommandContext#getArgument
name	the name of the argument to retrieve

Returns

the argument as a float

See also

CommandContext::getArgument

getMaximum()

float com.mojang.brigadier.arguments.FloatArgumentType.getMaximum

(

)

The maximal value an argument is allowed to be (inclusive).

Returns

the maximal value an argument is allowed to be (inclusive)

getMinimum()

float com.mojang.brigadier.arguments.FloatArgumentType.getMinimum

(

)

The minimum value an argument is allowed to be (inclusive).

Returns

the minimum value an argument is allowed to be (inclusive)

listSuggestions()

default< S > CompletableFuture< Suggestions > com.mojang.brigadier.arguments.ArgumentType< T >.listSuggestions ( final CommandContext< S >  context, final SuggestionsBuilder  builder  )

inherited

Gets suggestions for a parsed input string on what comes next.

As it is ultimately up to custom argument types to provide suggestions, it may be an asynchronous operation, for example getting in-game data or player names etc. As such, this method returns a future and no guarantees are made to when or how the future completes.

The suggestions provided will be in the context of the end of the parsed input string, but may suggest new or replacement strings for earlier in the input string. For example, if the end of the string was foobar but an argument preferred it to be minecraft:foobar, it will suggest a replacement for that whole segment of the input.

Parameters

context	the context to get them for
builder	the suggestions builder to add them to

Returns

a future that will eventually resolve into a Suggestions object @implSpec The default implementation simply returns an empty suggestions object