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

Methods

Method in

Summary

returns a boolean value representing if the particular variable is inside the variable storage

Parameters

Field in

Summary

Method in InMemoryVariableStorage

Summary

public string GetDebugList()

Method in

Summary

Load JSON data from Unity's built-in PlayerPrefs with defined playerPrefsKey parameter, and deserialize as variables.

Parameters

Field in

Summary

Method in

Summary

Removes all variables from storage.

Method in

Summary

Load JSON data from Unity's built-in PlayerPrefs with default playerPrefsKey, and deserialize as variables.

Method in InMemoryVariableStorage

Summary

Export variable storage to a JSON string, like when writing save game data.

public string SerializeAllVariablesToJSON(bool prettyPrint = false)

Parameters

Method in InMemoryVariableStorage

Summary

Load JSON data from a file, then deserialize as variables.

public void LoadFromFile(string filepath)

Parameters

Method in InMemoryVariableStorage

Summary

Serialize all variables to JSON, then write the data to a file.

public void SaveToFile(string filepath)

Parameters

Method in InMemoryVariableStorage

Summary

Import a JSON string into variable storage, like when loading save game data.

public void DeserializeAllVariablesFromJSON(string jsonData)

Parameters

Method in

Summary

Serialize all variables to JSON, then save data to Unity's built-in PlayerPrefs with default playerPrefsKey.

Method in

Summary

Serialize all variables to JSON, then save data to Unity's built-in PlayerPrefs under playerPrefsKey parameter.

Parameters

Method in

Summary

Parameters

Method in

Summary

Parameters

Method in InMemoryVariableStorage

Summary

public override void SetValue(string variableName, string stringValue)

Parameters

Method in InMemoryVariableStorage

Summary

Retrieves a Value by name.

public override bool TryGetValue<T>(string variableName, out T result)

Parameters

Returns

The Value . If a variable by the name of variableName is not present, returns a value representing null.