Skip to main content

settings.get

Overview

  • Get any game setting by its EB1GameOption enum name (e.g. ShadowQuality, MasterSoundVolume, Language, EnableAutoSave, FOV). Use this for settings not covered by domain-specific commands.

Metadata

FieldValue
DisplayGet Setting
Categorysettings
AccessPublic
ScopeB1Standalone
Tags
Aliases

Parameters

NameTypeRequiredDefaultDescription
optionstringyesEB1GameOption enum name (e.g. ShadowQuality, MasterSoundVolume)

Returns

Returns a JSON object with the following fields:

FieldTypeRequiredDescription
optionstringyesRequested option name
valuestringyesCurrent option value

Usage

await inzoi.cli.execute('settings.get', {
option: '',
});