Interface TourConfig

Tour configuration data

interface TourConfig {
    canBeResumed?: boolean;
    description?: string;
    display?: boolean;
    id: string;
    localization?: object;
    namespace: string;
    restricted?: boolean;
    steps: TourStep[];
    suggestedNextTours?: string[];
    title: string;
}

Properties

canBeResumed? description? display? id localization? namespace restricted? steps suggestedNextTours? title

Properties

OptionalcanBeResumed

canBeResumed?: boolean

Whether the Tour can be resumed or if it always needs to start from the beginning. Defaults to false.

Optionaldescription

description?: string

A human-readable description of this Tour. Localized.

Optionaldisplay

display?: boolean

Whether the Tour should be displayed in the Manage Tours UI. Defaults to false.

id

id: string

A machine-friendly id of the Tour, must be unique within the provided namespace

Optionallocalization

localization?: object

A map of localizations for the Tour that should be merged into the default localizations

namespace

namespace: string

The namespace this Tour belongs to. Typically, the name of the package which implements the tour should be used

Optionalrestricted

restricted?: boolean

Whether the Tour is restricted to the GM only. Defaults to false.

steps

steps: TourStep[]

The list of Tour Steps

OptionalsuggestedNextTours

suggestedNextTours?: string[]

A list of namespaced Tours that might be suggested to the user when this Tour is completed. The first non-completed Tour in the array will be recommended.

title

title: string

A human-readable name for this Tour. Localized.

Settings

Member Visibility

On This Page

Properties