summaryrefslogtreecommitdiff
path: root/src/script/api/script_storypagelist.hpp
blob: 7aa3389f32d25d2eee3af217dbe433e210b8ab5f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/* $Id$ */

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */

/** @file script_storypagelist.hpp List all story pages. */

#ifndef SCRIPT_STORYPAGELIST_HPP
#define SCRIPT_STORYPAGELIST_HPP

#include "script_list.hpp"
#include "script_company.hpp"

/**
 * Create a list of all story pages.
 * @api game
 * @ingroup ScriptList
 */
class ScriptStoryPageList : public ScriptList {
public:
	/**
	 * @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.
	 */
	ScriptStoryPageList(ScriptCompany::CompanyID company);
};

#endif /* SCRIPT_STORYPAGELIST_HPP */