OpenTTD/src/ai/api/ai_vehiclelist.hpp

86 lines
2.5 KiB
C++
Raw Normal View History

/* $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 ai_vehiclelist.hpp List all the vehicles (you own). */
#ifndef AI_VEHICLELIST_HPP
#define AI_VEHICLELIST_HPP
#include "ai_abstractlist.hpp"
#include "ai_vehicle.hpp"
/**
* Creates a list of vehicles of which you are the owner.
* @ingroup AIList
*/
class AIVehicleList : public AIAbstractList {
public:
static const char *GetClassName() { return "AIVehicleList"; }
AIVehicleList();
};
/**
* Creates a list of vehicles that have orders to a given station.
* @ingroup AIList
*/
class AIVehicleList_Station : public AIAbstractList {
public:
static const char *GetClassName() { return "AIVehicleList_Station"; }
/**
* @param station_id The station to get the list of vehicles from, which have orders to it.
* @pre AIBaseStation::IsValidBaseStation(station_id)
*/
AIVehicleList_Station(StationID station_id);
};
/**
* Creates a list of vehicles that share orders.
* @ingroup AIList
*/
class AIVehicleList_SharedOrders : public AIAbstractList {
public:
static const char *GetClassName() { return "AIVehicleList_SharedOrders"; }
/**
* @param vehicle_id The vehicle that the rest shared orders with.
*/
AIVehicleList_SharedOrders(VehicleID vehicle_id);
};
/**
* Creates a list of vehicles that are in a group.
* @ingroup AIList
*/
class AIVehicleList_Group : public AIAbstractList {
public:
static const char *GetClassName() { return "AIVehicleList_Group"; }
/**
* @param group_id The ID of the group the vehicles are in.
*/
AIVehicleList_Group(GroupID group_id);
};
/**
* Creates a list of vehicles that are in the default group.
* @ingroup AIList
*/
class AIVehicleList_DefaultGroup : public AIAbstractList {
public:
static const char *GetClassName() { return "AIVehicleList_DefaultGroup"; }
/**
* @param vehicle_type The VehicleType to get the list of vehicles for.
*/
AIVehicleList_DefaultGroup(AIVehicle::VehicleType vehicle_type);
};
#endif /* AI_VEHICLELIST_HPP */