Filter Inputs

Here's a list of all available inputs:

• Primitive/Basic inputs

  • Boolean Field

    • Description: Allows for True/False inputs, the checkbox can be set to be initially checked or not
    • Input example: ("Checkbox", False) or ("Checkbox", True)
    • UI Representation: A checkbox field, either initially check or not
    • Dictionary Representation: A Boolean, either True or False

  • Number Field

    • Description: Allows for whole and decimal number input
    • Input example: ("Whole Number", 1) or ("Decimal Number", 0.5)
    • UI Representation: A number field with the provided number as the default value
    • Dictionary Representation: Either an int object or a float object depending on the type of the field

  • Block Field

    • Description: Allows for Block type input
    • Input example: ("Block", "blocktype") or ("Block", alphaMaterials.Stone)
    • UI Representation: A Block selector field
    • Dictionary Representation: A :py:class:pymclevel.materials.Block object

  • String Field

    • Description: Allows for text input
    • Input example: ("Enter your name", "string")
    • UI Representation: A field that a user can type text into
    • Dictionary Representation: A string of the user entered text

  • Choice Field

    • Description: Allows for selecting an option from a dropdown list
    • Input example: ("Multiple Choice", ("First Option", "Second Option", "Third Option"))
    • UI Representation: A button that when clicked shows a dropdown menu and displays the current selected option
    • Dictionary Representation: The selected option as a string

  • Label Field

    • Description: Allows for displaying non-editable information/text to the user
    • Input example: ("Text to display", "label")
    • UI Representation: A line of text
    • Dictionary Representation: This field is not present in the Dictionary that is passed to the filter

  • Title Field

    • Description: Displays a title for the page when using multipage inputs
    • Input example: ("Title For Page", "title")
    • UI Representation: Shows up as the title for a page, only shows up when specifically using multipage inputs
    • Dictionary Representation: This field is not present in the Dictionary that is passed to the filter

• Advanced Fields

  • Variable Number Field

    • Description: Allows for whole and decimal number input with a custom minimum/maximum value and custom increment value
    • Input example: ("Limited range", (, )), ("Limited range and default value", (, , )), ("Limited range and custom increment", (, , , ))
    • UI Representation: A number field, default value is minimum if not specified
    • Dictionary Representation: Either an int object or a float object depending on the type of number in the field

  • Save File Field

    • Description: Allows for file selection via a save file dialog
    • Input example: ("Regular file saving", "file-save") or ("Save to certain file extensions", ("file-save", ["*.schematic", "*.nbt"]))
    • UI Representation: A button that when clicked will show a file save dialog. When finished, it displays the path to the file
    • Dictionary Representation: A string of the path to the selected file

  • Open File Field

    • Description: Allows for file selection via a open file dialog
    • Input example: ("Regular file opening", "file-open") or ("Open certain file extensions", ("file-open", [".schematic", ".nbt" ]))
    • UI Representation: A button that when clicked will show a file open dialog. When finished, it displays the path to the f ile
    • Dictionary Representation: A string of the path to the selected file