VariableStorageBehaviour

Class in Yarn.Unity

Inherits from UnityEngine.MonoBehaviour

Summary

A UnityEngine.MonoBehaviour that a DialogueRunner uses to store and retrieve variables.

public abstract class VariableStorageBehaviour : MonoBehaviour, Yarn.IVariableStorage

Remarks

This abstract class inherits from UnityEngine.MonoBehaviour , which means that subclasses of this class can be attached to UnityEngine.GameObject s.

Methods

NameDescription
AddChangeListener(System.Action<string, object>)Registers a delegate that will be called when any variable is modified.
AddChangeListener(string,Action)Registers a delegate that will be called when the variable variableName is modified.
Clear()
Contains(string)Returns a boolean value representing if a particular variable is inside the variable storage.
GetAllVariables()Provides a unified interface for exporting all variables. Intended to be a point for custom saving, editors, etc.
GetVariableKind(string)
SetAllVariables(FloatDictionary,StringDictionary,BoolDictionary,bool)Provides a unified interface for loading many variables all at once. Will override anything already in the variable storage.
SetValue(string,bool)
SetValue(string,float)
SetValue(string,string)
TryGetValue(string,T?)

Properties