InstructionModule Module

The InstructionModule class enables effects to provide instructions to the user.

Usage

const Instruction = require('Instruction');

Properties

PropertyDescription

automaticInstructionsEnabled

read/write: Boolean

Specifies a Boolean value indicating whether instructions are shown automatically.

Methods

MethodDescription

show(instructionType: Instruction.Type)

returns void

Displays the instruction specified by the instructionType parameter.

hide()

returns void

Hides any instructions being shown.

Enums

EnumDescription

Type

The Type enum describes an effect instruction.