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_clientlist.hpp List all the TODO. */
9 
10 #ifndef SCRIPT_CLIENTLIST_HPP
11 #define SCRIPT_CLIENTLIST_HPP
12 
13 #include "script_list.hpp"
14 #include "script_company.hpp"
15 
16 
17 /**
18  * Creates a list of clients that are currently in game.
19  * @api game
20  * @ingroup ScriptList
21  */
22 class ScriptClientList : public ScriptList {
23 public:
24 	ScriptClientList();
25 };
26 
27 /**
28  * Creates a list of clients that are playing in the company.
29  * @api game
30  * @ingroup ScriptList
31  */
32 class ScriptClientList_Company : public ScriptList {
33 public:
34 	/**
35 	 * @param company_id The company to list clients for.
36 	 */
37 	ScriptClientList_Company(ScriptCompany::CompanyID company);
38 };
39 
40 #endif /* SCRIPT_CIENTLIST_HPP */
41