ds_stack_clear

Clears all of the data from a given stack.

Syntax:

ds_stack_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 stack data-structure. This does NOT destroy the data-structure (for that you should use ds_stack_destroy) it only wipes all data from it and returns an empty stack.


Example:

if ai_count = 15 && !ds_stack_empty(AI_stack)
   {
   ds_stack_clear(AI_stack);
   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_stack indexed in the variable "AI_stack", sets an alarm, and resets the variable to 0.


Back: Stacks
Next: ds_stack_empty
© Copyright YoYo Games Ltd. 2019 All Rights Reserved