Click or drag to resize

BaseGlobalVariables Class

Abstract base class for generated variable storages.
Inheritance Hierarchy
SystemObject
  Object
    ScriptableObject
      Articy.UnityBaseGlobalVariables

Namespace:  Articy.Unity
Assembly:  ArticyRuntime (in ArticyRuntime.dll) Version: 1.0.3
Syntax
C#
Copy
public abstract class BaseGlobalVariables : ScriptableObject, 
	IGlobalVariables

The BaseGlobalVariables type exposes the following members.

Properties
  NameDescription
Public propertyIsInitialized
Gets a value indicating whether the global variables are fully initialized and ready to be used.
Public propertyIsInShadowState
Can be used to check if the variable storage is currently in a shadow state, thus not really changing values persistently
Public propertyNamespaceVariableMap
Gets a map of all variables grouped by namespace.
Public propertyNotifications
Gets the notifications manager.
Public propertySelfObject
Gets the self object. This is the object set while a flow player is evaluating the flow.
Public propertySpeakerObject
Gets the speaker object. This is the speaker set while a flow player is evaluating the flow.
Public propertyStatic memberVariableNames
HashSet off all used full qualified variable names.
Public propertyVariables
Gets all variables. the key contains the full qualified variable name, and the value is the value of the variable.
Top
Methods
  NameDescription
Public methodStatic memberCreateGlobalVariablesCloneTObject
Creates a new global variables clone without creating an asset for it.
Public methodGetVariableByStringTValue
Returns the value of a variable and converts it to the specified type
Public methodInit
Called to initialize the storage
Public methodIsVariableOfTypeBoolean
Determines whether the given variable is of type bool.
Public methodIsVariableOfTypeInteger
Determines whether the given variable is of type int.
Public methodIsVariableOfTypeString
Determines whether the given variable is of type string.
Public methodRegisterVariable(String, Boolean)
Registers a new bool variable.
Public methodRegisterVariable(String, Int32)
Registers a new int variable.
Public methodRegisterVariable(String, String)
Registers a new string variable.
Public methodResetVariables
Resets all variables to their initial values.
Public methodSetVariableByString
Allows setting a variable by its name.
Top
Remarks

An derived instance of this class will be generated when importing articy:draft data automatically by the plugin. The derived generated class is called GlobalVariableStorage.

See Also