script_config.hpp

Go to the documentation of this file.

/*
 * 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/>.
 */
 
#ifndef SCRIPT_CONFIG_HPP
#define SCRIPT_CONFIG_HPP
 
#include "../company_type.h"
#include "../textfile_gui.h"
#include "script_instance.hpp"
 
static const int INT32_DIGITS_WITH_SIGN_AND_TERMINATION = 10 + 1 + 1;
 
enum class ScriptConfigFlag : uint8_t {
  // Unused flag 0x1.
  Boolean   = 1, 
  InGame    = 2, 
  Developer = 3, 
};
 
using ScriptConfigFlags = EnumBitSet<ScriptConfigFlag, uint8_t>;
 
typedef std::map<int, std::string> LabelMapping; 
 
struct ScriptConfigItem {
  std::string name;             
  std::string description;      
  int min_value = 0;            
  int max_value = 1;            
  int default_value = 0;        
  int step_size = 1;            
  ScriptConfigFlags flags{};    
  LabelMapping labels;          
  bool complete_labels = false; 
 
  std::string GetString(int value) const;
  TextColour GetColour() const;
};
 
typedef std::vector<ScriptConfigItem> ScriptConfigItemList; 
 
class ScriptConfig {
protected:
  typedef std::map<std::string, int> SettingValueList;
 
public:
  ScriptConfig() :
    version(-1),
    info(nullptr),
    to_load_data(nullptr)
  {}
 
  ScriptConfig(const ScriptConfig *config);
 
  virtual ~ScriptConfig();
 
  void Change(std::optional<std::string> name, int version = -1, bool force_exact_match = false);
 
  class ScriptInfo *GetInfo() const;
 
  const ScriptConfigItemList *GetConfigList();
 
  enum ScriptSettingSource : uint8_t {
    SSS_DEFAULT,       
    SSS_FORCE_NEWGAME, 
    SSS_FORCE_GAME,    
  };
 
  void AnchorUnchangeableSettings();
 
  int GetSetting(const std::string &name) const;
 
  void SetSetting(const std::string_view name, int value);
 
  void ResetSettings();
 
  void ResetEditableSettings(bool yet_to_start);
 
  bool HasScript() const;
 
  const std::string &GetName() const;
 
  int GetVersion() const;
 
  void StringToSettings(const std::string &value);
 
  std::string SettingsToString() const;
 
  std::optional<std::string> GetTextfile(TextfileType type, CompanyID slot) const;
 
  void SetToLoadData(ScriptInstance::ScriptData *data);
  ScriptInstance::ScriptData *GetToLoadData();
 
protected:
  std::string name;                                         
  int version;                                              
  class ScriptInfo *info;                                   
  SettingValueList settings;                                
  std::unique_ptr<ScriptConfigItemList> config_list;        
  std::unique_ptr<ScriptInstance::ScriptData> to_load_data; 
 
  void ClearConfigList();
 
  virtual ScriptInfo *FindInfo(const std::string &name, int version, bool force_exact_match) = 0;
};
 
#endif /* SCRIPT_CONFIG_HPP */