BaseGlobalVariables Class

Abstract base class for generated variable storages.

Definition

Namespace: Articy.Unity
Assembly: ArticyRuntime (in ArticyRuntime.dll) Version: 1.3.1
C#
public abstract class BaseGlobalVariables : ScriptableObject, 
	IGlobalVariables
Inheritance
Object    Object    ScriptableObject    BaseGlobalVariables
Implements
IGlobalVariables

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.

Properties

IsInitialized Gets a value indicating whether the global variables are fully initialized and ready to be used.
IsInShadowState Can be used to check if the variable storage is currently in a shadow state, thus not really changing values persistently
NamespaceVariableMap Gets a map of all variables grouped by namespace.
Notifications Gets the notifications manager.
Seen Returns whether the currently set SelfObject has been seen by the flow player.
SeenCounter Returns how often the currently set SelfObject has been seen by the flow player.
SeenCounters Get and set all seen counters. This is can be especially useful for save games.
SelfObject Gets the self object. This is the object set while a flow player is evaluating the flow.
SpeakerObject Gets the speaker object. This is the speaker set while a flow player is evaluating the flow.
Unseen Returns whether the currently set SelfObject has not been seen by the flow player.
VariableNames HashSet off all used full qualified variable names.
Variables Gets all variables. the key contains the full qualified variable name, and the value is the value of the variable.

Methods

CreateGlobalVariablesCloneTObject Creates a new global variables clone without creating an asset for it.
GetSeenCounter Returns how often a flow object has been seen by the flow player.
GetVariableByStringTValue Returns the value of a variable and converts it to the specified type
Init Called to initialize the storage
IsVariableOfTypeBoolean Determines whether the given variable is of type bool.
IsVariableOfTypeInteger Determines whether the given variable is of type int.
IsVariableOfTypeString Determines whether the given variable is of type string.
RegisterVariable(String, Boolean) Registers a new bool variable.
RegisterVariable(String, Int32) Registers a new int variable.
RegisterVariable(String, String) Registers a new string variable.
ResetAllSeenCounters Resets how often flow objects have been seen by the flow player.
ResetVariable Resets the variable to its initial value
ResetVariables Resets all variables to their initial values.
SetSeenCounter Overrides how often a flow object has been seen by the flow player.
SetVariableByString Allows setting a variable by its name.

See Also