Extract reusable settings UI

Move the Commonwealth Online settings screen into a shared module with its own data, styles, and controller API. The pause menu now mounts the reusable component, keeps the prompt bar behavior consistent, and animates the panel open/close with a subtler transition.
This commit is contained in:
2026-07-05 21:30:52 +12:00
parent 1af6bbd3d2
commit 8acdb4f555
8 changed files with 1359 additions and 1217 deletions
+96 -694
View File
@@ -147,194 +147,11 @@
hydratePromptGlyphs();
// ── Multiplayer settings (data-driven) ─────────────────────────
var multiplayerSettings = [
{
section: "PROFILE",
items: [
{
key: "profile.displayName",
label: "Display Name",
type: "text",
value: "LoneWanderer",
description: "The name other players see in Commonwealth Online."
},
{
key: "profile.onlineStatus",
label: "Online Status",
type: "select",
value: "Friends",
options: ["Everyone", "Friends", "Nobody"],
description: "Who can see when you are online."
},
{
key: "profile.allowFriendJoin",
label: "Allow Friend Join",
type: "select",
value: "Ask First",
options: ["Always", "Ask First", "Never"],
description: "How friends may join your current session."
},
{
key: "profile.showLocationToFriends",
label: "Show Location To Friends",
type: "toggle",
value: true,
description: "Share your current cell or region with friends."
}
]
},
{
section: "VOICE CHAT",
items: [
{
key: "voice.voiceChat",
label: "Voice Chat",
type: "toggle",
value: true,
description: "Enable voice chat with other players."
},
{
key: "voice.pushToTalk",
label: "Push To Talk",
type: "toggle",
value: true,
description: "Require a key hold to transmit voice chat."
},
{
key: "voice.pushToTalkKey",
label: "Push To Talk Key",
type: "keybind",
value: "V",
description: "Key used for push-to-talk voice chat."
},
{
key: "voice.voiceChatVolume",
label: "Voice Chat Volume",
type: "slider",
value: 85,
min: 0,
max: 100,
step: 5,
description: "Adjusts incoming voice chat volume."
},
{
key: "voice.mutePlayersByDefault",
label: "Mute Players By Default",
type: "toggle",
value: false,
description: "Start new sessions with other players muted."
}
]
},
{
section: "MAP & SOCIAL",
items: [
{
key: "map.showPlayerMarkers",
label: "Show Player Markers",
type: "toggle",
value: true,
description: "Show other connected players on the world map."
},
{
key: "map.showFriendMarkers",
label: "Show Friend Markers",
type: "toggle",
value: true,
description: "Highlight friends with distinct map markers."
},
{
key: "map.showNameplates",
label: "Show Nameplates",
type: "toggle",
value: true,
description: "Show player nameplates above nearby remote players."
},
{
key: "map.mapMarkerSize",
label: "Map Marker Size",
type: "select",
value: "Medium",
options: ["Small", "Medium", "Large"],
description: "Size of player and friend markers on the map."
},
{
key: "map.friendRequests",
label: "Friend Requests",
type: "select",
value: "Everyone",
options: ["Everyone", "Friends of Friends", "Nobody"],
description: "Who can send you friend requests."
}
]
},
{
section: "NETWORK",
items: [
{
key: "network.regionPreference",
label: "Region Preference",
type: "select",
value: "Auto",
options: ["Auto", "North America", "Europe", "Asia", "Oceania"],
description: "Preferred matchmaking region for public servers."
},
{
key: "network.networkSmoothing",
label: "Network Smoothing",
type: "toggle",
value: true,
description: "Smooth remote transforms when packets arrive late."
},
{
key: "network.interpolationQuality",
label: "Interpolation Quality",
type: "select",
value: "High",
options: ["Low", "Medium", "High"],
description: "Smoothness of remote player movement interpolation."
},
{
key: "network.showPing",
label: "Show Ping",
type: "toggle",
value: true,
description: "Display your current latency on the HUD."
},
{
key: "network.networkStatsOverlay",
label: "Network Stats Overlay",
type: "toggle",
value: false,
description: "Show packet and bandwidth stats for debugging."
}
]
}
];
// Flat list of all settings for keyboard navigation.
var flatSettings = [];
multiplayerSettings.forEach(function (section) {
section.items.forEach(function (item) {
flatSettings.push(item);
});
});
// ── DOM refs ───────────────────────────────────────────────────
var pauseScreen = document.getElementById("pauseScreen");
var menu = document.getElementById("menu");
var settingsPanel = document.getElementById("settingsPanel");
var settingsTabsEl = document.getElementById("settingsTabs");
var settingsRowsEl = document.getElementById("settingsRows");
var settingsDescriptionEl = document.getElementById("settingsDescription");
var gameSettingsPane = document.getElementById("gameSettingsPane");
var multiplayerSettingsPane = document.getElementById("multiplayerSettingsPane");
var openGameSettingsBtn = document.getElementById("openGameSettingsBtn");
var tabGameSettings = document.getElementById("tabGameSettings");
var tabMultiplayerSettings = document.getElementById("tabMultiplayerSettings");
var pausePromptBar = document.getElementById("pausePromptBar");
var settingsPromptBar = document.getElementById("settingsPromptBar");
var mapPromptBar = document.getElementById("mapPromptBar");
@@ -343,22 +160,21 @@
var leftPanel = document.querySelector(".left-panel");
var mapWorld = document.getElementById("mapWorld");
if (!menu || !settingsPanel || !settingsTabsEl || !settingsRowsEl) {
if (!menu || !settingsPanel || !window.CO_Settings) {
return;
}
var settingsController = null;
var items = Array.prototype.slice.call(menu.querySelectorAll(".menu-item"));
var SETTINGS_INDEX = 4;
var TAB_IDS = ["game", "multiplayer"];
// viewMode: "pause" | "map" | "settings"
// settingsFocus: "tabs" | "content"
// activeTab: "game" | "multiplayer"
var viewMode = "pause";
var settingsFocus = "tabs";
var activeTab = "multiplayer";
var selectedIndex = -1;
var settingIndex = 0;
var SETTINGS_TRANSITION_MS = 220;
var settingsHideFallbackId = 0;
var settingsHideOnTransitionEnd = null;
// ── Pause menu selection ───────────────────────────────────────
@@ -435,443 +251,91 @@
});
});
// ── Settings helpers ───────────────────────────────────────────
function getCurrentSetting() {
return flatSettings[settingIndex] || null;
}
function formatSettingValue(setting) {
if (setting.type === "toggle") {
return setting.value ? "ON" : "OFF";
}
if (setting.type === "slider") {
return setting.value + "%";
}
return String(setting.value);
}
function notifySettingChanged(setting) {
window.CommonwealthOnlineUI.setMultiplayerSetting(setting.key, setting.value);
}
// ── Prompt bar ────────────────────────────────────────────────
function updateSettingsPromptBar() {
if (!settingsPromptBar) {
return;
}
var movePrompt = settingsPromptBar.querySelector('[data-prompt="move"]');
var changePrompt = settingsPromptBar.querySelector('[data-prompt="change"]');
var selectPrompt = settingsPromptBar.querySelector('[data-prompt="select"]');
var tabPrompt = settingsPromptBar.querySelector('[data-prompt="tab"]');
if (activeTab === "game") {
if (movePrompt) {
movePrompt.hidden = true;
}
if (changePrompt) {
changePrompt.hidden = false;
var changeLabel = changePrompt.querySelector(".prompt__label");
var changeGlyph = changePrompt.querySelector(".prompt__glyph");
if (changeLabel) {
changeLabel.textContent = "TAB";
}
if (changeGlyph) {
changeGlyph.textContent = "←→";
}
}
if (selectPrompt) {
var selectLabel = selectPrompt.querySelector(".prompt__label");
if (selectLabel) {
selectLabel.textContent = "OPEN";
}
}
if (tabPrompt) {
tabPrompt.hidden = true;
}
} else {
if (movePrompt) {
movePrompt.hidden = false;
}
if (changePrompt) {
changePrompt.hidden = false;
var changeLabelMp = changePrompt.querySelector(".prompt__label");
var changeGlyphMp = changePrompt.querySelector(".prompt__glyph");
if (changeLabelMp) {
changeLabelMp.textContent = "CHANGE";
}
if (changeGlyphMp) {
changeGlyphMp.textContent = "←→";
}
}
if (selectPrompt) {
var selectLabelMp = selectPrompt.querySelector(".prompt__label");
if (selectLabelMp) {
selectLabelMp.textContent = "SELECT";
}
}
if (tabPrompt) {
tabPrompt.hidden = false;
var tabLabel = tabPrompt.querySelector(".prompt__label");
var tabGlyph = tabPrompt.querySelector(".prompt__glyph");
if (tabLabel) {
tabLabel.textContent = "SWITCH FOCUS";
}
if (tabGlyph) {
tabGlyph.textContent = "TAB";
}
}
}
}
// ── Settings rendering ─────────────────────────────────────────
function renderTabs() {
var tabs = settingsTabsEl.querySelectorAll(".settings-tab");
for (var i = 0; i < tabs.length; i++) {
var tab = tabs[i];
var tabId = tab.getAttribute("data-tab");
var isSelected = tabId === activeTab;
tab.classList.toggle("is-selected", isSelected);
tab.setAttribute("aria-selected", isSelected ? "true" : "false");
tab.tabIndex = isSelected ? 0 : -1;
}
settingsTabsEl.classList.toggle("is-focus-region", settingsFocus === "tabs");
}
function buildValueMarkup(setting) {
if (setting.type === "slider") {
var min = setting.min != null ? setting.min : 0;
var max = setting.max != null ? setting.max : 100;
var fill = ((setting.value - min) / (max - min)) * 100;
return (
'<span class="settings-slider" aria-hidden="true">' +
'<span class="settings-slider__track">' +
'<span class="settings-slider__fill" style="width:' + fill + '%"></span>' +
'<span class="settings-slider__thumb" style="left:' + fill + '%"></span>' +
"</span>" +
'<span class="settings-slider__pct">' + setting.value + "%</span>" +
"</span>"
);
}
var usesCycler =
setting.type === "toggle" ||
setting.type === "select";
if (usesCycler) {
return (
'<span class="settings-cycler">' +
'<span class="settings-cycler__arrow" aria-hidden="true">&lt;</span>' +
'<span class="settings-row__value-text"></span>' +
'<span class="settings-cycler__arrow" aria-hidden="true">&gt;</span>' +
"</span>"
);
}
return '<span class="settings-row__value-text"></span>';
}
function renderRows() {
settingsRowsEl.innerHTML = "";
var flatIndex = 0;
multiplayerSettings.forEach(function (section) {
var sectionEl = document.createElement("div");
sectionEl.className = "settings-section";
var heading = document.createElement("h3");
heading.className = "settings-section__heading";
heading.textContent = section.section;
sectionEl.appendChild(heading);
section.items.forEach(function (setting) {
var index = flatIndex;
flatIndex += 1;
var button = document.createElement("button");
button.type = "button";
button.className = "settings-row";
button.setAttribute("role", "option");
button.setAttribute("data-setting-index", String(index));
button.setAttribute("data-setting-key", setting.key);
if (index === settingIndex) {
button.classList.add("is-selected");
}
if (setting.type === "text" || setting.type === "keybind") {
button.classList.add("is-readonly");
}
button.innerHTML =
'<span class="settings-row__label"></span>' +
'<span class="settings-row__value">' + buildValueMarkup(setting) + "</span>" +
'<span class="settings-row__bar" aria-hidden="true"></span>';
button.querySelector(".settings-row__label").textContent = setting.label;
var valueText = button.querySelector(".settings-row__value-text");
if (valueText) {
valueText.textContent = formatSettingValue(setting);
}
button.addEventListener("click", function () {
settingIndex = index;
settingsFocus = "content";
activeTab = "multiplayer";
console.log("[CO Settings] Row selected:", setting.key);
renderSettings();
});
sectionEl.appendChild(button);
});
settingsRowsEl.appendChild(sectionEl);
});
settingsRowsEl.classList.toggle(
"is-focus-region",
settingsFocus === "content" && activeTab === "multiplayer"
);
}
function renderDescription() {
if (!settingsDescriptionEl) {
return;
}
var setting = getCurrentSetting();
settingsDescriptionEl.textContent =
setting && setting.description ? setting.description : "";
}
function renderPanes() {
if (gameSettingsPane) {
gameSettingsPane.hidden = activeTab !== "game";
gameSettingsPane.classList.toggle(
"is-focus-region",
settingsFocus === "content" && activeTab === "game"
);
}
if (multiplayerSettingsPane) {
multiplayerSettingsPane.hidden = activeTab !== "multiplayer";
}
if (openGameSettingsBtn) {
openGameSettingsBtn.classList.toggle(
"is-focused",
settingsFocus === "content" && activeTab === "game"
);
}
}
function renderSettings() {
renderTabs();
renderPanes();
renderRows();
renderDescription();
updateSettingsPromptBar();
}
function setActiveTab(tabId) {
if (TAB_IDS.indexOf(tabId) === -1) {
return;
}
activeTab = tabId;
console.log("[CO Settings] Tab selected:", activeTab);
renderSettings();
}
function moveTab(delta) {
var current = TAB_IDS.indexOf(activeTab);
if (current < 0) {
current = 0;
}
var next = current + delta;
if (next < 0) {
next = TAB_IDS.length - 1;
} else if (next >= TAB_IDS.length) {
next = 0;
}
setActiveTab(TAB_IDS[next]);
}
function setSettingsFocus(region) {
settingsFocus = region;
console.log("[CO Settings] Focus:", settingsFocus);
renderSettings();
}
// ── Settings value changes ─────────────────────────────────────
function adjustSetting(delta) {
var setting = getCurrentSetting();
if (!setting || activeTab !== "multiplayer") {
return;
}
if (setting.type === "text") {
console.log("[CO Settings] Display name editing not implemented:", setting.key);
return;
}
if (setting.type === "keybind") {
console.log(
"[CO Settings] Keybind selected (rebinding not implemented):",
setting.key,
setting.value
);
return;
}
if (setting.type === "toggle") {
setting.value = !setting.value;
console.log("[CO Settings] Toggle:", setting.key, setting.value);
notifySettingChanged(setting);
renderSettings();
return;
}
if (setting.type === "select") {
var options = setting.options || [];
if (!options.length) {
return;
}
var current = options.indexOf(setting.value);
if (current < 0) {
current = 0;
}
var next = current + (delta === 0 ? 1 : delta);
if (next < 0) {
next = options.length - 1;
} else if (next >= options.length) {
next = 0;
}
setting.value = options[next];
console.log("[CO Settings] Select:", setting.key, setting.value);
notifySettingChanged(setting);
renderSettings();
return;
}
if (setting.type === "slider") {
var step = setting.step != null ? setting.step : 5;
var min = setting.min != null ? setting.min : 0;
var max = setting.max != null ? setting.max : 100;
var amount = delta === 0 ? step : delta * step;
var nextValue = Math.max(min, Math.min(max, setting.value + amount));
if (nextValue === setting.value) {
return;
}
setting.value = nextValue;
console.log("[CO Settings] Slider:", setting.key, setting.value);
notifySettingChanged(setting);
renderSettings();
}
}
function activateSetting() {
var setting = getCurrentSetting();
if (!setting || activeTab !== "multiplayer") {
return;
}
if (setting.type === "toggle" || setting.type === "select" || setting.type === "slider") {
adjustSetting(setting.type === "toggle" ? 0 : 1);
return;
}
if (setting.type === "keybind") {
console.log(
"[CO Settings] Keybind selected (rebinding not implemented):",
setting.key,
setting.value
);
return;
}
if (setting.type === "text") {
console.log("[CO Settings] Display name editing not implemented:", setting.key);
}
}
function moveSettingRow(delta) {
if (!flatSettings.length) {
return;
}
var next = settingIndex + delta;
if (next < 0) {
next = flatSettings.length - 1;
} else if (next >= flatSettings.length) {
next = 0;
}
settingIndex = next;
renderSettings();
var selectedRow = settingsRowsEl.querySelector(
'[data-setting-index="' + settingIndex + '"]'
);
if (selectedRow && typeof selectedRow.scrollIntoView === "function") {
selectedRow.scrollIntoView({ block: "nearest" });
}
}
function openVanillaGameSettings() {
window.CommonwealthOnlineUI.openGameSettings();
}
// ── Tab / button click handlers ────────────────────────────────
if (tabGameSettings) {
tabGameSettings.addEventListener("click", function () {
settingsFocus = "tabs";
setActiveTab("game");
});
}
if (tabMultiplayerSettings) {
tabMultiplayerSettings.addEventListener("click", function () {
settingsFocus = "tabs";
setActiveTab("multiplayer");
});
}
if (openGameSettingsBtn) {
openGameSettingsBtn.addEventListener("click", function () {
settingsFocus = "content";
activeTab = "game";
renderSettings();
openVanillaGameSettings();
});
}
// ── View mode transitions ──────────────────────────────────────
function cancelSettingsPanelHide() {
if (settingsHideFallbackId) {
window.clearTimeout(settingsHideFallbackId);
settingsHideFallbackId = 0;
}
if (settingsHideOnTransitionEnd) {
settingsPanel.removeEventListener("transitionend", settingsHideOnTransitionEnd);
settingsHideOnTransitionEnd = null;
}
}
function showSettingsPanelAnimated() {
cancelSettingsPanelHide();
if (pauseScreen) {
pauseScreen.classList.add("is-settings-mode");
}
settingsPanel.hidden = false;
settingsPanel.classList.remove("is-open");
void settingsPanel.offsetWidth;
settingsPanel.classList.add("is-open");
}
function hideSettingsPanelAnimated(done) {
if (settingsPanel.hidden) {
if (done) {
done();
}
return;
}
cancelSettingsPanelHide();
settingsPanel.classList.remove("is-open");
var completed = false;
function finishHide() {
if (completed) {
return;
}
completed = true;
cancelSettingsPanelHide();
if (viewMode === "settings" || settingsPanel.classList.contains("is-open")) {
if (done) {
done();
}
return;
}
if (pauseScreen) {
pauseScreen.classList.remove("is-settings-mode");
}
settingsPanel.hidden = true;
if (done) {
done();
}
}
settingsHideOnTransitionEnd = function (event) {
if (event.target !== settingsPanel || event.propertyName !== "opacity") {
return;
}
finishHide();
};
settingsPanel.addEventListener("transitionend", settingsHideOnTransitionEnd);
settingsHideFallbackId = window.setTimeout(finishHide, SETTINGS_TRANSITION_MS + 80);
}
function enterSettingsMode() {
if (viewMode === "map") {
exitMapMode();
}
viewMode = "settings";
settingsFocus = "tabs";
activeTab = "multiplayer";
settingIndex = 0;
console.log("[CO Pause Menu] Entering settings mode");
window.CommonwealthOnlineUI.onOpenView("settings");
setSelected(SETTINGS_INDEX);
if (pauseScreen) {
pauseScreen.classList.add("is-settings-mode");
}
settingsPanel.hidden = false;
showSettingsPanelAnimated();
if (pausePromptBar) {
pausePromptBar.hidden = true;
}
if (settingsPromptBar) {
settingsPromptBar.hidden = false;
}
if (mapPromptBar) {
mapPromptBar.hidden = true;
}
@@ -880,7 +344,7 @@
mapWorld.classList.remove("is-interactive");
}
renderSettings();
settingsController.show();
}
function exitSettingsMode() {
@@ -892,29 +356,35 @@
console.log("[CO Pause Menu] Exiting settings mode");
window.CommonwealthOnlineUI.onBack();
if (pauseScreen) {
pauseScreen.classList.remove("is-settings-mode");
}
settingsPanel.hidden = true;
if (pausePromptBar) {
pausePromptBar.hidden = false;
}
if (settingsPromptBar) {
settingsPromptBar.hidden = true;
}
settingsController.hide();
setSelected(SETTINGS_INDEX);
hideSettingsPanelAnimated(function () {
if (pausePromptBar) {
pausePromptBar.hidden = false;
}
setSelected(SETTINGS_INDEX);
});
}
settingsController = window.CO_Settings.create({
mount: settingsPanel,
promptBar: settingsPromptBar,
bridge: window.CommonwealthOnlineUI,
layout: "embedded",
onBack: function () {
exitSettingsMode();
}
});
function enterMapMode() {
if (viewMode === "settings") {
cancelSettingsPanelHide();
settingsController.hide();
settingsPanel.classList.remove("is-open");
settingsPanel.hidden = true;
if (pauseScreen) {
pauseScreen.classList.remove("is-settings-mode");
}
if (settingsPromptBar) {
settingsPromptBar.hidden = true;
}
}
viewMode = "map";
@@ -979,72 +449,6 @@
// ── Keyboard navigation ────────────────────────────────────────
function handleSettingsKeydown(event) {
switch (event.key) {
case "ArrowUp":
event.preventDefault();
if (settingsFocus === "content" && activeTab === "multiplayer") {
moveSettingRow(-1);
}
break;
case "ArrowDown":
event.preventDefault();
if (settingsFocus === "content" && activeTab === "multiplayer") {
moveSettingRow(1);
}
break;
case "ArrowLeft":
event.preventDefault();
if (settingsFocus === "tabs") {
moveTab(-1);
} else if (activeTab === "multiplayer") {
adjustSetting(-1);
} else {
moveTab(-1);
}
break;
case "ArrowRight":
event.preventDefault();
if (settingsFocus === "tabs") {
moveTab(1);
} else if (activeTab === "multiplayer") {
adjustSetting(1);
} else {
moveTab(1);
}
break;
case "Tab":
event.preventDefault();
setSettingsFocus(settingsFocus === "tabs" ? "content" : "tabs");
break;
case "Enter":
case " ":
event.preventDefault();
if (settingsFocus === "tabs") {
setSettingsFocus("content");
} else if (activeTab === "game") {
openVanillaGameSettings();
} else {
activateSetting();
}
break;
case "Escape":
event.preventDefault();
console.log("[CO Settings] Back");
exitSettingsMode();
break;
default:
break;
}
}
function handlePauseKeydown(event) {
switch (event.key) {
case "ArrowUp":
@@ -1079,7 +483,7 @@
document.addEventListener("keydown", function (event) {
if (viewMode === "settings") {
handleSettingsKeydown(event);
settingsController.handleKeydown(event);
return;
}
if (viewMode === "map") {
@@ -1420,6 +824,4 @@
});
}
// Open settings by default so the settings prototype is immediately visible.
enterSettingsMode();
})();