Random, Math, & More

This page is a grab-bag of “you’ll use these constantly” utilities: RNG, formatting, time, and a few core subsystems that show up in most games.

If you’re looking for arrays/slices, see Arrays and Collections.

Random numbers (RNG)

Random uses an explicit u64 seed. Pass the seed by ref so it updates.

rng: u64 = rng_seed_time();
// or deterministic per-entity:
// rng: u64 = rng_seed(entity.id);

// Range values are inclusive
roll := rng_range_int(ref rng, 1, 10);
chance := rng_range_float(ref rng, 0, 1);

If you want deterministic behavior for gameplay, keep RNG server-authoritative. Don’t roll important outcomes only on the client.

Math functions

Common math helpers:

angle_sin := sin(x);
angle_cos := cos(x);

result := pow(2.0, 3.0);   // 8.0
root := sqrt(16.0);        // 4.0

value := lerp(0.0, 100.0, 0.5);  // 50.0
clamped := clamp(value, 0.0, 10.0);

absolute := abs(-5);
minimum := min(5, 10);
maximum := max(5, 10);

len := length(v);
len_sq := length_squared(v);
normalized := normalize(v);

String formatting

Use % placeholders with an argument array:

format_string("Value: %", {42});
format_string("health: 100%%");

If you need an argument adjacent to a percent sign (or next to another argument), use %0 as an alias for %:

hp := 67;
format_string("health: %0%%", {hp}); // "health: 67%"

For decimal rounding, use format_float:

value := 3.14159;
format_string("pi: %", {format_float(value, decimals=2)}); // "pi: 3.14"

Logging

Logging follows the same formatting rules:

log_info("Name: %, age: %", {player->get_username(), 12});

Time

current_time := get_time();       // game time
real_time := get_real_time();     // real-world time
frame := get_frame_number();      // current frame number

SFX

sound := get_asset(SFX_Asset, "sfx/click.wav");

desc := SFX.default_sfx_desc();
desc.entity_to_follow = entity.id;
desc.delay = 0.25;

sound_id := SFX.play(sound, desc);
SFX.stop(sound_id);

Play important long sounds server-only (Game.is_server()), otherwise misprediction can cause duplicated playback (music, death SFX, etc).

Economy quick start (currencies)

Economy currencies are per-player and automatically persisted.

coin_icon := get_asset(Texture_Asset, "ui/coin.png");
Economy.register_currency("Coins", coin_icon);

Economy.deposit_currency(player, "Coins", 10);
coins := Economy.get_balance(player, "Coins");

COST :: 50;
if Economy.can_withdraw_currency(player, "Coins", COST) {
    Economy.withdraw_currency(player, "Coins", COST);
}

See Economy for the full guide.