IArticyFlowPlayerCallbacks Interface
Interface used together with ArticyFlowPlayer for notification of flow traversal events.
Definition
Namespace: Articy.Unity
Assembly: ArticyRuntime (in ArticyRuntime.dll) Version: 1.3.1
Assembly: ArticyRuntime (in ArticyRuntime.dll) Version: 1.3.1
C#
public interface IArticyFlowPlayerCallbacksRemarks
Implement this interface on your game object, that hosts an ArticyFlowPlayer to be notified about its traversal events.
Both methods are always called one after another, in always the same order OnFlowPlayerPaused(IFlowObject) first and OnBranchesUpdated(IListBranch) second.
Common use cases for OnFlowPlayerPaused(IFlowObject) are to show the paused node to the UI in a Dialogue for example or parse its Data/Template and simply continue using one of the Play methods, without displaying it.
Common use case for OnBranchesUpdated(IListBranch) is to build a list of branching options; create UI controls for each branch and display them on the UI.
Methods
| OnBranchesUpdated | Called when the traversal found multiple branches and/or when the execution paused because of a PausedOn, or it found a dead end. |
| OnFlowPlayerPaused | Called when the traversal has found a valid stop target, or when the execution has reached a dead end. |