OpenTTD AI API  20241117-master-ga6c526cfa0
Public Member Functions
AITileList_IndustryProducing Class Reference

Creates a list of tiles which the industry checks to see if a station is there to receive cargo produced by this industry. More...

Inheritance diagram for AITileList_IndustryProducing:
AITileList AIList

Public Member Functions

 AITileList_IndustryProducing (IndustryID industry_id, int radius)
 
- Public Member Functions inherited from AITileList
void AddRectangle (TileIndex tile_from, TileIndex tile_to)
 Adds the rectangle between tile_from and tile_to to the to-be-evaluated tiles. More...
 
void AddTile (TileIndex tile)
 Add a tile to the to-be-evaluated tiles. More...
 
void RemoveRectangle (TileIndex tile_from, TileIndex tile_to)
 Remove the tiles inside the rectangle between tile_from and tile_to from the list. More...
 
void RemoveTile (TileIndex tile)
 Remove a tile from the list. More...
 
- Public Member Functions inherited from AIList
void AddItem (int item, int value)
 Add a single item to the list. More...
 
void RemoveItem (int item)
 Remove a single item from the list. More...
 
void Clear ()
 Clear the list, making Count() returning 0 and IsEmpty() returning true.
 
bool HasItem (int item)
 Check if an item is in the list. More...
 
int Begin ()
 Go to the beginning of the list and return the item. More...
 
int Next ()
 Go to the next item in the list and return the item. More...
 
bool IsEmpty ()
 Check if a list is empty. More...
 
bool IsEnd ()
 Check if there is a element left. More...
 
int Count ()
 Returns the amount of items in the list. More...
 
int GetValue (int item)
 Get the value that belongs to this item. More...
 
bool SetValue (int item, int value)
 Set a value of an item directly. More...
 
void Sort (SorterType sorter, bool ascending)
 Sort this list by the given sorter and direction. More...
 
void AddList (AIList *list)
 Add one list to another one. More...
 
void SwapList (AIList *list)
 Swap the contents of two lists. More...
 
void RemoveAboveValue (int value)
 Removes all items with a higher value than 'value'. More...
 
void RemoveBelowValue (int value)
 Removes all items with a lower value than 'value'. More...
 
void RemoveBetweenValue (int start, int end)
 Removes all items with a value above start and below end. More...
 
void RemoveValue (int value)
 Remove all items with this value. More...
 
void RemoveTop (int count)
 Remove the first count items. More...
 
void RemoveBottom (int count)
 Remove the last count items. More...
 
void RemoveList (AIList *list)
 Remove everything that is in the given list from this list (same item index that is). More...
 
void KeepAboveValue (int value)
 Keep all items with a higher value than 'value'. More...
 
void KeepBelowValue (int value)
 Keep all items with a lower value than 'value'. More...
 
void KeepBetweenValue (int start, int end)
 Keep all items with a value above start and below end. More...
 
void KeepValue (int value)
 Keep all items with this value. More...
 
void KeepTop (int count)
 Keep the first count items, i.e. More...
 
void KeepBottom (int count)
 Keep the last count items, i.e. More...
 
void KeepList (AIList *list)
 Keeps everything that is in the given list from this list (same item index that is). More...
 
void Valuate (function valuator_function,...)
 Give all items a value defined by the valuator you give. More...
 

Additional Inherited Members

- Public Types inherited from AIList
enum  SorterType {
  SORT_BY_VALUE ,
  SORT_BY_ITEM
}
 Type of sorter. More...
 
- Static Public Attributes inherited from AIList
static const bool SORT_ASCENDING = true
 Sort ascending.
 
static const bool SORT_DESCENDING = false
 Sort descending.
 

Detailed Description

Creates a list of tiles which the industry checks to see if a station is there to receive cargo produced by this industry.

Constructor & Destructor Documentation

◆ AITileList_IndustryProducing()

AITileList_IndustryProducing::AITileList_IndustryProducing ( IndustryID  industry_id,
int  radius 
)
Parameters
industry_idThe industry to create the AITileList around.
radiusThe coverage radius of the station type you will be using.
Precondition
AIIndustry::IsValidIndustry(industry_id).
radius > 0.
Note
A station part built on any of the returned tiles will give you acceptance.