Files
@ r27802:31cc64ccda2d
Branch filter:
Location: cpp/openttd-patchpack/source/src/script/script_config.hpp - annotation
r27802:31cc64ccda2d
7.7 KiB
text/x-c++hdr
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r19068:3e8bf48b7b8a r19068:3e8bf48b7b8a r26699:573b113abb66 r18510:9d33e9643f80 r26899:f0f3f161bf12 r26899:f0f3f161bf12 r26899:f0f3f161bf12 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r27310:97eaae2636e8 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r27310:97eaae2636e8 r27310:97eaae2636e8 r27310:97eaae2636e8 r27310:97eaae2636e8 r27310:97eaae2636e8 r27310:97eaae2636e8 r27310:97eaae2636e8 r27310:97eaae2636e8 r27310:97eaae2636e8 r27310:97eaae2636e8 r27310:97eaae2636e8 r27310:97eaae2636e8 r27310:97eaae2636e8 r18510:9d33e9643f80 r18510:9d33e9643f80 r27310:97eaae2636e8 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r27308:abc0eb023c25 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r23607:36c15679007d r26699:573b113abb66 r26699:573b113abb66 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r27355:f091f5737dec r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r20561:5c762b60c932 r20561:5c762b60c932 r20561:5c762b60c932 r20561:5c762b60c932 r20561:5c762b60c932 r20561:5c762b60c932 r20561:5c762b60c932 r20561:5c762b60c932 r20561:5c762b60c932 r20561:5c762b60c932 r25484:c5af4712cb7f r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r27310:97eaae2636e8 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r27359:9505d4407412 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r24530:7d6ebaaa5c12 r24530:7d6ebaaa5c12 r24530:7d6ebaaa5c12 r24530:7d6ebaaa5c12 r24530:7d6ebaaa5c12 r18510:9d33e9643f80 r18510:9d33e9643f80 r27104:635f8101e375 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r27354:7a607c98c943 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r25469:0f19702a0708 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r25469:0f19702a0708 r18510:9d33e9643f80 r19068:3e8bf48b7b8a r19068:3e8bf48b7b8a r19068:3e8bf48b7b8a r19068:3e8bf48b7b8a r27259:59b91be38623 r19068:3e8bf48b7b8a r27259:59b91be38623 r19068:3e8bf48b7b8a r26699:573b113abb66 r26699:573b113abb66 r26699:573b113abb66 r18510:9d33e9643f80 r27354:7a607c98c943 r26699:573b113abb66 r26699:573b113abb66 r26699:573b113abb66 r27310:97eaae2636e8 r26699:573b113abb66 r26699:573b113abb66 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r27104:635f8101e375 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 r27354:7a607c98c943 r18510:9d33e9643f80 r18510:9d33e9643f80 r18510:9d33e9643f80 | /*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file script_config.hpp ScriptConfig stores the configuration settings of every Script. */
#ifndef SCRIPT_CONFIG_HPP
#define SCRIPT_CONFIG_HPP
#include "../company_type.h"
#include "../textfile_gui.h"
#include "script_instance.hpp"
/** Maximum of 10 digits for MIN / MAX_INT32, 1 for the sign and 1 for '\0'. */
static const int INT32_DIGITS_WITH_SIGN_AND_TERMINATION = 10 + 1 + 1;
/** Bitmask of flags for Script settings. */
enum ScriptConfigFlags {
SCRIPTCONFIG_NONE = 0x0, ///< No flags set.
SCRIPTCONFIG_RANDOM = 0x1, ///< When randomizing the Script, pick any value between min_value and max_value when on custom difficulty setting.
SCRIPTCONFIG_BOOLEAN = 0x2, ///< This value is a boolean (either 0 (false) or 1 (true) ).
SCRIPTCONFIG_INGAME = 0x4, ///< This setting can be changed while the Script is running.
SCRIPTCONFIG_DEVELOPER = 0x8, ///< This setting will only be visible when the Script development tools are active.
};
typedef std::map<int, std::string> LabelMapping; ///< Map-type used to map the setting numbers to labels.
/** Info about a single Script setting. */
struct ScriptConfigItem {
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 custom_value = 0; ///< The default value on custom difficulty setting.
int easy_value = 0; ///< The default value on easy difficulty setting.
int medium_value = 0; ///< The default value on medium difficulty setting.
int hard_value = 0; ///< The default value on hard difficulty setting.
int random_deviation = 0; ///< The maximum random deviation from the default value.
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.
};
typedef std::vector<ScriptConfigItem> ScriptConfigItemList; ///< List of ScriptConfig items.
/**
* Script settings.
*/
class ScriptConfig {
protected:
/** List with name=>value pairs of all script-specific settings */
typedef std::map<std::string, int> SettingValueList;
public:
ScriptConfig() :
version(-1),
info(nullptr),
is_random(false),
to_load_data(nullptr)
{}
/**
* Create a new Script config that is a copy of an existing config.
* @param config The object to copy.
*/
ScriptConfig(const ScriptConfig *config);
/** Delete an Script configuration. */
virtual ~ScriptConfig();
/**
* Set another Script to be loaded in this slot.
* @param name The name of the Script.
* @param version The version of the Script to load, or -1 of latest.
* @param force_exact_match If true try to find the exact same version
* as specified. If false any compatible version is ok.
* @param is_random Is the Script chosen randomly?
*/
void Change(std::optional<const std::string> name, int version = -1, bool force_exact_match = false, bool is_random = false);
/**
* Get the ScriptInfo linked to this ScriptConfig.
*/
class ScriptInfo *GetInfo() const;
/**
* Get the config list for this ScriptConfig.
*/
const ScriptConfigItemList *GetConfigList();
/**
* Where to get the config from, either default (depends on current game
* mode) or force either newgame or normal
*/
enum ScriptSettingSource {
SSS_DEFAULT, ///< Get the Script config from the current game mode
SSS_FORCE_NEWGAME, ///< Get the newgame Script config
SSS_FORCE_GAME, ///< Get the Script config from the current game
};
/**
* As long as the default of a setting has not been changed, the value of
* the setting is not stored. This to allow changing the difficulty setting
* without having to reset the script's config. However, when a setting may
* not be changed in game, we must "anchor" this value to what the setting
* would be at the time of starting. Otherwise changing the difficulty
* setting would change the setting's value (which isn't allowed).
*/
void AnchorUnchangeableSettings();
/**
* Get the value of a setting for this config. It might fallback to its
* 'info' to find the default value (if not set or if not-custom difficulty
* level).
* @return The (default) value of the setting, or -1 if the setting was not
* found.
*/
int GetSetting(const std::string &name) const;
/**
* Set the value of a setting for this config.
*/
void SetSetting(const std::string_view name, int value);
/**
* Reset all settings to their default value.
*/
void ResetSettings();
/**
* Reset only editable and visible settings to their default value.
*/
void ResetEditableSettings(bool yet_to_start);
/**
* Randomize all settings the Script requested to be randomized.
*/
void AddRandomDeviation();
/**
* Is this config attached to an Script? In other words, is there a Script
* that is assigned to this slot.
*/
bool HasScript() const;
/**
* Is the current Script a randomly chosen Script?
*/
bool IsRandom() const;
/**
* Get the name of the Script.
*/
const std::string &GetName() const;
/**
* Get the version of the Script.
*/
int GetVersion() const;
/**
* Convert a string which is stored in the config file or savegames to
* custom settings of this Script.
*/
void StringToSettings(const std::string &value);
/**
* Convert the custom settings to a string that can be stored in the config
* file or savegames.
*/
std::string SettingsToString() const;
/**
* Search a textfile file next to this script.
* @param type The type of the textfile to search for.
* @param slot #CompanyID to check status of.
* @return The filename for the textfile.
*/
std::optional<std::string> GetTextfile(TextfileType type, CompanyID slot) const;
void SetToLoadData(ScriptInstance::ScriptData *data);
ScriptInstance::ScriptData *GetToLoadData();
protected:
std::string name; ///< Name of the Script
int version; ///< Version of the Script
class ScriptInfo *info; ///< ScriptInfo object for related to this Script version
SettingValueList settings; ///< List with all setting=>value pairs that are configure for this Script
std::unique_ptr<ScriptConfigItemList> config_list; ///< List with all settings defined by this Script
bool is_random; ///< True if the AI in this slot was randomly chosen.
std::unique_ptr<ScriptInstance::ScriptData> to_load_data; ///< Data to load after the Script start.
/**
* Routine that clears the config list.
*/
void ClearConfigList();
/**
* This function should call back to the Scanner in charge of this Config,
* to find the ScriptInfo belonging to a name+version.
*/
virtual ScriptInfo *FindInfo(const std::string &name, int version, bool force_exact_match) = 0;
};
#endif /* SCRIPT_CONFIG_HPP */
|