1 of 9

VariableStorageBehaviour

Inherits from MonoBehaviour

Summary

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

public abstract class VariableStorageBehaviour : MonoBehaviour, Yarn.IVariableStorage

Remarks

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

Methods

Name

Description

Clear()

Method in VariableStorageBehaviour

Summary

public abstract void Clear();

Contains(string)

Method in VariableStorageBehaviour

Summary

Returns a boolean value representing if a particular variable is inside the variable storage.

public abstract bool Contains(string variableName);

Parameters

Name

Description

Returns

true if this variable storage contains a value for the variable named variableName ; false otherwise.

GetAllVariables()

Method in VariableStorageBehaviour

Summary

Provides a unified interface for exporting all variables. Intended to be a point for custom saving, editors, etc.

public abstract (System.Collections.Generic.Dictionary<string, float>, System.Collections.Generic.Dictionary<string, string>, System.Collections.Generic.Dictionary<string, bool>) GetAllVariables();

SetAllVariables(System.Collections.Generic.Dictionary<string,float>,System.Collections.Generic.Dicti

Method in VariableStorageBehaviour

Summary

Provides a unified interface for loading many variables all at once. Will override anything already in the variable storage.

public abstract void SetAllVariables(System.Collections.Generic.Dictionary<string, float> floats, System.Collections.Generic.Dictionary<string, string> strings, System.Collections.Generic.Dictionary<string, bool> bools, bool clear = true);

Parameters

Name

Description

SetValue(string,bool)

Method in VariableStorageBehaviour

Summary

public abstract void SetValue(string variableName, bool boolValue);

Parameters

Name

Description

SetValue(string,float)

Method in VariableStorageBehaviour

Summary

public abstract void SetValue(string variableName, float floatValue);

Parameters

Name

Description

SetValue(string,string)

Method in VariableStorageBehaviour

Summary

public abstract void SetValue(string variableName, string stringValue);

Parameters

Name

Description

TryGetValue(string,T)

Method in VariableStorageBehaviour

Summary

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

Parameters

Name

Description