Skip to content

Documentation for flpianoroll, ScriptDialog.AddInputCombo unclear #76

@HiddePoel

Description

@HiddePoel

When you add this input to a ScriptDialog, the function ScriptDialog.GetInputValue() will return the index of the chosen option. This is unclear from reading the documentation. Some developers might expect that it returns the string that represents the chosen option.

Suggestion for clarifying the description:

AddInputCheckbox(
name: str, value: bool, hint: str = ""
) -> None
Adds a checkbox input control with string value

Args:
	name (str): Name of control
	value (bool): Initial value
	hint (str, optional): Text to display in hint panel

Note:
	ScriptDialog.GetInputValue() will return the integer index of the selected option for this input type

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions