Difference between revisions of "Ar Null"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Odessa
(Created page with "{{Function |origin = NVSE |summary = Returns a constant, an invalid array. This is useful if you wish to specify that a variable which previously referred to an array shoul...")
 
imported>Odessa
(arrays are NOT always cleaned up automatically! source- personal testing)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Function
{{Function
  |origin = NVSE
  |origin = NVSE
  |summary = Returns a constant, an invalid array. This is useful if you wish to specify that a variable which previously referred to an array should no longer refer to any array.  
  |summary = Returns a constant, an invalid array. This is used to clear up array variables when they are no longer necessary, such as when a script terminates.


Note that redundant arrays which are no longer referenced by any scripts or other arrays are deleted automatically, there is no need to use this function.
As of NVSE 4.6.2, arrays defined in [[User Defined Function|UDF]] scripts are cleaned up automatically, <b>but those held in other scripts are not</b>. Therefore it is essential to use Ar_Null to clear any local array variables when other scripts terminate to avoid save game bloat.


  |name = Ar_Null
  |name = Ar_Null
Line 9: Line 9:
  |arguments =  
  |arguments =  
  }}
  }}
==Example==
<pre>
let SomeArray := Ar_Null
</pre>
==See Also==
==See Also==
*[[Array Variables]]
*[[Array Variable]]
*[[Sv_Destruct]] (Equivalent to clear redundant [[String Variable|string variables]])
*[[Ar_Resize]]
*[[Ar_BadNumericIndex]]
*[[Ar_BadStringIndex]]
[[Category:Functions_(NVSE)]]
[[Category:Functions_(NVSE)]]
[[Category:Array Variables]]
[[Category:Array Variables]]

Latest revision as of 08:11, 27 February 2015

< [[::Category:Functions|Category:Functions]]

A function added by the New Vegas Script Extender.

Description

Returns a constant, an invalid array. This is used to clear up array variables when they are no longer necessary, such as when a script terminates.

As of NVSE 4.6.2, arrays defined in UDF scripts are cleaned up automatically, but those held in other scripts are not. Therefore it is essential to use Ar_Null to clear any local array variables when other scripts terminate to avoid save game bloat.

Syntax

[help]
(NullArray:array) Ar_Null

Example

let SomeArray := Ar_Null

See Also