ScriptConfigItem Struct Reference

Info about a single Script setting. More...

#include <script_config.hpp>

Data Fields
std::string	name
	The name of the configuration setting.
std::string	description
	The description of the configuration setting.
int	min_value = 0
	The minimal value this configuration setting can have.
int	max_value = 1
	The maximal value this configuration setting can have.
int	default_value = 0
	The default value of this configuration setting.
int	step_size = 1
	The step size in the gui.
ScriptConfigFlags	flags = SCRIPTCONFIG_NONE
	Flags for the configuration setting.
LabelMapping	labels
	Text labels for the integer values.
bool	complete_labels = false
	True if all values have a label.

Detailed Description

Info about a single Script setting.

Definition at line 32 of file script_config.hpp.

Field Documentation

complete_labels

bool ScriptConfigItem::complete_labels = false

True if all values have a label.

Definition at line 41 of file script_config.hpp.

Referenced by ScriptInfo::AddLabels().

default_value

int ScriptConfigItem::default_value = 0

The default value of this configuration setting.

Definition at line 37 of file script_config.hpp.

Referenced by ScriptInfo::AddSetting(), and ScriptInfo::GetSettingDefaultValue().

description

std::string ScriptConfigItem::description

The description of the configuration setting.

Definition at line 34 of file script_config.hpp.

Referenced by ScriptInfo::AddSetting().

flags

ScriptConfigFlags ScriptConfigItem::flags = SCRIPTCONFIG_NONE

Flags for the configuration setting.

Definition at line 39 of file script_config.hpp.

Referenced by ScriptInfo::AddSetting(), and ScriptConfig::ResetEditableSettings().

labels

LabelMapping ScriptConfigItem::labels

Text labels for the integer values.

Definition at line 40 of file script_config.hpp.

Referenced by ScriptInfo::AddLabels().

max_value

int ScriptConfigItem::max_value = 1

The maximal value this configuration setting can have.

Definition at line 36 of file script_config.hpp.

Referenced by ScriptInfo::AddLabels(), ScriptInfo::AddSetting(), and ScriptConfig::SetSetting().

min_value

int ScriptConfigItem::min_value = 0

The minimal value this configuration setting can have.

Definition at line 35 of file script_config.hpp.

Referenced by ScriptInfo::AddLabels(), ScriptInfo::AddSetting(), and ScriptConfig::SetSetting().

name

std::string ScriptConfigItem::name

The name of the configuration setting.

Definition at line 33 of file script_config.hpp.

Referenced by ScriptInfo::AddSetting().

step_size

int ScriptConfigItem::step_size = 1

The step size in the gui.

Definition at line 38 of file script_config.hpp.

Referenced by ScriptInfo::AddSetting().

---

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

• src/script/script_config.hpp