Class PCGSeededGenerator

PCG seeded generator based on advanced maths

Hierarchy

SeededGenerator<Uint16Array>
- PCGSeededGenerator

Index

Constructors

Properties

requiresSynchronization state

Methods

advance clone cloneState generateState get getHistory getNextState getResult getSeed popSeed pushSeed setSeed startHistory stopHistory takeHistory

Constructors

constructor

new PCGSeededGenerator(requiresSynchronization: boolean, initialState?: number | Uint16Array): PCGSeededGenerator
Parameters
- requiresSynchronization: boolean
- Optional initialState: number | Uint16Array
Returns PCGSeededGenerator
Overrides SeededGenerator.constructor
- Defined in src/game/utilities/random/generators/PCGSeededGenerator.ts:44

Properties

requiresSynchronization

requiresSynchronization: boolean

`Protected` state

state: Uint16Array

Methods

advance

advance(): PCGSeededGenerator
Returns PCGSeededGenerator
Inherited from SeededGenerator.advance
- Defined in src/game/utilities/random/SeededGenerator.ts:167

clone

clone(requiresSynchronization?: boolean, initialState?: number | Uint16Array): any
Parameters
- Optional requiresSynchronization: boolean
- Optional initialState: number | Uint16Array
Returns any
Overrides SeededGenerator.clone
- Defined in src/game/utilities/random/generators/PCGSeededGenerator.ts:48

cloneState

cloneState(): Uint16Array
Returns Uint16Array
Overrides SeededGenerator.cloneState
- Defined in src/game/utilities/random/generators/PCGSeededGenerator.ts:52

`Protected` generateState

generateState(): Uint16Array
Returns Uint16Array
Overrides SeededGenerator.generateState
- Defined in src/game/utilities/random/generators/PCGSeededGenerator.ts:56

get

get(): number
Returns number
Inherited from SeededGenerator.get
- Defined in src/game/utilities/random/SeededGenerator.ts:86

getHistory

getHistory(): undefined | IRandomHistory<Uint16Array>[]
Returns undefined | IRandomHistory<Uint16Array>[]
Inherited from SeededGenerator.getHistory
- Defined in src/game/utilities/random/SeededGenerator.ts:142

getNextState

getNextState(state: Uint16Array): Uint16Array
Gets the next state and returns it as a new object
Parameters
- state: Uint16Array
Returns Uint16Array
Overrides SeededGenerator.getNextState
- Defined in src/game/utilities/random/generators/PCGSeededGenerator.ts:63

`Protected` getResult

getResult(state: Uint16Array): number
Parameters
- state: Uint16Array
Returns number
Overrides SeededGenerator.getResult
- Defined in src/game/utilities/random/generators/PCGSeededGenerator.ts:77

getSeed

getSeed(): Uint16Array
Returns Uint16Array
Inherited from SeededGenerator.getSeed
- Defined in src/game/utilities/random/SeededGenerator.ts:47

popSeed

popSeed(): Uint16Array
Returns Uint16Array
Inherited from SeededGenerator.popSeed
- Defined in src/game/utilities/random/SeededGenerator.ts:69

pushSeed

pushSeed(newSeed?: number | Uint16Array): void
Allow pushing number seeds
Parameters
- Optional newSeed: number | Uint16Array
Returns void
Overrides SeededGenerator.pushSeed
- Defined in src/game/utilities/random/generators/PCGSeededGenerator.ts:111

setSeed

setSeed(newSeed: number | Uint16Array): void
Allow setting seed to number
Parameters
- newSeed: number | Uint16Array
Returns void
Overrides SeededGenerator.setSeed
- Defined in src/game/utilities/random/generators/PCGSeededGenerator.ts:104

startHistory

startHistory(maxHistory?: number): void
Parameters
- maxHistory: number = 100
Returns void
Inherited from SeededGenerator.startHistory
- Defined in src/game/utilities/random/SeededGenerator.ts:137

stopHistory

stopHistory(): IRandomHistory<Uint16Array>[]
Returns IRandomHistory<Uint16Array>[]
Inherited from SeededGenerator.stopHistory
- Defined in src/game/utilities/random/SeededGenerator.ts:156

takeHistory

takeHistory(): undefined | IRandomHistory<Uint16Array>[]
Returns undefined | IRandomHistory<Uint16Array>[]
Inherited from SeededGenerator.takeHistory
- Defined in src/game/utilities/random/SeededGenerator.ts:146

Generated using TypeDoc