Class FloatTag

Hierarchy

Number
- FloatTag

Implements

BaseTag

Index

Constructors

constructor

new FloatTag(value: number, name?: null | string): FloatTag
Create a new FloatTag instance.
Parameters
- value: number
  The float value.
- Optionalname: null | string
  The name of the tag, defaults to null.
Returns FloatTag
Overrides Number.constructor
- Defined in packages/nbt/src/types/float.ts:18

Properties

name

name: null | string

The name of the nbt tag.

`Readonly`type

type: Float = TagType.Float

The nbt tag type of the data type.

`Static` `Readonly`EPSILON

EPSILON: number

The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1 that is representable as a Number value, which is approximately: 2.2204460492503130808472633361816 x 10‍−‍16.

`Static` `Readonly`MAX_SAFE_INTEGER

MAX_SAFE_INTEGER: number

The value of the largest integer n such that n and n + 1 are both exactly representable as a Number value. The value of Number.MAX_SAFE_INTEGER is 9007199254740991 2^53 − 1.

`Static` `Readonly`MAX_VALUE

MAX_VALUE: number

The largest number that can be represented in JavaScript. Equal to approximately 1.79E+308.

`Static` `Readonly`MIN_SAFE_INTEGER

MIN_SAFE_INTEGER: number

The value of the smallest integer n such that n and n − 1 are both exactly representable as a Number value. The value of Number.MIN_SAFE_INTEGER is −9007199254740991 (−(2^53 − 1)).

`Static` `Readonly`MIN_VALUE

MIN_VALUE: number

The closest number to zero that can be represented in JavaScript. Equal to approximately 5.00E-324.

`Static` `Readonly`NaN

NaN: number

A value that is not a number. In equality comparisons, NaN does not equal any value, including itself. To test whether a value is equivalent to NaN, use the isNaN function.

`Static` `Readonly`NEGATIVE_INFINITY

NEGATIVE_INFINITY: number

A value that is less than the largest negative number that can be represented in JavaScript. JavaScript displays NEGATIVE_INFINITY values as -infinity.

`Static` `Readonly`POSITIVE_INFINITY

POSITIVE_INFINITY: number

A value greater than the largest number that can be represented in JavaScript. JavaScript displays POSITIVE_INFINITY values as infinity.

Methods

toExponential

toExponential(fractionDigits?: number): string
Returns a string containing a number represented in exponential notation.
Parameters
- OptionalfractionDigits: number
  Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.
Returns string
Inherited from Number.toExponential
- Defined in node_modules/typescript/lib/lib.es5.d.ts:576

toFixed

toFixed(fractionDigits?: number): string
Returns a string representing a number in fixed-point notation.
Parameters
- OptionalfractionDigits: number
  Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.
Returns string
Inherited from Number.toFixed
- Defined in node_modules/typescript/lib/lib.es5.d.ts:570

toJSON

toJSON(): number
Convert the tag to a JSON object.

Returns number
Implementation of BaseTag.toJSON
- Defined in packages/nbt/src/types/float.ts:23

toLocaleString

toLocaleString(
locales?: string | string[],
options?: NumberFormatOptions,
): string
Converts a number to a string by using the current or specified locale.
Parameters
- Optionallocales: string | string[]
  A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.
- Optionaloptions: NumberFormatOptions
  An object that contains one or more properties that specify comparison options.
Returns string
Inherited from Number.toLocaleString
- Defined in node_modules/typescript/lib/lib.es5.d.ts:4571
toLocaleString(locales?: LocalesArgument, options?: NumberFormatOptions): string
Converts a number to a string by using the current or specified locale.
Parameters
- Optionallocales: LocalesArgument
  A locale string, array of locale strings, Intl.Locale object, or array of Intl.Locale objects that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.
- Optionaloptions: NumberFormatOptions
  An object that contains one or more properties that specify comparison options.
Returns string
Inherited from Number.toLocaleString
- Defined in node_modules/typescript/lib/lib.es2020.number.d.ts:27

toPrecision

toPrecision(precision?: number): string
Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits.
Parameters
- Optionalprecision: number
  Number of significant digits. Must be in the range 1 - 21, inclusive.
Returns string
Inherited from Number.toPrecision
- Defined in node_modules/typescript/lib/lib.es5.d.ts:582

toString

toString(radix?: number): string
Returns a string representation of an object.
Parameters
- Optionalradix: number
  Specifies a radix for converting numeric values to strings. This value is only used for numbers.
Returns string
Inherited from Number.toString
- Defined in node_modules/typescript/lib/lib.es5.d.ts:564

valueOf

valueOf(): number
Returns the primitive value of the specified object.

Returns number
Inherited from Number.valueOf
- Defined in node_modules/typescript/lib/lib.es5.d.ts:585

`Static`isFinite

isFinite(number: unknown): boolean
Returns true if passed value is finite. Unlike the global isFinite, Number.isFinite doesn't forcibly convert the parameter to a number. Only finite values of the type number, result in true.
Parameters
- number: unknown
  A numeric value.
Returns boolean
Inherited from Number.isFinite
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:227

`Static`isInteger

isInteger(number: unknown): boolean
Returns true if the value passed is an integer, false otherwise.
Parameters
- number: unknown
  A numeric value.
Returns boolean
Inherited from Number.isInteger
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:233

`Static`isNaN

isNaN(number: unknown): boolean
Returns a Boolean value that indicates whether a value is the reserved value NaN (not a number). Unlike the global isNaN(), Number.isNaN() doesn't forcefully convert the parameter to a number. Only values of the type number, that are also NaN, result in true.
Parameters
- number: unknown
  A numeric value.
Returns boolean
Inherited from Number.isNaN
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:241

`Static`isSafeInteger

isSafeInteger(number: unknown): boolean
Returns true if the value passed is a safe integer.
Parameters
- number: unknown
  A numeric value.
Returns boolean
Inherited from Number.isSafeInteger
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:247

`Static`parseFloat

parseFloat(string: string): number
Converts a string to a floating-point number.
Parameters
- string: string
  A string that contains a floating-point number.
Returns number
Inherited from Number.parseFloat
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:267

`Static`parseInt

parseInt(string: string, radix?: number): number
Converts A string to an integer.
Parameters
- string: string
  A string to convert into a number.
- Optionalradix: number
  A value between 2 and 36 that specifies the base of the number in string. If this argument is not supplied, strings with a prefix of '0x' are considered hexadecimal. All other strings are considered decimal.
Returns number
Inherited from Number.parseInt
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:276

`Static`read

read(stream: BinaryStream, options?: ReadWriteOptions): FloatTag
Read the nbt tag from the stream.
Parameters
- stream: BinaryStream
  The binary stream to read from.
- options: ReadWriteOptions = ...
  The options for reading the tag.
Returns FloatTag
- Defined in packages/nbt/src/types/float.ts:28

`Static`write

write(stream: BinaryStream, value: FloatTag, options?: ReadWriteOptions): void
Write the nbt tag to the stream.
Parameters
- stream: BinaryStream
  The binary stream to write to.
- value: FloatTag
  The value of the tag to write.
- options: ReadWriteOptions = ...
  The options for writing the tag.
Returns void
- Defined in packages/nbt/src/types/float.ts:70

Class FloatTag

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FloatTag

Properties

name

Readonlytype

Static ReadonlyEPSILON

Static ReadonlyMAX_SAFE_INTEGER

Static ReadonlyMAX_VALUE

Static ReadonlyMIN_SAFE_INTEGER

Static ReadonlyMIN_VALUE

Static ReadonlyNaN

Static ReadonlyNEGATIVE_INFINITY

Static ReadonlyPOSITIVE_INFINITY

Methods

toExponential

Parameters

Returns string

toFixed

Parameters

Returns string

toJSON

Returns number

toLocaleString

Parameters

Returns string

Parameters

Returns string

toPrecision

Parameters

Returns string

toString

Parameters

Returns string

valueOf

Returns number

StaticisFinite

Parameters

Returns boolean

StaticisInteger

Parameters

Returns boolean

StaticisNaN

Parameters

Returns boolean

StaticisSafeInteger

Parameters

Returns boolean

StaticparseFloat

Parameters

Returns number

StaticparseInt

Parameters

Returns number

Staticread

Parameters

Returns FloatTag

Staticwrite

Parameters

Returns void

Settings

On This Page

`Readonly`type

`Static` `Readonly`EPSILON

`Static` `Readonly`MAX_SAFE_INTEGER

`Static` `Readonly`MAX_VALUE

`Static` `Readonly`MIN_SAFE_INTEGER

`Static` `Readonly`MIN_VALUE

`Static` `Readonly`NaN

`Static` `Readonly`NEGATIVE_INFINITY

`Static` `Readonly`POSITIVE_INFINITY

`Static`isFinite

`Static`isInteger

`Static`isNaN

`Static`isSafeInteger

`Static`parseFloat

`Static`parseInt

`Static`read

`Static`write