ds_priority_delete_min

Returns the value in the priority queue with the smallest priority, and deletes it.

Syntax:

ds_priority_delete_min(id);


Argument Description
id The id of the priority queue to use.


Returns: Real or String


Description

This function will return the value that has the lowest priority in the queue and then remove the value (and priority) from the data structure. If more than one value has the same priority, the one that was added to the priority queue first will be the one to get removed, but all other values with the same priority will still be in the queue.


Example:

if ai_move
   {
   script_execute(ds_priority_delete_min(ai_priority));
   }

The above code checks an instance variable and if it returns true it will execute a script indexed in the priority queue with the lowest priority value and then remove that script from the queue.


Back: DS Priority Queues
Next: ds_priority_delete_value
© Copyright YoYo Games Ltd. 2015 All Rights Reserved