Skip to content

API reference / @jsprismarine/brigadier / FloatArgumentType

Class: FloatArgumentType ​

Defined in: arguments/FloatArgumentType.ts:8

Implements ​

Methods ​

equals() ​

equals(o): boolean

Defined in: arguments/FloatArgumentType.ts:57

Parameters ​

o ​

object

Returns ​

boolean


getExamples() ​

getExamples(): Iterable<string>

Defined in: arguments/FloatArgumentType.ts:75

Returns ​

Iterable<string>

Implementation of ​

ArgumentType.getExamples


getMaximum() ​

getMaximum(): number

Defined in: arguments/FloatArgumentType.ts:29

Returns ​

number


getMinimum() ​

getMinimum(): number

Defined in: arguments/FloatArgumentType.ts:25

Returns ​

number


parse() ​

parse(reader): number

Defined in: arguments/FloatArgumentType.ts:33

Parameters ​

reader ​

StringReader

Returns ​

number

Implementation of ​

ArgumentType.parse


toString() ​

toString(): string

Defined in: arguments/FloatArgumentType.ts:65

Returns a string representation of an object.

Returns ​

string


float() ​

static float(min?, max?): FloatArgumentType

Defined in: arguments/FloatArgumentType.ts:17

Parameters ​

min? ​

number = -Infinity

max? ​

number = Infinity

Returns ​

FloatArgumentType


getFloat() ​

static getFloat<S>(context, name): number

Defined in: arguments/FloatArgumentType.ts:21

Type Parameters ​

S ​

S

Parameters ​

context ​

CommandContext<S>

name ​

string

Returns ​

number