Skip to content
KCKingdoms Connected Scripting APIScripting guides and API
Data shapeClient APIGenerated

ScreenEffectParam

Defined in: client/api.d.ts:1302

One parameter a screen effect takes.

default: number

Defined in: client/api.d.ts:1326

What addScreenEffect uses when the parameter is not given.


description: string

Defined in: client/api.d.ts:1311

What it does to the picture.


max: number

Defined in: client/api.d.ts:1321

The highest value it takes. Anything higher is clamped.


min: number

Defined in: client/api.d.ts:1316

The lowest value it takes. Anything lower is clamped.


name: string

Defined in: client/api.d.ts:1306

The key to pass it under in a params bag.


neutral: number

Defined in: client/api.d.ts:1331

The value at which it leaves the picture alone, which is also where a fade starts and ends.