OpenTTD-patches/src/script/api/script_cargolist.hpp

/* $Id$ */

/*
 * 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_cargolist.hpp List all the cargos. */

#ifndef SCRIPT_CARGOLIST_HPP
#define SCRIPT_CARGOLIST_HPP

#include "script_list.hpp"

/**
 * Creates a list of cargos that can be produced in the current game.
 * @api ai
 * @ingroup ScriptList
 */
class ScriptCargoList : public ScriptList {
public:
	ScriptCargoList();
};

/**
 * Creates a list of cargos that the given industry accepts.
 * @note This list also includes cargos that are temporarily not accepted
 *   by this industry, @see ScriptIndustry::IsCargoAccepted.
 * @api ai
 * @ingroup ScriptList
 */
class ScriptCargoList_IndustryAccepting : public ScriptList {
public:
	/**
	 * @param industry_id The industry to get the list of cargos it accepts from.
	 */
	ScriptCargoList_IndustryAccepting(IndustryID industry_id);
};

/**
 * Creates a list of cargos that the given industry can produce.
 * @api ai
 * @ingroup ScriptList
 */
class ScriptCargoList_IndustryProducing : public ScriptList {
public:
	/**
	 * @param industry_id The industry to get the list of cargos it produces from.
	 */
	ScriptCargoList_IndustryProducing(IndustryID industry_id);
};

/**
 * Creates a list of cargos that the given station accepts.
 * @api ai
 * @ingroup ScriptList
 */
class ScriptCargoList_StationAccepting : public ScriptList {
public:
	/**
	 * @param station_id The station to get the list of cargos it accepts from.
	 */
	ScriptCargoList_StationAccepting(StationID station_id);
};

#endif /* SCRIPT_CARGOLIST_HPP */