Documentation / @giro3d/piero / modules / misc / Tour

Class: Tour

Defined in: packages/piero/src/modules/misc/Tour.ts:24

Provides a guided tour of the application.

Implements

• Module

Constructors

Constructor

new Tour(): Tour

Returns

Tour

Properties

id

readonly id: "builtin-tour" = 'builtin-tour'

Defined in: packages/piero/src/modules/misc/Tour.ts:25

The unique id of the module, that also acts as a key to find the module configuration in the app configuration.

Implementation of

Module.id

---

name

readonly name: "Tour" = 'Tour'

Defined in: packages/piero/src/modules/misc/Tour.ts:26

The readable name of the module.

Implementation of

Module.name

Methods

initialize()

initialize(context): void | Promise<void>

Defined in: packages/piero/src/modules/misc/Tour.ts:33

Initialize this module on the Piero context.

Parameters

context

PieroContext

Returns

void | Promise<void>

Implementation of

Module.initialize