From da2be55cb92f5643c4f0a80d6ec652d5fddd48f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kriszti=C3=A1n=20Nagy?= Date: Tue, 31 Dec 2024 02:18:53 +0100 Subject: [PATCH] Added settings for displaying / playing radio messages. - updated gameplay setting screen with flex styling --- src/config/config.json | 2 +- src/config/settings.json | 3 + src/config/strings/strings-hu.json | 7 +- src/config/strings/strings-it.json | 7 +- src/config/strings/strings.json | 7 +- src/data/screens/gameplay-settings.html | 37 ++++++----- src/js/armada/configuration.js | 22 +++++++ src/js/armada/screens/battle.js | 75 ++++++++++++++++------ src/js/armada/screens/gameplay-settings.js | 29 ++++++++- src/js/armada/strings.js | 6 +- src/js/modules/media-resources.js | 9 ++- src/scss/screens/gameplay-settings.scss | 13 +++- 12 files changed, 172 insertions(+), 45 deletions(-) diff --git a/src/config/config.json b/src/config/config.json index 1ee446da..1e84b45a 100644 --- a/src/config/config.json +++ b/src/config/config.json @@ -1,5 +1,5 @@ { - "version": "0.5.5-dev:1249 (2024.12.30.)", + "version": "0.5.5-dev:1250 (2024.12.31.)", "debugVersion": false, "logVerbosity": 1, "platform": "web", diff --git a/src/config/settings.json b/src/config/settings.json index bcf1e4f3..20870eb0 100644 --- a/src/config/settings.json +++ b/src/config/settings.json @@ -163,6 +163,9 @@ "battle": { "battleRenderFPS": 60, "simulationStepsPerSecond": 60, + "showGenericRadioMessages": true, + "playGenericRadioMessages": true, + "playMissionRadioMessages": true, "showReadyMessage": true, "particlePoolPrefillFactor": 0.2, "projectilePoolPrefillFactor": 0.75, diff --git a/src/config/strings/strings-hu.json b/src/config/strings/strings-hu.json index 9fda5bef..554a98e6 100644 --- a/src/config/strings/strings-hu.json +++ b/src/config/strings/strings-hu.json @@ -809,7 +809,9 @@ "many": "sok", "easy": "könnyű", "hard": "nehéz", - "custom": "egyéni" + "custom": "egyéni", + "missionOnly": "csak statikus", + "all": "mindig" }, "generalSettings": { "backButton": "Vissza a menübe", @@ -855,6 +857,7 @@ "title": "Játékmenet beállítások", "hudTitle": "HUD", "cameraTitle": "Kamera", + "radioTitle": "Rádióüzenetek", "controlsTitle": "Irányítás", "otherTitle": "Egyéb", "targetHealthAtCenter": "Célpont állapota mindig középen:", @@ -866,6 +869,8 @@ "preferredShipView": "Alapértelmezett hadihajó nézet:", "demoViewSwitching": "Automatikus nézetváltogatás demo módban:", "defaultSalvoMode": "Alapértelmezett sortűz mód rakétákhoz:", + "showGenericRadioMessages": "Gépi pilóták dinamikus rádióüzeneteinek kiírása:", + "playRadioMessages": "Rádióüzenetek hangjának lejátszása:", "showReadyMessage": "Küldetés kezdetén üzenet mutatása:" }, "controller": { diff --git a/src/config/strings/strings-it.json b/src/config/strings/strings-it.json index d316e98a..767233ea 100644 --- a/src/config/strings/strings-it.json +++ b/src/config/strings/strings-it.json @@ -740,7 +740,9 @@ "many": "tanti", "easy": "facile", "hard": "difficile", - "custom": "personalizzato" + "custom": "personalizzato", + "missionOnly": "non dinamici", + "all": "tutti" }, "generalSettings": { "backButton": "Torna al menu", @@ -786,6 +788,7 @@ "title": "Impostazioni di gioco", "hudTitle": "HUD", "cameraTitle": "Visuale", + "radioTitle": "Messaggi radio", "controlsTitle": "Controlli", "otherTitle": "Altre", "targetHealthAtCenter": "Barra di integrità del bersaglio sempre al centro:", @@ -797,6 +800,8 @@ "preferredShipView": "Vista dell'astronave preferita:", "demoViewSwitching": "Cambio automatico di visuale in modalità dimostrazione:", "defaultSalvoMode": "Modalità missile in serie per impostazione predefinita:", + "showGenericRadioMessages": "Mostra il testo dei messaggi radio dinamici dei piloti AI:", + "playRadioMessages": "Riproduci la voce fuori campo per i messaggi radio:", "showReadyMessage": "Mostra messaggio 'pronto' all'inizio delle missioni:" }, "controller": { diff --git a/src/config/strings/strings.json b/src/config/strings/strings.json index b771ddef..85dc721a 100644 --- a/src/config/strings/strings.json +++ b/src/config/strings/strings.json @@ -761,7 +761,9 @@ "many": "many", "easy": "easy", "hard": "hard", - "custom": "custom" + "custom": "custom", + "missionOnly": "non-dynamic only", + "all": "all" }, "generalSettings": { "backButton": "Back to menu", @@ -807,6 +809,7 @@ "title": "Gameplay settings", "hudTitle": "HUD", "cameraTitle": "Camera", + "radioTitle": "Radio messages", "controlsTitle": "Controls", "otherTitle": "Other", "targetHealthAtCenter": "Target integrity bar always at center:", @@ -818,6 +821,8 @@ "preferredShipView": "Preferred ship view:", "demoViewSwitching": "Automatic view switching in demo mode:", "defaultSalvoMode": "Missile salvo mode by default:", + "showGenericRadioMessages": "Show the text of dynamic radio messages by AI pilots:", + "playRadioMessages": "Play the voice-over for radio messages:", "showReadyMessage": "Show ready message at the start of missions:" }, "controller": { diff --git a/src/data/screens/gameplay-settings.html b/src/data/screens/gameplay-settings.html index 3b227a45..09c32c2b 100644 --- a/src/data/screens/gameplay-settings.html +++ b/src/data/screens/gameplay-settings.html @@ -3,22 +3,29 @@

-
-

-
+
+
+

+
+
+
+

+
+
-
-

-
-
-
-
-

-
-
-
-

-
+
+
+

+
+
+
+

+
+
+
+

+
+
diff --git a/src/js/armada/configuration.js b/src/js/armada/configuration.js index 3bcce045..f083099a 100644 --- a/src/js/armada/configuration.js +++ b/src/js/armada/configuration.js @@ -785,6 +785,28 @@ define([ type: "number", defaultValue: 60 }, + /** + * Whether to show the text of generic radio messages transmitted by AI pilots in the messages + * panel. + */ + SHOW_GENERIC_RADIO_MESSAGES: { + name: "showGenericRadioMessages", + type: "boolean" + }, + /** + * Whether to play the sound samples for the generic radio messages transmitted by AI pilots. + */ + PLAY_GENERIC_RADIO_MESSAGES: { + name: "playGenericRadioMessages", + type: "boolean" + }, + /** + * Whether to play the sound samples for the radio messages defined in the mission file. + */ + PLAY_MISSION_RADIO_MESSAGES: { + name: "playMissionRadioMessages", + type: "boolean" + }, /** * Whether to show the popup infobox with the ready message at the start of battles */ diff --git a/src/js/armada/screens/battle.js b/src/js/armada/screens/battle.js index 1d84852f..75b10110 100644 --- a/src/js/armada/screens/battle.js +++ b/src/js/armada/screens/battle.js @@ -622,6 +622,21 @@ define([ * @type Number */ _lastRadioType, + /** + * Cached value of the setting of whether to play the sound effects for generic radio messages. + * @type Boolean + */ + _playGenericRadioMessages, + /** + * Cached value of the setting of whether to play the sound effects for mission radio messages. + * @type Boolean + */ + _playMissionRadioMessages, + /** + * Cached value of the setting of whether to display the text for generic AI radio messages. + * @type Boolean + */ + _showGenericRadioMessages, /** * Whether the radio message queue has been updated since its message text has been assembled (we display multiple messages in a merged string) * @type Boolean @@ -1696,21 +1711,29 @@ define([ /** @type DOMHighResTimeStamp */ now, /** @type Number */ - index = -1; + index = -1, + /** @type SoundEffectResource */ + resource; if (_spacecraft && craft && craft.isAlive() && !craft.isAway() && !craft.isHostile(this)) { now = performance.now(); if ((_messageSource !== this) && ((now - _lastRadioTime > config.getSetting(config.BATTLE_SETTINGS.MIN_VOICE_MESSAGE_DELAY_FOR_SAME_TYPE)) || ((data.messageType !== _lastRadioType) && (now - _lastRadioTime > config.getSetting(config.BATTLE_SETTINGS.MIN_VOICE_MESSAGE_DELAY_FOR_DIFFERENT_TYPE))))) { if (!_playingMissionVoiceSound) { - // play the voice sample immediately, regardless of whether or not the text is shown - index = _genericVoiceSounds[data.voice][data.messageType].play(resources.SoundCategory.VOICE) + 1; - message = { - text: strings.get(strings.RADIO.PREFIX, _voiceMessages[data.messageType] + index), - source: this, - silent: true, - queue: RADIO_QUEUE - }; - _battleScreen.queueHUDMessage(message, true); + if (_playGenericRadioMessages || _showGenericRadioMessages) { + resource = _genericVoiceSounds[data.voice][data.messageType]; + // play the voice sample immediately, regardless of whether or not the text is shown + index = 1 + (_playGenericRadioMessages ? + resource.play(resources.SoundCategory.VOICE) : + resource.getRandomSampleIndex()); + message = { + text: strings.get(strings.RADIO.PREFIX, _voiceMessages[data.messageType] + index), + source: this, + silent: _playGenericRadioMessages, + appearAnimation: !_playGenericRadioMessages, + queue: RADIO_QUEUE + }; + _battleScreen.queueHUDMessage(message, true); + } _lastRadioTime = now; _lastRadioType = data.messageType; } @@ -2806,6 +2829,9 @@ define([ BattleScreen.prototype.setActive = function (active) { screens.HTMLScreen.prototype.setActive.call(this, active); if (active) { + _playGenericRadioMessages = config.getBattleSetting(config.BATTLE_SETTINGS.PLAY_GENERIC_RADIO_MESSAGES); + _playMissionRadioMessages = config.getBattleSetting(config.BATTLE_SETTINGS.PLAY_MISSION_RADIO_MESSAGES); + _showGenericRadioMessages = config.getBattleSetting(config.BATTLE_SETTINGS.SHOW_GENERIC_RADIO_MESSAGES); if (WAKE_LOCK_SUPPORTED && !_wakeLock) { navigator.wakeLock.request("screen").then(function (wakeLock) { _wakeLock = wakeLock; @@ -3912,16 +3938,18 @@ define([ if (messageQueue[0].new) { _playingMissionVoiceSound = false; // playing the voice-over for this message if it exists - if (_missionVoiceSounds[messageQueue[0].id]) { - _missionVoiceSounds[messageQueue[0].id].play(resources.SoundCategory.VOICE, undefined, undefined, undefined, true); - _playingMissionVoiceSound = true; - messageQueue[0].silent = true; - } else if (messageQueue[0].source) { - j = ai.getVoiceOfSpacecraft(messageQueue[0].source); - if ((j >= 0) && _missionPilotVoiceSounds[j][messageQueue[0].id]) { - _missionPilotVoiceSounds[j][messageQueue[0].id].play(resources.SoundCategory.VOICE, undefined, undefined, undefined, true); + if (_playMissionRadioMessages) { + if (_missionVoiceSounds[messageQueue[0].id]) { + _missionVoiceSounds[messageQueue[0].id].play(resources.SoundCategory.VOICE, undefined, undefined, undefined, true); _playingMissionVoiceSound = true; messageQueue[0].silent = true; + } else if (messageQueue[0].source) { + j = ai.getVoiceOfSpacecraft(messageQueue[0].source); + if ((j >= 0) && _missionPilotVoiceSounds[j][messageQueue[0].id]) { + _missionPilotVoiceSounds[j][messageQueue[0].id].play(resources.SoundCategory.VOICE, undefined, undefined, undefined, true); + _playingMissionVoiceSound = true; + messageQueue[0].silent = true; + } } } // playing the generic short message sound @@ -3930,6 +3958,7 @@ define([ } messageQueue[0].new = false; } + skip = false; // setting text if (MESSAGE_QUEUES[i] === RADIO_QUEUE) { // for the radio queue, multiple messages are displayed together @@ -3944,7 +3973,12 @@ define([ j--; } } - _messageText.setText(text); + if (_showGenericRadioMessages) { + _messageText.setText(text); + } else { + _messageText.setText(""); + skip = true; + } _radioQueueChanged = false; } } else { @@ -3975,9 +4009,8 @@ define([ } _messageText.setColor(color); // transmission source - _messageSource = messageQueue[0].source; + _messageSource = (messageQueue[0].timeLeft > 0) ? messageQueue[0].source : null; // managing timing - skip = false; if (!messageQueue[0].permanent) { if ((messageQueue[0] === _newHostilesMessage)) { messageQueue[0].timeLeft = _newHostilesAlertTimeLeft; diff --git a/src/js/armada/screens/gameplay-settings.js b/src/js/armada/screens/gameplay-settings.js index 822b245d..4f68b01b 100644 --- a/src/js/armada/screens/gameplay-settings.js +++ b/src/js/armada/screens/gameplay-settings.js @@ -1,5 +1,5 @@ /** - * Copyright 2017-2023 Krisztián Nagy + * Copyright 2017-2024 Krisztián Nagy * @file This module manages and provides the gameplay settings screen of the Interstellar Armada game. * @author Krisztián Nagy [nkrisztian89@gmail.com] * @licence GNU GPLv3 @@ -50,6 +50,9 @@ define([ _getShipViewSettingValues = function () { return _shipViewOptions.map(_getMapToCaptionFunction(strings.OBJECT_VIEW)); }, + _getPlayRadioMessagesSettingValues = function () { + return [strings.get(strings.SETTING.OFF), strings.get(strings.SETTING.ALL), strings.get(strings.SETTING.MISSION_ONLY)]; + }, // ------------------------------------------------------------------------------ // constants BACK_BUTTON_ID = "backButton", @@ -63,13 +66,18 @@ define([ PREFERRED_SHIP_VIEW_SELECTOR_ID = "preferredShipViewSelector", DEMO_VIEW_SWITCHING_SELECTOR_ID = "demoViewSwitchSelector", DEFAULT_SALVO_MODE_SELECTOR_ID = "defaultSalvoModeSelector", + SHOW_GENERIC_RADIO_MESSAGES_SELECTOR_ID = "showGenericRadioMessagesSelector", + PLAY_RADIO_MESSAGES_SELECTOR_ID = "playRadioMessagesSelector", SHOW_READY_MESSAGE_SELECTOR_ID = "showReadyMessage", HUD_OPTION_PARENT_ID = "hudSettingsDiv", CAMERA_OPTION_PARENT_ID = "cameraSettingsDiv", CONTROLS_OPTION_PARENT_ID = "controlsSettingsDiv", + RADIO_OPTION_PARENT_ID = "radioSettingsDiv", OTHER_OPTION_PARENT_ID = "otherSettingsDiv", SETTING_ON_INDEX = strings.getOnOffSettingValues().indexOf(strings.get(strings.SETTING.ON)), - SETTING_OFF_INDEX = strings.getOnOffSettingValues().indexOf(strings.get(strings.SETTING.OFF)); + SETTING_OFF_INDEX = strings.getOnOffSettingValues().indexOf(strings.get(strings.SETTING.OFF)), + SETTING_ALL_INDEX = _getPlayRadioMessagesSettingValues().indexOf(strings.get(strings.SETTING.ALL)), + SETTING_MISSION_ONLY_INDEX = _getPlayRadioMessagesSettingValues().indexOf(strings.get(strings.SETTING.MISSION_ONLY)); // ############################################################################## /** * @class Represents the Gameplay settings screen. @@ -108,6 +116,10 @@ define([ /** @type Selector */ this._defaultSalvoModeSelector = null; /** @type Selector */ + this._showGenericRadioMessagesSelector = null; + /** @type Selector */ + this._playRadioMessagesSelector = null; + /** @type Selector */ this._showReadyMessageSelector = null; config.executeWhenReady(function () { this._targetHullAtCenterSelector = this._registerSelector(TARGET_HULL_AT_CENTER_SELECTOR_ID, @@ -132,6 +144,12 @@ define([ this._defaultSalvoModeSelector = this._registerSelector(DEFAULT_SALVO_MODE_SELECTOR_ID, strings.GAMEPLAY_SETTINGS.DEFAULT_SALVO_MODE.name, CONTROLS_OPTION_PARENT_ID); + this._showGenericRadioMessagesSelector = this._registerSelector(SHOW_GENERIC_RADIO_MESSAGES_SELECTOR_ID, + strings.GAMEPLAY_SETTINGS.SHOW_GENERIC_RADIO_MESSAGES.name, + RADIO_OPTION_PARENT_ID); + this._playRadioMessagesSelector = this._registerSelector(PLAY_RADIO_MESSAGES_SELECTOR_ID, + strings.GAMEPLAY_SETTINGS.PLAY_RADIO_MESSAGES.name, + RADIO_OPTION_PARENT_ID); this._showReadyMessageSelector = this._registerSelector(SHOW_READY_MESSAGE_SELECTOR_ID, strings.GAMEPLAY_SETTINGS.SHOW_READY_MESSAGE.name, OTHER_OPTION_PARENT_ID); @@ -169,6 +187,9 @@ define([ config.setBattleSetting(config.BATTLE_SETTINGS.DEFAULT_SHIP_VIEW_NAME, _shipViewOptions[this._preferredShipViewSelector.getSelectedIndex()]); config.setBattleSetting(config.BATTLE_SETTINGS.DEMO_VIEW_SWITCHING, (this._demoViewSwitchingSelector.getSelectedIndex() === SETTING_ON_INDEX)); config.setBattleSetting(config.BATTLE_SETTINGS.DEFAULT_SALVO_MODE, (this._defaultSalvoModeSelector.getSelectedIndex() === SETTING_ON_INDEX)); + config.setBattleSetting(config.BATTLE_SETTINGS.SHOW_GENERIC_RADIO_MESSAGES, (this._showGenericRadioMessagesSelector.getSelectedIndex() === SETTING_ON_INDEX)); + config.setBattleSetting(config.BATTLE_SETTINGS.PLAY_GENERIC_RADIO_MESSAGES, (this._playRadioMessagesSelector.getSelectedIndex() === SETTING_ALL_INDEX)); + config.setBattleSetting(config.BATTLE_SETTINGS.PLAY_MISSION_RADIO_MESSAGES, (this._playRadioMessagesSelector.getSelectedIndex() !== SETTING_OFF_INDEX)); config.setBattleSetting(config.BATTLE_SETTINGS.SHOW_READY_MESSAGE, (this._showReadyMessageSelector.getSelectedIndex() === SETTING_ON_INDEX)); game.closeOrNavigateTo(armadaScreens.SETTINGS_SCREEN_NAME); }; @@ -203,6 +224,8 @@ define([ this._preferredShipViewSelector.setValueList(_getShipViewSettingValues()); this._demoViewSwitchingSelector.setValueList(strings.getOnOffSettingValues()); this._defaultSalvoModeSelector.setValueList(strings.getOnOffSettingValues()); + this._showGenericRadioMessagesSelector.setValueList(strings.getOnOffSettingValues()); + this._playRadioMessagesSelector.setValueList(_getPlayRadioMessagesSettingValues()); this._showReadyMessageSelector.setValueList(strings.getOnOffSettingValues()); if (config.getGeneralSetting(config.GENERAL_SETTINGS.SHOW_DEMO_BUTTON)) { this._demoViewSwitchingSelector.show(); @@ -225,6 +248,8 @@ define([ this._preferredShipViewSelector.selectValueWithIndex(_shipViewOptions.indexOf(config.getBattleSetting(config.BATTLE_SETTINGS.DEFAULT_SHIP_VIEW_NAME))); this._demoViewSwitchingSelector.selectValueWithIndex((config.getBattleSetting(config.BATTLE_SETTINGS.DEMO_VIEW_SWITCHING) === true) ? SETTING_ON_INDEX : SETTING_OFF_INDEX); this._defaultSalvoModeSelector.selectValueWithIndex((config.getBattleSetting(config.BATTLE_SETTINGS.DEFAULT_SALVO_MODE) === true) ? SETTING_ON_INDEX : SETTING_OFF_INDEX); + this._showGenericRadioMessagesSelector.selectValueWithIndex((config.getBattleSetting(config.BATTLE_SETTINGS.SHOW_GENERIC_RADIO_MESSAGES) === true) ? SETTING_ON_INDEX : SETTING_OFF_INDEX); + this._playRadioMessagesSelector.selectValueWithIndex((config.getBattleSetting(config.BATTLE_SETTINGS.PLAY_GENERIC_RADIO_MESSAGES) === true) ? SETTING_ALL_INDEX : (config.getBattleSetting(config.BATTLE_SETTINGS.PLAY_MISSION_RADIO_MESSAGES) === true) ? SETTING_MISSION_ONLY_INDEX : SETTING_OFF_INDEX); this._showReadyMessageSelector.selectValueWithIndex((config.getBattleSetting(config.BATTLE_SETTINGS.SHOW_READY_MESSAGE) === true) ? SETTING_ON_INDEX : SETTING_OFF_INDEX); }.bind(this)); }; diff --git a/src/js/armada/strings.js b/src/js/armada/strings.js index de0044dd..dd972cdb 100644 --- a/src/js/armada/strings.js +++ b/src/js/armada/strings.js @@ -377,7 +377,9 @@ define([ MANY: {name: "setting.many"}, EASY: {name: "setting.easy"}, HARD: {name: "setting.hard"}, - CUSTOM: {name: "setting.custom"} + CUSTOM: {name: "setting.custom"}, + MISSION_ONLY: {name: "setting.missionOnly"}, + ALL: {name: "setting.all"} }; strings.GENERAL_SETTINGS = { BACK: {name: "generalSettings.backButton"}, @@ -427,6 +429,8 @@ define([ PREFERRED_SHIP_VIEW: {name: "gameplaySettings.preferredShipView"}, DEMO_VIEW_SWITCHING: {name: "gameplaySettings.demoViewSwitching"}, DEFAULT_SALVO_MODE: {name: "gameplaySettings.defaultSalvoMode"}, + SHOW_GENERIC_RADIO_MESSAGES: {name: "gameplaySettings.showGenericRadioMessages"}, + PLAY_RADIO_MESSAGES: {name: "gameplaySettings.playRadioMessages"}, SHOW_READY_MESSAGE: {name: "gameplaySettings.showReadyMessage"} }; strings.AUDIO = { diff --git a/src/js/modules/media-resources.js b/src/js/modules/media-resources.js index bff4a8cc..a32784e3 100644 --- a/src/js/modules/media-resources.js +++ b/src/js/modules/media-resources.js @@ -1268,6 +1268,13 @@ define([ application.log_DEBUG("WARNING: Sound effect sample from file: " + params.path + " could not be loaded.", 1); return false; }; + /** + * Returns a random integer between 0 and the number of samples associated with this resource minus one. + * @returns {Number} + */ + SoundEffectResource.prototype.getRandomSampleIndex = function () { + return Math.floor(Math.random() * this._samples.length); + }; /** * Plays back one of the samples (randomly chosen) corresponding to this effect, without saving a reference to it. The samples must be * loaded. @@ -1284,7 +1291,7 @@ define([ application.showError("Cannot play sound effect '" + this.getName() + "', as it has not been loaded from file yet!"); return -1; } - index = Math.floor(Math.random() * this._samples.length); + index = this.getRandomSampleIndex(); sample = this._samples[index]; if (sample) { audio.playSound(sample, soundCategory, volume, position, rolloff, long); diff --git a/src/scss/screens/gameplay-settings.scss b/src/scss/screens/gameplay-settings.scss index f8a0e69a..47a7057b 100644 --- a/src/scss/screens/gameplay-settings.scss +++ b/src/scss/screens/gameplay-settings.scss @@ -4,10 +4,21 @@ margin-top: $page-padding; text-align: center; height: calc(100% - #{2*$separator-height + 2*$page-padding}); + display: flex; + flex-direction: row; + justify-content: center; +} + +div.gameplaySettingsColumn { + display: flex; + flex-direction: column; } div.gameplaySettingsContainer { - display: inline-block; + display: inline-block; + &>div { + padding-top: 0.5em; + } } h2.settings {