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

 
#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;

enum class StoryPageElementType : uint8_t {
  Text = 0, 
  Location, 
  Goal, 
  ButtonPush, 
  ButtonTile, 
  ButtonVehicle, 
  Invalid = 0xFF, 
};

enum class StoryPageButtonFlag : uint8_t {
  FloatLeft, 
  FloatRight, 
};

using StoryPageButtonFlags = EnumBitSet<StoryPageButtonFlag, uint8_t>;

enum class StoryPageButtonCursor : uint8_t {
  Mouse, 
  Zzz, 
  Buoy, 
  Query, 
  HQ, 
  ShipDepot, 
  Sign, 
  Tree, 
  BuyLand, 
  LevelLand, 
  Town, 
  Industry, 
  RockyArea, 
  Desert, 
  Transmitter, 
  Airport, 
  Dock, 
  Canal, 
  Lock, 
  River, 
  Aqueduct, 
  Bridge, 
  RailStation, 
  TunnelRail, 
  TunnelElrail, 
  TunnelMono, 
  TunnelMaglev, 
  AutoRail, 
  AutoElrail, 
  AutoMono, 
  AutoMaglev, 
  Waypoint, 
  RailDepot, 
  ElrailDepot, 
  MonoDepot, 
  MaglevDepot, 
  ConvertRail, 
  ConvertElrail, 
  ConvertMono, 
  ConvertMaglev, 
  AutoRoad, 
  AutoTram, 
  RoadDepot, 
  BusStation, 
  TruckStation, 
  RoadTunnel, 
  CloneTrain, 
  CloneRoadVeh, 
  CloneShip, 
  CloneAirplane, 
  Demolish, 
  LowerLand, 
  RaiseLand, 
  PickStation, 
  BuildSignals, 
  End, 
  Invalid = 0xFF, 
};

inline bool IsValidStoryPageButtonCursor(StoryPageButtonCursor cursor)
{
  return cursor < StoryPageButtonCursor::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(StoryPageElementID index) : StoryPageElementPool::PoolItem<&_story_page_element_pool>(index) {}
  StoryPageElement(StoryPageElementID index, uint32_t sort_value, StoryPageElementType type, StoryPageID page) :
    StoryPageElementPool::PoolItem<&_story_page_element_pool>(index), 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(StoryPageID index) : StoryPagePool::PoolItem<&_story_page_pool>(index) {}
  StoryPage(StoryPageID index, uint32_t sort_value, TimerGameCalendar::Date date, CompanyID company, const EncodedString &title) :
    StoryPagePool::PoolItem<&_story_page_pool>(index), sort_value(sort_value), date(date), company(company), title(title) {}
 
  ~StoryPage();
};
 
#endif /* STORY_BASE_H */