Class Selector UI Devices

Create a UI element that lists the classes that players can choose from.

The Class Selector UI device can create both a popup dialog and a new tab on the game Map screen to display a list of classes players can choose from. You can use this class selection UI in many ways:

  • Have players choose a class when they spawn at the beginning of the game, and they keep that class for the entire game.

  • Allow players to choose their class when the game starts, then let them change their class when they respawn during the game.

  • Decide whether a class change happens with the popup dialog or the Map screen tab, or both if they both are available.

Below are illustrations of the Class Selector UI popup dialog, and the Class Selector UI tab on the Map screen.

Class Selector UI Popup Dialog

Class Selector UI Map Screen

Class Selector UI Popup Dialog

Class Selector UI Map Screen

The list of classes can also provide more details about a class to the player, such as what weapon loadout or resources are granted to that class.

This device requires that you use the Class Designer device. The Class Designer, along with the Team Settings & Inventory device, can sometimes override My Island settings. This could produce unexpected results if you are not aware of how the game prioritizes these settings. The hierarchy of setting or device option overrides is as follows:

  • My Island settings are the baseline for an island.

  • Options in the Team Settings & Inventory device override My Island settings if there is a specific value set in the device.

  • The Class Designer device overrides both Team Settings & Inventory and My Island, if there is a specific value set in the device that differs from the My Island or Team Settings & Inventory values.

  • Some options in the Class Selector UI device override Class Designer options.

You can only place one instance of this device on an island.

Using the Class Selector UI

To use this device effectively, you need to use it with Class Designer devices (one Class Designer for each class you want to provide for players). First, place the Class Selector UI device, then place your Class Designer devices. Set up your Class Designers for each class you want to provide to players:

  • Add a class name and description (these are Class Designer options used by the Class Selector UI device).

  • Add a different class identifier for each class.

  • Add whatever items, weapons and resources you want to grant each class.

  • Make sure that each Class Designer has the Visible in UI option set to Yes.

There are also channel options in the Class Designer that you can use to enable or disable the class selection UI. For more information on the Class Designer device, see Class Designer Devices in the Creative documentation.

Finding and Placing the Device

Click image to enlarge.

  1. From Create mode, press the Tab key to open the CREATIVE inventory screen.

  2. Click the DEVICES tab. You can scroll to select the device, use the Search box to look up the device by name, or the Categories in the panel on the left.

  3. Click PLACE NOW to place immediately, or put the device in the QUICK BAR to place later.

  4. Press Esc to return to your island in Create mode. Use your phone to position the device, then click to place it. Press Esc to detach the device from your phone.

  5. Point at the device with your phone. If the CUSTOMIZE popup doesn't open immediately, move closer until it does, then press E to open the Customize panel.

Contextual Filtering

Some devices are affected by a feature called contextual filtering. This feature hides or displays options depending on the values selected for certain related options. This feature will reduce clutter in the Customize panel and make options easier to manage and navigate. However, it may not be easy to recognize which options or values trigger contextual filtering. To help you identify them, in our device reference documents we use italic for any values that trigger contextual filtering. All options will be listed, including those affected by contextual filtering; if they are hidden or displayed based on a specific option's value, there will be a note about that in the Description field for that option.

Device Options

This device has some basic functionality, like enabling or disabling the device, and determining whether the Popup or Map screen UI displays. Additionally, there are some advanced options, like saving a player's shield and health data.

You can configure this device with the following options.

Default values are bold. Values that trigger contextual filtering are italic.

Basic Options

Option

Value

Description

Enabled

On, Off

Turns all functionality on or off, including whether the Pop-up UI appears and whether the UI appears in the Player Menu.

Label

Custom Label, Classes, Loadouts, Heroes, Adventurers, Warriors, Characters, Shopkeepers, Fisherfolk, Townsfolk, Monsters, Aliens, Soldiers, Zombies, Wizards, Survivors, Perks

A localized name used in the UI to describe what the classes are. This is used as the name of the new tab displayed in the Map screen and is used in the in-game UI. If you choose Custom Label, you can enter your own non-localized label; choosing Custom Label also displays two additional options.

Custom Singular Label

Enter text

This option is only displayed if you choose Custom Label for the Label option. The singular form of your custom label that appears in the UI (for example, "Class" instead of "Classes"). The text field is limited to 24 characters. The customized label is not localized to other languages.

Custom Plural Label

Enter text

This option is only displayed if you choose Custom Label for the Label option. The plural form of your custom label that appears in the UI (for example, "Classes" instead of "Class"). The text field is limited to 24 characters. The customized label is not localized to other languages.

Show Popup UI

Manually Only, Player Spawn, Custom

Determines when the class selector popup dialog is automatically shown.

Show in Map Key Menu

Visible, Hidden

Determines whether the new class selector tab appears in the Map screen.

All Options (Additional)

Option

Value

Description

Player Can Disable Popup UI

On, Off

If this is set to On, players can click a button in the UI to disable the Popup class dialog from displaying when the player respawns. If the Show in Map Key Menu option is set to Visible, the player can still change their class from the Map screen.

Popup Auto Select Timer

30 seconds, Pick an amount of time

By default, a 30-second timer is displayed when the class selector popup opens. You can select or type in a different number of seconds for this timer. When the timer reaches zero, a class is automatically set for the player and the popup dialog closes. If this option is set to 0 seconds, the timer is hidden.

Change on Next Respawn

Neither, Map Key Menu, Popup UI, Both

This setting delays the class change until the next time the player respawns, instead of changing the class immediately. By default this is set to only delay class changes made on the Map screen.

Show Close Button

Off, On

Determines whether the Close button is displayed in the class selector popup dialog or the class selector UI in the Map screen.

Always Grant Items on Respawn

On, Off

Determines whether the device grants items to players automatically on respawn. This overrides item-related options in the Class Designer devices.

Channels

When one device needs to "talk" to another device, it does so by transmitting a signal on a specific channel. The receiving device needs to be set up to receive the signal on the same channel.

A channel is identified by a number, and channel numbers are customized for a device under the option that uses the channel. Most devices will also pass the identity of the player who triggered the device with the signal.

This device has receivers that perform a variety of functions when receiving a signal over a channel. Also, this device can transmit signals when certain conditions are met.

Receivers

Receivers listen for a channel and perform an action when they hear any device (including themselves) send a signal on that channel.

Option

Value

Description

Enable When Receiving From

No channel, Pick a channel or enter a channel number

Enables the device when it receives a signal on the selected channel. When the device is enabled, the popup UI or Map screen UI can be displayed.

Disable When Receiving From

No channel, Pick a channel or enter a channel number

Disables the device when it receives a signal on the selected channel. When the device is disabled, neither the popup UI nor the Map screen UI will display.

Show Popup UI When Receiving From

No channel, Pick a channel or enter a channel number

Displays the class selector popup dialog when the device receives a signal on the selected channel.

Transmitters

Transmitters send a signal on the selected channel when triggered.

Option

Value

Description

When Class Selected Transmit On

No channel, Pick a channel or enter a channel number

When a player selects a class, the device transmits a signal on the selected channel.

When Popup UI Closed Transmit On

No channel, Pick a channel or enter a channel number

When a player closes the class selector popup dialog, the device transmits a signal on the selected channel.