Preferences System

[LucaHaverty]

Description

A system to save and load player preferences including settings from the settings modal, robot controls, robot game piece manipulation configuration, field scoring zone data, and color themes. There are default preferences that will be used if a preference is not yet configured by the user.

Objectives

• System for getting/settings preferences, including default preferences
• Ability to save and load preferences to local storage
• Integrate with the settings modal
• Integrate with the robot controls modal
• Saving and loading of robot specific preferences
• Saving and loading of field specific preferences

Note

The goal of this PR is to build a system to load, modify, and save preferences, not to make the preferences themselves have an effect on gameplay. While you should be able to change like zoom sensitivity for example, it won't yet affect the actual camera movement. The only preferences that should fully work are robot controls and color themes.

Preferences List (all checked off have been implemented AND TESTED)

• Global

  • Screen mode
  • Quality
  • Zoom sensitivity
  • Pitch sensitivity
  • Yaw sensitivity
  • Report analytics
  • Use metric
  • Render scoring zones

• Robot Specific

  • Control scheme
  • Intake transform
  • Ejector transform and velocity

• Field Specific

  • Scoring zones (location, alliance, points, destroy GP, persistent, parent obj)
  • Default robot spawn location

Testing Done

• All controls that are checked off have been tested

How to add a global preference

1. Add it to type GlobalPreference in PreferencesTypes.ts

export type GlobalPreference =
    | "ScreenMode"
    ...
    | "MyPreference"

2. Assign it a default value in PreferenceTypes.ts

 export const DefaultGlobalPreferences: { [key: string]: Object } = {
    "ScreenMode": "Windowed",
    ...
    "MyPreference":  0.5,
}

3. From anywhere, set the value by calling

PreferencesSystem.setGlobalPreference<number>("MyPreference", 2)

4. From anywhere, get the value by calling. This is guaranteed to return a value, and will return the default value if it has not yet been assigned

PreferencesSystem.getGlobalPreference<number>("MyPreference")

Warning

Merge after #986

JIRA Issue

[LucaHaverty]

Access events from elsewhere by calling
PreferencesSystem.addEventListener((e) => { /* functionality here */ })

[HunterBarclay]

This will definitely be shaped as it gets used more and more, but good for now

[PepperLola]

Could this and robotsSpawned be combined? Maybe a map from key to list of spawned robots? That might be a bit slower if we're iterating over robotsSpawned a lot but it would also mean the information would only be stored in one place and we don't have to maintain two separate places.

[LucaHaverty]

An issue I see with this is if you spawn two robots for example 'mean machine [0]' and 'mean machine [1]', then remove only 'mean machine [0]', it needs to know that the robot still around is index 1 not 0. I can't think of an easy way around this, but let me know if you do.

[BrandonPacewic]

Love it. Nice work!