InMemoryVariableStorage

Class in Yarn.Unity

Inherits from VariableStorageBehaviour

Summary

A simple implementation of VariableStorageBehaviour.

public class InMemoryVariableStorage : VariableStorageBehaviour, IEnumerable<KeyValuePair<string, object>>

Remarks

This class stores variables in memory, and is erased when the game exits.

This class also has basic serialization and save/load example functions.

You can also enumerate over the variables by using a foreach loop:

// 'storage' is an InMemoryVariableStorage
foreach (var variable in storage) {
string name = variable.Key;
System.Object value = variable.Value;
}

Note that as of v2.0, this class no longer uses Yarn.Value, to enforce static typing of declared variables within the Yarn Program.

Fields

Name	Description
showDebug
TypeMappings

Methods

Name	Description
Clear()	Removes all variables from storage.
Contains(string)	returns a boolean value representing if the particular variable is inside the variable storage
DeserializeAllVariablesFromJSON(string)	Import a JSON string into variable storage, like when loading save game data.
GetDebugList()
LoadFromFile(string)	Load JSON data from a file, then deserialize as variables.
LoadFromPlayerPrefs()	Load JSON data from Unity's built-in PlayerPrefs with default playerPrefsKey, and deserialize as variables.
LoadFromPlayerPrefs(string)	Load JSON data from Unity's built-in PlayerPrefs with defined playerPrefsKey parameter, and deserialize as variables.
SaveToFile(string)	Serialize all variables to JSON, then write the data to a file.
SaveToPlayerPrefs()	Serialize all variables to JSON, then save data to Unity's built-in PlayerPrefs with default playerPrefsKey.
SaveToPlayerPrefs(string)	Serialize all variables to JSON, then save data to Unity's built-in PlayerPrefs under playerPrefsKey parameter.
SerializeAllVariablesToJSON(bool)	Export variable storage to a JSON string, like when writing save game data.
SetValue(string,bool)
SetValue(string,float)
SetValue(string,string)
TryGetValue(string,T)	Retrieves a Value by name.