ds_map_clear

Clears all of the data from a given map.

Syntax:

ds_map_clear(id);


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


Returns: N/A.


Description

This function will clear the (previously created) ds_map of all key/value pairs, but it will not delete the ds_map itself from memory. For that you should use the function ds_map_destroy.



Example:

if global.new_game
   {
   ds_map_clear(inventory);
   }

The above function will check a global variable to see if it is true and, if it is, then the ds_map indexed in the instance variable "inventory" will be cleared of all key/value pairs (but it is not destroyed).


Back: DS Maps
Next: ds_map_copy
© Copyright YoYo Games Ltd. 2018 All Rights Reserved