Login
Create

Workshop Settings Last updated February 20, 2021

Jump To:


Overview

Oftentimes, a Workshop developer may wish to allow the lobby host to customize certain aspects of their Workshop mode without requiring said host to open up the Workshop rules. The Workshop Settings values address this issue by introducing a new custom submenu of options for lobby hosts.

General Usage

A Workshop Setting is created when a Workshop Setting value is used within the Rules of a Workshop mode. The submenu itself automatically shows up as long as one or more Workshop Settings are included in the Rules of a Workshop mode.

All Workshop settings contain a Name field, and no two Workshop Setting values can share the same name. Within the Workshop script, a Workshop Setting value will evaluate to a value depending on what type of Workshop Setting it is (see Types of Workshop Settings.)

Workshop Settings are grouped by their Category field (case-sensitive). Categories appear in the order that they are listed in the script. Within a Category, each setting is ordered first by its sort order (bigger sort order = lower on the screen), then alphanumerically.

Types of Workshop Settings

Combo

Workshop Settings Menu

Workshop Editor Example

A Workshop Setting Combo is used to define a list of strings which the host may choose from. The string selected is then communicated to the Workshop mode as the index of the string selected, with the first item being index 0.

For example, if the Workshop mode presents options "Option A", "Option B", and "Option C", in that order, and the host selects "Option B", the Workshop Setting will evaluate internally to 1.

Full Wiki Article: Workshop Setting Combo

Hero

Workshop Settings Menu

Workshop Editor Example

A Workshop Setting Hero value is used to select a hero from the roster of available heroes. This value will evaluate to a hero value just like the Hero value.

Full Wiki Article: Workshop Setting Hero

Integer

Workshop Settings Menu

Workshop Editor Example

A Workshop Setting Integer allows the lobby host to select a whole number from a range of whole numbers (limits included). The value will evaluate to a whole number.

Full Wiki Article: Workshop Setting Integer

Real

Workshop Settings Menu

Workshop Editor Example

A Workshop Setting Real allows the lobby host to select any real number from a range of numbers (limits included). The value will evaluate to a real number.

Full Wiki Article: Workshop Setting Real

Toggle

Workshop Settings Menu

Workshop Editor Example

A Workshop Setting Toggle allows the lobby host to toggle something On or Off. The value will evaluate to True if the setting is turned On, and False if the setting is turned Off.

Full Wiki Article: Workshop Setting Toggle

Full Workshop Code:

rule("Rule 1")
{
    event
    {
        Ongoing - Global;
    }

    actions
    {
        Global.A = Workshop Setting Combo(Custom String("Category Name Here"), Custom String("Combo"), 0, Array(Custom String("Option 1"),
            Custom String("Option 2"), Custom String("Option 3")), 0);
        Global.B = Workshop Setting Hero(Custom String("Category Name Here"), Custom String("Hero"), Ana, 0);
        Global.C = Workshop Setting Integer(Custom String("Category Name Here"), Custom String("Integer"), 0, 0, 100, 0);
        Global.D = Workshop Setting Real(Custom String("Category Name Here"), Custom String("Real"), 0, 0, 100, 0);
        Global.E = Workshop Setting Toggle(Custom String("Category Name Here"), Custom String("Toggle"), False, 0);
    }
}
Elo Hell Logo_H-M-Dark
Join the Elo Hell Workshops Discord