Method in LineProviderBehaviour


Signals to the line provider that lines with the provided line IDs may be presented shortly.

public virtual void PrepareForLines(IEnumerable<string> lineIDs)


Subclasses of LineProviderBehaviour can override this to prepare any neccessary resources needed to present these lines, like pre-loading voice-over audio. The default implementation does nothing.

Not every line may run; this method serves as a way to give the line provider advance notice that a line may run, not will run.

When this method is run, the value returned by the LinesAvailable property should change to false until the necessary resources have loaded.



System.Collections.Generic.IEnumerable<string> lineIDs

A collection of line IDs that the line provider should prepare for.

Yarn Spinner® and Secret Lab® are trade marks of Secret Lab Pty. Ltd., and are used by Yarn Spinner Pty. Ltd. under license.