story_base.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 STORY_BASE_H
#define STORY_BASE_H
 
#include "company_type.h"
#include "story_type.h"
#include "strings_type.h"
#include "timer/timer_game_calendar.h"
#include "gfx_type.h"
#include "vehicle_type.h"
#include "core/pool_type.hpp"
 
using StoryPageElementPool = Pool<StoryPageElement, StoryPageElementID, 64>;
using StoryPagePool = Pool<StoryPage, StoryPageID, 64>;
extern StoryPageElementPool _story_page_element_pool;
extern StoryPagePool _story_page_pool;
extern uint32_t _story_page_element_next_sort_value;
extern uint32_t _story_page_next_sort_value;
 
/*
 * Each story page element is one of these types.
 */
enum StoryPageElementType : uint8_t {
  SPET_TEXT = 0,       
  SPET_LOCATION,       
  SPET_GOAL,           
  SPET_BUTTON_PUSH,    
  SPET_BUTTON_TILE,    
  SPET_BUTTON_VEHICLE, 
  SPET_END,
  INVALID_SPET = 0xFF,
};
 
enum StoryPageButtonFlags : uint8_t {
  SPBF_NONE        = 0,
  SPBF_FLOAT_LEFT  = 1 << 0,
  SPBF_FLOAT_RIGHT = 1 << 1,
};
DECLARE_ENUM_AS_BIT_SET(StoryPageButtonFlags)
 
 
enum StoryPageButtonCursor : uint8_t {
  SPBC_MOUSE,
  SPBC_ZZZ,
  SPBC_BUOY,
  SPBC_QUERY,
  SPBC_HQ,
  SPBC_SHIP_DEPOT,
  SPBC_SIGN,
  SPBC_TREE,
  SPBC_BUY_LAND,
  SPBC_LEVEL_LAND,
  SPBC_TOWN,
  SPBC_INDUSTRY,
  SPBC_ROCKY_AREA,
  SPBC_DESERT,
  SPBC_TRANSMITTER,
  SPBC_AIRPORT,
  SPBC_DOCK,
  SPBC_CANAL,
  SPBC_LOCK,
  SPBC_RIVER,
  SPBC_AQUEDUCT,
  SPBC_BRIDGE,
  SPBC_RAIL_STATION,
  SPBC_TUNNEL_RAIL,
  SPBC_TUNNEL_ELRAIL,
  SPBC_TUNNEL_MONO,
  SPBC_TUNNEL_MAGLEV,
  SPBC_AUTORAIL,
  SPBC_AUTOELRAIL,
  SPBC_AUTOMONO,
  SPBC_AUTOMAGLEV,
  SPBC_WAYPOINT,
  SPBC_RAIL_DEPOT,
  SPBC_ELRAIL_DEPOT,
  SPBC_MONO_DEPOT,
  SPBC_MAGLEV_DEPOT,
  SPBC_CONVERT_RAIL,
  SPBC_CONVERT_ELRAIL,
  SPBC_CONVERT_MONO,
  SPBC_CONVERT_MAGLEV,
  SPBC_AUTOROAD,
  SPBC_AUTOTRAM,
  SPBC_ROAD_DEPOT,
  SPBC_BUS_STATION,
  SPBC_TRUCK_STATION,
  SPBC_ROAD_TUNNEL,
  SPBC_CLONE_TRAIN,
  SPBC_CLONE_ROADVEH,
  SPBC_CLONE_SHIP,
  SPBC_CLONE_AIRPLANE,
  SPBC_DEMOLISH,
  SPBC_LOWERLAND,
  SPBC_RAISELAND,
  SPBC_PICKSTATION,
  SPBC_BUILDSIGNALS,
  SPBC_END,
  INVALID_SPBC = 0xFF
};
 
inline bool IsValidStoryPageButtonCursor(StoryPageButtonCursor cursor)
{
  return cursor < SPBC_END;
}
 
struct StoryPageButtonData {
  uint32_t referenced_id = 0;
 
  void SetColour(Colours button_colour);
  void SetFlags(StoryPageButtonFlags flags);
  void SetCursor(StoryPageButtonCursor cursor);
  void SetVehicleType(VehicleType vehtype);
  Colours GetColour() const;
  StoryPageButtonFlags GetFlags() const;
  StoryPageButtonCursor GetCursor() const;
  VehicleType GetVehicleType() const;
  bool ValidateColour() const;
  bool ValidateFlags() const;
  bool ValidateCursor() const;
  bool ValidateVehicleType() const;
};
 
struct StoryPageElement : StoryPageElementPool::PoolItem<&_story_page_element_pool> {
  uint32_t sort_value = 0; 
  StoryPageID page{}; 
  StoryPageElementType type{}; 
 
  uint32_t referenced_id = 0; 
  EncodedString text{}; 
 
  StoryPageElement() { }
  StoryPageElement(uint32_t sort_value, StoryPageElementType type, StoryPageID page) :
    sort_value(sort_value), page(page), type(type) { }
 
  ~StoryPageElement() { }
};
 
struct StoryPage : StoryPagePool::PoolItem<&_story_page_pool> {
  uint32_t sort_value = 0; 
  TimerGameCalendar::Date date{}; 
  CompanyID company = CompanyID::Invalid(); 
 
  EncodedString title; 
 
  StoryPage() { }
  StoryPage(uint32_t sort_value, TimerGameCalendar::Date date, CompanyID company, const EncodedString &title) :
    sort_value(sort_value), date(date), company(company), title(title) {}
 
  ~StoryPage();
};
 
#endif /* STORY_BASE_H */