Mod Local Data

In some circumstances, it is useful for a mod to record information about its state independent of the savegame. For instance, a mod which uses NVSE commands to modify objects or settings using certain otherwise persistent methods may want to reset those changes when a different savegame is loaded. Mod local data provides each loaded mod with the ability to define data which persists for the duration of the game session (until the game is quit).

Data is defined as key-value pairs, like a string map, where the key is a string and the value may be a number, object, or string, but not an array. A script has access only to the data defined for the mod to which it belongs.

Functions

• GetModLocalData
• SetModLocalData
• ModLocalDataExists
• RemoveModLocalData
• GetAllModLocalData

See Also

• Auxiliary Variables (can replicate the function of Mod Local Data via Temporary Aux Vars)
• RefMap Array (a specialized form of Auxiliary Variables)