Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: document sprocket ordering #1625

Merged
merged 1 commit into from
Dec 5, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lua/lib/lattice.lua
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ end
-- - "enabled" (boolean) is this sprocket enabled, defaults to true
-- - "swing" (number) is the percentage of swing (0 - 100%), defaults to 50
-- - "delay" (number) specifies amount of delay, as fraction of division (0.0 - 1.0), defaults to 0
-- - "order" (number) specifies the place in line this lattice occupies from 1 to 5, lower first, defaults to 3
-- @treturn table a new sprocket
function Lattice:new_sprocket(args)
self.sprocket_id_counter = self.sprocket_id_counter + 1
Expand Down Expand Up @@ -231,4 +232,4 @@ function Sprocket:set_delay(delay)
self.delay_new = util.clamp(delay,0,1)
end

return Lattice
return Lattice