Type Alias Beatbox9Pattern

key	value
type	entity
key	`"beatbox9Pattern"`
is

A pattern for the composer

type Beatbox9Pattern = {
    groove: PrimitiveField<NexusLocation, "mut">;
    length: PrimitiveField<number, "mut">;
    slot: PrimitiveField<NexusLocation, "immut">;
    steps: ArrayField<NexusObject<Beatbox9PatternStep>, 64>;
    stepScaleIndex: PrimitiveField<number, "mut">;
}

Index

Properties

groove length slot steps stepScaleIndex

Properties

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">

Length of the pattern

key	value
default	16
range	[1, 64]

slot

slot: PrimitiveField<NexusLocation, "immut">

The beatbox9 this pattern belongs to, also includes the index of the pattern.

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

steps

steps: ArrayField<NexusObject<Beatbox9PatternStep>, 64>

Steps inside the current pattern.

stepScaleIndex

stepScaleIndex: PrimitiveField<number, "mut">

The duration of each step in ticks.

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

key	value
default	3
range	[1, 4]