vimp-engine 0.38.3 → 0.39.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vimp-engine",
-  "version": "0.38.3",
+  "version": "0.39.0",
   "description": "VIMP engine SDK: browser host and client runtime, standalone mode and CLI tools (vimp-sim, vimp-contract) for VIMP game plugins",
   "license": "MIT",
   "repository": {

package/src/client/InputListener.js

@@ -20,6 +20,9 @@ export default class InputListener {
       this.publisher.emit('keyUp', event),
     );
 
+    // keyup за пределами окна не приходит — эфир залип бы до таймаута
+    window.addEventListener('blur', () => this.publisher.emit('blur'));
+
     const emitMouse = () => this.publisher.emit('mouseAction');
 
     window.addEventListener('mouseup', emitMouse);

package/src/client/SoundManager.js

@@ -892,6 +892,19 @@ export default class SoundManager {
     }
   }
 
+  /**
+   * Выход Web Audio движка для голосовой связи: контекст Howler и его master
+   * gain. Голос подчиняется общей громкости и mute (скрытая вкладка, пауза
+   * миграции).
+   * @returns {{ ctx: AudioContext, destination: AudioNode } | null} null —
+   *   Web Audio недоступен.
+   */
+  getAudioOutput() {
+    return Howler.usingWebAudio && Howler.ctx && Howler.masterGain
+      ? { ctx: Howler.ctx, destination: Howler.masterGain }
+      : null;
+  }
+
   /**
    * Выключает все звуки.
    */

package/src/client/components/controller/Controls.js

@@ -54,6 +54,16 @@ export default class ControlsCtrl {
     this._model.resendHeld();
   }
 
+  // назначает клавишу связи (push-to-talk)
+  setPushToTalk(keyCode) {
+    this._model.setPushToTalk(keyCode);
+  }
+
+  // отпускает связь (потеря фокуса, скрытая вкладка)
+  releasePtt() {
+    this._model.releasePtt();
+  }
+
   // скрывает курсор
   resetCursorHideTimer() {
     this._view.resetCursorHideTimer();

package/src/client/components/controller/Voice.js

@@ -0,0 +1,31 @@
+// Singleton VoiceCtrl
+
+let voiceCtrl;
+
+export default class VoiceCtrl {
+  constructor(model, view) {
+    if (voiceCtrl) {
+      return voiceCtrl;
+    }
+
+    voiceCtrl = this;
+
+    this._model = model;
+    this._view = view;
+  }
+
+  // состояние своего эфира
+  showOwn(kind, data) {
+    this._model.showOwn(kind, data);
+  }
+
+  // чужой эфир (null — скрыть)
+  setIncoming(speaker) {
+    this._model.setIncoming(speaker);
+  }
+
+  destroy() {
+    this._model.destroy();
+    this._view.destroy();
+  }
+}

package/src/client/components/model/Controls.js

@@ -2,6 +2,17 @@ import Publisher from '../../../lib/Publisher.js';
 
 // Singleton ControlsModel
 
+// keyCode самих модификаторов: Ctrl, Alt, Meta (два кода и Firefox)
+const MODIFIER_CODES = new Set([17, 18, 91, 93, 224]);
+
+// фокус в поле ввода: клавиша печатает букву
+function isEditableTarget(target) {
+  return (
+    target?.isContentEditable === true ||
+    ['INPUT', 'TEXTAREA', 'SELECT'].includes(target?.tagName)
+  );
+}
+
 let controlsModel;
 
 export default class ControlsModel {
@@ -25,6 +36,8 @@ export default class ControlsModel {
     // возобновления сессии должен знать, что игрок держит на самом деле
     this._heldCodes = new Set();
     this._areKeysEnabled = false; // статус возможности нажатия клавиш
+    this._pttKey = null; // keyCode клавиши связи, null — связи нет
+    this._pttHeld = false;
 
     // канал указателя: игра, не объявившая modules.controls.pointer, его не
     // получает вовсе — ни одного лишнего сообщения по проводу
@@ -79,6 +92,34 @@ export default class ControlsModel {
         this.publisher.emit('mode', mode);
       }
     } else {
+      // Cmd, нажатый при уже зажатой клавише связи: её keyup на macOS не
+      // придёт — эфир отпускается сразу
+      if (event.metaKey && this._pttHeld && keyCode !== this._pttKey) {
+        this.releasePtt();
+      }
+
+      // клавиша связи никогда не уходит в игру командой. Автоповтор keydown
+      // игнорируется — удержание и так длится до keyup. Фокус в поле ввода
+      // (любом, не только в строке чата) — клавиша печатает букву. С
+      // Ctrl/Cmd/Alt — системная комбинация (вставка), не связь: на macOS при
+      // Cmd keyup обычной клавиши не приходит и связь залипла бы
+      // Сам модификатор может быть клавишей связи: его keydown несёт свой флаг
+      if (
+        keyCode === this._pttKey &&
+        (MODIFIER_CODES.has(keyCode) ||
+          !(event.ctrlKey || event.metaKey || event.altKey)) &&
+        !isEditableTarget(event.target)
+      ) {
+        event.preventDefault();
+
+        if (!event.repeat && !this._pttHeld) {
+          this._pttHeld = true;
+          this.publisher.emit('ptt', true);
+        }
+
+        return;
+      }
+
       // если клавиша ещё не зажата
       if (!this._pressedKeys[keyCode]) {
         const name = this._currentKeySet[keyCode];
@@ -111,6 +152,11 @@ export default class ControlsModel {
 
     this._heldCodes.delete(keyCode);
 
+    // отпускание засчитывается всегда, без проверки цели
+    if (keyCode === this._pttKey && this._pttHeld) {
+      this.releasePtt();
+    }
+
     // если клавиша была зажата
     if (this._pressedKeys[keyCode]) {
       const name = this._currentKeySet[keyCode];
@@ -131,6 +177,10 @@ export default class ControlsModel {
     if (status === 'opened') {
       this._currentModes[mode] = true;
 
+      if (mode === 'chat') {
+        this.releasePtt();
+      }
+
       // иначе змейка так и ехала бы к последней точке, пока игрок набирает
       // сообщение в чат
       this._releasePointer(this._lastTapX, this._lastTapY);
@@ -260,6 +310,20 @@ export default class ControlsModel {
 
     if (isEnabled === false) {
       this._releasePointer(this._lastTapX, this._lastTapY);
+      this.releasePtt();
+    }
+  }
+
+  // клавиша связи (push-to-talk); null выключает
+  setPushToTalk(keyCode) {
+    this._pttKey = keyCode ?? null;
+  }
+
+  // отпускает связь (клавиша вверх, потеря фокуса, чат, запрет ввода)
+  releasePtt() {
+    if (this._pttHeld) {
+      this._pttHeld = false;
+      this.publisher.emit('ptt', false);
     }
   }
 }

package/src/client/components/model/Voice.js

@@ -0,0 +1,96 @@
+import Publisher from '../../../lib/Publisher.js';
+
+// вспышка ошибки гаснет сама
+const ERROR_FLASH_MS = 1500;
+
+// Singleton VoiceModel
+
+let voiceModel;
+
+export default class VoiceModel {
+  /**
+   * @param {Object} data
+   * @param {Object} data.texts - CONFIG_DATA.voice.texts.
+   */
+  constructor({ texts }) {
+    if (voiceModel) {
+      return voiceModel;
+    }
+
+    voiceModel = this;
+
+    this._texts = texts ?? {};
+    // один таймер авто-скрытия: новый показ снимает прежний, иначе таймер
+    // старой ошибки погасил бы эфир, начатый после неё
+    this._timer = null;
+
+    // 'own' ({ kind, text, endsAt, totalMs }) и 'incoming' (speaker | null)
+    this.publisher = new Publisher();
+  }
+
+  /**
+   * Состояние своего эфира.
+   * @param {'hidden'|'talking'|'busy'|'cooldown'|'error'} kind
+   * @param {Object} [data] - talking: { endsAt, totalMs }, cooldown:
+   *   { endsAt }, error: { textKey }.
+   */
+  showOwn(kind, data = {}) {
+    this._clearTimer();
+
+    let text = '';
+    let endsAt = 0;
+    let totalMs = 0;
+
+    if (kind === 'busy') {
+      text = this._texts.busy ?? '';
+    } else if (kind === 'cooldown') {
+      text = this._texts.cooldown ?? '';
+      endsAt = data.endsAt;
+    } else if (kind === 'error') {
+      text = this._texts[data.textKey] ?? '';
+    } else if (kind === 'talking') {
+      endsAt = data.endsAt;
+      totalMs = data.totalMs;
+    }
+
+    this.publisher.emit('own', { kind, text, endsAt, totalMs });
+
+    if (kind === 'error') {
+      this._arm(ERROR_FLASH_MS);
+    } else if (kind === 'cooldown') {
+      this._arm(Math.max(0, endsAt - performance.now()));
+    }
+  }
+
+  /**
+   * Чужой эфир.
+   * @param {{ name: string, teamId: number|null, color: string|null }|null}
+   *   speaker - null скрывает.
+   */
+  setIncoming(speaker) {
+    this.publisher.emit('incoming', speaker);
+  }
+
+  destroy() {
+    this._clearTimer();
+  }
+
+  _arm(ms) {
+    this._timer = setTimeout(() => {
+      this._timer = null;
+      this.publisher.emit('own', {
+        kind: 'hidden',
+        text: '',
+        endsAt: 0,
+        totalMs: 0,
+      });
+    }, ms);
+  }
+
+  _clearTimer() {
+    if (this._timer !== null) {
+      clearTimeout(this._timer);
+      this._timer = null;
+    }
+  }
+}

package/src/client/components/model/Vote.js

@@ -1,4 +1,5 @@
 import Publisher from '../../../lib/Publisher.js';
+import { VOTE_ANSWER_KEYS } from '../../../config/voteKeys.js';
 
 // Singleton VoteModel
 
@@ -215,7 +216,7 @@ export default class VoteModel {
     }
 
     // если keyCode это число от 0 до 9
-    if (48 <= keyCode && keyCode <= 57) {
+    if (VOTE_ANSWER_KEYS[0] <= keyCode && keyCode <= VOTE_ANSWER_KEYS[1]) {
       number = String.fromCharCode(keyCode);
       number = parseInt(number, 10);
 

package/src/client/components/view/Voice.js

@@ -0,0 +1,172 @@
+// Singleton VoiceView
+
+let voiceView;
+
+const SVG_NS = 'http://www.w3.org/2000/svg';
+const RING_RADIUS = 15;
+const RING_LENGTH = 2 * Math.PI * RING_RADIUS;
+
+// константная разметка значка микрофона: капсула, дуга держателя, ножка
+// (перечёркивание — .voice-cross)
+const MIC_SVG =
+  '<rect x="9" y="3" width="6" height="11" rx="3"/>' +
+  '<path d="M5 11a7 7 0 0 0 14 0M12 18v3"/>' +
+  '<path class="voice-cross" d="M4 4l16 16"/>';
+
+function createIcon() {
+  const svg = document.createElementNS(SVG_NS, 'svg');
+
+  svg.setAttribute('class', 'voice-icon');
+  svg.setAttribute('aria-hidden', 'true');
+  svg.setAttribute('viewBox', '0 0 24 24');
+  svg.innerHTML = MIC_SVG;
+
+  return svg;
+}
+
+export default class VoiceView {
+  /**
+   * @param {Object} model
+   * @param {HTMLElement} container - точка монтирования (контейнер игры).
+   */
+  constructor(model, container = document.body) {
+    if (voiceView) {
+      return voiceView;
+    }
+
+    voiceView = this;
+
+    this._hud = document.createElement('div');
+    this._hud.id = 'voice-hud';
+
+    const own = document.createElement('div');
+    const incoming = document.createElement('div');
+    const ring = document.createElementNS(SVG_NS, 'svg');
+
+    own.className = 'voice-own';
+    incoming.className = 'voice-incoming';
+
+    ring.setAttribute('class', 'voice-ring');
+    ring.setAttribute('aria-hidden', 'true');
+    ring.setAttribute('viewBox', '0 0 36 36');
+    ring.innerHTML = `<circle cx="18" cy="18" r="${RING_RADIUS}"/>`;
+    this._circle = ring.firstChild;
+    this._circle.style.strokeDasharray = String(RING_LENGTH);
+
+    this._timerElem = document.createElement('span');
+    this._timerElem.className = 'voice-timer';
+    this._timerElem.setAttribute('aria-hidden', 'true');
+
+    this._textElem = document.createElement('span');
+    this._textElem.className = 'voice-text';
+    this._textElem.setAttribute('role', 'status');
+    this._textElem.setAttribute('aria-live', 'polite');
+
+    this._nameElem = document.createElement('span');
+    this._nameElem.className = 'voice-name';
+
+    own.append(createIcon(), ring, this._timerElem, this._textElem);
+    incoming.append(createIcon(), this._nameElem);
+    this._hud.append(own, incoming);
+    container.appendChild(this._hud);
+
+    this._own = null;
+    this._raf = null;
+
+    model.publisher.on('own', 'renderOwn', this);
+    model.publisher.on('incoming', 'renderIncoming', this);
+  }
+
+  // свой эфир: класс состояния, текст, цикл отсчёта
+  renderOwn(data) {
+    const { kind, text, endsAt, totalMs } = data;
+
+    for (const name of ['talking', 'busy', 'cooldown', 'error']) {
+      this._hud.classList.toggle(`is-${name}`, name === kind);
+    }
+
+    this._textElem.textContent = text;
+
+    if (kind === 'talking' || kind === 'cooldown') {
+      this._own = { kind, endsAt, totalMs };
+
+      if (this._raf === null) {
+        this._raf = requestAnimationFrame(() => this._tick());
+      }
+
+      return;
+    }
+
+    this._stopCountdown();
+  }
+
+  // чужой эфир: ник как текст, цвет как у чата
+  renderIncoming(speaker) {
+    this._hud.classList.toggle('is-incoming', Boolean(speaker));
+
+    for (const className of [...this._nameElem.classList]) {
+      if (className.startsWith('voice-team')) {
+        this._nameElem.classList.remove(className);
+      }
+    }
+
+    if (!speaker) {
+      this._nameElem.textContent = '';
+      this._nameElem.style.removeProperty('--voice-name-color');
+
+      return;
+    }
+
+    this._nameElem.textContent = speaker.name;
+
+    if (Number.isInteger(speaker.teamId)) {
+      this._nameElem.classList.add(`voice-team${speaker.teamId}`);
+    }
+
+    if (speaker.color) {
+      this._nameElem.style.setProperty('--voice-name-color', speaker.color);
+    } else {
+      this._nameElem.style.removeProperty('--voice-name-color');
+    }
+  }
+
+  destroy() {
+    this._stopCountdown();
+    this._hud.remove();
+  }
+
+  _tick() {
+    const own = this._own;
+
+    this._raf = null;
+
+    // вид сменился после планирования кадра
+    if (!own || (own.kind !== 'talking' && own.kind !== 'cooldown')) {
+      return;
+    }
+
+    const remaining = Math.max(0, own.endsAt - performance.now());
+
+    this._timerElem.textContent = `${(remaining / 1000).toFixed(1)}s`;
+
+    // у кулдауна кольца нет
+    this._circle.style.strokeDashoffset = String(
+      own.kind === 'talking' && own.totalMs > 0
+        ? RING_LENGTH * (1 - remaining / own.totalMs)
+        : RING_LENGTH,
+    );
+
+    this._raf = requestAnimationFrame(() => this._tick());
+  }
+
+  _stopCountdown() {
+    if (this._raf !== null) {
+      cancelAnimationFrame(this._raf);
+      this._raf = null;
+    }
+
+    this._own = null;
+    this._timerElem.textContent = '';
+    this._circle.style.strokeDashoffset = String(RING_LENGTH);
+  }
+}

package/src/client/lib/voiceState.js

@@ -0,0 +1,78 @@
+// Сервис пула зависимостей `voice`: кто сейчас в эфире.
+//
+// Сервис только читает (его получают парты игры — индикаторы над танком,
+// на радаре); пишет хранилище, которым владеет движок: оно применяет
+// разобранные сообщения VOICE_DATA. START/STOP приходят только слушателям
+// канала, поэтому противник при командном режиме не узнаёт о говорящем
+// ничего.
+//
+// Ключи — строки: id в part приходит ключом кадра (строкой), а на проводе
+// это число.
+export function createVoiceState({ now = () => performance.now() } = {}) {
+  // String(speakerId) → { talkId, since, name }
+  const talks = new Map();
+  let enabled = false;
+
+  const service = Object.freeze({
+    // связь в этом матче включена (конфиг + контур с ретранслятором)
+    get enabled() {
+      return enabled;
+    },
+
+    isTalking(id) {
+      return talks.has(String(id));
+    },
+
+    // момент START по часам клиента (мс performance.now) или null — фаза
+    // анимации индикатора
+    talkingSince(id) {
+      return talks.get(String(id))?.since ?? null;
+    },
+  });
+
+  const store = {
+    setEnabled(flag) {
+      enabled = flag === true;
+    },
+
+    // разобранное parseVoiceMessage; прочие типы игнорируются
+    apply(message) {
+      if (message?.type === 'start') {
+        talks.set(String(message.speakerId), {
+          talkId: message.talkId,
+          since: now(),
+          name: message.name,
+        });
+      } else if (message?.type === 'stop') {
+        const key = String(message.speakerId);
+
+        // поздний STOP старого эфира не гасит новый
+        if (talks.get(key)?.talkId === message.talkId) {
+          talks.delete(key);
+        }
+      }
+    },
+
+    // эфир, не закрытый STOP дольше maxAgeMs, гаснет сам (страховка при
+    // потерянном STOP). Возвращает число погашенных
+    expire(maxAgeMs) {
+      const current = now();
+      let removed = 0;
+
+      for (const [key, talk] of talks) {
+        if (current - talk.since > maxAgeMs) {
+          talks.delete(key);
+          removed += 1;
+        }
+      }
+
+      return removed;
+    },
+
+    clear() {
+      talks.clear();
+    },
+  };
+
+  return { service, store };
+}