src/script/api/script_bridgelist.hpp

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