OpenTTD AI API
20241130-master-g8d394c697c
|
Class that creates a list which can keep item/value pairs, which you can walk. More...
Public Types | |
enum | SorterType { SORT_BY_VALUE , SORT_BY_ITEM } |
Type of sorter. More... | |
Public Member Functions | |
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... | |
Static Public Attributes | |
static const bool | SORT_ASCENDING = true |
Sort ascending. | |
static const bool | SORT_DESCENDING = false |
Sort descending. | |
Class that creates a list which can keep item/value pairs, which you can walk.
enum AIList::SorterType |
void AIList::AddItem | ( | int | item, |
int | value | ||
) |
Add a single item to the list.
item | the item to add. Should be unique, otherwise it is ignored. |
value | the value to assign. |
void AIList::AddList | ( | AIList * | list | ) |
Add one list to another one.
list | The list that will be added to the caller. |
int AIList::Begin | ( | ) |
Go to the beginning of the list and return the item.
To get the value use list.GetValue(list.Begin()).
int AIList::Count | ( | ) |
Returns the amount of items in the list.
int AIList::GetValue | ( | int | item | ) |
Get the value that belongs to this item.
item | the item to get the value from |
bool AIList::HasItem | ( | int | item | ) |
Check if an item is in the list.
item | the item to check for. |
bool AIList::IsEmpty | ( | ) |
Check if a list is empty.
bool AIList::IsEnd | ( | ) |
void AIList::KeepAboveValue | ( | int | value | ) |
Keep all items with a higher value than 'value'.
value | the value above which all items are kept. |
void AIList::KeepBelowValue | ( | int | value | ) |
Keep all items with a lower value than 'value'.
value | the value below which all items are kept. |
void AIList::KeepBetweenValue | ( | int | start, |
int | end | ||
) |
Keep all items with a value above start and below end.
start | the lower bound of the to be kept values (exclusive). |
end | the upper bound of the to be kept values (exclusive). |
void AIList::KeepBottom | ( | int | count | ) |
Keep the last count items, i.e.
remove everything except the last count items.
count | the amount of items to keep. |
void AIList::KeepList | ( | AIList * | list | ) |
Keeps everything that is in the given list from this list (same item index that is).
list | the list of items to keep. |
void AIList::KeepTop | ( | int | count | ) |
Keep the first count items, i.e.
remove everything except the first count items.
count | the amount of items to keep. |
void AIList::KeepValue | ( | int | value | ) |
Keep all items with this value.
value | the value to keep. |
int AIList::Next | ( | ) |
Go to the next item in the list and return the item.
To get the value use list.GetValue(list.Next()).
void AIList::RemoveAboveValue | ( | int | value | ) |
Removes all items with a higher value than 'value'.
value | the value above which all items are removed. |
void AIList::RemoveBelowValue | ( | int | value | ) |
Removes all items with a lower value than 'value'.
value | the value below which all items are removed. |
void AIList::RemoveBetweenValue | ( | int | start, |
int | end | ||
) |
Removes all items with a value above start and below end.
start | the lower bound of the to be removed values (exclusive). |
end | the upper bound of the to be removed values (exclusive). |
void AIList::RemoveBottom | ( | int | count | ) |
Remove the last count items.
count | the amount of items to remove. |
void AIList::RemoveItem | ( | int | item | ) |
Remove a single item from the list.
item | the item to remove. If not existing, it is ignored. |
void AIList::RemoveList | ( | AIList * | list | ) |
Remove everything that is in the given list from this list (same item index that is).
list | the list of items to remove. |
void AIList::RemoveTop | ( | int | count | ) |
Remove the first count items.
count | the amount of items to remove. |
void AIList::RemoveValue | ( | int | value | ) |
Remove all items with this value.
value | the value to remove. |
bool AIList::SetValue | ( | int | item, |
int | value | ||
) |
Set a value of an item directly.
item | the item to set the value for. |
value | the value to give to the item |
void AIList::Sort | ( | SorterType | sorter, |
bool | ascending | ||
) |
Sort this list by the given sorter and direction.
sorter | the type of sorter to use |
ascending | if true, lowest value is on top, else at bottom. |
void AIList::SwapList | ( | AIList * | list | ) |
Swap the contents of two lists.
list | The list that will be swapped with. |
void AIList::Valuate | ( | function | valuator_function, |
... | |||
) |
Give all items a value defined by the valuator you give.
valuator_function | The function which will be doing the valuation. |
... | The params to give to the valuators (minus the first param, which is always the index-value we are valuating). |