Class ValueRange

Hierarchy

ValueRange

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ValueRange(range: ValueRangeLike): ValueRange

- Defined in packages/mods/src/calculator/ValueRange.ts:29
Parameters
- range: ValueRangeLike
Returns ValueRange

Properties

max

max: number

min

min: number

Static one

one: ValueRange

Static zero

zero: ValueRange

Methods

add

add(other: ValueRangeLike): ValueRange

- Defined in packages/mods/src/calculator/ValueRange.ts:37
Parameters
- other: ValueRangeLike
Returns ValueRange

asTuple

asTuple(): [number, number]

- Defined in packages/mods/src/calculator/ValueRange.ts:80
Returns [number, number]

isAddIdentity

isAddIdentity(): boolean

- Defined in packages/mods/src/calculator/ValueRange.ts:65
Returns boolean

isMultIdentity

isMultIdentity(): boolean

- Defined in packages/mods/src/calculator/ValueRange.ts:69
Returns boolean

map

map(mapFn: (n: number) => number): ValueRange

- Defined in packages/mods/src/calculator/ValueRange.ts:55
Parameters
- mapFn: (n: number) => number
  - - (n: number): number
    - Parameters
      - n: number
      Returns number
Returns ValueRange

mult

mult(other: ValueRangeLike): ValueRange

- Defined in packages/mods/src/calculator/ValueRange.ts:46
Parameters
- other: ValueRangeLike
Returns ValueRange

percentToFactor

percentToFactor(): ValueRange

- Defined in packages/mods/src/calculator/ValueRange.ts:76
+29% => 1.29

Returns ValueRange

valueOf

valueOf(): number | [number, number]

- Defined in packages/mods/src/calculator/ValueRange.ts:84
Returns number | [number, number]

Static cmpMax

cmpMax(a: ValueRangeLike, b: ValueRangeLike): number

- Defined in packages/mods/src/calculator/ValueRange.ts:22
compares the max value of two value ranges

Parameters
- a: ValueRangeLike
- b: ValueRangeLike
Returns number

Static isZero

isZero(value: ValueRangeLike): boolean

- Defined in packages/mods/src/calculator/ValueRange.ts:12
Parameters
- value: ValueRangeLike
Returns boolean

Generated using TypeDoc