Appearance

Documentation / @debuffjp/core / ParamRegistry

Class: ParamRegistry ​

Defined in: params.ts:87

Registry of every param group in a game; the surface agents and dev tools inspect.

Constructors ​

Constructor ​

new ParamRegistry(): ParamRegistry

Returns ​

ParamRegistry

Methods ​

define() ​

define<S>(id, schema): ParamGroup<S>

Defined in: params.ts:91

Type Parameters ​

S ​

S extends ParamSchema

Parameters ​

id ​

string

schema ​

S

Returns ​

ParamGroup<S>

describe() ​

describe(): Record<string, ParamDescription>

Defined in: params.ts:110

JSON-serialisable snapshot of schemas and current values.

Returns ​

Record<string, ParamDescription>

group() ​

group(id): ParamGroup<ParamSchema> | undefined

Defined in: params.ts:100

Parameters ​

id ​

string

Returns ​

ParamGroup<ParamSchema> | undefined

onChange() ​

onChange(listener): () => void

Defined in: params.ts:104

Parameters ​

listener ​

(change) => void

Returns ​

() => void