Skip to content

State

The state functions within the ui module are used to query and control the state of FL Studio's user interface.

isClosing 

isClosing() -> bool

Returns True when FL Studio is closing.

Returns

  • bool: whether is closing.

Included since API version 1.

isMetronomeEnabled 

isMetronomeEnabled() -> bool

Returns whether the metronome is enabled.

Returns

  • bool: whether metronome is enabled.

Included since API version 1.

isStartOnInputEnabled 

isStartOnInputEnabled() -> bool

Returns whether start on input is enabled.

Returns

  • bool: whether start on input is enabled.

Included since API version 1.

isPrecountEnabled 

isPrecountEnabled() -> bool

Returns whether precount is enabled.

Returns

  • bool: whether precount is enabled.

Included since API version 1.

isLoopRecEnabled 

isLoopRecEnabled() -> bool

Returns whether loop recording is enabled.

Returns

  • bool: whether loop recording is enabled.

Included since API version 1.

getSnapMode 

getSnapMode() -> int

Returns the current snap mode.

Returns

Included since API version 1.

snapMode 

snapMode(value: int) -> int

Changes the snap mode, by shifting it by value in the list of modes.

This can be used by controls such as jog wheels or arrow buttons to select a snapping mode. To select a value directly, use ui.setSnapMode().

Args

  • value (int): delta (1 for next, -1 for previous).

Returns

  • int: ???

Included since API version 1.

setSnapMode 

setSnapMode(value: int) -> None

Set the snap mode using an absolute value.

This can be used on a controller to have different buttons map to different modes. To increment or decrement the value, use ui.snapMode().

Args

Included since API version 24.

snapOnOff 

snapOnOff() -> int

Toggle whether snapping is enabled globally.

Returns

  • int: ?

Included since API version 1

getTimeDispMin 

getTimeDispMin() -> bool

Returns True when the song position panel is displaying time, rather than bar and beat.

Returns

  • bool: whether song position is displaying time.

Included since API version 1.

setTimeDispMin 

setTimeDispMin() -> None

Toggles whether the song position panel is displaying time or bar and beat.

Included since API version 1.

getHintMsg 

getHintMsg() -> str

Returns the current message in FL Studio's hint panel.

Returns

  • str: hint.

Included since API version 1.

setHintMsg 

setHintMsg(msg: str) -> None

Sets the current hint message in FL Studio's hint panel to msg.

For information about using icons within hint messages, refer to the hint message icon tutorial.

Args

  • msg (str): new message.

Included since API version 1.

showNotification 

showNotification(notificationId: int)

Show a notification to the user, which is chosen from a set of notification strings. This notification appears in the hint panel, much like with ui.setHintMsg(), except with less customization. Currently there is no apparent way to link these to the Script output window.

WARNING

  • This function appears to cause FL Studio's scripting environment to crash when used under Wine on Linux.

Note

  • This function is not documented.

Args

  • notificationId (int): Notification ID, the identifier of the notification string to send.

    • 0: "Now firmware is available for your MIDI device"

    • 1: "New version of script is available"

Included since API Version 20

getHintValue 

getHintValue(value: int, max: int) -> str

Returns value/max as a percentage.

Equivalent to:

f"{value/max:.0%}"

Args

  • value (int): the value.

  • max (int): the maximum value.

Returns

  • str: hint for value.

Included since API version 1.

getProgTitle 

getProgTitle() -> str

Returns the title of the FL Studio window.

Returns

  • str: program title.

Included since API version 1.

getVersion 

getVersion(mode: int = 4) -> str | int

Returns the version number of FL Studio.

Args

  • mode (int, optional):

    • VER_Major (0): Major version number (as int) Eg: 20.

    • VER_Minor (1): Minor version number (as int) Eg: 8.

    • VER_Release (2): Release version number (as int) Eg: 4.

    • VER_Build (3): Program build number (as int) Eg: 2553.

    • VER_VersionAndEdition (4): Program version and edition (as str). Eg: "Producer Edition v20.8.4 [build 2553]"

    • VER_FillVersionAndEdition (5): Full version and edition (as str). Eg: "Producer Edition v20.8.4 [build 2553] - Signature Bundle - 64Bit".

    • VER_ArchAndBuild (6): Operating system and system architecture. Eg: "Windows - 64Bit [BETA]"

Returns

  • int or str: FL Studio version information.

Included since API version 1, with mode parameter since API version 7.

getStepEditMode 

getStepEditMode() -> bool

Returns the value of the "step edit mode" within FL Studio.

Returns

  • bool: True if step editing is enabled, else False.

Included since API Version 28.

setStepEditMode 

setStepEditMode(newValue: bool)

Sets the value of the "step edit mode" within FL Studio.

Args

  • newValue (bool): True if step editing should be enabled, else False.

Included since API Version 28.