src/script/api/script_grouplist.hpp

   1 /* $Id: script_grouplist.hpp 23370 2011-11-29 23:27:26Z truebrain $ */
   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_grouplist.hpp List all the groups (you own). */
  11
  12 #ifndef SCRIPT_GROUPLIST_HPP
  13 #define SCRIPT_GROUPLIST_HPP
  14
  15 #include "script_list.hpp"
  16
  17 /**
  18  * Creates a list of groups of which you are the owner.
  19  * @note Neither ScriptGroup::GROUP_ALL nor ScriptGroup::GROUP_DEFAULT is in this list.
  20  * @api ai
  21  * @ingroup ScriptList
  22  */
  23 class ScriptGroupList : public ScriptList {
  24 public:
  25         ScriptGroupList();
  26 };
  27
  28 #endif /* SCRIPT_GROUPLIST_HPP */