Random — Seeded Random Number Generation in RollingQuest

-- Unseeded — different sequence every run
local rng = Random.new()

-- Seeded with an integer — reproducible sequence
local seededRng = Random.new(42)

-- Seeded with a string
local namedRng = Random.new("level_3_seed")

--- @return integer
function Random:nextInteger()

--- @param maxInclusive integer
--- @return integer
function Random:nextInteger(maxInclusive)

--- @param minInclusive integer
--- @param maxInclusive integer
--- @return integer
function Random:nextInteger(minInclusive, maxInclusive)

--- @return number
function Random:nextNumber()

--- @param maxExclusive number
--- @return number
function Random:nextNumber(maxExclusive)

--- @param minInclusive number
--- @param maxExclusive number
--- @return number
function Random:nextNumber(minInclusive, maxExclusive)

--- @return number
function Random:nextGaussian()

--- @return boolean
function Random:nextBoolean()

--- @param table table
--- @return any
function Random:nextElement(table)

--- @param table table
--- @return integer
function Random:nextIndex(table)

--- @param table table
function Random:shuffle(table)

--- @return table
function Random:serializeToTable()

--- @return LocalObject
function Random:serialize()

--- @return integer
function Random.randomSeed()

--- @return string
function Random.randomStringSeed()

--- @param table table
--- @return Random
function Random.deserializeFromTable(table)

--- @param obj LocalObject
--- @return Random
function Random.deserialize(obj)

local rng = Random.new()

local enemies = { enemy1, enemy2, enemy3, enemy4, enemy5 }

for _, enemy in ipairs(enemies) do
    -- Each enemy has a 60 % chance to be active at the start
    enemy.active = rng:nextNumber() < 0.6
end

local rng = Random.new()

local lines = {
    "The winds carry ill omens today.",
    "I wouldn't go that way if I were you.",
    "Have you spoken to the elder yet?",
    "Strange lights were seen near the ruins last night.",
}

function OnInteract()
    local chosen = rng:nextElement(lines)
    Dialog.show({ text = chosen })
end

local rng = Random.new()

local loot = { "sword", "shield", "potion", "gold", "key" }
rng:shuffle(loot)

-- Give the player the first two items after the shuffle
giveItem(player, loot[1])
giveItem(player, loot[2])

-- Using the same seed always produces the same dungeon layout
local dungeonRng = Random.new("dungeon_floor_7")

local roomCount = dungeonRng:nextInteger(5, 12)
print("Rooms this floor: " .. tostring(roomCount))

-- Capture the state mid-sequence
local savedState = rng:serializeToTable()

-- … later, restore and continue from the exact same point
local restoredRng = Random.deserializeFromTable(savedState)