Interface InstrumentOptions

Options available for an Instrument.

interface InstrumentOptions {
    key?: number;
    name?: string;
    pressKey?: boolean;
    soundFile?: string;
}

Properties

key? name? pressKey? soundFile?

Properties

Optionalkey

key?: number

Key of the sound file.

Remarks

Just like note blocks, this ranges from 0-87.

Optionalname

name?: string

Name of the instrument.

OptionalpressKey

pressKey?: boolean

Whether the on-screen piano should visually press keys when these notes are played.

OptionalsoundFile

soundFile?: string

Sound file of the instrument.

Remarks

Relative to the Data/Sounds/ directory of Note Block Studio installations.

Settings

Member Visibility

On This Page

Properties