Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Environment

cinnabar:extension/environment@0.1.0

Local presentation only; no world mutation or outbound packets.

Grants: environment for weather and time; fullbright for lighting.

Types

weather

Local visual weather target; none restores tracked server weather.

enum weather {
    clear,
    rain,
    thunder,
}
MemberTypeDescription
clear
rain
thunder

Functions

set-weather-override

set-weather-override: func(value: option<weather>) -> result<_, string>;

Retains a local weather target after success; none resumes tracked server weather.

Types: weather.

set-time-override

set-time-override: func(ticks: option<u32>) -> result<_, string>;

Fixes visual time to 0–23999 ticks; none restores the tracked server clock.

set-fullbright

set-fullbright: func(enabled: bool) -> result<_, string>;

Retained local lighting override; requires the separate fullbright grant.