dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r23355) -Codechange: rename all AI* to Script* (Rubidium)

Browse Source
This commit is contained in:
truebrain
2011-11-29 23:15:35 +00:00
parent afdb67a353
commit 98103121d4
175 changed files with 4048 additions and 4034 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
src/script/api/script_tilelist.hpp
View File

@@ -17,23 +17,23 @@
/**
* Creates an empty list, in which you can add tiles.
* @ingroup AIList
* @ingroup ScriptList
*/
class AITileList : public AIList {
class ScriptTileList : public ScriptList {
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).
* @pre ScriptMap::IsValidTile(tile_from).
* @pre ScriptMap::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).
* @pre ScriptMap::IsValidTile(tile).
*/
void AddTile(TileIndex tile);
@@ -41,15 +41,15 @@ public:
* 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).
* @pre ScriptMap::IsValidTile(tile_from).
* @pre ScriptMap::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).
* @pre ScriptMap::IsValidTile(tile).
*/
void RemoveTile(TileIndex tile);
};
@@ -57,47 +57,47 @@ public:
/**
* 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
* @ingroup ScriptList
*/
class AITileList_IndustryAccepting : public AITileList {
class ScriptTileList_IndustryAccepting : public ScriptTileList {
public:
/**
* @param industry_id The industry to create the AITileList around.
* @param industry_id The industry to create the ScriptTileList around.
* @param radius The radius of the station you will be using.
* @pre AIIndustry::IsValidIndustry(industry_id).
* @pre ScriptIndustry::IsValidIndustry(industry_id).
* @pre radius > 0.
*/
AITileList_IndustryAccepting(IndustryID industry_id, int radius);
ScriptTileList_IndustryAccepting(IndustryID industry_id, int 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
* @ingroup ScriptList
*/
class AITileList_IndustryProducing : public AITileList {
class ScriptTileList_IndustryProducing : public ScriptTileList {
public:
/**
* @param industry_id The industry to create the AITileList around.
* @param industry_id The industry to create the ScriptTileList around.
* @param radius The radius of the station you will be using.
* @pre AIIndustry::IsValidIndustry(industry_id).
* @pre ScriptIndustry::IsValidIndustry(industry_id).
* @pre radius > 0.
*/
AITileList_IndustryProducing(IndustryID industry_id, int radius);
ScriptTileList_IndustryProducing(IndustryID industry_id, int radius);
};
/**
* Creates a list of tiles which have the requested StationType of the
* StationID.
* @ingroup AIList
* @ingroup ScriptList
*/
class AITileList_StationType : public AITileList {
class ScriptTileList_StationType : public ScriptTileList {
public:
/**
* @param station_id The station to create the AITileList for.
* @param station_type The StationType to create the AIList for.
* @param station_id The station to create the ScriptTileList for.
* @param station_type The StationType to create the ScriptList for.
*/
AITileList_StationType(StationID station_id, AIStation::StationType station_type);
ScriptTileList_StationType(StationID station_id, ScriptStation::StationType station_type);
};
#endif /* SCRIPT_TILELIST_HPP */