@scml/hook-macro-rng

TypeScript type definitions for Macro RNG hook, mounting RNG used by SugarCube macros for deterministic or custom RNG behavior.

Installation

npm
yarn
pnpm
bun
deno
npm install -D @scml/hook-macro-rng

Quick Start

Add type reference

/// <reference types="@scml/hook-macro-rng" />

Use global instance

hookMacroRng is mounted on window.

Global Types global

PropertyTypeDescription
hookMacroRngHookMacroRngMacro RNG Hook instance

Subpath Exports

SubpathDescription
.Main entry
./HookMacroRngType declarations (entry: inject_early)

API Reference

HookMacroRng class

Addon class that installs macro RNG hook.

Type Definition Source

INFO