KAPLAY Docs, RNG

RNG

A random number generator using the linear congruential generator algorithm.

group Math

subgroup Random

seed

: number

The current seed value used by the random number generator.

gen

() => number

Generate a random number between 0 and 1.

const rng = new RNG(Date.now())
const value = rng.gen() // Returns number between 0-1

returns A number between 0 and 1.

genNumber

(a: number, b: number) => number

Generate a random number between two values.

param a- The minimum value.

param b- The maximum value.

const rng = new RNG(Date.now())
const value = rng.genNumber(10, 20) // Returns number between 10-20

returns A number between a and b.

genVec2

(a: Vec2, b: Vec2) => Vec2

Generate a random 2D vector between two vectors.

param a- The minimum vector.

param b- The maximum vector.

const rng = new RNG(Date.now())
const vec = rng.genVec2(vec2(0,0), vec2(100,100))

returns A vector between vectors a and b.

genColor

(a: Color, b: Color) => Color

Generate a random color between two colors.

param a- The first color.

param b- The second color.

const rng = new RNG(Date.now())
const color = rng.genColor(rgb(0,0,0), rgb(255,255,255))

returns A color between colors a and b.

genAny

(args: [] | [T] | [T, T]) => T

Generate a random value of a specific type.

param args- No args for [0-1], one arg for [0-arg], or two args for [arg1-arg2].

const rng = new RNG(Date.now())
const val = rng.genAny(0, 100) // Number between 0-100
const vec = rng.genAny(vec2(0,0), vec2(100,100)) // Vec2
const col = rng.genAny(rgb(0,0,0), rgb(255,255,255)) // Color

returns A random value.