Scripting API
InstructionModule

InstructionModule

Allows instructions to be displayed to the user within an effect.

Example

Properties

PropertyDescription

automaticHintsEnabled

(get) automaticHintsEnabled: BoolSignal
(set) automaticHintsEnabled: BoolSignal


Specifies whether or not automatic instruction hints are enabled.

Methods

MethodDescription

bind

bind(enabled: BoolSignal, 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.