RefMapArrayGetString

From the Fallout3 GECK Wiki
Revision as of 23:49, 24 April 2015 by imported>Jazzisparis (Created page with "{{Function |origin = JIP |summary = Returns the string value of the element with a <i>Key</i> matching the specified <i>Object</i>, in the specified RefMap Array. |name...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
< [[::Category:Functions|Category:Functions]]

A function added by the JIP NVSE Plugin.

Description

Returns the string value of the element with a Key matching the specified Object, in the specified RefMap Array.

Syntax

[help]
(value:string_var) reference.RefMapArrayGetString arrName:string baseForm:ref 

Or:

(value:string_var) reference.RefMapGetStr arrName:string baseForm:ref

Example

let sValue := RaulRef.RefMapArrayGetString "someRefMap"
let sValue := RefMapGetStr "someRefMap" ArmorCombat

Notes

  • The function will return a null string if the RefMap is not defined/has no matching Key/element is not of type string. When necessary, verify using RefMapArrayGetType.

See Also