(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / story_type.h
blob392249da23416b142d112ff0a910e74c0b9db395
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
10 /** @file story_type.h basic types related to story pages */
12 #ifndef STORY_TYPE_H
13 #define STORY_TYPE_H
15 #include "core/enum_type.hpp"
17 typedef uint16 StoryPageElementID; ///< ID of a story page element
18 typedef uint16 StoryPageID; ///< ID of a story page
19 struct StoryPageElement;
20 struct StoryPage;
22 extern StoryPageElementID _new_story_page_element_id;
23 extern StoryPageID _new_story_page_id;
24 static const StoryPageElementID INVALID_STORY_PAGE_ELEMENT = 0xFFFF; ///< Constant representing a non-existing story page element.
25 static const StoryPageID INVALID_STORY_PAGE = 0xFFFF; ///< Constant representing a non-existing story page.
27 #endif /* STORY_TYPE_H */