miguelguthridge / fl-studio-api-stubs Goto Github PK

Currently the plugins stubs don't support global indexes, which were added in FL 21.0.3. Test, document, and code this.

Hello, I noticed on the API Stubs that most Live modules have "Help Wanted" on them, and I wanted to help clarify. "Live" in FL refers to Performance Mode

getDisplayZone() gets the display zone, which is this red box that shows up in performance mode over a specific area of blocks

liveDisplayZone() sets the area for a display zone in live mode, int left starts 0, int top starts at 1 referring to Track 1, int right refers to the amount of bars right, and int bottom refers to the bottom Track number.

getLiveLoopMode() at the int Track index gets the selection in the "Motion" tab when right clicking a track and looking at "Performance Settings"

getLiveTriggerMode() at the int Track index gets the selection in the "Press" tab when right clicking a track and looking at "Performance Settings"

getLivePosSnap() at the int Track index gets the selection in the "Position Sync" tab when right clicking a track and looking at "Performance Settings"

getLiveTrigSnap() at the int Track index gets the selection in the "Trigger Sync" tab when right clicking a track and looking at "Performance Settings"

getLiveStatus() at the int Track index gets if at the track index if any blocks are playing, scheduled, or if its empty

getLiveBlockStatus() at Track index, block index, gets back if the block is filled, scheduled, or playing (or empty with different flags)

getLiveBlockColor() at Track index, block index, gets the color of the specified block.

triggerLiveClip() at Track index, block index, flag, triggers the block clip at that index with the specified flag (I wish the documentation explained the flags)

refreshLiveClips() at Track index, for clip number refreshes the clip

incLivePosSnap, incLiveTrigSnap, incLiveLoopMode, and incLiveTrigMode at index increases the selection at "Position Sync", "Trigger Sync", "Motion", and "Press" tabs respectively for the track, I think value means what mode it uses for each one.

getVisTimeTick() I'm not sure what it gets, but I get different numbers depending on what clip I play, how many clips, and where they are in performance mode

getVisTimeStep() is a bit of the same, but I think it adds together all playing clips' positions in steps?

The ones I still couldn't figure out are lockDisplayZone() and getVisTimeBar(), but hopefully this helps you find how these work

channels.getChannelPitch and channels.setChannelPitch seem to have some very weird behavior. See if I can find a better explanation, and perhaps opena bug report with FL Studio.

Can you please add piano roll Scripting?
import flpianoroll

Thanks

Some functions such as channels.setChannelColor adjust the given color to ensure it remains readable, but others don't. Document this behaviour.

The fl_model code is incomplete, and in many cases doesn't reflect FL Studio's behavior. In a future version, support for it will be removed.

If you depend on this code to test your script, you may prefer to use the flapi library to remotely control FL Studio. In the near future, it will support decorating other scripts in order to provide support for decorating scripts so that unit tests can be written using frameworks such as Pytest. See Flapi#4

• Figure out a way to hook into Poetry's build system to rewrite all of the docstrings
• Set up a templating system so that repetitive parts of the docstrings can be added easily

Things to template-ify:

• Note on colors using utils module
• Note on playlist track indexes

Other useful features:

• Allow for separate rewriting depending on whether we are building the documentation site, or the Python package
• Rewrite links to functions to be documentation page links (full URL for docs package, internal link for the docs site)

The documentation states that FFNEP_DontPromptName is 1, where it doesn't work, but inputting 2 does work correctly and doesn't prompt a name when creating a new empty pattern.

src/transport/__position.py:88

Currently, the stubs won't give errors when calling a function with kwargs (eg: foo(value=42)), even though this causes errors in FL Studio.

Add a / as the last param for each API function in order to prevent kwarg usage.