Class RNG

Hierarchy

RNG

Index

Properties

Methods

Properties

_c

_c: number = 0

_s0

_s0: number = 0

_s1

_s1: number = 0

_s2

_s2: number = 0

_seed

_seed: number = 0

Methods

clone

clone(): RNG

- Defined in rng.ts:147
Returns a cloned RNG

Returns RNG

getItem

getItem<T>(array: Array<T>): null | T

- Defined in rng.ts:86
Type parameters
- T
Parameters
- array: Array<T>
Returns null | T

Randomly picked item, null when length=0

getNormal

getNormal(mean?: number, stddev?: number): number

- Defined in rng.ts:64
Parameters
- Default value mean: number = 0
  
  Mean value
- Default value stddev: number = 1
  
  Standard deviation. ~95% of the absolute values will be lower than 2*stddev.
Returns number

A normally distributed pseudorandom value

getPercentage

getPercentage(): number

- Defined in rng.ts:79
Returns number

Pseudorandom value [1,100] inclusive, uniformly distributed

getSeed

getSeed(): number

- Defined in rng.ts:15
Returns number

getState

getState(): number[]

- Defined in rng.ts:131
Get RNG state. Useful for storing the state and re-setting it via setState.

Returns number[]

Internal state

getUniform

getUniform(): number

- Defined in rng.ts:39
Returns number

Pseudorandom value [0,1), uniformly distributed

getUniformInt

getUniformInt(lowerBound: number, upperBound: number): number

- Defined in rng.ts:53
Parameters
- lowerBound: number
  
  The lower end of the range to return a value from, inclusive
- upperBound: number
  
  The upper end of the range to return a value from, inclusive
Returns number

Pseudorandom value [lowerBound, upperBound], using ROT.RNG.getUniform() to distribute the value

getWeightedValue

getWeightedValue(data: object): undefined | string

- Defined in rng.ts:108
Parameters
- data: object
  
  key=whatever, value=weight (relative probability)
  - [key: number]: number
Returns undefined | string

whatever

setSeed

setSeed(seed: number): this

- Defined in rng.ts:20
Seed the number generator

Parameters
- seed: number
Returns this

setState

setState(state: number[]): this

- Defined in rng.ts:136
Set a previously retrieved state.

Parameters
- state: number[]
Returns this

shuffle

shuffle<T>(array: Array<T>): T[]

- Defined in rng.ts:94
Type parameters
- T
Parameters
- array: Array<T>
Returns T[]

New array with randomized items

Generated using TypeDoc