Skip to content

Commit

Permalink
Update docs for channels.getStepParam
Browse files Browse the repository at this point in the history
  • Loading branch information
MaddyGuthridge committed Aug 7, 2024
1 parent 3f47f1e commit 5e9ddb3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "fl-studio-api-stubs"
version = "37.0.0"
version = "37.0.1"

description = "Stub code, type definitions and documentation for the FL Studio Python API"
readme = "README.md"
Expand Down
14 changes: 10 additions & 4 deletions src/midi_controller_scripting/channels/__sequencer.py
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ def isGridBitAssigned(index: int, useGlobalIndex: bool = False) -> bool:
def getStepParam(
step: int,
param: int,
offset: int,
index: int,
startPos: int,
padsStride: int = 16,
useGlobalIndex: bool = False,
Expand All @@ -169,11 +169,17 @@ def getStepParam(
* `param` (`int`): one of the parameter types (see below).
* `offset` (`int`): ???
* `index` (`int`): channel index
* `startPos` (`int`): ????
* `offset` (`int`): step offset. This is added to the `step` value, but
allows you to look past the end of the pattern if the pattern length has
been limited (eg if the pattern length if `16`, `step` has a maximum of
`15`, but `offset` can be used to look further)
* `padsStride` (`int`, optional): ?????. Defaults to 16.
* `padsStride` (`int`, optional): pattern length control -- setting this
value determines the pattern's length during the lookup, and is an
alternate way to look past the end of a pattern if the pattern length has
been limited. Defaults to 16.
* `useGlobalIndex` (`bool`, optional): whether to use the global channel
index.
Expand Down

0 comments on commit 5e9ddb3

Please sign in to comment.