Difference between revisions of "GetArrayVariable"
Jump to navigation
Jump to search
imported>Odessa (created- source whastnew + personal) |
imported>Odessa |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
|origin = NVSE | |origin = NVSE | ||
|summary = Returns the array that corresponds to the array variable specified by name for the calling reference or specified scriptable object. Added by NVSE V4.1. | |summary = Returns the array that corresponds to the array variable specified by name for the calling reference or specified scriptable object. Added by NVSE V4.1*. | ||
|name = GetArrayVariable | |name = GetArrayVariable | ||
|returnType = array | |returnType = array | ||
| Line 26: | Line 26: | ||
</pre> | </pre> | ||
==Note== | ==Note== | ||
*Since two array <i>variables</i> point to the same array contents if one is let to the other, a 'set' version of this function is not necessary- changes to one will affect the other, because they both refer to the same data. Use [[Ar_Copy]] or [[Ar_DeepCopy]] if you wish to duplicate arrays. | *Since two array <i>variables</i> point to the same array contents if one is let to the other, a 'set' version of this function is not necessary- changes to one will affect the other, because they both refer to the same data. Use [[Ar_Copy]] or [[Ar_DeepCopy]] if you wish to duplicate arrays. | ||
*This function was originally broken and is fixed in NVSE 4.5.7. | |||
==See Also== | ==See Also== | ||
*[[GetVariable]] (To get a numeric variable value instead) | *[[GetVariable]] (To get a numeric variable value instead) | ||
| Line 34: | Line 35: | ||
*[[SetRefVariable]] (Aded by NVSE 4.5.6) | *[[SetRefVariable]] (Aded by NVSE 4.5.6) | ||
[[Category:Functions_(NVSE)]] | [[Category:Functions_(NVSE)]] | ||
[[Category:Script Functions]] | |||
Latest revision as of 05:33, 6 August 2014
< [[::Category:Functions|Category:Functions]]
A function added by the New Vegas Script Extender.
Description
Returns the array that corresponds to the array variable specified by name for the calling reference or specified scriptable object. Added by NVSE V4.1*.
Syntax
(array) ref.GetArrayVariable VarName:string Parent:Object
Example
ref rActor array_var aData let aData := rActor.GetArrayVariable "aData" ; Alternatively, (or required if rActor holds a base form): let aData := GetArrayVariable "aData", rActor
Note
- Since two array variables point to the same array contents if one is let to the other, a 'set' version of this function is not necessary- changes to one will affect the other, because they both refer to the same data. Use Ar_Copy or Ar_DeepCopy if you wish to duplicate arrays.
- This function was originally broken and is fixed in NVSE 4.5.7.
See Also
- GetVariable (To get a numeric variable value instead)
- GetRefVariable (and for ref variables)
- HasVariable (to check if a variable exists at all)
- SetVariable (Added by NVSE 4.5.6)
- SetRefVariable (Aded by NVSE 4.5.6)