MapObj Parameters

[Scutlet]

Changes the way MapObj Parameters can be edited, providing more background information and limited validation. Moves all the hardcoded parameter descriptions to several JSON files.
DX mapObjs are not included as they were not present previously.

Supports parameter descriptions, default values, validation (min/max)

Details

Defines parameter types: float (default), int, bool, bytes, time, enum. Under the hood everything remains a float, only the widget changes. It's always possible to revert back to the old layout through a toggle ("Raw")

Details

Local overrides. This way, parameters can be documented on the go. An edit button is included as a shortcut to the user folder. Errors in the file format are displayed.

Details

Shows supported game versions. A toggle allows hiding unsupported parameters. This only really affects the Item Box Double-parameter.

Details

Search for mapObj aliases in the asset list and outliner. E.g. When searching for "Thwomp", lists "Dossun".
- NB: Requires Toolbox.core and MapStudio.UI to be updated (see separate PR's there as well)

Details

JSON Example

The same info is included in the user folder.

    ...
    "3026": {
        "name": "DL_Metro",
        "description": "A subway train with a variable number of wagons.",
        "aliases": [ "Train", "Subway" ],
        "usages": [ "U Super Bell Subway" ],
        "versionU": "Animal",
        "param_0": {
            "name": "Number of trains",
            "description": "Number of wagons. The locomotive has a boost panel at the front.",
            "type": "int",
            "default": 6,
            "minValue": 1
        },
        "param_1": {
            "default": 5
        },
        "param_2": {
            "default": 5
        },
        "param_3": {
            "default": 6
        },
        "param_4": {
            "name": "First respawn delay",
            "description": "The duration after which the train respawns in its starting position. The train will respawn at path point 0 of its assigned rail path when the timer ends, even if it's still moving on its path. If 0, the train doesn't respawn. For path-loops this means it keeps going.",
            "type": "time",
            "default": 0,
            "minValue": 0
        },
        "param_5": {
            "name": "Consecutive respawn delay",
            "description": "Identical to the previous parameter, but instead for every respawn after the first.",
            "type": "time",
            "default": 0,
            "minValue": 0
        },
        "param_6": {
            "name": "Train color",
            "type": "enum",
            "default": 1,
            "enum": {
                0: "Red",
                1: "Blue"
            }
        },
        "param_7": {
            "default": 1
        }
    }
    ...

JSON description

    "3026": { // MapObj ID
        "name": "DL_Metro", // MapObj name
        "description": "A subway train with a variable number of wagons.",
        "aliases": ["Train", "Subway"], // Additional search terms in the asset viewer and outliner
        "usages": ["U Super Bell Subway"],
        "versionU": 0, // Wii U version this mapObj was introduced in (Default 0/"base"). -1 means unsupported in Wii U
        "versionDX": "base", // Same as above, but for Deluxe
        "param_0": {
            "name": "Number of trains",
            "description": "Number of wagons. The locomotive has a boost panel at the front.",
            "samples": [0.0, 3.0], // Example values
            "versionU": 0, // Same as for the mapObj, but instead specifically for this parameter
            "versionDX": 1, // Same as for the mapObj, but instead specifically for this parameter
            "type": "int", // Determines which widget to use. Valid values include, int, float, bool, time, enum, bytes
            "default": 0, // Default value when creating a new object
            "minValue": 0,
            "maxValue": null,
            "enum": { // Predetermined values with special meaning
                0: "Red",
                1: "Blue",
            }
        },
        // Unused parameters can be skipped. E.g., skip "param_1"
        "param_2": {} // Empty parameters are marked as 'used', but won't have any documentation
        ...
        "param_7": {}
    },

Any value can be left out, meaning you'll only need to define the docs you wish to add.
E.g., the following is valid:

    "3026": {
        "description": "Trains are fun!",
        "param_6": {
            "name": "Train Hue"
        }
    }

or even

    "3026": {
        "param_4": {}
    }