OpenTTD
|
Information about one grf parameter. More...
#include <newgrf_config.h>
Public Member Functions | |
GRFParameterInfo (uint nr) | |
Create a new empty GRFParameterInfo object. | |
GRFParameterInfo (GRFParameterInfo &info) | |
Create a new GRFParameterInfo object that is a deep copy of an existing parameter info object. | |
~GRFParameterInfo () | |
Cleanup all parameter info. | |
uint32 | GetValue (struct GRFConfig *config) const |
Get the value of this user-changeable parameter from the given config. | |
void | SetValue (struct GRFConfig *config, uint32 value) |
Set the value of this user-changeable parameter in the given config. | |
void | Finalize () |
Finalize Action 14 info after file scan is finished. |
Data Fields | |
struct GRFText * | name |
The name of this parameter. | |
struct GRFText * | desc |
The description of this parameter. | |
GRFParameterType | type |
The type of this parameter. | |
uint32 | min_value |
The minimal value this parameter can have. | |
uint32 | max_value |
The maximal value of this parameter. | |
uint32 | def_value |
Default value of this parameter. | |
byte | param_nr |
GRF parameter to store content in. | |
byte | first_bit |
First bit to use in the GRF parameter. | |
byte | num_bit |
Number of bits to use for this parameter. | |
SmallMap< uint32, struct GRFText *, 8 > | value_names |
Names for each value. | |
bool | complete_labels |
True if all values have a label. |
Information about one grf parameter.
Definition at line 123 of file newgrf_config.h.
GRFParameterInfo::GRFParameterInfo | ( | uint | nr | ) |
Create a new empty GRFParameterInfo object.
nr | The newgrf parameter that is changed. |
Definition at line 233 of file newgrf_config.cpp.
GRFParameterInfo::GRFParameterInfo | ( | GRFParameterInfo & | info | ) |
Create a new GRFParameterInfo object that is a deep copy of an existing parameter info object.
info | The GRFParameterInfo object to make a copy of. |
Definition at line 251 of file newgrf_config.cpp.
References DuplicateGRFText(), SmallVector< T, S >::Get(), SmallMap< T, U, S >::Insert(), SmallVector< T, S >::Length(), and value_names.
GRFParameterInfo::~GRFParameterInfo | ( | ) |
Cleanup all parameter info.
Definition at line 270 of file newgrf_config.cpp.
References CleanUpGRFText(), desc, SmallVector< T, S >::Get(), SmallVector< T, S >::Length(), name, and value_names.
uint32 GRFParameterInfo::GetValue | ( | struct GRFConfig * | config | ) | const |
Get the value of this user-changeable parameter from the given config.
config | The GRFConfig to get the value from. |
Definition at line 285 of file newgrf_config.cpp.
References GB(), num_bit, GRFConfig::param, and param_nr.
Referenced by NewGRFParametersWindow::DrawWidget(), and NewGRFParametersWindow::OnClick().
void GRFParameterInfo::SetValue | ( | struct GRFConfig * | config, |
uint32 | value | ||
) |
Set the value of this user-changeable parameter in the given config.
config | The GRFConfig to set the value in. |
value | The new value. |
Definition at line 297 of file newgrf_config.cpp.
References num_bit, GRFConfig::num_params, GRFConfig::param, param_nr, SB(), SetWindowDirty(), WC_GAME_OPTIONS, and WN_GAME_OPTIONS_NEWGRF_STATE.
Referenced by NewGRFParametersWindow::OnClick(), NewGRFParametersWindow::OnDropdownSelect(), and NewGRFParametersWindow::OnQueryTextFinished().