@3dsource/angular-unreal-module 0.0.181 → 0.0.182

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@3dsource/angular-unreal-module",
-  "version": "0.0.181",
+  "version": "0.0.182",
   "description": "Angular integration for Unreal Engine Pixel Streaming",
   "keywords": [
     "3dsource",

package/types/3dsource-angular-unreal-module.d.ts

@@ -268,24 +268,43 @@ declare const MouseButtonsMask: {
  * punctuation keys by ASCII — `;` as 59, `=` as 61, `-` as 173) and keys Unreal
  * numbers differently from the DOM (the right-hand modifiers, the Cmd/Win keys).
  *
- * The numpad is deliberately absent. A numpad key reports the same `code` in
- * both NumLock states but a different virtual key — `Numpad4` is 37/`VK_LEFT`
- * with NumLock off and 100/`VK_NUMPAD4` with it on — so any entry here would
- * have to commit to one state and be wrong in the other. Falling through to
- * `event.keyCode` is right in both. `NumpadAdd`/`Subtract`/`Multiply`/`Divide`
- * stay because they do not change with NumLock.
+ * The numpad digits, `NumpadDecimal` and `NumpadEnter` are the exception to the
+ * rule above, and the reason it is worded as a rule. A numpad key reports the
+ * same `code` in both NumLock states but a different virtual key — `Numpad4` is
+ * 37/`VK_LEFT` with NumLock off and 100/`VK_NUMPAD4` with it on. Their entries
+ * here hold the NumLock-*off* values, so an entry wins over the value the
+ * browser resolved and pins that state: with NumLock on the engine is told
+ * `VK_LEFT`. Read `event.keyCode` directly if you need the other state.
+ * `NumpadAdd`/`Subtract`/`Multiply`/`Divide` carry no such caveat — they do not
+ * change with NumLock.
  *
  * `SpecialKeyCodes` in `./buttons-codes` repeats seven of these entries with
  * the same values. The two are kept apart because both are public API; merging
  * them would be a breaking change.
  *
- * Values must stay unique so `InvertedKeyMap` is lossless. The `OSLeft`/
- * `MetaLeft` and `OSRight`/`MetaRight` pairs share a value on purpose: they are
- * legacy and current names for the same physical key.
+ * `InvertedKeyMap` is consequently lossy. `NumpadEnter` and `Numpad4/8/6/2`
+ * share their values with `Enter` and `Arrow*`, and the derivation keeps the
+ * last name written for a value, so those five cannot be reached through it —
+ * which is what makes them unnameable through the numeric form of
+ * `useKeyboardKeys()`. The `OSLeft`/`MetaLeft` and `OSRight`/`MetaRight` pairs
+ * share a value on purpose: they are legacy and current names for the same
+ * physical key.
  */
 declare const KeyboardNumericCode: {
     readonly Backspace: 8;
     readonly Tab: 9;
+    readonly Numpad5: 12;
+    readonly NumpadEnter: 13;
+    readonly Numpad9: 33;
+    readonly Numpad3: 34;
+    readonly Numpad1: 35;
+    readonly Numpad7: 36;
+    readonly Numpad4: 37;
+    readonly Numpad8: 38;
+    readonly Numpad6: 39;
+    readonly Numpad2: 40;
+    readonly Numpad0: 45;
+    readonly NumpadDecimal: 46;
     readonly Enter: 13;
     readonly ShiftLeft: 16;
     readonly ControlLeft: 17;
@@ -392,7 +411,7 @@ type IKeyCode = (typeof KeyboardNumericCode)[IKeyName];
  *
  * The union lists the names this table knows a virtual-key code for, so editors
  * complete them. The `string` branch keeps every other DOM code assignable —
- * `'Numpad4'`, `'Delete'`, `'Home'` — since a key needs no entry here to be
+ * `'Delete'`, `'Home'`, `'PageUp'` — since a key needs no entry here to be
  * matched against `event.code`.
  */
 type IKeyCodeName = IKeyName | (string & Record<never, never>);