src/story_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 story_type.h basic types related to story pages */
   9
  10 #ifndef STORY_TYPE_H
  11 #define STORY_TYPE_H
  12
  13 #include "core/enum_type.hpp"
  14
  15 typedef uint16_t StoryPageElementID; ///< ID of a story page element
  16 typedef uint16_t StoryPageID; ///< ID of a story page
  17 struct StoryPageElement;
  18 struct StoryPage;
  19 enum StoryPageElementType : uint8_t;
  20
  21 static const StoryPageElementID INVALID_STORY_PAGE_ELEMENT = 0xFFFF; ///< Constant representing a non-existing story page element.
  22 static const StoryPageID INVALID_STORY_PAGE = 0xFFFF; ///< Constant representing a non-existing story page.
  23
  24 #endif /* STORY_TYPE_H */
  25