@antha/input 0.9.0 → 0.11.0

package/dist/bindings/antha-input-bindings.mod.js

@@ -65,6 +65,7 @@ export function createAnthaInputBindingsMod(options = {}) {
 const gamepadInputDeviceKeys = getEnumValues(GamepadInputDeviceKey);
 function filterRawInput(entry, binding) {
     return (entry?.direction === binding.direction &&
+        !entry.isIgnoredByConsumer &&
         (binding.gamepadBrand ? binding.gamepadBrand === entry.mapped.gamepadBrand : true));
 }
 function readPlayerBindings({ bindingsMap, activeBindingsMap, rawInputs, msSinceLastExecute, gamepadKeyMap, }) {

package/dist/bindings/player-bindings.d.ts

@@ -85,6 +85,15 @@ export type BindingAssignments<BindingNames extends string = string> = Partial<R
  * @category Internal
  */
 export type PlayersBindingAssignments<BindingNames extends string = string> = Record<PlayerPosition, BindingAssignments<BindingNames>>;
+/**
+ * Returns assignments limited to the binding names supported by the consuming game.
+ *
+ * @category Internal
+ */
+export declare function filterToAllowedActions<BindingNames extends string>({ allowedBindingNames, bindingAssignments, }: Readonly<{
+    allowedBindingNames: ReadonlyArray<BindingNames>;
+    bindingAssignments: Readonly<Partial<Record<PlayerPosition, Readonly<BindingAssignments>>>>;
+}>): PlayersBindingAssignments<BindingNames>;
 /**
  * An individual active binding. Used in `createAnthaReadBindingsMod` and {@link ActiveBindings}.
  *

package/dist/bindings/player-bindings.js

@@ -1,3 +1,4 @@
+import { getObjectTypedEntries, pickObjectKeys } from '@augment-vir/common';
 import { InputDeviceKey } from 'input-device-handler';
 import { defineShape, enumShape, nonEmptyStringShape, optionalShape, recordShape, typedStringShape, } from 'object-shape-tester';
 import { InputDirection } from '../raw-inputs/raw-input.js';
@@ -35,3 +36,16 @@ export const playersBindingAssignmentsShape = recordShape({
         values: [bindingAssignmentShape],
     }),
 });
+/**
+ * Returns assignments limited to the binding names supported by the consuming game.
+ *
+ * @category Internal
+ */
+export function filterToAllowedActions({ allowedBindingNames, bindingAssignments, }) {
+    return getObjectTypedEntries(bindingAssignments).reduce((filteredBindingAssignments, [playerPosition, playerBindingAssignments,]) => {
+        return {
+            ...filteredBindingAssignments,
+            [playerPosition]: pickObjectKeys(playerBindingAssignments, allowedBindingNames),
+        };
+    }, {});
+}

package/dist/raw-inputs/antha-read-raw-input.mod.d.ts

@@ -20,6 +20,7 @@ export type AnthaReadRawInputModOptions = PartialWithUndefined<{
      */
     deviceHandlerOptions: Omit<InputDeviceHandlerOptions, 'startLoopImmediately'>;
     debugRawInputs: AnthaReadRawInputModState['debugRawInputs'];
+    startRawInputConsumer: AnthaReadRawInputModState['rawInputConsumer'];
 }>;
 /**
  * All state used by and set by `createAnthaReadRawInputMod`.
@@ -29,6 +30,8 @@ export type AnthaReadRawInputModOptions = PartialWithUndefined<{
 export type AnthaReadRawInputModState = {
     deviceHandler: Pick<InputDeviceHandler, 'readAllDevices'>;
     rawInputs: RawInputs;
+    /** Identifies the part of the game that owns newly started raw inputs. */
+    rawInputConsumer: string | undefined;
     currentInputDevices: SimpleInputDevicesMap;
     /** The engine time when a timed input lock expires. */
     inputDisableEndsAt: EngineTime | undefined;
@@ -78,6 +81,7 @@ export type AnthaReadRawInputMod = ReturnType<typeof createAnthaReadRawInputMod>
  */
 export declare function readRawInputs(state: SetRequired<SelectFrom<Partial<AnthaReadRawInputModState>, {
     rawInputs: true;
+    rawInputConsumer: true;
     deviceHandler: true;
     gamepadLayouts: true;
     gamepadBrandMap: true;

package/dist/raw-inputs/antha-read-raw-input.mod.js

@@ -17,6 +17,7 @@ export function createAnthaReadRawInputMod(options = {}) {
         initState: {
             debugRawInputs: !!options.debugRawInputs,
             inputDisableEndsAt: undefined,
+            rawInputConsumer: options.startRawInputConsumer,
         },
         execute({ engine, state, msSinceLastExecute }) {
             if (state.inputDisableEndsAt != undefined &&
@@ -71,6 +72,9 @@ export function readRawInputs(state, { msSinceLastExecute, }) {
             const previousRawInput = potentialPreviousRawInput?.direction === direction
                 ? potentialPreviousRawInput
                 : undefined;
+            const consumedBy = previousRawInput
+                ? previousRawInput.consumedBy
+                : state.rawInputConsumer;
             const duration = {
                 milliseconds: previousRawInput
                     ? Math.round(previousRawInput.duration.milliseconds + msSinceLastExecute)
@@ -100,7 +104,7 @@ export function readRawInputs(state, { msSinceLastExecute, }) {
                 gamepadModel: model?.gamepadModel,
             });
             const rawInput = {
-                consumedBy: previousRawInput?.consumedBy,
+                consumedBy,
                 mapped: {
                     deviceName: model?.gamepadModel || device.deviceName,
                     gamepadBrand: model?.gamepadBrand,
@@ -113,6 +117,9 @@ export function readRawInputs(state, { msSinceLastExecute, }) {
                 duration,
                 inputName: currentInput.inputName,
                 inputValue: currentInput.inputValue,
+                isIgnoredByConsumer: !!state.rawInputConsumer &&
+                    !!consumedBy &&
+                    consumedBy !== state.rawInputConsumer,
             };
             if (mappedInputName) {
                 deviceInputs[mappedInputName] = rawInput;

package/dist/raw-inputs/raw-input.d.ts

@@ -26,6 +26,8 @@ export declare function calculateInputDirection(inputValue: number): InputDirect
 export type RawInput = Omit<InputValueWrapper<InputDeviceKey, any>, 'details'> & {
     /** An identifier set by a game when it claims this input. */
     consumedBy: string | undefined;
+    /** True when this input belongs to a different raw input consumer. */
+    isIgnoredByConsumer: boolean;
     mapped: SelectFrom<InputValueWrapper<InputDeviceKey, any>, {
         /**
          * `deviceName` is mapped by `gamepadModelMap`. If no mapping exists, this will always

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@antha/input",
-    "version": "0.9.0",
+    "version": "0.11.0",
     "description": "An Antha mod for handling inputs.",
     "keywords": [
         "vir",
@@ -33,7 +33,7 @@
         "test:docs": "virmator docs check"
     },
     "dependencies": {
-        "@antha/gamepad-type": "^0.9.0",
+        "@antha/gamepad-type": "^0.11.0",
         "@augment-vir/assert": "^32.2.3",
         "@augment-vir/common": "^32.2.3",
         "date-vir": "^9.1.1",
@@ -48,10 +48,12 @@
         "@web/test-runner": "^1.0.0",
         "@web/test-runner-playwright": "^1.0.0",
         "element-vir": "^26.17.3",
-        "istanbul-smart-text-reporter": "^1.1.5"
+        "istanbul-smart-text-reporter": "^1.1.5",
+        "markdown-code-example-inserter": "^3.0.6",
+        "typedoc": "^0.28.20"
     },
     "peerDependencies": {
-        "@antha/engine": "^0.9.0",
+        "@antha/engine": "^0.11.0",
         "element-vir": ">=26"
     },
     "engines": {