The library documents itself · Collections & objects
stzPattern
14 own methods · 0 forms written with extensions, listed under their method
the source: base/common/stzPattern.ring(opens in a new tab) · All classes · The area reference: Collections & objects
Under each method, its extensions (Q CS XT Z ZZ IB W U): bold and ticked, it exists; struck, it does not. The extensions and what they mean
Examples: 0 come from the library's tests; 7 were composed from each method's signature and run for this page, on a fresh object, for example o1 = new stzPattern("red ~ blue [green green]"). 7 methods have none yet. Examples run on 2026-10-03 12:54 inside the library at commit 0e72e2e2c.
Method
Explanation, as the source carries it
init
(no comment in the source: the name reads as a sentence) initno extension
IsValid
(no comment in the source: the name reads as a sentence) is validno extension
composed example
o1 = new stzPattern("red ~ blue [green green]")
? o1.IsValid()
#--> 1composed from the signature, run for this pageText
(no comment in the source: the name reads as a sentence) textno extension
composed example
o1 = new stzPattern("red ~ blue [green green]")
? o1.Text()
#--> red ~ blue [green green]composed from the signature, run for this pageLastError
(no comment in the source: the name reads as a sentence) last errorno extension
Refusals
(no comment in the source: the name reads as a sentence) refusalsno extension
composed example
o1 = new stzPattern("red ~ blue [green green]")
? o1.Refusals()
#--> 0composed from the signature, run for this pageTree
(no comment in the source: the name reads as a sentence) treeno extension
composed example
o1 = new stzPattern("red ~ blue [green green]")
? @@( o1.Tree() )
#--> [ "seq", [ [ [ "atom", [ "word", "red" ] ], 1 ], [ [ "rest" ], 1 ], [ [ "atom", [ "word", "blue" ] ], 1 ], [ [ "seq", [ [ [ "atom", [ "word", "green" ] ], 1 ], [ [ "atom", [ "word", "green" ] ], 1 ] ] ], 1 ] ] ]composed from the signature, run for this pageCycleEvents
querying ------------------------------------------------------------ The events of cycle `pnCycle` (a whole number, 0 is the first), sorted by onset: [ onset, length, kind, name ] with onset in [0, 1) and length in cycles. `kind` is "note" or "stroke".no extension
composed example
o1 = new stzPattern("red ~ blue [green green]")
? @@( o1.CycleEvents(2) )
#--> [ [ 0, 0.25, "word", "red" ], [ 0.50, 0.25, "word", "blue" ], [ 0.75, 0.13, "word", "green" ], [ 0.88, 0.13, "word", "green" ] ]composed from the signature, run for this pageDistinctValues
Every distinct [ kind, name, length ] over the pattern's first `pnCycles` cycles -- what a player prepares BEFORE it starts (in sound: renders), so nothing is prepared while a cycle is being posted.no extension
composed example
o1 = new stzPattern("red ~ blue [green green]")
? @@( o1.DistinctValues(2) )
#--> [ [ "word", "red", 0.25 ], [ "word", "blue", 0.25 ], [ "word", "green", 0.13 ] ]composed from the signature, run for this pagePeriod
How many cycles before the pattern repeats -- alternations, slow factors and Every all lengthen it. Capped at 64: a pattern that takes longer than that to come round is rendered as it arrives.no extension
composed example
o1 = new stzPattern("red ~ blue [green green]")
? o1.Period()
#--> 1composed from the signature, run for this pageFast
(no comment in the source: the name reads as a sentence) fastno extension
Slow
(no comment in the source: the name reads as a sentence) slowno extension
Rev
Each cycle backwards: an event at onset o of length d moves to 1-o-d.no extension
Every
On cycles 0, n, 2n, ... apply a transformation: :Rev, or [ :Fast, k ], or [ :Slow, k ]. The other cycles are left alone.no extension
Off
The pattern PLUS a copy of itself `pnCycles` later (0 < t < 1). What the shift pushes past the end of a cycle arrives at the start of the next. `pArg` is handed to _Shift for every copied value: here it changes nothing; a domain gives it a meaning (in sound: semitones).no extension