ds_map_find_value

Finds the key specified and returns the paired value from the ds_map.

Syntax:

ds_map_find_value(id, key)


Argument Description
id The id of the map to use.
key The key to find.


Returns: Real, string or undefined


Description

With this function you can get the value from a specified key. The input values of the function are the (previously created) ds_map to use and the key to check for.

NOTE: If no such key exists then the function will return <undefined>. You should always check this using the is_undefined() function.


Example:

amount = ds_map_find_value(inventory, "food");

Or, using the map accessor "?":

amount = inventory[? "food"];

The above code will get the value of the key "food" and store it in the variable "amount".


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