IModPersistentData Interface |
Allows primitive data types to be stored persistently inbetween mod loads.
This is useful if the mod needs to store settings or other persistent information.
Most games will disallow access to System.IO by default and as a result this interface is usually the only way to create persistent data.
The interface is designed to mimic Unity's PlayerPres class as close as possible with a couple of extra features.
Namespace: UMod
Assembly: UMod-Interface (in UMod-Interface.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public interface IModPersistentData
The IModPersistentData type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AllKeys |
Enumerates all saved keys for this mod.
|
| HasData |
Returns true if there is any data stored for this mod.
|
Methods| Name | Description | |
|---|---|---|
 | ClearAll |
Clears all saved data for this mod.
|
| Exists |
Checks whether a value exists for the specified key.
|
| LoadBool |
Attempts to load a boolean value from the persistent store.
|
| LoadFloat |
Attempts to load a floating point value from the persistent store.
|
| LoadInt |
Attempt to load an integer value from the persistent store.
|
| LoadString |
Attempts to load a string value from the persistent store.
|
| SaveBool |
Save a boolean value to the persistent data store.
|
| SaveFloat |
Save a floating point value to the persistent data store.
|
| SaveInt |
Save an integer value to the persistent data store.
|
| SaveString |
Save a string value to the persistent data store.
|
See Also