OpenTTD GameScript API
20240906-master-gd5ff6b4156
|
Class that creates a queue which keeps its items ordered by an item priority. More...
Public Member Functions | |
bool | Insert (object item, int priority) |
Add a single item to the queue. More... | |
object | Pop () |
Remove and return the item with the lowest priority. More... | |
object | Peek () |
Get the item with the lowest priority, keeping it in the queue. More... | |
bool | Exists (object item) |
Check if an items is already included in the queue. More... | |
void | Clear () |
Clear the queue, making Count() returning 0 and IsEmpty() returning true. | |
bool | IsEmpty () |
Check if the queue is empty. More... | |
int | Count () |
Returns the amount of items in the queue. More... | |
Class that creates a queue which keeps its items ordered by an item priority.
int GSPriorityQueue::Count | ( | ) |
Returns the amount of items in the queue.
bool GSPriorityQueue::Exists | ( | object | item | ) |
Check if an items is already included in the queue.
item | The item to check whether it's already in this queue. |
bool GSPriorityQueue::Insert | ( | object | item, |
int | priority | ||
) |
Add a single item to the queue.
item | The item to add. Can be any Squirrel type. Should be unique, otherwise it is ignored. |
priority | The priority to assign the item. |
bool GSPriorityQueue::IsEmpty | ( | ) |
Check if the queue is empty.
object GSPriorityQueue::Peek | ( | ) |
Get the item with the lowest priority, keeping it in the queue.
object GSPriorityQueue::Pop | ( | ) |
Remove and return the item with the lowest priority.