InstructionModule
The InstructionModule
class enables effects to provide instructions to the user.
Example
//==============================================================================
// The following example demonstrates how to hide an instruction when more than
// one face is detected and show it if not.
//
// Project setup:
// - Set the 'Max Faces' of the 'Face Tracking' capability to 2 or more
// - Add the 'Instructions' capability
// - Select 'Custom Instructions'
// - Add the 'Try it with friends' instruction
//==============================================================================
// Load in the required modules
const Instruction = require('Instruction');
const FaceTracking = require('FaceTracking');
// Define a boolean that will be true until 2 faces are detected
var show = FaceTracking.count.lt(2);
// Bind the visibility of the instruction to the boolean
Instruction.bind(show, 'try_with_friends');
Properties
Property
Description
automaticInstructionsEnabled
(get) automaticInstructionsEnabled: boolean (set) (Not Available)
Specifies whether or not automatic instructions are enabled.
Methods
Method
Description
bind
bind(enabled: BooleanSignal, token: StringSignal): void
When enabled, shows instruction for given token (you can find and select custom instruction tokens in project capabilities)
To hide instruction simply set enabled to false
.
You can have at most one binding for instructions, meaning that setting a different binding would replace any previously created and setup binding for instructions.
Classes
This module exposes no classes.
Last updated
Was this helpful?