Skip to content

1681-engine / index / EngineSettings

Interface: EngineSettings ​

Defined in: src/settings.ts:5

The few player settings the engine itself reads. A game keeps its own settings store and mirrors these fields into this one (engineSettings.set) whenever they change; the engine never reads the game's store.

Properties ​

batterySaver ​

ts
batterySaver: boolean;

Defined in: src/settings.ts:9

Turns off everything that only costs battery: transient lights, heavy particles.


combatLights ​

ts
combatLights: boolean;

Defined in: src/settings.ts:11

Short-lived lights a fight throws into the dark (pixel/lights.ts).


musicVolume ​

ts
musicVolume: number;

Defined in: src/settings.ts:15

0–1, the music's volume.


reducedFx ​

ts
reducedFx: boolean;

Defined in: src/settings.ts:7

Fewer particles and lighter effects.


sfxVolume ​

ts
sfxVolume: number;

Defined in: src/settings.ts:13

0–1, the combat sounds' volume (audio/SoundEngine.ts).

Released under the MIT License.