A wave can have deliberate pauses without burying every spawn in the main loop.
Use it in a project
COUNT is 1–4 and INDEX must be below it. E0–E3 are event IDs and L0–L3 are delay ticks before each event. WAIT is retained elapsed delay. Each call with WAIT below the current delay increments it without firing; otherwise emit that event, reset WAIT and advance INDEX. At the final event DONE latches. At most one event fires per call, even when delays are zero.
Include component.inc once (MOS callers include the shared 6502 implementation through it). Reserve the public fields in this exact order: EVENT, FIRED, INDEX, WAIT, COUNT, DONE, VALID, E0, E1, E2, E3, L0, L1, L2, L3. They occupy 15 contiguous bytes. Also reserve the private workspace: T0 (1 bytes). Array names in the explanation refer to the numbered consecutive bindings, such as C0, C1 and so on.
Call spawn_timeline_init once at the intended reset boundary. It clears inputs as well as outputs and workspace. Set your starting state and configuration afterwards, then call spawn_timeline_step whenever the described event occurs. The helper reads no device, waits for no frame and installs no interrupt handler.
| Ownership | Fields |
|---|---|
| Retain between calls | INDEX, WAIT and DONE |
| Supply before service | COUNT, E0–E3 and L0–L3 |
| Read after service | EVENT, FIRED and VALID |
A cursor selects the event and its delay. Emitting at most one event bounds per-update work and makes zero-delay entries consecutive updates rather than an unbounded burst.
Reusable initialisation and service
; SPDX-License-Identifier: MIT
; Service a Small Spawn Timeline. See README.md for the byte interface and ownership.
; init clears the public fields and private workspace; set inputs afterwards.
spawn_timeline_init:
move.b #0,d0
move.b d0,EVENT
move.b d0,FIRED
move.b d0,INDEX
move.b d0,WAIT
move.b d0,COUNT
move.b d0,DONE
move.b d0,VALID
move.b d0,E0
move.b d0,E1
move.b d0,E2
move.b d0,E3
move.b d0,L0
move.b d0,L1
move.b d0,L2
move.b d0,L3
move.b d0,T0
rts
spawn_timeline_step:
; EVENT = 255
move.b #255,d0
move.b d0,EVENT
; FIRED = 0
move.b #0,d0
move.b d0,FIRED
; VALID = 0
move.b #0,d0
move.b d0,VALID
; if COUNT == 0:
move.b COUNT,d0
cmp.b #0,d0
beq spawn_timeline_L1
jmp spawn_timeline_L2
spawn_timeline_L1:
; return
rts
jmp spawn_timeline_L3
spawn_timeline_L2:
spawn_timeline_L3:
; if COUNT > 4:
move.b COUNT,d0
cmp.b #4,d0
bhi spawn_timeline_L4
jmp spawn_timeline_L5
spawn_timeline_L4:
; return
rts
jmp spawn_timeline_L6
spawn_timeline_L5:
spawn_timeline_L6:
; if INDEX >= COUNT:
move.b INDEX,d0
move.b COUNT,d1
cmp.b d1,d0
bcc spawn_timeline_L7
jmp spawn_timeline_L8
spawn_timeline_L7:
; return
rts
jmp spawn_timeline_L9
spawn_timeline_L8:
spawn_timeline_L9:
; VALID = 1
move.b #1,d0
move.b d0,VALID
; if DONE != 0:
move.b DONE,d0
cmp.b #0,d0
bne spawn_timeline_L10
jmp spawn_timeline_L11
spawn_timeline_L10:
; return
rts
jmp spawn_timeline_L12
spawn_timeline_L11:
spawn_timeline_L12:
; T0 = L[INDEX]
moveq #0,d1
move.b INDEX,d1
lea L0,a0
move.b 0(a0,d1.w),d0
move.b d0,T0
; if WAIT < T0:
move.b WAIT,d0
move.b T0,d1
cmp.b d1,d0
bcs spawn_timeline_L13
jmp spawn_timeline_L14
spawn_timeline_L13:
; WAIT = WAIT + 1
move.b WAIT,d0
add.b #1,d0
move.b d0,WAIT
; return
rts
jmp spawn_timeline_L15
spawn_timeline_L14:
spawn_timeline_L15:
; EVENT = E[INDEX]
moveq #0,d1
move.b INDEX,d1
lea E0,a0
move.b 0(a0,d1.w),d0
move.b d0,EVENT
; FIRED = 1
move.b #1,d0
move.b d0,FIRED
; WAIT = 0
move.b #0,d0
move.b d0,WAIT
; T0 = COUNT - 1
move.b COUNT,d0
sub.b #1,d0
move.b d0,T0
; if INDEX < T0:
move.b INDEX,d0
move.b T0,d1
cmp.b d1,d0
bcs spawn_timeline_L16
jmp spawn_timeline_L17
spawn_timeline_L16:
; INDEX = INDEX + 1
move.b INDEX,d0
add.b #1,d0
move.b d0,INDEX
jmp spawn_timeline_L18
spawn_timeline_L17:
; DONE = 1
move.b #1,d0
move.b d0,DONE
spawn_timeline_L18:
rts
component_end:Machine contract
D0–D3/A0–A1/CCR may change; D4–D7/A2–A6 are preserved. A direct BSR/JSR needs four return-address stack bytes. The helper makes no nested calls and adds no other stack use. Its named scratch is private workspace, not a pointer, a ROM variable or shared zero-page space that the game may borrow concurrently. The samples use fixed symbol bindings. Scope or rename every label and binding, including the component_end measurement marker, and allocate a separate block for each independent instance. Different helpers can also use common field names, so combining them needs separate namespaces or explicitly renamed bindings. Give each block one mutation owner.
The A500 OCS diagnostic cold-boots an OFS disk, owns the Copper and bitplane and disables interrupt/DMA sources. The helper does not take over hardware or allocate Chip RAM.
Adapt the caller
demo.asm supplies the bindings and include order. exercise.inc first runs table cases, then a separate client retaining state between calls. A game can call the public step entry directly and remove the diagnostic packet and display. Do not copy the diagnostic’s hardware takeover into an existing game loop.
Build with make ASM198X=/path/to/asm198x and BUILD198X=/path/to/build198x. The Makefile produces normal, custom, deliberately wrong and repaired programs. Tools must already be installed; the sample downloads nothing.
Bindings and include order
section code,code_c
CUSTOM = 0
BROKEN = 0
COYOTE_STEPS = 4
BUFFER_STEPS = 4
TEXT_CAP = 8
PROPERTY_COUNT = 16
STREAM_BYTES = 13
CRC_POLY = 7
include "caller.inc"
include "exercise.inc"
component_start:
include "component.inc"
even
include "data.inc"
include "cases.inc"
even
include "display.inc"
include "../../framework/turn-deadline/font.inc"
code_end:
STATE:
EVENT: dc.b 0
FIRED: dc.b 0
INDEX: dc.b 0
WAIT: dc.b 0
COUNT: dc.b 0
DONE: dc.b 0
VALID: dc.b 0
E0: dc.b 0
E1: dc.b 0
E2: dc.b 0
E3: dc.b 0
L0: dc.b 0
L1: dc.b 0
L2: dc.b 0
L3: dc.b 0
T0: dc.b 0
even
ready: dc.w 0
preview: dcb.b 8,0
OUTPUT: dcb.b 1300,0
even
signature: dc.b "198XWORLDKIT000",0
even
copperlist:
dc.w $08e,$2c81,$090,$2cc1,$092,$0038,$094,$00d0
dc.w $100,$1200,$102,0,$104,0,$108,0,$10a,0
dc.w $180,$012,$182,$fff
copbpl:
dc.w $0e0,0,$0e2,0
dc.w $ffff,$fffe
plane: dcb.b 10240,0A client retaining state between calls
preview_rules:
ifne CUSTOM
; COUNT = 2
move.b #2,d0
move.b d0,COUNT
; E0 = 9
move.b #9,d0
move.b d0,E0
; E1 = 3
move.b #3,d0
move.b d0,E1
; L0 = 1
move.b #1,d0
move.b d0,L0
; L1 = 0
move.b #0,d0
move.b d0,L1
ifne BROKEN
; INDEX = 0
move.b #0,d0
move.b d0,INDEX
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; INDEX = 0
move.b #0,d0
move.b d0,INDEX
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; INDEX = 0
move.b #0,d0
move.b d0,INDEX
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; INDEX = 0
move.b #0,d0
move.b d0,INDEX
endif
bsr checked_step
bsr emit_state
rts
else
; COUNT = 3
move.b #3,d0
move.b d0,COUNT
; E0 = 2
move.b #2,d0
move.b d0,E0
; E1 = 4
move.b #4,d0
move.b d0,E1
; E2 = 7
move.b #7,d0
move.b d0,E2
; L0 = 0
move.b #0,d0
move.b d0,L0
; L1 = 2
move.b #2,d0
move.b d0,L1
; L2 = 1
move.b #1,d0
move.b d0,L2
ifne BROKEN
; INDEX = 0
move.b #0,d0
move.b d0,INDEX
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; INDEX = 0
move.b #0,d0
move.b d0,INDEX
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; INDEX = 0
move.b #0,d0
move.b d0,INDEX
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; INDEX = 0
move.b #0,d0
move.b d0,INDEX
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; INDEX = 0
move.b #0,d0
move.b d0,INDEX
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; INDEX = 0
move.b #0,d0
move.b d0,INDEX
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; INDEX = 0
move.b #0,d0
move.b d0,INDEX
endif
bsr checked_step
bsr emit_state
endif
rtsCustomise it
Use two different events and move the opening delay. The maintained custom caller changes its inputs or client sequence rather than hiding a different implementation behind the same label. Compare every state of the two clients, not only their final display.
Custom client selection
section code,code_c
CUSTOM = 1
BROKEN = 0
COYOTE_STEPS = 2
BUFFER_STEPS = 2
TEXT_CAP = 4
PROPERTY_COUNT = 16
STREAM_BYTES = 13
CRC_POLY = 49
include "caller.inc"
include "exercise.inc"
component_start:
include "component.inc"
even
include "data.inc"
include "cases.inc"
even
include "display.inc"
include "../../framework/turn-deadline/font.inc"
code_end:
STATE:
EVENT: dc.b 0
FIRED: dc.b 0
INDEX: dc.b 0
WAIT: dc.b 0
COUNT: dc.b 0
DONE: dc.b 0
VALID: dc.b 0
E0: dc.b 0
E1: dc.b 0
E2: dc.b 0
E3: dc.b 0
L0: dc.b 0
L1: dc.b 0
L2: dc.b 0
L3: dc.b 0
T0: dc.b 0
even
ready: dc.w 0
preview: dcb.b 8,0
OUTPUT: dcb.b 1300,0
even
signature: dc.b "198XWORLDKIT000",0
even
copperlist:
dc.w $08e,$2c81,$090,$2cc1,$092,$0038,$094,$00d0
dc.w $100,$1200,$102,0,$104,0,$108,0,$10a,0
dc.w $180,$012,$182,$fff
copbpl:
dc.w $0e0,0,$0e2,0
dc.w $ffff,$fffe
plane: dcb.b 10240,0The custom diagnostic row is FF 00 01 00 02 01 01 09. The full client trace in the source explains how it gets there.
Mistake and repair
The wrong caller rewinds INDEX each update, so the first event keeps firing and the rest of the wave never arrives. Retain the cursor and waiting state until a deliberate timeline restart.
The BROKEN branch lives in the sequential client, not the reusable helper. wrong.asm selects it; repaired.asm restores the normal call sequence. The repaired executable matches the normal program (for Spectrum, compare loaded CODE rather than the tape filename).
Select the deliberately wrong client
section code,code_c
CUSTOM = 0
BROKEN = 1
COYOTE_STEPS = 4
BUFFER_STEPS = 4
TEXT_CAP = 8
PROPERTY_COUNT = 16
STREAM_BYTES = 13
CRC_POLY = 7
include "caller.inc"
include "exercise.inc"
component_start:
include "component.inc"
even
include "data.inc"
include "cases.inc"
even
include "display.inc"
include "../../framework/turn-deadline/font.inc"
code_end:
STATE:
EVENT: dc.b 0
FIRED: dc.b 0
INDEX: dc.b 0
WAIT: dc.b 0
COUNT: dc.b 0
DONE: dc.b 0
VALID: dc.b 0
E0: dc.b 0
E1: dc.b 0
E2: dc.b 0
E3: dc.b 0
L0: dc.b 0
L1: dc.b 0
L2: dc.b 0
L3: dc.b 0
T0: dc.b 0
even
ready: dc.w 0
preview: dcb.b 8,0
OUTPUT: dcb.b 1300,0
even
signature: dc.b "198XWORLDKIT000",0
even
copperlist:
dc.w $08e,$2c81,$090,$2cc1,$092,$0038,$094,$00d0
dc.w $100,$1200,$102,0,$104,0,$108,0,$10a,0
dc.w $180,$012,$182,$fff
copbpl:
dc.w $0e0,0,$0e2,0
dc.w $ffff,$fffe
plane: dcb.b 10240,0
Cost and alternatives
The measured helper extent is 370 code bytes; public state is 15 bytes and private scratch is 1 bytes. There are no immutable helper tables. Caller data, the test cases, return-address stack, alignment and display buffers cost additional space. These are assembled sizes, not cycle measurements.
Constant work per tick with four caller-owned event/delay pairs. A larger asset-backed timeline needs bounds checks on its record count and a policy for reading data.
Events are requests: the caller owns actual spawning, pool capacity and what to do when an event cannot be accepted. This helper advances after emission, so a reliable deferred-spawn policy must retain or queue rejected work explicitly.
Execution evidence
Four variants run on A500 OCS PAL, Kickstart1.3 OFS cold boot, using Asm198x 0.0.72, Emu198x 0.44.2 and Build198x 0.2.9. Each executes 64 boundary/varied/error table cases, dirty initialisation and the separate retained-state client. An independent mathematical/container model checks every public byte after every call. This is bounded example coverage, not exhaustive correctness for every possible state.
The records retain loaded immutable code, completion, register sentinels, full packets, source/tool/firmware hashes and captures. The public gate validates these retained observations and rejects altered evidence; it does not run restricted firmware. No firmware is distributed. The eight displayed bytes are the first eight public fields, zero-padded when shorter; the packet includes every field.
Where it fits
Event queues: A timeline can emit into a queue when the spawn consumer runs at a different point in the frame.