Files
@ r11718:aded86618f59
Branch filter:
Location: cpp/openttd-patchpack/source/src/ai/api/ai_tilelist.hpp
r11718:aded86618f59
3.2 KiB
text/x-c++hdr
(svn r16111) -Cleanup: remove some duplicate/unused strings
-Change: move a string to a more sensible location
-Change: move a string to a more sensible location
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 | /* $Id$ */
/** @file ai_tilelist.hpp List tiles. */
#ifndef AI_TILELIST_HPP
#define AI_TILELIST_HPP
#include "ai_abstractlist.hpp"
#include "ai_station.hpp"
/**
* Creates an empty list, in which you can add tiles.
* @ingroup AIList
*/
class AITileList : public AIAbstractList {
public:
static const char *GetClassName() { return "AITileList"; }
private:
/**
* Make sure t1.x is smaller than t2.x and t1.y is smaller than t2.y.
* They are swapped to ensure they are after calling this function.
* @param t1 one of the corners of the rectangle.
* @param t2 the other corner of the rectangle.
*/
void FixRectangleSpan(TileIndex &t1, TileIndex &t2);
public:
/**
* Adds the rectangle between tile_from and tile_to to the to-be-evaluated tiles.
* @param tile_from One corner of the tiles to add.
* @param tile_to The other corner of the tiles to add.
* @pre AIMap::IsValidTile(tile_from).
* @pre AIMap::IsValidTile(tile_to).
*/
void AddRectangle(TileIndex tile_from, TileIndex tile_to);
/**
* Add a tile to the to-be-evaluated tiles.
* @param tile The tile to add.
* @pre AIMap::IsValidTile(tile).
*/
void AddTile(TileIndex tile);
/**
* Remove the tiles inside the rectangle between tile_from and tile_to form the list.
* @param tile_from One corner of the tiles to remove.
* @param tile_to The other corner of the files to remove.
* @pre AIMap::IsValidTile(tile_from).
* @pre AIMap::IsValidTile(tile_to).
*/
void RemoveRectangle(TileIndex tile_from, TileIndex tile_to);
/**
* Remove a tile from the list.
* @param tile The tile to remove.
* @pre AIMap::IsValidTile(tile).
*/
void RemoveTile(TileIndex tile);
};
/**
* Creates a list of tiles that will accept cargo for the given industry.
* @note If a simular industry is close, it might happen that this industry receives the cargo.
* @ingroup AIList
*/
class AITileList_IndustryAccepting : public AITileList {
public:
static const char *GetClassName() { return "AITileList_IndustryAccepting"; }
/**
* @param industry_id The industry to create the AITileList around.
* @param radius The radius of the station you will be using.
*/
AITileList_IndustryAccepting(IndustryID industry_id, uint radius);
};
/**
* Creates a list of tiles which the industry checks to see if a station is
* there to receive cargo produced by this industry.
* @ingroup AIList
*/
class AITileList_IndustryProducing : public AITileList {
public:
static const char *GetClassName() { return "AITileList_IndustryProducing"; }
/**
* @param industry_id The industry to create the AITileList around.
* @param radius The radius of the station you will be using.
*/
AITileList_IndustryProducing(IndustryID industry_id, uint radius);
};
/**
* Creates a list of tiles which have the requested StationType of the
* StationID.
* @ingroup AIList
*/
class AITileList_StationType : public AITileList {
public:
static const char *GetClassName() { return "AITileList_StationType"; }
/**
* @param station_id The station to create the AITileList for.
* @param station_type The StationType to create the AIList for.
*/
AITileList_StationType(StationID station_id, AIStation::StationType station_type);
};
#endif /* AI_TILELIST_HPP */
|