src/script/api/script_storypagelist.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_storypagelist.hpp List all story pages. */
   9
  10 #ifndef SCRIPT_STORYPAGELIST_HPP
  11 #define SCRIPT_STORYPAGELIST_HPP
  12
  13 #include "script_list.hpp"
  14 #include "script_company.hpp"
  15
  16 /**
  17  * Create a list of all story pages.
  18  * @api game
  19  * @ingroup ScriptList
  20  */
  21 class ScriptStoryPageList : public ScriptList {
  22 public:
  23         /**
  24          * @param company The company to list story pages for, or ScriptCompany::COMPANY_INVALID to only show global pages. Global pages are always included independent of this parameter.
  25          */
  26         ScriptStoryPageList(ScriptCompany::CompanyID company);
  27 };
  28
  29 #endif /* SCRIPT_STORYPAGELIST_HPP */