Class Tour

constructor

• new Tour(
      config: TourConfig,
      options?: { id?: string; namespace?: string },
  ): Tour

  Construct a Tour by providing a configuration.

  Parameters

  • config: TourConfig

    The configuration of the Tour
  • Optionaloptions: { id?: string; namespace?: string } = {}

    Additional options for configuring the tour

    • Optionalid?: string

      A tour ID that supercedes TourConfig#id

    • Optionalnamespace?: string

      A tour namespace that supercedes TourConfig#namespace

  Returns Tour

config

fadeElement

overlayElement

targetElement

StaticHIGHLIGHT_PADDING

canStart

• get canStart(): boolean

  Return whether this Tour is currently eligible to be started? This is useful for tours which can only be used in certain circumstances, like if the canvas is active.

  Returns boolean

currentStep

• get currentStep(): null | TourStep

  Return the current Step, or null if the tour has not yet started.

  Returns null | TourStep

description

• get description(): string

  The human-readable description of the tour.

  Returns string

hasNext

• get hasNext(): boolean

  Returns True if there is a next TourStep

  Returns boolean

hasPrevious

• get hasPrevious(): boolean

  Returns True if there is a previous TourStep

  Returns boolean

id

• get id(): string

  The unique identifier of the tour.

  Returns string

key

• get key(): string

  The key the Tour is stored under in game.tours, of the form ${namespace}.${id}

  Returns string

namespace

• get namespace(): string

  The package namespace for the tour.

  Returns string

status

• get status(): TourStatus

  The current status of the Tour

  Returns TourStatus

stepIndex

• get stepIndex(): null | number

  The index of the current step; -1 if the tour has not yet started, or null if the tour is finished.

  Returns null | number

steps

• get steps(): TourStep[]

  The configuration of tour steps

  Returns TourStep[]

title

• get title(): string

  The human-readable title for the tour.

  Returns string

StaticactiveTour

• get activeTour(): null | Tour

  Returns the active Tour, if any

  Returns null | Tour

StatictourInProgress

• get tourInProgress(): boolean

  Indicates if a Tour is currently in progress.

  Returns boolean

complete

• complete(): Promise<any>

  Advance the tour to a completed state.

  Returns Promise<any>

exit

• exit(): void

  Exit the tour at the current step.

  Returns void

next

• next(): Promise<any>

  Progress the Tour to the next step.

  Returns Promise<any>

previous

• previous(): Promise<any>

  Rewind the Tour to the previous step.

  Returns Promise<any>

progress

• progress(stepIndex: number): Promise<any>

  Progresses to a given Step

  Parameters

  • stepIndex: number

    The step to progress to

  Returns Promise<any>

reset

• reset(): Promise<any>

  Reset the Tour to an un-started state.

  Returns Promise<any>

start

• start(): Promise<any>

  Start the Tour at its current step, or at the beginning if the tour has not yet been started.

  Returns Promise<any>

StaticfromJSON

• fromJSON(filepath: string): Promise<Tour>

  Creates and returns a Tour by loading a JSON file

  Parameters

  • filepath: string

    The path to the JSON file

  Returns Promise<Tour>

StaticonMovementAction

• onMovementAction(movementDirections: string[]): true | void

  Handle a movement action to either progress or regress the Tour.

  Parameters

  • movementDirections: string[]

    The Directions being moved in

  Returns true | void