cdnutter
/
pokerogue
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

commented settings-gamepad-ui-handler.ts

pull/685/head
Greenlamp 2024-05-12 13:13:15 +02:00
parent 8f340509e5
commit 956379bc31
2 changed files with 189 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/configs/gamepad-utils.ts
View File

@ -12,7 +12,7 @@ export function getKeyFromInputIndex(config: GamepadConfig, index: number): Stri
}
// Given a setting name, return the key assigned to it from the config file
export function getKeyForSettingName(config: GamepadConfig, settingName: SettingGamepad): String | null {
export function getKeyForSettingName(config: GamepadConfig, settingName: string): String | null {
for (const key of Object.keys(config.setting)) {
if (config.setting[key] === settingName) return key;
}
@ -28,7 +28,7 @@ export function getCurrenlyAssignedKeyToAction(config: GamepadConfig, action: Bu
}
// Given a setting name, return the custom key for the default action from the config file
export function getCurrentlyAssignedToSettingName(config: GamepadConfig, settingName: SettingGamepad): String {
export function getCurrentlyAssignedToSettingName(config: GamepadConfig, settingName: string): String {
const oldKey = getKeyForSettingName(config, settingName)
const action = config.default[oldKey];
const key = getCurrenlyAssignedKeyToAction(config, action);
@ -42,7 +42,7 @@ export function getCurrenlyAssignedIconFromInputIndex(config: GamepadConfig, ind
}
// Given a setting name, return the icon currently assigned to this setting name
export function getCurrentlyAssignedIconToSettingName(config: GamepadConfig, settingName: SettingGamepad) {
export function getCurrentlyAssignedIconToSettingName(config: GamepadConfig, settingName: string) {
const key = getCurrentlyAssignedToSettingName(config, settingName);
return config.icons[key];
}

261
src/ui/settings-gamepad-ui-handler.ts
View File

@ -54,6 +54,9 @@ export default class SettingsGamepadUiHandler extends UiHandler {
// list all the setting keys used in the selected layout (because dualshock has more buttons than xbox)
private keys: Array<String>;
// Store the specific settings related to key bindings for the current gamepad configuration.
private bindingSettings: Array<String>;
constructor(scene: BattleScene, mode?: Mode) {
super(scene, mode);
}
@ -84,43 +87,55 @@ export default class SettingsGamepadUiHandler extends UiHandler {
this.settingsContainer.add(gamepadText);
this.settingsContainer.add(this.optionsBg);
// for every config, we create a new "screen"
/// Initialize a new configuration "screen" for each type of gamepad.
for (const config of [pad_xbox360, pad_dualshock, pad_unlicensedSNES]) {
// Create a map to store layout settings based on the pad type.
this.layout[config.padType] = new Map();
// Create a container for gamepad options in the scene, initially hidden.
const optionsContainer = this.scene.add.container(0, 0);
optionsContainer.setVisible(false);
// this is all the binding this specific config contains
// Gather all gamepad binding settings from the configuration.
const bindingSettings = Object.keys(config.setting).map(k => config.setting[k]);
// the setting name - Default Controller, Gamepad Support, Button Action, ...
const settingLabels = [];
// Array to hold labels for different settings such as 'Default Controller', 'Gamepad Support', etc.
const settingLabels: Phaser.GameObjects.Text[] = [];
// the option for the setting - Auto, Disabled, ...
const optionValueLabels = [];
// Array to hold options for each setting, e.g., 'Auto', 'Disabled'.
const optionValueLabels: Phaser.GameObjects.Text[][] = [];
// the sprites for each button to display
const inputsIcons = {};
// Object to store sprites for each button configuration.
const inputsIcons: InputsIcons = {};
// Default Controller, Gamepad Support
// Fetch common setting keys such as 'Default Controller' and 'Gamepad Support' from gamepad settings.
const commonSettingKeys = Object.keys(SettingGamepad).slice(0, 2).map(key => SettingGamepad[key]);
// All the binding of this specific config
// Combine common and specific bindings into a single array.
const specificBindingKeys = [...commonSettingKeys, ...Object.keys(config.setting).map(k => config.setting[k])];
// we merge both keys, and we fetch their default values, to change the label color of the selected one
// Fetch default values for these settings and prepare to highlight selected options.
const optionCursors = Object.values(Object.keys(settingGamepadDefaults).filter(s => specificBindingKeys.includes(s)).map(k => settingGamepadDefaults[k]));
// we filter the SettingGamepad setting to let only the specificBindingKeys, we need the keys from this setting to compute the name to display
// Filter out settings that are not relevant to the current gamepad configuration.
const settingGamepadFiltered = Object.keys(SettingGamepad).filter(_key => specificBindingKeys.includes(SettingGamepad[_key]));
// Loop through the filtered settings to manage display and options.
settingGamepadFiltered.forEach((setting, s) => {
// Convert the setting key from format 'Key_Name' to 'Key name' for display.
let settingName = setting.replace(/\_/g, ' ');
// Create and add a text object for the setting name to the scene.
settingLabels[s] = addTextObject(this.scene, 8, 28 + s * 16, settingName, TextStyle.SETTINGS_LABEL);
settingLabels[s].setOrigin(0, 0);
optionsContainer.add(settingLabels[s]);
const valueLabels = []
// Initialize an array to store the option labels for this setting.
const valueLabels: Phaser.GameObjects.Text[] = []
// Process each option for the current setting.
for (const [o, option] of settingGamepadOptions[SettingGamepad[setting]].entries()) {
// Check if the current setting is for binding keys.
if (bindingSettings.includes(SettingGamepad[setting])) {
// Create a label for non-null options, typically indicating actionable options like 'change'.
if (o) {
const valueLabel = addTextObject(this.scene, 0, 0, option, TextStyle.WINDOW);
valueLabel.setOrigin(0, 0);
@ -128,6 +143,7 @@ export default class SettingsGamepadUiHandler extends UiHandler {
valueLabels.push(valueLabel);
continue;
}
// For null options, add an icon for the key.
const key = getKeyForSettingName(config as GamepadConfig, SettingGamepad[setting]);
const icon = this.scene.add.sprite(0, 0, config.padType);
icon.setScale(0.1);
@ -137,71 +153,151 @@ export default class SettingsGamepadUiHandler extends UiHandler {
valueLabels.push(icon);
continue;
}
// For regular settings like 'Gamepad support', create a label and determine if it is selected.
const valueLabel = addTextObject(this.scene, 0, 0, option, settingGamepadDefaults[SettingGamepad[setting]] === o ? TextStyle.SETTINGS_SELECTED : TextStyle.WINDOW);
valueLabel.setOrigin(0, 0);
optionsContainer.add(valueLabel);
//if a setting has 2 options, valueLabels will be an array of 2 elements
valueLabels.push(valueLabel);
}
// Collect all option labels for this setting into the main array.
optionValueLabels.push(valueLabels);
// Calculate the total width of all option labels within a specific setting
// This is achieved by summing the width of each option label
const totalWidth = optionValueLabels[s].map(o => o.width).reduce((total, width) => total += width, 0);
// Define the minimum width for a label, ensuring it's at least 78 pixels wide or the width of the setting label plus some padding
const labelWidth = Math.max(78, settingLabels[s].displayWidth + 8);
// Calculate the total available space for placing option labels next to their setting label
// We reserve space for the setting label and then distribute the remaining space evenly
const totalSpace = (300 - labelWidth) - totalWidth / 6;
// Calculate the spacing between options based on the available space divided by the number of gaps between labels
const optionSpacing = Math.floor(totalSpace / (optionValueLabels[s].length - 1));
// Initialize xOffset to zero, which will be used to position each option label horizontally
let xOffset = 0;
// Start positioning each option label one by one
for (let value of optionValueLabels[s]) {
// Set the option label's position right next to the setting label, adjusted by xOffset
value.setPositionRelative(settingLabels[s], labelWidth + xOffset, 0);
// Move the xOffset to the right for the next label, ensuring each label is spaced evenly
xOffset += value.width / 6 + optionSpacing;
}
});
// Assigning the newly created components to the layout map under the specific gamepad type.
this.layout[config.padType].optionsContainer = optionsContainer; // Container for this pad's options.
this.layout[config.padType].inputsIcons = inputsIcons; // Icons for each input specific to this pad.
this.layout[config.padType].settingLabels = settingLabels; // Text labels for each setting available on this pad.
this.layout[config.padType].optionValueLabels = optionValueLabels; // Labels for values corresponding to each setting.
this.layout[config.padType].optionCursors = optionCursors; // Cursors to navigate through the options.
this.layout[config.padType].keys = specificBindingKeys; // Keys that identify each setting specifically bound to this pad.
this.layout[config.padType].bindingSettings = bindingSettings; // Settings that define how the keys are bound.
this.layout[config.padType].optionsContainer = optionsContainer;
this.layout[config.padType].inputsIcons = inputsIcons;
this.layout[config.padType].settingLabels = settingLabels;
this.layout[config.padType].optionValueLabels = optionValueLabels;
this.layout[config.padType].optionCursors = optionCursors
this.layout[config.padType].keys = specificBindingKeys
this.layout[config.padType].bindingSettings = bindingSettings
// Add the options container to the overall settings container to be displayed in the UI.
this.settingsContainer.add(optionsContainer);
}
// If no gamepads are detected, set up a default UI prompt in the settings container.
this.layout['noGamepads'] = new Map();
const optionsContainer = this.scene.add.container(0, 0);
optionsContainer.setVisible(false);
optionsContainer.setVisible(false); // Initially hide the container as no gamepads are connected.
const label = addTextObject(this.scene, 8, 28, 'Please plug a controller or press a button', TextStyle.SETTINGS_LABEL);
label.setOrigin(0, 0);
optionsContainer.add(label);
this.settingsContainer.add(optionsContainer);
// Map the 'noGamepads' layout options for easy access.
this.layout['noGamepads'].optionsContainer = optionsContainer;
this.layout['noGamepads'].label = label;
// Add the settings container to the UI.
ui.add(this.settingsContainer);
// Initially hide the settings container until needed (e.g., when a gamepad is connected or a button is pressed).
this.settingsContainer.setVisible(false);
}
updateBindings(): void {
// Hide the options container for all layouts to reset the UI visibility.
Object.keys(this.layout).forEach((key) => this.layout[key].optionsContainer.setVisible(false));
// Fetch the active gamepad configuration from the input controller.
const activeConfig = this.scene.inputController.getActiveConfig();
if (!activeConfig) {
const layout = this.layout['noGamepads'];
layout.optionsContainer.setVisible(true);
return;
// Set the UI layout for the active configuration. If unsuccessful, exit the function early.
if (!this.setLayout(activeConfig)) return;
// Retrieve the gamepad settings from local storage or use an empty object if none exist.
const settings: object = localStorage.hasOwnProperty('settingsGamepad') ? JSON.parse(localStorage.getItem('settingsGamepad')) : {};
// Update the cursor for each key based on the stored settings or default cursors.
this.keys.forEach((key, index) => {
this.setOptionCursor(index, settings.hasOwnProperty(key) ? settings[key] : this.optionCursors[index])
});
// If the active configuration has no custom bindings set, exit the function early.
// by default, if custom does not exists, a default is assigned to it
// it only means the gamepad is not yet initalized
if (!activeConfig.custom) return;
// For each element in the binding settings, update the icon according to the current assignment.
for (const elm of this.bindingSettings) {
const key = getKeyForSettingName(activeConfig, elm); // Get the key for the setting name.
const icon = getCurrentlyAssignedIconToSettingName(activeConfig, elm); // Fetch the currently assigned icon for the setting.
this.inputsIcons[key].setFrame(icon); // Set the icon frame to the inputs icon object.
}
// Set the cursor and scroll cursor to their initial positions.
this.setCursor(0);
this.setScrollCursor(0);
}
show(args: any[]): boolean {
super.show(args);
// Update the bindings for the current active gamepad configuration.
this.updateBindings();
// Make the settings container visible to the user.
this.settingsContainer.setVisible(true);
// Reset the scroll cursor to the top of the settings container.
this.setScrollCursor(0);
// Move the settings container to the end of the UI stack to ensure it is displayed on top.
this.getUi().moveTo(this.settingsContainer, this.getUi().length - 1);
// Hide any tooltips that might be visible before showing the settings container.
this.getUi().hideTooltip();
// Return true to indicate the UI was successfully shown.
return true;
}
setLayout(activeConfig: GamepadConfig): boolean {
// Check if there is no active configuration (e.g., no gamepad connected).
if (!activeConfig) {
// Retrieve the layout for when no gamepads are connected.
const layout = this.layout['noGamepads'];
// Make the options container visible to show message.
layout.optionsContainer.setVisible(true);
// Return false indicating the layout application was not successful due to lack of gamepad.
return false;
}
// Extract the type of the gamepad from the active configuration.
const configType = activeConfig.padType;
// If a cursor object exists, destroy it to clean up previous UI states.
this.cursorObj?.destroy();
// Reset the cursor object and scroll cursor to ensure they are re-initialized correctly.
this.cursorObj = null;
this.scrollCursor = null;
// Retrieve the layout settings based on the type of the gamepad.
const layout = this.layout[configType];
// Update the main controller with configuration details from the selected layout.
this.keys = layout.keys;
this.optionsContainer = layout.optionsContainer;
this.optionsContainer.setVisible(true);
@ -209,35 +305,11 @@ export default class SettingsGamepadUiHandler extends UiHandler {
this.optionValueLabels = layout.optionValueLabels;
this.optionCursors = layout.optionCursors;
this.inputsIcons = layout.inputsIcons;
const bindingSettings = layout.bindingSettings;
const settings: object = localStorage.hasOwnProperty('settingsGamepad') ? JSON.parse(localStorage.getItem('settingsGamepad')) : {};
this.keys.forEach((key, index) => {
this.setOptionCursor(index, settings.hasOwnProperty(key) ? settings[key] : this.optionCursors[index])
});
if (!activeConfig.custom) return;
for (const elm of bindingSettings) {
const key = getKeyForSettingName(activeConfig, elm);
const icon = getCurrentlyAssignedIconToSettingName(activeConfig, elm);
this.inputsIcons[key].setFrame(icon);
}
this.setCursor(0);
this.setScrollCursor(0);
}
show(args: any[]): boolean {
super.show(args);
this.updateBindings();
this.settingsContainer.setVisible(true);
this.setScrollCursor(0);
this.getUi().moveTo(this.settingsContainer, this.getUi().length - 1);
this.getUi().hideTooltip();
this.bindingSettings = layout.bindingSettings;
// Return true indicating the layout was successfully applied.
return true;
}
processInput(button: Button): boolean {
@ -247,17 +319,19 @@ export default class SettingsGamepadUiHandler extends UiHandler {
let success = false;
// Handle the input based on the button pressed.
if (button === Button.CANCEL) {
// Handle cancel button press, reverting UI mode to previous state.
success = true;
this.scene.ui.revertMode();
} else {
const cursor = this.cursor + this.scrollCursor;
const cursor = this.cursor + this.scrollCursor; // Calculate the absolute cursor position.
switch (button) {
case Button.UP:
if (cursor) {
case Button.UP: // Move up in the menu.
if (cursor) { // If not at the top, move the cursor up.
if (this.cursor)
success = this.setCursor(this.cursor - 1);
else
else // If at the top of the visible items, scroll up.
success = this.setScrollCursor(this.scrollCursor - 1);
} else {
// When at the top of the menu and pressing UP, move to the bottommost item.
@ -268,7 +342,7 @@ export default class SettingsGamepadUiHandler extends UiHandler {
success = successA && successB; // success is just there to play the little validation sound effect
}
break;
case Button.DOWN:
case Button.DOWN: // Move down in the menu.
if (cursor < this.optionValueLabels.length - 1) {
if (this.cursor < rowsToDisplay - 1)
success = this.setCursor(this.cursor + 1);
@ -283,19 +357,17 @@ export default class SettingsGamepadUiHandler extends UiHandler {
success = successA && successB; // Indicates a successful cursor and scroll adjustment.
}
break;
case Button.LEFT:
case Button.LEFT: // Move selection left within the current option set.
if (!this.optionCursors) return;
if (this.optionCursors[cursor])
success = this.setOptionCursor(cursor, this.optionCursors[cursor] - 1, true);
break;
case Button.RIGHT:
case Button.RIGHT: // Move selection right within the current option set.
if (!this.optionCursors) return;
if (this.optionCursors[cursor] < this.optionValueLabels[cursor].length - 1)
success = this.setOptionCursor(cursor, this.optionCursors[cursor] + 1, true);
break;
case Button.CYCLE_FORM:
this.scene.ui.setMode(Mode.SETTINGS)
success = true;
case Button.CYCLE_FORM: // Change the UI mode to SETTINGS mode.
case Button.CYCLE_SHINY:
this.scene.ui.setMode(Mode.SETTINGS)
success = true;
@ -303,34 +375,47 @@ export default class SettingsGamepadUiHandler extends UiHandler {
}
}
// If a change occurred, play the selection sound.
if (success)
ui.playSelect();
return success;
return success; // Return whether the input resulted in a successful action.
}
setCursor(cursor: integer): boolean {
const ret = super.setCursor(cursor);
// If the optionsContainer is not initialized, return the result from the parent class directly.
if (!this.optionsContainer) return ret;
// Check if the cursor object exists, if not, create it.
if (!this.cursorObj) {
this.cursorObj = this.scene.add.nineslice(0, 0, 'summary_moves_cursor', null, (this.scene.game.canvas.width / 6) - 10, 16, 1, 1, 1, 1);
this.cursorObj.setOrigin(0, 0);
this.optionsContainer.add(this.cursorObj);
this.cursorObj.setOrigin(0, 0); // Set the origin to the top-left corner.
this.optionsContainer.add(this.cursorObj); // Add the cursor to the options container.
}
// Update the position of the cursor object relative to the options background based on the current cursor and scroll positions.
this.cursorObj.setPositionRelative(this.optionsBg, 4, 4 + (this.cursor + this.scrollCursor) * 16);
return ret;
return ret; // Return the result from the parent class's setCursor method.
}
updateChosenGamepadDisplay(): void {
// Update any bindings that might have changed since the last update.
this.updateBindings();
// Iterate over the keys in the SettingGamepad enumeration.
for (const [index, key] of Object.keys(SettingGamepad).entries()) {
const setting = SettingGamepad[key]
const setting = SettingGamepad[key] // Get the actual setting value using the key.
// Check if the current setting corresponds to the default controller setting.
if (setting === SettingGamepad.Default_Controller) {
// Iterate over all layouts excluding the 'noGamepads' special case.
for (const _key of Object.keys(this.layout)) {
if (_key === 'noGamepads') continue;
if (_key === 'noGamepads') continue; // Skip updating the no gamepad layout.
// Update the text of the first option label under the current setting to the name of the chosen gamepad,
// truncating the name to 30 characters if necessary.
this.layout[_key].optionValueLabels[index][0].setText(truncateString(this.scene.inputController.chosenGamepad, 30));
}
}
@ -338,48 +423,67 @@ export default class SettingsGamepadUiHandler extends UiHandler {
}
setOptionCursor(settingIndex: integer, cursor: integer, save?: boolean): boolean {
// Retrieve the specific setting using the settingIndex from the SettingGamepad enumeration.
const setting = SettingGamepad[Object.keys(SettingGamepad)[settingIndex]];
// Get the current cursor position for this setting.
const lastCursor = this.optionCursors[settingIndex];
if (!noOptionsCursors.includes(setting)) {
// Check if the setting is not part of the bindings (i.e., it's a regular setting).
if (!this.bindingSettings.includes(setting)) {
// Get the label of the last selected option and revert its color to the default.
const lastValueLabel = this.optionValueLabels[settingIndex][lastCursor];
lastValueLabel.setColor(this.getTextColor(TextStyle.WINDOW));
lastValueLabel.setShadowColor(this.getTextColor(TextStyle.WINDOW, true));
// Update the cursor for the setting to the new position.
this.optionCursors[settingIndex] = cursor;
// Change the color of the new selected option to indicate it's selected.
const newValueLabel = this.optionValueLabels[settingIndex][cursor];
newValueLabel.setColor(this.getTextColor(TextStyle.SETTINGS_SELECTED));
newValueLabel.setShadowColor(this.getTextColor(TextStyle.SETTINGS_SELECTED, true));
}
// If the save flag is set and the setting is not the default controller setting, save the setting to local storage
if (save) {
if (SettingGamepad[setting] !== SettingGamepad.Default_Controller)
this.scene.gameData.saveGamepadSetting(setting, cursor)
}
return true;
return true; // Return true to indicate the cursor was successfully updated.
}
setScrollCursor(scrollCursor: integer): boolean {
// Check if the new scroll position is the same as the current one; if so, do not update.
if (scrollCursor === this.scrollCursor)
return false;
// Update the internal scroll cursor state
this.scrollCursor = scrollCursor;
// Apply the new scroll position to the settings UI.
this.updateSettingsScroll();
// Reset the cursor to its current position to adjust its visibility after scrolling.
this.setCursor(this.cursor);
return true;
return true; // Return true to indicate the scroll cursor was successfully updated.
}
updateSettingsScroll(): void {
// Return immediately if the options container is not initialized.
if (!this.optionsContainer) return;
// Set the vertical position of the options container based on the current scroll cursor, multiplying by the item height.
this.optionsContainer.setY(-16 * this.scrollCursor);
// Iterate over all setting labels to update their visibility.
for (let s = 0; s < this.settingLabels.length; s++) {
// Determine if the current setting should be visible based on the scroll position.
const visible = s >= this.scrollCursor && s < this.scrollCursor + 9;
// Set the visibility of the setting label and its corresponding options.
this.settingLabels[s].setVisible(visible);
for (let option of this.optionValueLabels[s])
option.setVisible(visible);
@ -388,13 +492,20 @@ export default class SettingsGamepadUiHandler extends UiHandler {
clear(): void {
super.clear();
// Hide the settings container to remove it from the view.
this.settingsContainer.setVisible(false);
// Remove the cursor from the UI.
this.eraseCursor();
}
eraseCursor(): void {
// Check if a cursor object exists.
if (this.cursorObj)
this.cursorObj.destroy();
this.cursorObj.destroy(); // Destroy the cursor object to clean up resources.
// Set the cursor object reference to null to fully dereference it.
this.cursorObj = null;
}
}