Type Alias MachinistePattern

key	value
type	entity
key	`"machinistePattern"`
is

A machiniste pattern. Contains all steps for all channels in a single pattern. Can point to a "pattern slot" of the machiniste.

type MachinistePattern = {
    channelPatterns: ArrayField<NexusObject<MachinisteChannelPattern>, 9>;
    groove: PrimitiveField<NexusLocation, "mut">;
    length: PrimitiveField<number, "mut">;
    slot: PrimitiveField<NexusLocation, "immut">;
    stepScaleIndex: PrimitiveField<number, "mut">;
}

Index

Properties

channelPatterns groove length slot stepScaleIndex

Properties

channelPatterns

channelPatterns: ArrayField<NexusObject<MachinisteChannelPattern>, 9>

Storage of the actual pattern steps for each of the 9 channels.

groove

groove: PrimitiveField<NexusLocation, "mut">

Every pattern can have a groove applied individually.

key	value
default	empty location
required	false
targets	api.TargetType.Groove, meaning one of: entities.Groove

length

length: PrimitiveField<number, "mut">

Number of steps before the pattern repeats.

key	value
default	16
range	[1, 128]

slot

slot: PrimitiveField<NexusLocation, "immut">

The slot in a machiniste that this pattern belongs to.

key	value
default	no default, required
required	true
targets	api.TargetType.MachinistePatternSlot, meaning one of: entities.Machiniste.patternSlots
immutable	true

stepScaleIndex

stepScaleIndex: PrimitiveField<number, "mut">

The duration of each step in ticks:

0: invalid
1: 4 steps per 1/4th note = 1/16th semibreve (960 ticks) per step
2: 8 steps per 1/4th note = 1/32nd semibreve (480 ticks) per step
3: 3 steps per 1/4th note = 1/12th semibreve (1280 ticks) per step
4: 6 steps per 1/4th note = 1/24th semibreve (640 ticks) per step

key	value
default	1
range	[1, 4]