ClearModNVSEVars

From the Fallout3 GECK Wiki
Revision as of 16:31, 24 March 2017 by imported>Jazzisparis (Created page with "{{Function |origin = JIP |summary = Clears and deletes all '''array_vars''' and '''string_vars''' <u>created by the mod owning the script</u> from which the function is call...")
(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

Clears and deletes all array_vars and string_vars created by the mod owning the script from which the function is called.

The two optional arguments are "exclude lists", and may be used for specifying which array_vars and string_vars are not to be deleted.

The main use of this function is for fixing/preventing bloating of the NVSE co-save file with orphaned arrays/strings, which were (for any reason) not properly deleted and/or are no longer being referenced. This bloating may, in some cases, significantly increase loading times.

Syntax

[help]
ClearModNVSEVars arraysToKeep:array_var stringsToKeep:array_var

Example

let aKeepArrays := ar_List aArray1, aArray2, aArray3
let aKeepStrings := ar_List sString1, sString2
ClearModNVSEVars aKeepArrays aKeepStrings

Deletes all arrays except the ones specified in aKeepArrays, and all strings except the ones specified in aKeepStrings.

ClearModNVSEVars

Deletes all arrays and strings.

See Also