OpenTTD/src/script/api/script_grouplist.hpp

30 lines
1.1 KiB
C++

/*
* 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_grouplist.hpp List all the groups (you own). */
#ifndef SCRIPT_GROUPLIST_HPP
#define SCRIPT_GROUPLIST_HPP
#include "script_list.hpp"
/**
* Creates a list of groups of which you are the owner.
* @note Neither ScriptGroup::GROUP_ALL nor ScriptGroup::GROUP_DEFAULT is in this list.
* @api ai game
* @ingroup ScriptList
*/
class ScriptGroupList : public ScriptList {
public:
/**
* @game @pre ScriptCompanyMode::IsValid().
*/
ScriptGroupList();
};
#endif /* SCRIPT_GROUPLIST_HPP */