OpenTTD GameScript API  20240328-master-gca53e134be
Public Member Functions
GSTownList Class Reference

Creates a list of towns that are currently on the map. More...

Inheritance diagram for GSTownList:
GSList

Public Member Functions

 GSTownList (void *filter_function, int params,...)
 Apply a filter when building the list. More...
 
- Public Member Functions inherited from GSList
void AddItem (SQInteger item, SQInteger value)
 Add a single item to the list. More...
 
void RemoveItem (SQInteger item)
 Remove a single item from the list. More...
 
void Clear ()
 Clear the list, making Count() returning 0 and IsEmpty() returning true.
 
bool HasItem (SQInteger item)
 Check if an item is in the list. More...
 
SQInteger Begin ()
 Go to the beginning of the list and return the item. More...
 
SQInteger 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...
 
SQInteger Count ()
 Returns the amount of items in the list. More...
 
SQInteger GetValue (SQInteger item)
 Get the value that belongs to this item. More...
 
bool SetValue (SQInteger item, SQInteger 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 (GSList *list)
 Add one list to another one. More...
 
void SwapList (GSList *list)
 Swap the contents of two lists. More...
 
void RemoveAboveValue (SQInteger value)
 Removes all items with a higher value than 'value'. More...
 
void RemoveBelowValue (SQInteger value)
 Removes all items with a lower value than 'value'. More...
 
void RemoveBetweenValue (SQInteger start, SQInteger end)
 Removes all items with a value above start and below end. More...
 
void RemoveValue (SQInteger value)
 Remove all items with this value. More...
 
void RemoveTop (SQInteger count)
 Remove the first count items. More...
 
void RemoveBottom (SQInteger count)
 Remove the last count items. More...
 
void RemoveList (GSList *list)
 Remove everything that is in the given list from this list (same item index that is). More...
 
void KeepAboveValue (SQInteger value)
 Keep all items with a higher value than 'value'. More...
 
void KeepBelowValue (SQInteger value)
 Keep all items with a lower value than 'value'. More...
 
void KeepBetweenValue (SQInteger start, SQInteger end)
 Keep all items with a value above start and below end. More...
 
void KeepValue (SQInteger value)
 Keep all items with this value. More...
 
void KeepTop (SQInteger count)
 Keep the first count items, i.e. More...
 
void KeepBottom (SQInteger count)
 Keep the last count items, i.e. More...
 
void KeepList (GSList *list)
 Keeps everything that is in the given list from this list (same item index that is). More...
 
void Valuate (void *valuator_function, int params,...)
 Give all items a value defined by the valuator you give. More...
 

Additional Inherited Members

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

Detailed Description

Creates a list of towns that are currently on the map.

Constructor & Destructor Documentation

◆ GSTownList()

GSTownList::GSTownList ( void *  filter_function,
int  params,
  ... 
)

Apply a filter when building the list.

Parameters
filter_functionThe function which will be doing the filtering.
paramsThe params to give to the filters (minus the first param, which is always the index-value).
Note
You can write your own filters and use them. Just remember that the first parameter should be the index-value, and it should return a bool.
Example: GSTownList(GSTown.IsActionAvailable, GSTown.TOWN_ACTION_BRIBE); function MinPopulation(town_id, pop) { return GSTown.GetPopulation(town_id) >= pop; } GSTownList(MinPopulation, 1000);