src/story_base.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 story_base.h %StoryPage base class. */
   9
  10 #ifndef STORY_BASE_H
  11 #define STORY_BASE_H
  12
  13 #include "company_type.h"
  14 #include "story_type.h"
  15 #include "timer/timer_game_calendar.h"
  16 #include "gfx_type.h"
  17 #include "vehicle_type.h"
  18 #include "core/pool_type.hpp"
  19
  20 typedef Pool<StoryPageElement, StoryPageElementID, 64, 64000> StoryPageElementPool;
  21 typedef Pool<StoryPage, StoryPageID, 64, 64000> StoryPagePool;
  22 extern StoryPageElementPool _story_page_element_pool;
  23 extern StoryPagePool _story_page_pool;
  24 extern uint32_t _story_page_element_next_sort_value;
  25 extern uint32_t _story_page_next_sort_value;
  26
  27 /*
  28  * Each story page element is one of these types.
  29  */
  30 enum StoryPageElementType : byte {
  31         SPET_TEXT = 0,       ///< A text element.
  32         SPET_LOCATION,       ///< An element that references a tile along with a one-line text.
  33         SPET_GOAL,           ///< An element that references a goal.
  34         SPET_BUTTON_PUSH,    ///< A push button that triggers an immediate event.
  35         SPET_BUTTON_TILE,    ///< A button that allows the player to select a tile, and triggers an event with the tile.
  36         SPET_BUTTON_VEHICLE, ///< A button that allows the player to select a vehicle, and triggers an event wih the vehicle.
  37         SPET_END,
  38         INVALID_SPET = 0xFF,
  39 };
  40
  41 /** Flags available for buttons */
  42 enum StoryPageButtonFlags : byte {
  43         SPBF_NONE        = 0,
  44         SPBF_FLOAT_LEFT  = 1 << 0,
  45         SPBF_FLOAT_RIGHT = 1 << 1,
  46 };
  47 DECLARE_ENUM_AS_BIT_SET(StoryPageButtonFlags)
  48
  49 /** Mouse cursors usable by story page buttons. */
  50 enum StoryPageButtonCursor : byte {
  51         SPBC_MOUSE,
  52         SPBC_ZZZ,
  53         SPBC_BUOY,
  54         SPBC_QUERY,
  55         SPBC_HQ,
  56         SPBC_SHIP_DEPOT,
  57         SPBC_SIGN,
  58         SPBC_TREE,
  59         SPBC_BUY_LAND,
  60         SPBC_LEVEL_LAND,
  61         SPBC_TOWN,
  62         SPBC_INDUSTRY,
  63         SPBC_ROCKY_AREA,
  64         SPBC_DESERT,
  65         SPBC_TRANSMITTER,
  66         SPBC_AIRPORT,
  67         SPBC_DOCK,
  68         SPBC_CANAL,
  69         SPBC_LOCK,
  70         SPBC_RIVER,
  71         SPBC_AQUEDUCT,
  72         SPBC_BRIDGE,
  73         SPBC_RAIL_STATION,
  74         SPBC_TUNNEL_RAIL,
  75         SPBC_TUNNEL_ELRAIL,
  76         SPBC_TUNNEL_MONO,
  77         SPBC_TUNNEL_MAGLEV,
  78         SPBC_AUTORAIL,
  79         SPBC_AUTOELRAIL,
  80         SPBC_AUTOMONO,
  81         SPBC_AUTOMAGLEV,
  82         SPBC_WAYPOINT,
  83         SPBC_RAIL_DEPOT,
  84         SPBC_ELRAIL_DEPOT,
  85         SPBC_MONO_DEPOT,
  86         SPBC_MAGLEV_DEPOT,
  87         SPBC_CONVERT_RAIL,
  88         SPBC_CONVERT_ELRAIL,
  89         SPBC_CONVERT_MONO,
  90         SPBC_CONVERT_MAGLEV,
  91         SPBC_AUTOROAD,
  92         SPBC_AUTOTRAM,
  93         SPBC_ROAD_DEPOT,
  94         SPBC_BUS_STATION,
  95         SPBC_TRUCK_STATION,
  96         SPBC_ROAD_TUNNEL,
  97         SPBC_CLONE_TRAIN,
  98         SPBC_CLONE_ROADVEH,
  99         SPBC_CLONE_SHIP,
 100         SPBC_CLONE_AIRPLANE,
 101         SPBC_DEMOLISH,
 102         SPBC_LOWERLAND,
 103         SPBC_RAISELAND,
 104         SPBC_PICKSTATION,
 105         SPBC_BUILDSIGNALS,
 106         SPBC_END,
 107         INVALID_SPBC = 0xFF
 108 };
 109
 110 /**
 111  * Checks if a StoryPageButtonCursor value is valid.
 112  *
 113  * @param wc The value to check
 114  * @return true if the given value is a valid StoryPageButtonCursor.
 115  */
 116 inline bool IsValidStoryPageButtonCursor(StoryPageButtonCursor cursor)
 117 {
 118         return cursor < SPBC_END;
 119 }
 120
 121 /** Helper to construct packed "id" values for button-type StoryPageElement */
 122 struct StoryPageButtonData {
 123         uint32_t referenced_id;
 124
 125         void SetColour(Colours button_colour);
 126         void SetFlags(StoryPageButtonFlags flags);
 127         void SetCursor(StoryPageButtonCursor cursor);
 128         void SetVehicleType(VehicleType vehtype);
 129         Colours GetColour() const;
 130         StoryPageButtonFlags GetFlags() const;
 131         StoryPageButtonCursor GetCursor() const;
 132         VehicleType GetVehicleType() const;
 133         bool ValidateColour() const;
 134         bool ValidateFlags() const;
 135         bool ValidateCursor() const;
 136         bool ValidateVehicleType() const;
 137 };
 138
 139 /**
 140  * Struct about story page elements.
 141  * Each StoryPage is composed of one or more page elements that provide
 142  * page content. Each element only contain one type of content.
 143  **/
 144 struct StoryPageElement : StoryPageElementPool::PoolItem<&_story_page_element_pool> {
 145         uint32_t sort_value;         ///< A number that increases for every created story page element. Used for sorting. The id of a story page element is the pool index.
 146         StoryPageID page;          ///< Id of the page which the page element belongs to
 147         StoryPageElementType type; ///< Type of page element
 148
 149         uint32_t referenced_id;      ///< Id of referenced object (location, goal etc.)
 150         std::string text;          ///< Static content text of page element
 151
 152         /**
 153          * We need an (empty) constructor so struct isn't zeroed (as C++ standard states)
 154          */
 155         inline StoryPageElement() { }
 156
 157         /**
 158          * (Empty) destructor has to be defined else operator delete might be called with nullptr parameter
 159          */
 160         inline ~StoryPageElement() { }
 161 };
 162
 163 /** Struct about stories, current and completed */
 164 struct StoryPage : StoryPagePool::PoolItem<&_story_page_pool> {
 165         uint32_t sort_value;            ///< A number that increases for every created story page. Used for sorting. The id of a story page is the pool index.
 166         TimerGameCalendar::Date date; ///< Date when the page was created.
 167         CompanyID company;            ///< StoryPage is for a specific company; INVALID_COMPANY if it is global
 168
 169         std::string title;            ///< Title of story page
 170
 171         /**
 172          * We need an (empty) constructor so struct isn't zeroed (as C++ standard states)
 173          */
 174         inline StoryPage() { }
 175
 176         /**
 177          * (Empty) destructor has to be defined else operator delete might be called with nullptr parameter
 178          */
 179         inline ~StoryPage()
 180         {
 181                 if (!this->CleaningPool()) {
 182                         for (StoryPageElement *spe : StoryPageElement::Iterate()) {
 183                                 if (spe->page == this->index) delete spe;
 184                         }
 185                 }
 186         }
 187 };
 188
 189 #endif /* STORY_BASE_H */
 190