OpenTTD
script_config.hpp
Go to the documentation of this file.
1 /* $Id: script_config.hpp 26493 2014-04-24 04:41:54Z rubidium $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
12 #ifndef SCRIPT_CONFIG_HPP
13 #define SCRIPT_CONFIG_HPP
14 
15 #include <map>
16 #include <list>
17 #include "../core/smallmap_type.hpp"
18 #include "../core/string_compare_type.hpp"
19 #include "../company_type.h"
20 #include "../textfile_gui.h"
21 
29 };
30 
32 
35  const char *name;
36  const char *description;
37  int min_value;
38  int max_value;
40  int easy_value;
42  int hard_value;
44  int step_size;
48 };
49 
50 typedef std::list<ScriptConfigItem> ScriptConfigItemList;
51 
53 
57 class ScriptConfig {
58 protected:
60  typedef std::map<const char *, int, StringCompare> SettingValueList;
61 
62 public:
63  ScriptConfig() :
64  name(NULL),
65  version(-1),
66  info(NULL),
67  config_list(NULL),
68  is_random(false)
69  {}
70 
75  ScriptConfig(const ScriptConfig *config);
76 
78  virtual ~ScriptConfig();
79 
88  void Change(const char *name, int version = -1, bool force_exact_match = false, bool is_random = false);
89 
93  class ScriptInfo *GetInfo() const;
94 
99 
108  };
109 
118  void AnchorUnchangeableSettings();
119 
127  virtual int GetSetting(const char *name) const;
128 
132  virtual void SetSetting(const char *name, int value);
133 
137  void ResetSettings();
138 
142  void AddRandomDeviation();
143 
148  bool HasScript() const;
149 
153  bool IsRandom() const;
154 
158  const char *GetName() const;
159 
163  int GetVersion() const;
164 
169  void StringToSettings(const char *value);
170 
175  void SettingsToString(char *string, const char *last) const;
176 
183  const char *GetTextfile(TextfileType type, CompanyID slot) const;
184 
185 protected:
186  const char *name;
187  int version;
188  class ScriptInfo *info;
189  SettingValueList settings;
191  bool is_random;
192 
197  virtual void PushExtraConfigList() {};
198 
202  virtual void ClearConfigList();
203 
208  virtual ScriptInfo *FindInfo(const char *name, int version, bool force_exact_match) = 0;
209 };
210 
211 #endif /* SCRIPT_CONFIG_HPP */
int GetVersion() const
Get the version of the script.
Definition: script_info.hpp:74
This setting will only be visible when the Script development tools are active.
int random_deviation
The maximum random deviation from the default value.
const ScriptConfigItemList * GetConfigList() const
Get the config list for this Script.
int min_value
The minimal value this configuration setting can have.
const char * GetName() const
Get the Name of the script.
Definition: script_info.hpp:59
std::list< ScriptConfigItem > ScriptConfigItemList
List of ScriptConfig items.
Implementation of simple mapping class.
ScriptConfigItem _start_date_config
Configuration for AI start date, every AI has this setting.
Definition: ai_config.cpp:22
LabelMapping * labels
Text labels for the integer values.
SettingValueList settings
List with all setting=>value pairs that are configure for this Script.
int max_value
The maximal value this configuration setting can have.
Script settings.
bool is_random
True if the AI in this slot was randomly chosen.
int medium_value
The default value on medium difficulty setting.
ScriptConfigItemList * config_list
List with all settings defined by this Script.
No flags set.
Get the Script config from the current game mode.
ScriptConfigFlags
Bitmask of flags for Script settings.
std::map< const char *, int, StringCompare > SettingValueList
List with name=>value pairs of all script-specific settings.
bool complete_labels
True if all values have a label.
All static information from an Script like name, version, etc.
Definition: script_info.hpp:32
ScriptSettingSource
Where to get the config from, either default (depends on current game mode) or force either newgame o...
int easy_value
The default value on easy difficulty setting.
When randomizing the Script, pick any value between min_value and max_value when on custom difficulty...
int custom_value
The default value on custom difficulty setting.
TextfileType
Additional text files accompanying Tar archives.
Definition: textfile_type.h:16
SmallMap< int, char * > LabelMapping
Map-type used to map the setting numbers to labels.
This value is a boolean (either 0 (false) or 1 (true) ).
const char * description
The description of the configuration setting.
ScriptConfigFlags flags
Flags for the configuration setting.
Info about a single Script setting.
int version
Version of the Script.
Get the newgame Script config.
This setting can be changed while the Script is running.
class ScriptInfo * info
ScriptInfo object for related to this Script version.
int hard_value
The default value on hard difficulty setting.
const char * name
Name of the Script.
Owner
Enum for all companies/owners.
Definition: company_type.h:20
const char * GetTextfile(TextfileType type, Subdirectory dir, const char *filename)
Search a textfile file next to the given content.
int step_size
The step size in the gui.
Get the Script config from the current game.
virtual void PushExtraConfigList()
In case you have mandatory non-Script-definable config entries in your list, add them to this functio...
const char * name
The name of the configuration setting.