Random
A deterministic generator: the same seed always gives the same sequence, on every platform.
Namespace: caffeine.random · Dryad prefix: caffeine_random_
setSeed#
Lua: caffeine.random.setSeed · Dryad: caffeine_random_set_seed
setSeed(seed)
Restarts the sequence.
| Parameters | Type | Description |
|---|---|---|
seed | number | Any whole number; 0 is replaced by a fixed value. |
Returns: none
Example
caffeine.random.setSeed(1234)
value#
Lua: caffeine.random.value · Dryad: caffeine_random_value
value() -> number
Next random number.
Returns: number. A number in [0, 1).
Example
local r = caffeine.random.value()
range#
Lua: caffeine.random.range · Dryad: caffeine_random_range
range(min, max) -> number
A random number in a range.
| Parameters | Type | Description |
|---|---|---|
min | number | Lower bound (inclusive). |
max | number | Upper bound (exclusive). |
Returns: number. A number in [min, max).
Example
local x = caffeine.random.range(-5, 5)
int#
Lua: caffeine.random.int · Dryad: caffeine_random_int
int(min, max) -> number
A random whole number, both ends included.
| Parameters | Type | Description |
|---|---|---|
min | number | Lower bound (inclusive). |
max | number | Upper bound (inclusive); reversed bounds are swapped. |
Returns: number. A whole number in [min, max].
Example
local roll = caffeine.random.int(1, 6)
chance#
Lua: caffeine.random.chance · Dryad: caffeine_random_chance
chance(p) -> boolean
A weighted coin flip.
| Parameters | Type | Description |
|---|---|---|
p | number | Probability from 0 to 1. |
Returns: boolean. true with probability p.
Example
if caffeine.random.chance(0.25) then end