Hiyve Components - v1.0.0
    Preparing search index...

    Interface PotionOrder

    One order at the hatch: what to brew, how it is answered, and the card it settles.

    interface PotionOrder {
        answerKey?: string;
        bottle: string;
        card: KeySignatureIdCard | ScaleIdCard | ChordBuildCard | ListenCard;
        chord: boolean;
        clef: Clef;
        colour: number;
        customer: number;
        degree?: number;
        fifths: number;
        id: string;
        key?: string;
        kind: PotionOrderKind;
        notes: Pitch[];
        numeral?: string;
        ordered: boolean;
        pad: PotionPad;
        quality?: PotionQuality;
        rare: boolean;
        root?: Pitch;
        round: number;
        scale?: "major" | "harmonicMinor";
        sound: number[];
        symbol?: string;
        tries: number;
    }
    Index

    Properties

    answerKey?: string

    relative: the minor key that is the answer

    bottle: string

    The potion book's bottle it fills

    The card behind it: build a chord, name a scale, name a key signature, or listen

    chord: boolean

    Whether sound ends with its notes struck together: a chord's

    clef: Clef

    staff: the clef the notes are placed on

    colour: number

    Its liquid's colour, 0 to POTION_COLOURS − 1: there for charm, never for meaning

    customer: number

    Which forest customer brings it, 0 to POTION_CUSTOMERS − 1

    degree?: number
    fifths: number

    The key's signature: sharps (positive) or flats (negative); 0 where no key is named. A staff order's staff carries it

    id: string

    order-0, order-1… in the order the customers arrive

    key?: string

    The key named: tonicChord, numeral, scale (a minor key's scale is its harmonic minor), signature, and relative (the major key whose signature is shared), as a 'G:major' code

    notes: Pitch[]

    The notes to brew, spelled: a chord's root, 3rd and 5th (in any order, any octave); a scale's eight notes up from its tonic (in order); a key's sharps or flats in the order they are written (in any order); the relative minor's keynote. None for a taste

    numeral?: string

    numeral: the Roman numeral ('IV') and the scale degree it is built on

    ordered: boolean

    Whether the notes go in one after another, in order: a scale

    quality?: PotionQuality
    rare: boolean

    Sealed in gold: harder, worth more, and gone after a few brews if not taken

    root?: Pitch

    A chord's root and quality (and a taste's quality: its answer)

    round: number

    The round of the lab's deck it settles: its place in the arrivals

    scale?: "major" | "harmonicMinor"

    scale: the scale brewed

    sound: number[]

    The potion as it plays once brewed, as MIDI numbers in the order played: a chord's notes (then all together), a scale up, a key's scale up for its signature, the minor tonic chord for a relative minor

    symbol?: string

    symbol: the chord symbol, as written ('Am', 'B♭')

    tries: number

    Wrong notes it takes before it settles