Appearance

Documentation / @debuffjp/core / ParamGroup

Class: ParamGroup<S> ​

Defined in: params.ts:36

Type Parameters ​

S ​

S extends ParamSchema

Constructors ​

Constructor ​

new ParamGroup<S>(id, schema, onChange?): ParamGroup<S>

Defined in: params.ts:39

Parameters ​

id ​

string

schema ​

S

onChange? ​

(change) => void

Returns ​

ParamGroup<S>

Properties ​

id ​

readonly id: string

Defined in: params.ts:40

schema ​

readonly schema: S

Defined in: params.ts:41

Accessors ​

values ​

Get Signature ​

get values(): Readonly<ParamValues<S>>

Defined in: params.ts:48

Live view of current values; read every frame, write via set.

Returns ​

Readonly<ParamValues<S>>

Methods ​

get() ​

get<K>(key): ParamValues<S>[K]

Defined in: params.ts:52

Type Parameters ​

K ​

K extends string

Parameters ​

key ​

K

Returns ​

ParamValues<S>[K]

reset() ​

reset(): void

Defined in: params.ts:76

Returns ​

void

set() ​

set(key, value): void

Defined in: params.ts:57

Set a value, validating type and range. Throws on invalid input rather than clamping silently.

Parameters ​

key ​

keyof S & string

value ​

ParamValue

Returns ​

void