Skip to content

Commit 8633032

Browse files
committed
update CycleMapContext docs
1 parent 82b68e6 commit 8633032

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

types/nerdo/library/cycle.lua

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,16 @@
66

77
----------------------------------------------------------------------------------------------------
88

9-
---Context passed to 'emit' functions.
9+
---Context passed to 'cycle:map` functions.
1010
---@class CycleMapContext : TimeContext
1111
---
1212
---channel/voice index within the cycle. each channel in the cycle gets emitted and thus mapped
1313
---separately, starting with the first channel index 1.
1414
---@field channel integer
15-
---Continues step counter for each channel, incrementing with each new value in the cycle.
16-
---Unlike `pulse_step` this does not include holds so it basically counts how often the map
17-
---function already got called.
18-
---Starts from 1 when the rhythm starts running or after it got reset.
15+
---Continues step counter for each channel, incrementing with each new mapped value in the cycle.
16+
---Starts from 1 when the cycle starts running or after it got reset.
1917
---@field step integer
20-
---step length fraction within the cycle
18+
---step length fraction within the cycle, where 1 is the total duration of a single cycle run.
2119
---@field step_length number
2220

2321
----------------------------------------------------------------------------------------------------

0 commit comments

Comments
 (0)