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

package/fesm2022/3dsource-angular-unreal-module.mjs

@@ -316,24 +316,46 @@ 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.
  */
 const KeyboardNumericCode = {
     Backspace: 8,
     Tab: 9,
+    // The NumLock-*off* virtual keys. Declared before `Enter` and the arrows on
+    // purpose: those come later and so win the `InvertedKeyMap` derivation, which
+    // keeps 13 resolving to `Enter` and 37-40 to `Arrow*`.
+    Numpad5: 12,
+    NumpadEnter: 13,
+    Numpad9: 33,
+    Numpad3: 34,
+    Numpad1: 35,
+    Numpad7: 36,
+    Numpad4: 37,
+    Numpad8: 38,
+    Numpad6: 39,
+    Numpad2: 40,
+    Numpad0: 45,
+    NumpadDecimal: 46,
     Enter: 13,
     ShiftLeft: 16,
     ControlLeft: 17,