Editing Ar Map

==Description==
Added by NVSE V4. Returns a "map" or "stringmap" array variable with the specified key::element pairs as its entries. 

Up to 20 key::element pairs may specified during creation, although more can be added using alternative functions on subsequent lines.

All keys must be of the same type, either int or string, which will cause the function to return an array of the type "map" or "stringmap", respectively.

Array elements may be of any type in any combination. To assign the function return to a variable, the [[Let]] command must be used, rather than 'set'. 

==Syntax==
<pre>
(array) Ar_Map Key(int-or-str)::Value(multi) ...
</pre>
==Example==
<pre>
array_var aOutfit
ref rItem

let aOutfit := Ar_Map 2::ArmorLeather, 10::CowboyHat05, 5::WeapNV357Revolver

; I've created a "map" with those 3 key::element entries

let rItem := aOutfit[10] ; this ref now points to CowboyHat05
</pre>

Identical style for a "stringmap":
<pre>
array_var aContacts
ref rActor

let aContacts := Ar_Map "Nemesis"::EasyPeteREF, "Saviour"::DocMitchelREF, "Bestie"::SunnyREF

; I've created a "stringmap" with those 3 key::element entries

let rActor := aContacts["Nemesis"] ; rActor is my nemesis, EasyPeteREF
</pre>

The next example illustrates a possible mistake- it is <u>incorrect</u> and will fail:
<pre>
array_var aPartners

let aPartners := Ar_Map SunnyREF::EasyPeteREF, VeronicaREF::CraigBooneREF

; FAILURE- you can not use a ref as a key, it must be either a string or int. 
; Side note: NVSE4 adds ToNumber and ToString to convert types

let aPartners := Ar_Map "key"::SunnyREF, 45::VeronicaREF

; FAILURE- all keys must be the same type, either string or int, not a combination of both

</pre>
==See Also==
*[[Array Variables]]
*[[Ar_List]]
*[[Ar_Construct]]
*[[Let]]
*[[Foreach]]
*[[ToString]]
*[[ToNumber]]
[[Category:Functions_(NVSE)]]
[[Category:Array Variables]]