pixijs-input-devices 0.1.0 → 0.1.2

package/dist/index.d.ts

@@ -0,0 +1,461 @@
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import * as PIXI from 'pixi.js';
+
+/*
+ * PixiJs Mixin:
+ */
+
+declare module 'pixi.js' {
+
+  export interface Container {
+
+    /**
+     * @returns true when navigationMode is "target", or
+     * navigationMode is "auto" and the container handles
+     * either "pointerdown" or "mousedown" events.
+     */
+    readonly isNavigatable: boolean;
+
+    /**
+     * When selecting a default navigation focus target, the
+     * target with the largest priority is chosen.
+     * @default 0
+     */
+    readonly navigationPriority: number;
+
+    /**
+     * Whether this container is explicitly navigatable or not.
+     */
+    navigationMode?: "auto" | "target" | "disabled" | undefined;
+  }
+
+}
+
+export {};
+import { Container } from 'pixi.js';
+
+declare class GamepadJoystick {
+	private _owner;
+	private ix;
+	private iy;
+	constructor(_owner: GamepadDeviceSource, ix: number, iy: number);
+	/** A scalar -1.0 to 1.0 representing the X-axis position on the stick */
+	get x(): number;
+	/** A scalar -1.0 to 1.0 representing the Y-axis position on the stick */
+	get y(): number;
+}
+export declare abstract class CustomDevice {
+	readonly id: string;
+	readonly type = "custom";
+	assignee?: any;
+	lastUpdated: number;
+	constructor(id: string);
+	update(now: number): void;
+	clear(): void;
+}
+/**
+ * A gamepad (game controller).
+ *
+ * Provides bindings and accessors for standard controller/gamepad layout:
+ * - 2 Joysticks: `leftJoystick`, `rightJoystick`
+ * - 16 Buttons: `button[...]`
+ *
+ * Direct Gamepad API access available too, via `source`.
+ */
+export declare class GamepadDevice {
+	source: Gamepad;
+	static defaultOptions: {
+		binds: {
+			0: "trigger";
+			1: "navigateBack";
+			8: "navigateBack";
+			13: "navigateDown";
+			14: "navigateLeft";
+			15: "navigateRight";
+			12: "navigateUp";
+		};
+		joystickDeadzone: number;
+		intent: {
+			joystickCommitSensitivity: number;
+			firstCooldownMs: number;
+			defaultCooldownMs: number;
+		};
+	};
+	/**
+	 * Globally unique identifier for this gamepad slot.
+	 * @example "gamepad0"
+	 */
+	readonly id: string;
+	readonly type = "gamepad";
+	/**
+	 * Platform of this gamepad, useful for configuring standard
+	 * button layouts or displaying branded icons.
+	 * @example "playstation"
+	 */
+	platform: GamepadPlatform;
+	lastUpdated: number;
+	/** Configurable metadata. */
+	assignee?: any;
+	options: {
+		binds: {
+			0: "trigger";
+			1: "navigateBack";
+			8: "navigateBack";
+			13: "navigateDown";
+			14: "navigateLeft";
+			15: "navigateRight";
+			12: "navigateUp";
+		};
+		joystickDeadzone: number;
+		intent: {
+			joystickCommitSensitivity: number;
+			firstCooldownMs: number;
+			defaultCooldownMs: number;
+		};
+	};
+	private _btnPrevState;
+	private _axisIntents;
+	private readonly _throttleIdLeftStickX;
+	private readonly _throttleIdLeftStickY;
+	/** Left Joystick */
+	readonly leftJoystick: GamepadJoystick;
+	/** Right Joystick */
+	readonly rightJoystick: GamepadJoystick;
+	/** A scalar 0.0 to 1.0 representing the trigger pull */
+	get leftTrigger(): number;
+	/** A scalar 0.0 to 1.0 representing the trigger pull */
+	get rightTrigger(): number;
+	/** A scalar 0.0 to 1.0 representing the trigger pull */
+	get leftShoulder(): number;
+	/** A scalar 0.0 to 1.0 representing the trigger pull */
+	get rightShoulder(): number;
+	/** Gamepad button accessors */
+	get button(): GamepadButtons;
+	/** Check whether a button is pressed */
+	pressing(button: Button): boolean;
+	/** Check whether all buttons in a group are pressed */
+	pressingAll(group: Button[]): boolean;
+	/** Check whether at least one button in a group is pressed */
+	pressingAny(group: Button[]): boolean;
+	update(source: Gamepad, now: number): void;
+	clear(): void;
+	constructor(source: Gamepad);
+	private updatePresses;
+}
+export declare class InputDeviceManager {
+	static readonly shared: InputDeviceManager;
+	static readonly gamepadsApiSupported: boolean;
+	private hasFocus;
+	/** Global keyboard. These inputs are always up to date.. */
+	readonly keyboard: KeyboardDevice;
+	/** Connected gamepads. Keep in mind these inputs are only up-to-date from the last update(). */
+	get gamepads(): readonly GamepadDevice[];
+	/** Connected devices. Keep in mind these inputs may only be up-to-date from the last update(). */
+	get devices(): readonly InputDevice[];
+	options: {
+		clearInputInBackground: boolean;
+	};
+	private _devices;
+	private _gamepadDevices;
+	private _gamepadDeviceMap;
+	private constructor();
+	/**
+	 * Performs a poll of latest input from all devices
+	 */
+	update(): ReadonlyArray<InputDevice>;
+	/** Add a custom device. */
+	add(device: CustomDevice): void;
+	/** Remove a custom device. */
+	remove(device: InputDevice): void;
+	/**
+	 * @returns updates connected gamepads, performing a poll of latest input
+	 */
+	pollGamepads(now: number): ReadonlyArray<GamepadDevice>;
+	private removeGamepad;
+}
+export declare class KeyboardDevice {
+	readonly id: "keyboard";
+	readonly type: "keyboard";
+	layout: KeyboardLayout;
+	assignee?: any;
+	lastUpdated: number;
+	static defaultOptions: {
+		binds: {
+			Enter: "trigger";
+			Escape: "navigateBack";
+			ArrowDown: "navigateDown";
+			ArrowLeft: "navigateLeft";
+			ArrowRight: "navigateRight";
+			ArrowUp: "navigateUp";
+		};
+	};
+	options: {
+		binds: {
+			0: "trigger";
+			1: "navigateBack";
+			8: "navigateBack";
+			13: "navigateDown";
+			14: "navigateLeft";
+			15: "navigateRight";
+			12: "navigateUp";
+		};
+	};
+	configureEventListeners(): void;
+	/** Accessors for keys */
+	key: Record<KeyCode, boolean>;
+	/** Check whether a key is pressed */
+	pressing(key: KeyCode): boolean;
+	/** Check whether all buttons in a group are pressed */
+	pressingAll(group: KeyCode[]): boolean;
+	/** Check whether at least one button in a group is pressed */
+	pressingAny(group: KeyCode[]): boolean;
+	/**
+	 * Get the label for the given key code in the current keyboard layout.
+	 *
+	 * @example
+	 * // when AZERTY
+	 * keyboard.localeLabel( "KeyQ" ) // "A"
+	 *
+	 * // when JCUKEN
+	 * keyboard.localeLabel( "KeyQ" ) // "Й"
+	 */
+	keyLabel(key: KeyCode, layout?: KeyboardLayout): string;
+	/**
+	 * Clear all keyboard keys.
+	 */
+	clear(): void;
+}
+/**
+ * Responsible for global navigation interactions.
+ *
+ * Set stageRoot to enable the global responder behaviors.
+ */
+export declare class Navigation {
+	static shared: Navigation;
+	/**
+	 * Set the stage root to automatically handle global
+	 * navigation intents.
+	 */
+	stageRoot?: Container;
+	private _focused?;
+	private _responderStack;
+	private constructor();
+	/**
+	 * Active global interaction target
+	 */
+	get firstResponder(): NavigationResponder | undefined;
+	/**
+	 * Stack of global interaction targets
+	 */
+	get responders(): readonly NavigationResponder[];
+	/**
+	 * Emit interaction intent to the first responder,
+	 * or the global responder if none.
+	 */
+	emit(intent: NavigationIntent, device: InputDevice): void;
+	/**
+	 * Remove the top-most global interaction target
+	 */
+	popResponder(): NavigationResponder | undefined;
+	/**
+	 * Set the new top-most global interaction target.
+	 */
+	pushResponder(responder: NavigationResponder): void;
+	private _propogateIntent;
+	private _handleGlobalIntent;
+}
+export declare const Button: {
+	/** A Button (Xbox / Nintendo: "A", PlayStation: "Cross") */
+	readonly A: 0;
+	/** B Button (Xbox: "B", PlayStation: "Circle", Nintendo: "X") */
+	readonly B: 1;
+	/** X Button (Xbox: "X", PlayStation: "Square", Nintendo: "B") */
+	readonly X: 2;
+	/** Y Button (Xbox / Nintendo: "Y", PlayStation: "Triangle") */
+	readonly Y: 3;
+	/** Left Shoulder Button (Xbox: "LB", PlayStation: "L1", Nintendo: "L") */
+	readonly LeftShoulder: 4;
+	/** Right Shoulder Button (Xbox: "RB", PlayStation: "R1", Nintendo: "R") */
+	readonly RightShoulder: 5;
+	/** Left Trigger (Xbox: "LT", PlayStation: "L2", Nintendo: "ZL") */
+	readonly LeftTrigger: 6;
+	/** Right Trigger (Xbox: "RT", PlayStation: "R2", Nintendo: "ZR") */
+	readonly RightTrigger: 7;
+	/** Bak Button (Xbox: "Share", PlayStation: "Options", Nintendo: "-") */
+	readonly Back: 8;
+	/** Start Button (Xbox: "Start", PlayStation: "Select", Nintendo: "+") */
+	readonly Start: 9;
+	/** Left Stick Press (Xbox / PlayStation: "LS", Nintendo: "L3") */
+	readonly LeftStick: 10;
+	/** Right Stick Press (Xbox / PlayStation: "RS", Nintendo: "R3") */
+	readonly RightStick: 11;
+	/** D-Pad Up */
+	readonly DPadUp: 12;
+	/** D-Pad Down */
+	readonly DPadDown: 13;
+	/** D-Pad Left */
+	readonly DPadLeft: 14;
+	/** D-Pad Right */
+	readonly DPadRight: 15;
+};
+export declare const KeyCode: {
+	readonly ArrowLeft: "ArrowLeft";
+	readonly ArrowRight: "ArrowRight";
+	readonly ArrowUp: "ArrowUp";
+	readonly ArrowDown: "ArrowDown";
+	readonly KeyA: "KeyA";
+	readonly KeyB: "KeyB";
+	readonly KeyC: "KeyC";
+	readonly KeyD: "KeyD";
+	readonly KeyE: "KeyE";
+	readonly KeyF: "KeyF";
+	readonly KeyG: "KeyG";
+	readonly KeyH: "KeyH";
+	readonly KeyI: "KeyI";
+	readonly KeyJ: "KeyJ";
+	readonly KeyK: "KeyK";
+	readonly KeyL: "KeyL";
+	readonly KeyM: "KeyM";
+	readonly KeyN: "KeyN";
+	readonly KeyO: "KeyO";
+	readonly KeyP: "KeyP";
+	readonly KeyQ: "KeyQ";
+	readonly KeyR: "KeyR";
+	readonly KeyS: "KeyS";
+	readonly KeyT: "KeyT";
+	readonly KeyU: "KeyU";
+	readonly KeyV: "KeyV";
+	readonly KeyW: "KeyW";
+	readonly KeyX: "KeyX";
+	readonly KeyY: "KeyY";
+	readonly KeyZ: "KeyZ";
+	readonly Digit0: "Digit0";
+	readonly Digit1: "Digit1";
+	readonly Digit2: "Digit2";
+	readonly Digit3: "Digit3";
+	readonly Digit4: "Digit4";
+	readonly Digit5: "Digit5";
+	readonly Digit6: "Digit6";
+	readonly Digit7: "Digit7";
+	readonly Digit8: "Digit8";
+	readonly Digit9: "Digit9";
+	readonly Backquote: "Backquote";
+	readonly Backslash: "Backslash";
+	readonly Backspace: "Backspace";
+	readonly BracketLeft: "BracketLeft";
+	readonly BracketRight: "BracketRight";
+	readonly Comma: "Comma";
+	readonly Delete: "Delete";
+	readonly End: "End";
+	readonly Enter: "Enter";
+	readonly Equal: "Equal";
+	readonly Escape: "Escape";
+	readonly Home: "Home";
+	readonly Minus: "Minus";
+	readonly Period: "Period";
+	readonly Quote: "Quote";
+	readonly Semicolon: "Semicolon";
+	readonly Slash: "Slash";
+	readonly Space: "Space";
+	readonly ShiftRight: "ShiftRight";
+	readonly AltRight: "AltRight";
+	readonly ControlRight: "ControlRight";
+	readonly MetaRight: "MetaRight";
+	readonly ShiftLeft: "ShiftLeft";
+	readonly AltLeft: "AltLeft";
+	readonly ControlLeft: "ControlLeft";
+	readonly MetaLeft: "MetaLeft";
+	readonly Numpad0: "Numpad0";
+	readonly Numpad1: "Numpad1";
+	readonly Numpad2: "Numpad2";
+	readonly Numpad3: "Numpad3";
+	readonly Numpad4: "Numpad4";
+	readonly Numpad5: "Numpad5";
+	readonly Numpad6: "Numpad6";
+	readonly Numpad7: "Numpad7";
+	readonly Numpad8: "Numpad8";
+	readonly Numpad9: "Numpad9";
+};
+/**
+ * @returns all navigatable containers in some container
+ */
+export declare function getAllNavigatables(root: Container): NavigatableContainer[];
+/**
+ * @returns the first navigatable container in the given direction
+ */
+export declare function getFirstNavigatable(root: Container, currentFocus?: Container, nearestDirection?: NavigationDirection, { minimumDistance, }?: {
+	minimumDistance?: number;
+}): NavigatableContainer | undefined;
+/**
+ * @returns the first navigatable container in the given direction
+ */
+export declare function getFirstNavigatableInDirection(navigatables: NavigatableContainer[], currentFocus?: Container, nearestDirection?: NavigationDirection, { minimumDistance, }?: {
+	minimumDistance?: number;
+}): NavigatableContainer | undefined;
+/**
+ * A target that responds to navigation on the stack.
+ */
+export interface NavigationResponder {
+	/**
+	 * Called when received a navigation intent. The target should handle, and
+	 * respond with a boolean indicating whether or not the intent was handled.
+	 *
+	 * Unhandled interaction intents will be bubbled up to the next target. You
+	 * might return `true` here to prevent any intent from being propagated.
+	 */
+	handledNavigationIntent?(intent: NavigationIntent, device: InputDevice): boolean;
+	/**
+	 * This method is triggered when the target became the first responder.
+	 *
+	 * Either when pushed, or when another target stopped being the first
+	 * responder.
+	 */
+	becameFirstResponder?(): void;
+	/**
+	 * This method is triggered when the target stopped being first responder.
+	 *
+	 * Either popped, or another target was pushed on top of the stack.
+	 */
+	resignedAsFirstResponder?(): void;
+}
+export type Button = (typeof Button)[keyof typeof Button];
+/** Array with strongly-typed indices (0-15) */
+export type GamepadButtons = {
+	[Button.A]: GamepadButton;
+	[Button.B]: GamepadButton;
+	[Button.X]: GamepadButton;
+	[Button.Y]: GamepadButton;
+	[Button.LeftShoulder]: GamepadButton;
+	[Button.RightShoulder]: GamepadButton;
+	[Button.LeftTrigger]: GamepadButton;
+	[Button.RightTrigger]: GamepadButton;
+	[Button.Back]: GamepadButton;
+	[Button.Start]: GamepadButton;
+	[Button.LeftStick]: GamepadButton;
+	[Button.RightStick]: GamepadButton;
+	[Button.DPadUp]: GamepadButton;
+	[Button.DPadDown]: GamepadButton;
+	[Button.DPadLeft]: GamepadButton;
+	[Button.DPadRight]: GamepadButton;
+};
+export type GamepadDeviceSource = {
+	source: Gamepad;
+};
+/**
+ * Common gamepad platforms, which may indicate button layout.
+ *
+ * Note: Non-comprehensive list, covers the most brands only.
+ */
+export type GamepadPlatform = "logitech" | "nintendo" | "playstation" | "steam" | "xbox" | "other";
+export type InputDevice = GamepadDevice | KeyboardDevice | CustomDevice;
+export type KeyCode = (typeof KeyCode)[keyof typeof KeyCode];
+/**
+ * Supported keyboard layouts.
+ */
+export type KeyboardLayout = "QWERTY" | "AZERTY" | "JCUKEN" | "QWERTZ";
+export type NavigatableContainer = Container;
+export type NavigationDirection = "navigateLeft" | "navigateRight" | "navigateUp" | "navigateDown";
+export type NavigationIntent = "navigateBack" | "navigateDown" | "navigateLeft" | "navigateRight" | "navigateUp" | "trigger";
+export type NavigationTargetEvent = "focus" | "blur";
+
+export {};