ArticyFlowPlayer Class

public class ArticyFlowPlayer : MonoBehaviour, 
	IArticyFlowPlayerCallbacks

Inheritance

Object    Object    Component    Behaviour    MonoBehaviour    ArticyFlowPlayer

Implements

IArticyFlowPlayerCallbacks

Attach this component to one of your game objects to have access to a single flow traversal unit. You can set a startOn object on which the ArticyFlowPlayer should start traversing. The flow player will walk the flow until it hits an object of the type you supplied in pauseOn and calls on your game object a method called "OnFlowPlayerPaused" and/or until the flow is no longer distinct. In this case, the flow player will notify you about all available options, called branches, via a method on your game object called "OnBranchesUpdated. Once stopped, the flow player can continue traversal by calling one of the Play() methods.

The flow player and the underlying ExecutionEngine will automatically take care of evaluating all found scripts and storing the modified variables.

It is perfectly valid to have multiple ArticyFlowPlayers in your scene and/or game. Unless overwritten each new flow player will use the same default Global variables, this default can be found on DefaultGlobalVariables. If necessary you can create a new instance of a Global Variable Storage (Via unity menu entry "Articy/Create new global variables copy" and assign this in the inspector to your ArticyFlowPlayer component.

If you script code contains methods, the flow player will need your help to call the correct implementation. To do that, your game object, hosting the ArticyFlowPlayer needs to implement the generated interface called IScriptMethodProvider". Once implemented, if the flow player encounters a method inside the scripts, it will call your game object and use the correct method.

Reference