ds_priority_clear

Clears all of the data from a given priority queue.

Syntax:

ds_priority_clear(id);


Argument Description
id The id of the data structure to clear.


Returns: N/A


Description

With this function you can clear all data from the given priority queue data-structure. This does NOT destroy the data-structure (for that you should use ds_priority_destroy) it only wipes all data from it and returns an empty priority queue.


Example:

if count = 15 && !ds_priority_empty(command_queue)
   {
   ds_priority_clear(command_queue);
   alarm[0] = room_speed;
   ai_count = 0;
   }

The above code checks a variable to see if it has reached a specific value and if it has it clears the ds_priority queue indexed in the variable "command_queue", sets an alarm, and resets the variable to 0.

Back: Priority Queues
Next: ds_priority_empty
© Copyright YoYo Games Ltd. 2018 All Rights Reserved