api.settings

Members

api.settings.get(): Effect.Effect<ScriptSettings>

Returns: ScriptSettings

Errors: never

Updates the supplied settings, leaving the rest unchanged.

api.settings.update(patch: ScriptSettingsPatch): Effect.Effect<void>

Name	Type	Required	Default	Description
`patch`	`ScriptSettingsPatch`

Returns: void

Errors: never

yield* api.settings.update({
  animations: false,
  hidePlayers: true,
  frameRate: 30,
});