src/script/api/script_storypageelementlist.hpp

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