src/script/api/script_storypageelementlist.hpp

   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 script_storypageelementlist.hpp List all story page elements. */
   9
  10 #ifndef SCRIPT_STORYPAGEELEMENTLIST_HPP
  11 #define SCRIPT_STORYPAGEELEMENTLIST_HPP
  12
  13 #include "script_list.hpp"
  14 #include "script_company.hpp"
  15 #include "script_story_page.hpp"
  16
  17 /**
  18  * Create a list of all story page elements.
  19  * @api game
  20  * @ingroup ScriptList
  21  */
  22 class ScriptStoryPageElementList : public ScriptList {
  23 public:
  24         /**
  25          * @param story_page_id The page id of the story page of which all page elements should be included in the list.
  26          */
  27         ScriptStoryPageElementList(ScriptStoryPage::StoryPageID story_page_id);
  28 };
  29
  30 #endif /* SCRIPT_STORYPAGEELEMENTLIST_HPP */