Class PredictableRng

An Rng type that can be used to give predictable results for testing purposes, and giving known results.

Hierarchy (view full)

RngAbstract
- PredictableRng

Implements

RngInterface

Constructors

constructor

new PredictableRng(seed?, results?): PredictableRng
Parameters
- Optionalseed: Seed
- Optionalresults: number[]
Returns PredictableRng
Overrides RngAbstract.constructor
- Defined in src/rng/predictable.ts:14

Properties

`Protected`_results

_results: number[] = ...

counter

counter: number = 0

Accessors

results

get results(): number[]
Returns number[]
- Defined in src/rng/predictable.ts:21
set results(results): void
Parameters
- results: number[]
Returns void
- Defined in src/rng/predictable.ts:25

Methods

`Protected`_random

_random(): number
Returns number
Overrides RngAbstract._random
- Defined in src/rng/predictable.ts:65

bin

bin(val, bins, min, max): number
Parameters
- val: number
- bins: number
- min: number
- max: number
Returns number
Implementation of RngInterface.bin
Inherited from RngAbstract.bin
- Defined in src/rng.ts:593

boxMuller

boxMuller(mean?, stddev?): number
Parameters
- mean: number = 0
- stddev: number = 1
Returns number
Inherited from RngAbstract.boxMuller
- Defined in src/rng.ts:306

chance

chance(n, chanceIn?): boolean
Parameters
- n: number
- chanceIn: number = 1
Returns boolean
Implementation of RngInterface.chance
Inherited from RngAbstract.chance
- Defined in src/rng.ts:184

chanceTo

chanceTo(from, to): boolean
Parameters
- from: number
- to: number
Returns boolean
Implementation of RngInterface.chanceTo
Inherited from RngAbstract.chanceTo
- Defined in src/rng.ts:190

chancy

chancy(input): number
Parameters
- input: Chancy
Returns number
Implementation of RngInterface.chancy
Inherited from RngAbstract.chancy
- Defined in src/rng.ts:324

chancyInt

chancyInt(input): number
Parameters
- input: Chancy
Returns number
Implementation of RngInterface.chancyInt
Inherited from RngAbstract.chancyInt
- Defined in src/rng.ts:314

choice

choice(data): any
Parameters
- data: any[]
Returns any
Implementation of RngInterface.choice
Inherited from RngAbstract.choice
- Defined in src/rng.ts:419

clamp

clamp(number, lower, upper): number
Parameters
- number: number
- lower: number
- upper: number
Returns number
Implementation of RngInterface.clamp
Inherited from RngAbstract.clamp
- Defined in src/rng.ts:583

convertStringToNumber

convertStringToNumber(str): number
Parameters
- str: string
Returns number
Implementation of RngInterface.convertStringToNumber
Inherited from RngAbstract.convertStringToNumber
- Defined in src/rng.ts:163

dice

dice(n?, d?, plus?): number
Parameters
- n:
      | string
      | number
      | number[]
      | DiceInterface = 1
- d: number = 6
- plus: number = 0
Returns number
Implementation of RngInterface.dice
Inherited from RngAbstract.dice
- Defined in src/rng.ts:560

evenSpread

evenSpread(n): number[]
Parameters
- n: number
Returns number[]
- Defined in src/rng/predictable.ts:41

getSeed

getSeed(): number
Returns number
Implementation of RngInterface.getSeed
Inherited from RngAbstract.getSeed
- Defined in src/rng.ts:102

hashStr

hashStr(str): number
Parameters
- str: string
Returns number
Implementation of RngInterface.hashStr
Inherited from RngAbstract.hashStr
- Defined in src/rng.ts:150

normal

normal(__namedParameters?, depth?): number
Parameters
- __namedParameters: NormalArgs = {}
- depth: number = 0
Returns number
Implementation of RngInterface.normal
Inherited from RngAbstract.normal
- Defined in src/rng.ts:252

parseDiceArgs

parseDiceArgs(n?, d?, plus?): DiceInterface
Parameters
- n:
      | string
      | number
      | number[]
      | DiceInterface = 1
- d: number = 6
- plus: number = 0
Returns DiceInterface
Inherited from RngAbstract.parseDiceArgs
- Defined in src/rng.ts:519

parseDiceString

parseDiceString(string): DiceInterface
Parameters
- string: string
Returns DiceInterface
Implementation of RngInterface.parseDiceString
Inherited from RngAbstract.parseDiceString
- Defined in src/rng.ts:578

percentage

percentage(): number
Returns number
Implementation of RngInterface.percentage
Inherited from RngAbstract.percentage
- Defined in src/rng.ts:176

predictable

predictable(seed?): RngInterface
Parameters
- Optionalseed: Seed
Returns RngInterface
Implementation of RngInterface.predictable
Inherited from RngAbstract.predictable
- Defined in src/rng.ts:140

randBetween

randBetween(from?, to?, skew?): number
Parameters
- from: number = 0
- to: number = 1
- skew: number = 0
Returns number
Implementation of RngInterface.randBetween
Inherited from RngAbstract.randBetween
- Defined in src/rng.ts:223

randInt

randInt(from?, to?, skew?): number
Parameters
- from: number = 0
- to: number = 1
- skew: number = 0
Returns number
Implementation of RngInterface.randInt
Inherited from RngAbstract.randInt
- Defined in src/rng.ts:194

random

random(from?, to?, skew?): number
Parameters
- from: number = 0
- to: number = 1
- skew: number = 0
Returns number
Implementation of RngInterface.random
Inherited from RngAbstract.random
- Defined in src/rng.ts:180

reset

reset(): PredictableRng
Returns PredictableRng
- Defined in src/rng/predictable.ts:60

sameAs

sameAs(other): boolean
Parameters
- other: PredictableRng
Returns boolean
Implementation of RngInterface.sameAs
Overrides RngAbstract.sameAs
- Defined in src/rng/predictable.ts:55

scale

scale(number, from, to, min?, max?): number
Parameters
- number: number
- from: number
- to: number
- min: number = 0
- max: number = 1
Returns number
Inherited from RngAbstract.scale
- Defined in src/rng.ts:234

scaleNorm

scaleNorm(number, from, to): number
Parameters
- number: number
- from: number
- to: number
Returns number
Inherited from RngAbstract.scaleNorm
- Defined in src/rng.ts:242

seed

seed(seed?): this
Parameters
- Optionalseed: Seed
Returns this
Implementation of RngInterface.seed
Inherited from RngAbstract.seed
- Defined in src/rng.ts:122

serialize

serialize(): any
Returns any
Implementation of RngInterface.serialize
Inherited from RngAbstract.serialize
- Defined in src/rng.ts:127

setEvenSpread

setEvenSpread(n): PredictableRng
Parameters
- n: number
Returns PredictableRng
- Defined in src/rng/predictable.ts:50

`Protected`setSeed

setSeed(seed?): this
Parameters
- Optionalseed: Seed
Returns this
Inherited from RngAbstract.setSeed
- Defined in src/rng.ts:110

shouldThrowOnMaxRecursionsReached

shouldThrowOnMaxRecursionsReached(): boolean
Returns boolean
Inherited from RngAbstract.shouldThrowOnMaxRecursionsReached
- Defined in src/rng.ts:247

uniqid

uniqid(prefix?, random?): string
Parameters
- prefix: string = ''
- random: boolean = false
Returns string
Implementation of RngInterface.uniqid
Inherited from RngAbstract.uniqid
- Defined in src/rng.ts:206

uniqstr

uniqstr(len?): string
Parameters
- len: number = 6
Returns string
Implementation of RngInterface.uniqstr
Inherited from RngAbstract.uniqstr
- Defined in src/rng.ts:213

weightedChoice

weightedChoice(data): any
data format: { choice1: 1, choice2: 2, choice3: 3, }
Parameters
- data: any[] | Record<any, number> | Map<any, number>
Returns any
Implementation of RngInterface.weightedChoice
Inherited from RngAbstract.weightedChoice
- Defined in src/rng.ts:431

`Static`chancyMax

chancyMax(input): number
Parameters
- input: Chancy
Returns number
Inherited from RngAbstract.chancyMax
- Defined in src/rng.ts:388

`Static`chancyMin

chancyMin(input): number
Parameters
- input: Chancy
Returns number
Inherited from RngAbstract.chancyMin
- Defined in src/rng.ts:357

`Static`diceMax

diceMax(n?, d?, plus?): number
Parameters
- n:
      | string
      | number
      | number[]
      | DiceInterface = 1
- d: number = 6
- plus: number = 0
Returns number
Inherited from RngAbstract.diceMax
- Defined in src/rng.ts:550

`Static`diceMin

diceMin(n?, d?, plus?): number
Parameters
- n:
      | string
      | number
      | number[]
      | DiceInterface = 1
- d: number = 6
- plus: number = 0
Returns number
Inherited from RngAbstract.diceMin
- Defined in src/rng.ts:555

`Protected` `Static`parseDiceArgs

parseDiceArgs(n?, d?, plus?): DiceInterface
Parameters
- n:
      | string
      | number
      | number[]
      | DiceInterface = 1
- d: number = 6
- plus: number = 0
Returns DiceInterface
Inherited from RngAbstract.parseDiceArgs
- Defined in src/rng.ts:500

`Static`parseDiceString

parseDiceString(string): DiceInterface
Parameters
- string: string
Returns DiceInterface
Inherited from RngAbstract.parseDiceString
- Defined in src/rng.ts:524

`Static`predictable

predictable<T>(this, seed): T
Type Parameters
- T extends RngAbstract
Parameters
- this: (new (seed: Seed) => T)
  - - new (seed): T
    - Parameters
      seed: Seed
      Returns T
- seed: Seed
Returns T
Inherited from RngAbstract.predictable
- Defined in src/rng.ts:146

`Static`unserialize

unserialize(serialized): RngInterface
Parameters
- serialized: SerializedRng
Returns RngInterface
Inherited from RngAbstract.unserialize
- Defined in src/rng.ts:133