src/news_type.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file news_type.h Types related to news. */
   9
  10 #ifndef NEWS_TYPE_H
  11 #define NEWS_TYPE_H
  12
  13 #include "core/enum_type.hpp"
  14 #include "date_type.h"
  15 #include "strings_type.h"
  16 #include "sound_type.h"
  17
  18 /**
  19  * Type of news.
  20  */
  21 enum NewsType : byte {
  22         NT_ARRIVAL_COMPANY, ///< First vehicle arrived for company
  23         NT_ARRIVAL_OTHER,   ///< First vehicle arrived for competitor
  24         NT_ACCIDENT,        ///< An accident or disaster has occurred
  25         NT_ACCIDENT_OTHER,  ///< An accident or disaster has occurred
  26         NT_COMPANY_INFO,    ///< Company info (new companies, bankruptcy messages)
  27         NT_INDUSTRY_OPEN,   ///< Opening of industries
  28         NT_INDUSTRY_CLOSE,  ///< Closing of industries
  29         NT_ECONOMY,         ///< Economic changes (recession, industry up/dowm)
  30         NT_INDUSTRY_COMPANY,///< Production changes of industry serviced by local company
  31         NT_INDUSTRY_OTHER,  ///< Production changes of industry serviced by competitor(s)
  32         NT_INDUSTRY_NOBODY, ///< Other industry production changes
  33         NT_ADVICE,          ///< Bits of news about vehicles of the company
  34         NT_NEW_VEHICLES,    ///< New vehicle has become available
  35         NT_ACCEPTANCE,      ///< A type of cargo is (no longer) accepted
  36         NT_SUBSIDIES,       ///< News about subsidies (announcements, expirations, acceptance)
  37         NT_GENERAL,         ///< General news (from towns)
  38         NT_END,             ///< end-of-array marker
  39 };
  40
  41 /**
  42  * References to objects in news.
  43  *
  44  * @warning
  45  * Be careful!
  46  * Vehicles are a special case, as news are kept when vehicles are autoreplaced/renewed.
  47  * You have to make sure, #ChangeVehicleNews catches the DParams of your message.
  48  * This is NOT ensured by the references.
  49  */
  50 enum NewsReferenceType : byte {
  51         NR_NONE,      ///< Empty reference
  52         NR_TILE,      ///< Reference tile.     Scroll to tile when clicking on the news.
  53         NR_VEHICLE,   ///< Reference vehicle.  Scroll to vehicle when clicking on the news. Delete news when vehicle is deleted.
  54         NR_STATION,   ///< Reference station.  Scroll to station when clicking on the news. Delete news when station is deleted.
  55         NR_INDUSTRY,  ///< Reference industry. Scroll to industry when clicking on the news. Delete news when industry is deleted.
  56         NR_TOWN,      ///< Reference town.     Scroll to town when clicking on the news.
  57         NR_ENGINE,    ///< Reference engine.
  58 };
  59
  60 /**
  61  * Various OR-able news-item flags.
  62  * @note #NF_INCOLOUR is set automatically if needed.
  63  */
  64 enum NewsFlag {
  65         NFB_INCOLOUR       = 0,                      ///< News item is shown in colour (otherwise it is shown in black & white).
  66         NFB_NO_TRANSPARENT = 1,                      ///< News item disables transparency in the viewport.
  67         NFB_SHADE          = 2,                      ///< News item uses shaded colours.
  68         NFB_WINDOW_LAYOUT  = 3,                      ///< First bit for window layout.
  69         NFB_WINDOW_LAYOUT_COUNT = 3,                 ///< Number of bits for window layout.
  70         NFB_VEHICLE_PARAM0 = 6,                      ///< String param 0 contains a vehicle ID. (special autoreplace behaviour)
  71
  72         NF_INCOLOUR       = 1 << NFB_INCOLOUR,       ///< Bit value for coloured news.
  73         NF_NO_TRANSPARENT = 1 << NFB_NO_TRANSPARENT, ///< Bit value for disabling transparency.
  74         NF_SHADE          = 1 << NFB_SHADE,          ///< Bit value for enabling shading.
  75         NF_VEHICLE_PARAM0 = 1 << NFB_VEHICLE_PARAM0, ///< Bit value for specifying that string param 0 contains a vehicle ID. (special autoreplace behaviour)
  76
  77         NF_THIN           = 0 << NFB_WINDOW_LAYOUT,  ///< Thin news item. (Newspaper with headline and viewport)
  78         NF_SMALL          = 1 << NFB_WINDOW_LAYOUT,  ///< Small news item. (Information window with text and viewport)
  79         NF_NORMAL         = 2 << NFB_WINDOW_LAYOUT,  ///< Normal news item. (Newspaper with text only)
  80         NF_VEHICLE        = 3 << NFB_WINDOW_LAYOUT,  ///< Vehicle news item. (new engine available)
  81         NF_COMPANY        = 4 << NFB_WINDOW_LAYOUT,  ///< Company news item. (Newspaper with face)
  82 };
  83 DECLARE_ENUM_AS_BIT_SET(NewsFlag)
  84
  85
  86 /**
  87  * News display options
  88  */
  89 enum NewsDisplay {
  90         ND_OFF,        ///< Only show a reminder in the status bar
  91         ND_SUMMARY,    ///< Show ticker
  92         ND_FULL,       ///< Show newspaper
  93 };
  94
  95 /**
  96  * Per-NewsType data
  97  */
  98 struct NewsTypeData {
  99         const char * const name;    ///< Name
 100         const byte age;             ///< Maximum age of news items (in days)
 101         const SoundFx sound;        ///< Sound
 102
 103         /**
 104          * Construct this entry.
 105          * @param name The name of the type.
 106          * @param age The maximum age for these messages.
 107          * @param sound The sound to play.
 108          */
 109         NewsTypeData(const char *name, byte age, SoundFx sound) :
 110                 name(name),
 111                 age(age),
 112                 sound(sound)
 113         {
 114         }
 115
 116         NewsDisplay GetDisplay() const;
 117 };
 118
 119 /** Container for any custom data that must be deleted after the news item has reached end-of-life. */
 120 struct NewsAllocatedData {
 121         virtual ~NewsAllocatedData() {}
 122 };
 123
 124
 125 /** Information about a single item of news. */
 126 struct NewsItem {
 127         NewsItem *prev;              ///< Previous news item
 128         NewsItem *next;              ///< Next news item
 129         StringID string_id;          ///< Message text
 130         Date date;                   ///< Date of the news
 131         NewsType type;               ///< Type of the news
 132         NewsFlag flags;              ///< NewsFlags bits @see NewsFlag
 133
 134         NewsReferenceType reftype1;  ///< Type of ref1
 135         NewsReferenceType reftype2;  ///< Type of ref2
 136         uint32 ref1;                 ///< Reference 1 to some object: Used for a possible viewport, scrolling after clicking on the news, and for deleting the news when the object is deleted.
 137         uint32 ref2;                 ///< Reference 2 to some object: Used for scrolling after clicking on the news, and for deleting the news when the object is deleted.
 138
 139         std::unique_ptr<const NewsAllocatedData> data; ///< Custom data for the news item that will be deallocated (deleted) when the news item has reached its end.
 140
 141         uint64 params[10]; ///< Parameters for string resolving.
 142
 143         NewsItem(StringID string_id, NewsType type, NewsFlag flags, NewsReferenceType reftype1, uint32 ref1, NewsReferenceType reftype2, uint32 ref2, const NewsAllocatedData *data);
 144 };
 145
 146 /** Container for a single string to be passed as NewsAllocatedData. */
 147 struct NewsStringData : NewsAllocatedData {
 148         std::string string; ///< The string to retain.
 149         NewsStringData(const std::string &str) : string(str) {}
 150 };
 151
 152 /**
 153  * Data that needs to be stored for company news messages.
 154  * The problem with company news messages are the custom name
 155  * of the companies and the fact that the company data is reset,
 156  * resulting in wrong names and such.
 157  */
 158 struct CompanyNewsInformation : NewsAllocatedData {
 159         std::string company_name;       ///< The name of the company
 160         std::string president_name;     ///< The name of the president
 161         std::string other_company_name; ///< The name of the company taking over this one
 162
 163         uint32 face; ///< The face of the president
 164         byte colour; ///< The colour related to the company
 165
 166         CompanyNewsInformation(const struct Company *c, const struct Company *other = nullptr);
 167 };
 168
 169 #endif /* NEWS_TYPE_H */