RecommendedSetting

A value shape that methods take or return.

Methods
None
Fields
7

Fields

FieldTypeDescription
settingstringThe setting, by its key: buff_bar, level_up_popups, ... The Game settings reference on the docs site lists every key, with its kind and…
onboolean?A toggle's value: false turns the game's own version off.
optionstring?A dropdown's or keybind's option, by its name in All Settings (any case).
valuenumber?Any other setting's value (a number; a colour's RGB), or an option's value.
notOption(string | {string})?Values the setting must not hold, by option name: one name or a list (a dropdown or keybind). With it, option or value is only what the…
notValue(number | {number})?As notOption, by value: one number or a list.
reasonstring?Why, for the player.

Returned by

MethodReturnsDescription
Plugin.recommendedSettings{RecommendedSetting}The game settings this plugin recommends values for (any row of All Settings that holds one: a toggle, a dropdown, ...), as a list of `Reco…

Field details

setting

setting: string

The setting, by its key: buff_bar, level_up_popups, ... The Game settings reference on the docs site lists every key, with its kind and options.

notOption

notOption: (string | {string})?

Values the setting must not hold, by option name: one name or a list (a dropdown or keybind). With it, option or value is only what the guide suggests; left out, the guide suggests the first option not excluded (a number has no options: give value). A toggle takes on instead.