src/script/api/script_bridgelist.hpp

   1 /* $Id: script_bridgelist.hpp 23615 2011-12-19 20:57:34Z 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_bridgelist.hpp List all the bridges. */
  11
  12 #ifndef SCRIPT_BRIDGELIST_HPP
  13 #define SCRIPT_BRIDGELIST_HPP
  14
  15 #include "script_list.hpp"
  16
  17 /**
  18  * Create a list of bridges types.
  19  * @api ai game
  20  * @ingroup ScriptList
  21  */
  22 class ScriptBridgeList : public ScriptList {
  23 public:
  24         ScriptBridgeList();
  25 };
  26
  27 /**
  28  * Create a list of bridges types that can be built on a specific length.
  29  * @api ai game
  30  * @ingroup ScriptList
  31  */
  32 class ScriptBridgeList_Length : public ScriptList {
  33 public:
  34         /**
  35          * @param length The length of the bridge you want to build.
  36          */
  37         ScriptBridgeList_Length(uint length);
  38 };
  39
  40 #endif /* SCRIPT_BRIDGELIST_HPP */