Storyboard

public class Storyboard : MonoBehaviour, IStoryboardNodeResponder;

Description

A storyboard component used to present a storyboard in the scene.

Properties
automaticPresentationMode The automatic presentation mode of the storyboard component. Can be one of PresentOnAwake, PresentOnStart, or DontPresentAutomatically.
presentationSpace The presentation space in which the storyboard will be presented. Can be either ScreenSpace or WorldSpace.
storyboard The storyboard asset.
StoryboardWillDismiss A UnityEvent that is triggered when the storyboard is about to perform its exit transition, i.e. dismiss its initial canvas controller.
StoryboardWillPerformTransition A UnityEvent that is triggered when the storyboard is about to perform a transition, excluding its initial/entry transition.
StoryboardWillPresentInitialCanvasController A UnityEvent that is triggered when the storyboard is about to perform its entry transition, i.e. present its initial canvas controller.
worldSpaceContainer When set to StoryboardPresentationSpace.WorldSpace, the world space container specifies the world canvas in which the subsequently loaded canvas controllers will be contained.
Methods
Present Present the storyboard manually.

automaticPresentationMode

public AutomaticPresentationMode automaticPresentationMode = AutomaticPresentationMode.PresentOnAwake;

Description

The automatic presentation mode of the storyboard component. Can be one of PresentOnAwake, PresentOnStart, or DontPresentAutomatically.


presentationSpace

public StoryboardPresentationSpace presentationSpace;

Description

The presentation space in which the storyboard will be presented. Can be either ScreenSpace or WorldSpace.


storyboard

public StoryboardData storyboard;

Description

The storyboard asset.


StoryboardWillDismiss

public StoryboardTransitionEvent StoryboardWillDismiss;

Description

A UnityEvent that is triggered when the storyboard is about to perform its exit transition, i.e. dismiss its initial canvas controller.

This event receives a StoryboardTransition for the transition to be performed. Therefore, the required method signature to use this event is public void yourMethodName(StoryboardTransition transition).


StoryboardWillPerformTransition

public StoryboardTransitionEvent StoryboardWillPerformTransition;

Description

A UnityEvent that is triggered when the storyboard is about to perform a transition, excluding its initial/entry transition.

This event receives a StoryboardTransition for the transition to be performed. Therefore, the required method signature to use this event is public void yourMethodName(StoryboardTransition transition).


StoryboardWillPresentInitialCanvasController

public StoryboardTransitionEvent StoryboardWillPresentInitialCanvasController;

Description

A UnityEvent that is triggered when the storyboard is about to perform its entry transition, i.e. present its initial canvas controller.

This event receives a StoryboardTransition for the transition to be performed. Therefore, the required method signature to use this event is public void yourMethodName(StoryboardTransition transition).


worldSpaceContainer

public CanvasControllerWorldSpaceContainer worldSpaceContainer;

Description

When set to StoryboardPresentationSpace.WorldSpace, the world space container specifies the world canvas in which the subsequently loaded canvas controllers will be contained.


Present

public void Present();

Description

Present the storyboard manually.

This can be used in conjunction with automaticPresentationMode to present the storyboard manually.