Click or drag to resize

ArticyNotificationManager Class

Handles adding and removing of listeners to notify about changes of global variables.
Inheritance Hierarchy
SystemObject
  Articy.UnityArticyNotificationManager

Namespace:  Articy.Unity
Assembly:  ArticyRuntime (in ArticyRuntime.dll) Version: 1.0.3
Syntax
C#
Copy
public sealed class ArticyNotificationManager

The ArticyNotificationManager type exposes the following members.

Methods
  NameDescription
Public methodAddListener
Public methodNotifyPropertyChanged
Called to notify each added listener about a variable change.
Public methodRemoveAllListeners
Removes all listeners.
Public methodRemoveListener
Top
Remarks

Note Note
It is important to remember that each BaseGlobalVariables has its own ArticyNotificationManager. If you are using multiple instances of the GlobalVariables, make sure you add your listener methods to the correct notification manager.
Examples
C#
Copy
public class MyNotificationScript : MonoBehaviour
{
    void Start()
    {
        // we get the default variable storage from our database and add a listener to the notification manager
        // to call our supplied method every time any Variable inside the namespace "GameState" is changed.
        ArticyDatabase.DefaultGlobalVariables.Notifications.AddListener("GameState.*", MyGameStateVariablesChanged);
    }
    // here we handle every variable change inside the "GameState" namespace
    void MyGameStateVariablesChanged(string aVariableName, object aValue)
    {
        // for example:
        // When our exit variable was set to true, we quit the game.
        if(aVariableName == "GameState.exit" && ((bool)aValue) == true)
             Application.Quit();

        // in this example we play a beep when the variable changes
        // its worth noting that we won't hear a beep now every frame once the variable has been set to true. Because our listener method will only
        // be called once, when our variable changes.
        if(aVariableName == "GameState.beep" && ((bool) aValue) == true)
            EditorApplication.Beep();
    }
}
See Also