RefMapArrayGetString

From GECK
(Redirected from RefMapGetStr)
Jump to: navigation, search


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