TogglePurgeOnUnload

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

When toggled on an object reference, makes it so the reference will not be saved by the game and will be deleted once its 3D is unloaded.

  • This function will only work on non-persistent, dynamic (mod index = FF) references.
  • By omitting the argument, the function can be used to return whether the calling reference is marked for purging, without making any changes.

Syntax

[help]
(isToggled:0/1) reference.TogglePurgeOnUnload toggle:1/0

Example

objectRef.TogglePurgeOnUnload 1
bPurgeOnUnload = objectRef.TogglePurgeOnUnload