OpenTTD Source: BoolSettingDesc Struct Reference

OpenTTD Source 15.0-RC2

Public Member Functions | Static Public Member Functions
BoolSettingDesc Struct Reference

Boolean setting. More...

`#include <settings_internal.h>`

Inheritance diagram for BoolSettingDesc:

## Public Member Functions
| BoolSettingDesc (const SaveLoad &save, SettingFlags flags, bool startup, bool def, StringID str, StringID str_help, StringID str_val, SettingCategory cat, PreChangeCheck pre_check, PostChangeCallback post_callback, GetTitleCallback get_title_cb, GetHelpCallback get_help_cb, GetValueParamsCallback get_value_params_cb, GetDefaultValueCallback get_def_cb)
bool | IsBoolSetting () const override
| Check whether this setting is a boolean type setting.
int32_t | ParseValue (std::string_view str) const override
| Convert a string representation (external) of an integer-like setting to an integer.
std::string | FormatValue (const void *object) const override
| Format the value of the setting associated with this object.
Public Member Functions inherited from IntSettingDesc
template<ConvertibleThroughBaseOrTo< int32_t > Tdef, ConvertibleThroughBaseOrTo< int32_t > Tmin, ConvertibleThroughBaseOrTo< uint32_t > Tmax, ConvertibleThroughBaseOrTo< int32_t > Tinterval>
| IntSettingDesc (const SaveLoad &save, SettingFlags flags, bool startup, Tdef def, Tmin min, Tmax max, Tinterval interval, StringID str, StringID str_help, StringID str_val, SettingCategory cat, PreChangeCheck pre_check, PostChangeCallback post_callback, GetTitleCallback get_title_cb, GetHelpCallback get_help_cb, GetValueParamsCallback get_value_params_cb, GetDefaultValueCallback get_def_cb, GetRangeCallback get_range_cb)
StringID | GetTitle () const
| Get the title of the setting.
StringID | GetHelp () const
| Get the help text of the setting.
std::pair< StringParameter, StringParameter > | GetValueParams (int32_t value) const
| Get parameters for drawing the value of the setting.
int32_t | GetDefaultValue () const
| Get the default value of the setting.
std::tuple< int32_t, uint32_t > | GetRange () const
| Get the min/max range for the setting.
bool | IsIntSetting () const override
| Check whether this setting is an integer type setting.
void | ChangeValue (const void *object, int32_t newvalue) const
| Handle changing a value.
void | MakeValueValidAndWrite (const void *object, int32_t value) const
| Make the value valid and then write it to the setting.
std::string | FormatValue (const void *object) const override
| Format the value of the setting associated with this object.
void | ParseValue (const IniItem *item, void *object) const override
| Parse/read the value from the Ini item into the setting associated with this object.
bool | IsSameValue (const IniItem *item, void *object) const override
| Check whether the value in the Ini item is the same as is saved in this setting in the object.
bool | IsDefaultValue (void *object) const override
| Check whether the value is the same as the default value.
void | ResetToDefault (void *object) const override
| Reset the setting to its default value.
int32_t | Read (const void *object) const
| Read the integer from the the actual setting.
Public Member Functions inherited from SettingDesc
| SettingDesc (const SaveLoad &save, SettingFlags flags, bool startup)
bool | IsEditable (bool do_command=false) const
| Check whether the setting is editable in the current gamemode.
SettingType | GetType () const
| Return the type of the setting.
constexpr const std::string & | GetName () const
| Get the name of this setting.
virtual bool | IsStringSetting () const
| Check whether this setting is an string type setting.
const struct IntSettingDesc * | AsIntSetting () const
| Get the setting description of this setting as an integer setting.
const struct StringSettingDesc * | AsStringSetting () const
| Get the setting description of this setting as a string setting.

## Static Public Member Functions
static std::optional< bool > | ParseSingleValue (std::string_view str)
| Find whether a string was a boolean true or a boolean false.

## Additional Inherited Members
Public Types inherited from IntSettingDesc
using | GetTitleCallback = StringID(const IntSettingDesc &sd)
using | GetHelpCallback = StringID(const IntSettingDesc &sd)
using | GetValueParamsCallback = std::pair< StringParameter, StringParameter >(const IntSettingDesc &sd, int32_t value)
using | GetDefaultValueCallback = int32_t(const IntSettingDesc &sd)
using | GetRangeCallback = std::tuple< int32_t, uint32_t >(const IntSettingDesc &sd)
using | PreChangeCheck = bool(int32_t &value)
| A check to be performed before the setting gets changed.
using | PostChangeCallback = void(int32_t value)
| A callback to denote that a setting has been changed.
Data Fields inherited from IntSettingDesc
int32_t | def
| default value given when none is present
int32_t | min
| minimum values
uint32_t | max
| maximum values
int32_t | interval
| the interval to use between settings in the 'settings' window. If interval is '0' the interval is dynamically determined
StringID | str
| (translated) string with descriptive text; gui and console
StringID | str_help
| (Translated) string with help text; gui only.
StringID | str_val
| (Translated) first string describing the value.
SettingCategory | cat
| assigned categories of the setting
PreChangeCheck * | pre_check
| Callback to check for the validity of the setting.
PostChangeCallback * | post_callback
| Callback when the setting has been changed.
GetTitleCallback * | get_title_cb
GetHelpCallback * | get_help_cb
GetValueParamsCallback * | get_value_params_cb
GetDefaultValueCallback * | get_def_cb
| Callback to set the correct default value.
GetRangeCallback * | get_range_cb
Data Fields inherited from SettingDesc
SettingFlags | flags
| Handles how a setting would show up in the GUI (text/currency, etc.).
bool | startup
| Setting has to be loaded directly at startup?.
SaveLoad | save
| Internal structure (going to savegame, parts to config).

## Detailed Description

Boolean setting.

Definition at line 252 of file settings_internal.h.

## Constructor & Destructor Documentation

## ◆ BoolSettingDesc()

BoolSettingDesc::BoolSettingDesc | ( | const SaveLoad & | save,
|  | SettingFlags | flags,
|  | bool | startup,
|  | bool | def,
|  | StringID | str,
|  | StringID | str_help,
|  | StringID | str_val,
|  | SettingCategory | cat,
|  | PreChangeCheck | pre_check,
|  | PostChangeCallback | post_callback,
|  | GetTitleCallback | get_title_cb,
|  | GetHelpCallback | get_help_cb,
|  | GetValueParamsCallback | get_value_params_cb,
|  | GetDefaultValueCallback | get_def_cb
| ) |  |
| inline

Definition at line 253 of file settings_internal.h.

## Member Function Documentation

## ◆ FormatValue()

std::string BoolSettingDesc::FormatValue | ( | const void * | object | ) | const
| overridevirtual

Format the value of the setting associated with this object.

Parameters

  buf | The before of the buffer to format into.
  last | The end of the buffer to format into.
  object | The object the setting is in.

Implements SettingDesc.

Definition at line 747 of file settings.cpp.

References IntSettingDesc::Read().

## ◆ IsBoolSetting()

bool BoolSettingDesc::IsBoolSetting | ( |  | ) | const
| inlineoverridevirtual

Check whether this setting is a boolean type setting.

Returns
  True when the underlying type is an integer.

Reimplemented from IntSettingDesc.

Definition at line 263 of file settings_internal.h.

## ◆ ParseSingleValue()

std::optional< bool > BoolSettingDesc::ParseSingleValue | ( | std::string_view | str | ) |
| static

Find whether a string was a boolean true or a boolean false.

Parameters

  str | the current value of the setting for which a value needs found.

Returns
  Either true/false, or nullopt if no boolean value found.

Definition at line 206 of file settings.cpp.

References IntSettingDesc::str.

Referenced by LoadFromConfig(), and ParseValue().

## ◆ ParseValue()

int32_t BoolSettingDesc::ParseValue | ( | std::string_view | str | ) | const
| overridevirtual

Convert a string representation (external) of an integer-like setting to an integer.

Parameters

  str | Input string that will be parsed based on the type of desc.

Returns
  The value from the parse string, or the default value of the setting.

Reimplemented from IntSettingDesc.

Definition at line 411 of file settings.cpp.

References _settings_error_list, IntSettingDesc::GetDefaultValue(), GetEncodedString(), SettingDesc::GetName(), ParseSingleValue(), and IntSettingDesc::str.

The documentation for this struct was generated from the following files:

- src/settings_internal.h
- src/settings.cpp