Interface TutorialStep

Defines a single step in a game tutorial sequence.

interface TutorialStep {
    advanceOn: TutorialAdvanceOn;
    messageKey: string;
    onEnter?: () => void;
    placement: TutorialPlacement;
    target: string;
}

Index

Properties

advanceOn messageKey onEnter? placement target

Properties

advanceOn

advanceOn: TutorialAdvanceOn

How to advance: 'click' watches the target, 'next' shows a next button.

messageKey

messageKey: string

i18n key for the tooltip message text.

`Optional`onEnter

onEnter?: () => void

Optional callback executed when this step becomes active.

placement

placement: TutorialPlacement

Tooltip placement relative to the target element.

target

target: string

CSS selector or data-tutorial attribute value to highlight.