Class Selector UI

How To Use[]

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.

All Settings[]

All default values have been Bolded.

All Options

Option	Value	Description
Enabled	On, Off	A way to turn all of the functionality on or off including whether the Popup UI appears and if the UI appears in the Map key 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	{Custom 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	{Custom 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	When to automatically show the Popup UI.
Player Can Disable Popup UI	On, Off	Shows a button in the UI allowing the player to disable seeing the Popup UI on respawn. If the UI is visible in the Map key menu, the player will still be able to change their Class there.
Popup Auto Select Timer	30 Seconds, Pick an amount of time	A time in seconds for when a class is automatically selected and the Popup UI closes. Setting this to zero seconds hides the timer.
Show in Map Key Menu	Visible, Hidden	Should the UI appear as a new tab in the Map key menu?
Change on Next Respawn	Neither, Map Key Menu, Popup UI, Both	Delays the Class change until the next respawns rather than changing the class immediately when selected.
Show Close Button	Off, On	Whether or not the player sees the Close button in the UI. Without it, the player will be forced to choose a Class to exit the UI.
Always Grant Items on Respawn	On, Off	Should the class selector UI always grant items on respawn?
Show HUD Message Post Popup UI	Always, Skip First Time, Never	When to show the HUD message about which class was selected after the popup version of the UI closes. This is useful for timing events at the start of the match in case the HUD message is overlapping with other player messaging at the beginning of the match.

Functions and Events[]

Functions

Option	Description
Enable When Receiving From	Allow the UI to appear when triggered as a Popup UI or in the Map key menu.
Disable When Receiving From	Makes it so the UI won't appear as a Popup UI or in the Player Menu, even if Activated.
Show Popup UI When Receiving From	Shows the Popup UI if the device is enabled.

Events

Option	Description
When Class Selected Send Event To	Triggered when a player selects a Class
When Popup UI Closed Send Event To	Triggered when the Popup UI closes, either because a class was selected or because the player used the Close Button. Will not trigger when the Map Key version of the UI closes.
When Popup UI Opened Send Event To	Triggered when the Popup UI opens.

Gallery[]