1 of 12

VariableStorageBehaviour

Class in

Inherits from UnityEngine.MonoBehaviour

Summary

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

Remarks

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

Methods

Name

Description

Properties

Clear()

Method in

Summary

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

string variableName

The name of the variable to check for.

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 (FloatDictionary FloatVariables, StringDictionary StringVariables, BoolDictionary BoolVariables) GetAllVariables();

GetVariableKind(string)

Method in VariableStorageBehaviour

Summary

public VariableKind GetVariableKind(string name)

Parameters

Name

Description

string name

SetAllVariables(FloatDictionary,StringDictionary,BoolDictionary,bool)

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(FloatDictionary floats, StringDictionary strings, BoolDictionary bools, bool clear = true);

Parameters

Name

Description

bool clear

Should the load also wipe the storage. Defaults to true so all existing variables will be cleared.

System.Collections.Generic.Dictionary<string, float> floats

System.Collections.Generic.Dictionary<string, string> strings

System.Collections.Generic.Dictionary<string, bool> bools

SetValue(string,bool)

Method in VariableStorageBehaviour

Summary

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

Parameters

Name

Description

string variableName

bool boolValue

SetValue(string,float)

Method in VariableStorageBehaviour

Summary

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

Parameters

Name

Description

string variableName

float floatValue

SetValue(string,string)

Method in VariableStorageBehaviour

Summary

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

Parameters

Name

Description

string variableName

string stringValue

TryGetValue(string,T)

Method in

Summary

Parameters

Name

Description

Program

Property in

Summary

SmartVariableEvaluator

Property in

Summary

SetAllVariables(FloatDictionary,StringDictionary,BoolDictionary,bool)

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(FloatDictionary floats, StringDictionary strings, BoolDictionary bools, bool clear = true);

Parameters

Name

Description

bool clear

Should the load also wipe the storage. Defaults to true so all existing variables will be cleared.

System.Collections.Generic.Dictionary<string, float> floats

System.Collections.Generic.Dictionary<string, string> strings

System.Collections.Generic.Dictionary<string, bool> bools