OpenTTD GameScript API
20240906-master-gd5ff6b4156
|
Create a list of all story page elements. More...
Public Member Functions | |
GSStoryPageElementList (GSStoryPage::StoryPageID story_page_id) | |
![]() | |
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 (GSList *list) |
Add one list to another one. More... | |
void | SwapList (GSList *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 (GSList *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 (GSList *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 | |
![]() | |
enum | SorterType { SORT_BY_VALUE, SORT_BY_ITEM } |
Type of sorter. More... | |
![]() | |
static const bool | SORT_ASCENDING = true |
Sort ascending. | |
static const bool | SORT_DESCENDING = false |
Sort descending. | |
Create a list of all story page elements.
GSStoryPageElementList::GSStoryPageElementList | ( | GSStoryPage::StoryPageID | story_page_id | ) |
story_page_id | The page id of the story page of which all page elements should be included in the list. |