news_type.h

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 NEWS_TYPE_H
#define NEWS_TYPE_H
 
#include "core/enum_type.hpp"
#include "gfx_type.h"
#include "timer/timer_game_calendar.h"
#include "timer/timer_game_economy.h"
#include "strings_type.h"
#include "sound_type.h"
 
enum NewsType : uint8_t {
  NT_ARRIVAL_COMPANY, 
  NT_ARRIVAL_OTHER,   
  NT_ACCIDENT,        
  NT_ACCIDENT_OTHER,  
  NT_COMPANY_INFO,    
  NT_INDUSTRY_OPEN,   
  NT_INDUSTRY_CLOSE,  
  NT_ECONOMY,         
  NT_INDUSTRY_COMPANY,
  NT_INDUSTRY_OTHER,  
  NT_INDUSTRY_NOBODY, 
  NT_ADVICE,          
  NT_NEW_VEHICLES,    
  NT_ACCEPTANCE,      
  NT_SUBSIDIES,       
  NT_GENERAL,         
  NT_END,             
};
 
enum class AdviceType : uint8_t {
  AircraftDestinationTooFar, 
  AutorenewFailed, 
  Order, 
  RefitFailed, 
  TrainStuck, 
  VehicleLost, 
  VehicleOld, 
  VehicleUnprofitable, 
  VehicleWaiting, 
 
  Invalid
};
 
enum NewsReferenceType : uint8_t {
  NR_NONE,      
  NR_TILE,      
  NR_VEHICLE,   
  NR_STATION,   
  NR_INDUSTRY,  
  NR_TOWN,      
  NR_ENGINE,    
};
 
enum NewsFlag : uint8_t {
  NFB_INCOLOUR       = 0,                      
  NFB_NO_TRANSPARENT = 1,                      
  NFB_SHADE          = 2,                      
  NFB_WINDOW_LAYOUT  = 3,                      
  NFB_WINDOW_LAYOUT_COUNT = 3,                 
  NFB_VEHICLE_PARAM0 = 6,                      
 
  NF_INCOLOUR       = 1 << NFB_INCOLOUR,       
  NF_NO_TRANSPARENT = 1 << NFB_NO_TRANSPARENT, 
  NF_SHADE          = 1 << NFB_SHADE,          
  NF_VEHICLE_PARAM0 = 1 << NFB_VEHICLE_PARAM0, 
 
  NF_THIN           = 0 << NFB_WINDOW_LAYOUT,  
  NF_SMALL          = 1 << NFB_WINDOW_LAYOUT,  
  NF_NORMAL         = 2 << NFB_WINDOW_LAYOUT,  
  NF_VEHICLE        = 3 << NFB_WINDOW_LAYOUT,  
  NF_COMPANY        = 4 << NFB_WINDOW_LAYOUT,  
};
DECLARE_ENUM_AS_BIT_SET(NewsFlag)
 
 
 
enum NewsDisplay : uint8_t {
  ND_OFF,        
  ND_SUMMARY,    
  ND_FULL,       
};
 
struct NewsTypeData {
  const char * const name;    
  const uint8_t age;             
  const SoundFx sound;        
 
  NewsTypeData(const char *name, uint8_t age, SoundFx sound) :
    name(name),
    age(age),
    sound(sound)
  {
  }
 
  NewsDisplay GetDisplay() const;
};
 
struct NewsAllocatedData {
  virtual ~NewsAllocatedData() = default;
};
 
 
struct NewsItem {
  StringID string_id;           
  TimerGameCalendar::Date date; 
  TimerGameEconomy::Date economy_date; 
  NewsType type;                
  AdviceType advice_type; 
  NewsFlag flags;               
 
  NewsReferenceType reftype1;   
  NewsReferenceType reftype2;   
  uint32_t ref1;                  
  uint32_t ref2;                  
 
  std::unique_ptr<NewsAllocatedData> data; 
 
  std::vector<StringParameterData> params; 
 
  NewsItem(StringID string_id, NewsType type, NewsFlag flags, NewsReferenceType reftype1, uint32_t ref1, NewsReferenceType reftype2, uint32_t ref2, std::unique_ptr<NewsAllocatedData> &&data, AdviceType advice_type);
};
 
struct CompanyNewsInformation : NewsAllocatedData {
  std::string company_name;       
  std::string president_name;     
  std::string other_company_name; 
 
  uint32_t face; 
  Colours colour; 
 
  CompanyNewsInformation(const struct Company *c, const struct Company *other = nullptr);
};
 
using NewsContainer = std::list<NewsItem>; 
using NewsIterator = NewsContainer::const_iterator; 
 
#endif /* NEWS_TYPE_H */