Class VariablesService

The variable service can be used to provide variables to other components. It is essentially a producer-consumer service. Variable Sources provide variables names along with their values. Any component can register as a listener of variables and receive callbacks when any of those variables change value.

Inheritance
Object
VariablesService
Implements
Namespace: NoSuchStudio.Variables
Assembly: NoSuchStudio-Variables.dll
Syntax
[ExecuteInEditMode]
public class VariablesService : Service<VariablesService>, Service<VariablesService>

Properties

undefinedVariableValue

Declaration
public string undefinedVariableValue { get; set; }
Property Value
Type Description
String

UndefinedVariableValue

The value to use for variables that are undefined (No Variable Source provides the variable).

Declaration
public static string UndefinedVariableValue { get; set; }
Property Value
Type Description
String

variableSources

Declaration
public Dictionary<string, IVariableSource> variableSources { get; }
Property Value
Type Description
Dictionary<String, IVariableSource>

Methods

AddVariableChangeListener(String, VariablesService.VariableChangeDelegate)

Declaration
public static void AddVariableChangeListener(string variable, VariablesService.VariableChangeDelegate action)
Parameters
Type Name Description
String variable
VariablesService.VariableChangeDelegate action

AddVariableSource(String, IVariableSource)

Declaration
public static void AddVariableSource(string variable, IVariableSource source)
Parameters
Type Name Description
String variable
IVariableSource source

GetVariable(String)

Declaration
public static string GetVariable(string variable)
Parameters
Type Name Description
String variable
Returns
Type Description
String

GetVariableSource(String)

Declaration
public static IVariableSource GetVariableSource(string variable)
Parameters
Type Name Description
String variable
Returns
Type Description
IVariableSource

HasVariable(String)

Declaration
public static bool HasVariable(string variable)
Parameters
Type Name Description
String variable
Returns
Type Description
Boolean

Init()

Declaration
public void Init()

OnServiceRegister()

Declaration
public override void OnServiceRegister()

OnServiceUnregister()

Declaration
public override void OnServiceUnregister()

ProcessChangedVariables()

Declaration
public void ProcessChangedVariables()

RemoveVariableChangeListener(String, VariablesService.VariableChangeDelegate)

Declaration
public static void RemoveVariableChangeListener(string variable, VariablesService.VariableChangeDelegate action)
Parameters
Type Name Description
String variable
VariablesService.VariableChangeDelegate action

RemoveVariableSource(String, IVariableSource)

Declaration
public static void RemoveVariableSource(string variable, IVariableSource source)
Parameters
Type Name Description
String variable
IVariableSource source

SetVariable(String, String)

Declaration
public static bool SetVariable(string variable, string value)
Parameters
Type Name Description
String variable
String value
Returns
Type Description
Boolean

SetVariableValueChanged(String, IVariableSource)

Declaration
public static bool SetVariableValueChanged(string variable, IVariableSource source)
Parameters
Type Name Description
String variable
IVariableSource source
Returns
Type Description
Boolean

Implements

Service<>