2009-08-21 22:21:05 +02:00
|
|
|
/*
|
|
|
|
* 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/>.
|
|
|
|
*/
|
|
|
|
|
2011-12-15 22:56:00 +01:00
|
|
|
/** @file script_cargolist.hpp List all the cargoes. */
|
2009-01-12 18:11:45 +01:00
|
|
|
|
2011-11-30 00:07:38 +01:00
|
|
|
#ifndef SCRIPT_CARGOLIST_HPP
|
|
|
|
#define SCRIPT_CARGOLIST_HPP
|
2009-01-12 18:11:45 +01:00
|
|
|
|
2011-11-30 00:07:38 +01:00
|
|
|
#include "script_list.hpp"
|
2009-01-12 18:11:45 +01:00
|
|
|
|
|
|
|
/**
|
2011-12-15 22:56:00 +01:00
|
|
|
* Creates a list of cargoes that can be produced in the current game.
|
2011-12-19 21:57:34 +01:00
|
|
|
* @api ai game
|
2011-11-30 00:15:35 +01:00
|
|
|
* @ingroup ScriptList
|
2009-01-12 18:11:45 +01:00
|
|
|
*/
|
2011-11-30 00:15:35 +01:00
|
|
|
class ScriptCargoList : public ScriptList {
|
2009-01-12 18:11:45 +01:00
|
|
|
public:
|
2011-11-30 00:15:35 +01:00
|
|
|
ScriptCargoList();
|
2009-01-12 18:11:45 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2011-12-15 22:56:00 +01:00
|
|
|
* Creates a list of cargoes that the given industry accepts.
|
|
|
|
* @note This list also includes cargoes that are temporarily not accepted
|
2011-11-30 00:15:35 +01:00
|
|
|
* by this industry, @see ScriptIndustry::IsCargoAccepted.
|
2011-12-19 21:57:34 +01:00
|
|
|
* @api ai game
|
2011-11-30 00:15:35 +01:00
|
|
|
* @ingroup ScriptList
|
2009-01-12 18:11:45 +01:00
|
|
|
*/
|
2011-11-30 00:15:35 +01:00
|
|
|
class ScriptCargoList_IndustryAccepting : public ScriptList {
|
2009-01-12 18:11:45 +01:00
|
|
|
public:
|
|
|
|
/**
|
2011-12-15 22:56:00 +01:00
|
|
|
* @param industry_id The industry to get the list of cargoes it accepts from.
|
2009-01-12 18:11:45 +01:00
|
|
|
*/
|
2011-11-30 00:15:35 +01:00
|
|
|
ScriptCargoList_IndustryAccepting(IndustryID industry_id);
|
2009-01-12 18:11:45 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2011-12-15 22:56:00 +01:00
|
|
|
* Creates a list of cargoes that the given industry can produce.
|
2011-12-19 21:57:34 +01:00
|
|
|
* @api ai game
|
2011-11-30 00:15:35 +01:00
|
|
|
* @ingroup ScriptList
|
2009-01-12 18:11:45 +01:00
|
|
|
*/
|
2011-11-30 00:15:35 +01:00
|
|
|
class ScriptCargoList_IndustryProducing : public ScriptList {
|
2009-01-12 18:11:45 +01:00
|
|
|
public:
|
|
|
|
/**
|
2011-12-15 22:56:00 +01:00
|
|
|
* @param industry_id The industry to get the list of cargoes it produces from.
|
2009-01-12 18:11:45 +01:00
|
|
|
*/
|
2011-11-30 00:15:35 +01:00
|
|
|
ScriptCargoList_IndustryProducing(IndustryID industry_id);
|
2009-01-12 18:11:45 +01:00
|
|
|
};
|
|
|
|
|
2011-11-08 16:44:53 +01:00
|
|
|
/**
|
2011-12-15 22:56:00 +01:00
|
|
|
* Creates a list of cargoes that the given station accepts.
|
2011-12-19 21:57:34 +01:00
|
|
|
* @api ai game
|
2011-11-30 00:15:35 +01:00
|
|
|
* @ingroup ScriptList
|
2011-11-08 16:44:53 +01:00
|
|
|
*/
|
2011-11-30 00:15:35 +01:00
|
|
|
class ScriptCargoList_StationAccepting : public ScriptList {
|
2011-11-08 16:44:53 +01:00
|
|
|
public:
|
|
|
|
/**
|
2011-12-15 22:56:00 +01:00
|
|
|
* @param station_id The station to get the list of cargoes it accepts from.
|
2011-11-08 16:44:53 +01:00
|
|
|
*/
|
2011-11-30 00:15:35 +01:00
|
|
|
ScriptCargoList_StationAccepting(StationID station_id);
|
2011-11-08 16:44:53 +01:00
|
|
|
};
|
|
|
|
|
2011-11-30 00:07:38 +01:00
|
|
|
#endif /* SCRIPT_CARGOLIST_HPP */
|