Epok Engine

EPOK RUNTIME

epok::dungeon::random

Function · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Function

A gameplay random number below `below`, the same for the same stream, index and dungeon seed on every run.

Belongs to
epok::dungeon
Header
dungeon_map.hpp
Overloads
1

Declaration

Declaration
inline uint32_t random(uint32_t stream,uint32_t index,uint32_t below)

A gameplay random number below `below`, the same for the same stream, index and dungeon seed on every run.

ParameterTypeMeaning
streamuint32_tNot documented; consult the linked header.
indexuint32_tNot documented; consult the linked header.
belowuint32_tNot documented; consult the linked header.

Returns: uint32_t. Consult the linked header for its meaning.

Example sketch

C++ example
#include "dungeon_map.hpp"

// Assume these named values have been initialized with valid data:
// uint32_t stream
// uint32_t index
// uint32_t below

auto result = epok::dungeon::random(stream, index, below);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/dungeon_map.hpp:85

Related members