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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef NEWS_TYPE_H
#define NEWS_TYPE_H
 
#include "core/enum_type.hpp"
#include "company_type.h"
#include "engine_type.h"
#include "industry_type.h"
#include "gfx_type.h"
#include "sound_type.h"
#include "station_type.h"
#include "strings_type.h"
#include "timer/timer_game_calendar.h"
#include "timer/timer_game_economy.h"
#include "town_type.h"
#include "vehicle_type.h"

enum class NewsType : uint8_t {
  ArrivalCompany, 
  ArrivalOther, 
  Accident, 
  AccidentOther, 
  CompanyInfo, 
  IndustryOpen, 
  IndustryClose, 
  Economy, 
  IndustryCompany, 
  IndustryOther, 
  IndustryNobody, 
  Advice, 
  NewVehicles, 
  Acceptance, 
  Subsidies, 
  General, 
 
  End, 
};

enum class AdviceType : uint8_t {
  AircraftDestinationTooFar, 
  AutorenewFailed, 
  Order, 
  RefitFailed, 
  TrainStuck, 
  VehicleLost, 
  VehicleOld, 
  VehicleUnprofitable, 
  VehicleWaiting, 
 
  Invalid, 
};

using NewsReference = std::variant<std::monostate, TileIndex, VehicleID, StationID, IndustryID, TownID, EngineID>;

enum class NewsStyle : uint8_t {
  Thin, 
  Small, 
  Normal, 
  Vehicle, 
  Company, 
};

enum class NewsFlag : uint8_t {
  InColour, 
  NoTransparency, 
  Shaded, 
  VehicleParam0, 
};
using NewsFlags = EnumBitSet<NewsFlag, uint8_t>;

enum class NewsDisplay : uint8_t {
  Off, 
  Summary, 
  Full, 
};

struct NewsTypeData {
  const std::string_view name; 
  const uint8_t age;             
  const SoundFx sound;        

  NewsTypeData(std::string_view name, uint8_t age, SoundFx sound) :
    name(name),
    age(age),
    sound(sound)
  {
  }
 
  NewsDisplay GetDisplay() const;
};

struct NewsAllocatedData {
  virtual ~NewsAllocatedData() = default;
};
 

struct NewsItem {
  EncodedString headline; 
  TimerGameCalendar::Date date; 
  TimerGameEconomy::Date economy_date; 
  NewsType type;                
  AdviceType advice_type; 
  NewsStyle style; 
  NewsFlags flags;               
 
  NewsReference ref1; 
  NewsReference ref2; 
 
  std::unique_ptr<NewsAllocatedData> data; 
 
  NewsItem(EncodedString &&headline, NewsType type, NewsStyle style, NewsFlags flags, NewsReference ref1, NewsReference ref2, std::unique_ptr<NewsAllocatedData> &&data, AdviceType advice_type);
 
  std::string GetStatusText() const;
};

struct CompanyNewsInformation : NewsAllocatedData {
  std::string company_name;       
  std::string president_name;     
  std::string other_company_name; 
 
  StringID title;
  CompanyManagerFace face; 
  Colours colour; 
 
  CompanyNewsInformation(StringID title, const struct Company *c, const struct Company *other = nullptr);
};
 
using NewsContainer = std::list<NewsItem>; 
using NewsIterator = NewsContainer::const_iterator; 
 
#endif /* NEWS_TYPE_H */