dualsense-ts 2.1.44 → 2.2.0

package/docs/Unisense.md

@@ -91,7 +91,7 @@
 
 #### Defined in
 
-[src/elements/unisense.ts:22](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/unisense.ts#L22)
+[src/elements/unisense.ts:22](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/unisense.ts#L22)
 
 ## Properties
 
@@ -120,7 +120,7 @@
 
 #### Defined in
 
-[src/input.ts:128](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L128)
+[src/input.ts:128](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L128)
 
 ___
 
@@ -134,7 +134,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:162](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L162)
+[src/input.ts:162](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L162)
 
 ___
 
@@ -148,7 +148,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:157](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L157)
+[src/input.ts:157](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L157)
 
 ___
 
@@ -162,7 +162,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:154](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L154)
+[src/input.ts:154](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L154)
 
 ___
 
@@ -176,7 +176,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:160](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L160)
+[src/input.ts:160](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L160)
 
 ___
 
@@ -186,7 +186,7 @@ ___
 
 #### Defined in
 
-[src/elements/unisense.ts:19](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/unisense.ts#L19)
+[src/elements/unisense.ts:19](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/unisense.ts#L19)
 
 ___
 
@@ -196,7 +196,7 @@ ___
 
 #### Defined in
 
-[src/elements/unisense.ts:18](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/unisense.ts#L18)
+[src/elements/unisense.ts:18](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/unisense.ts#L18)
 
 ___
 
@@ -206,7 +206,7 @@ ___
 
 #### Defined in
 
-[src/elements/unisense.ts:20](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/unisense.ts#L20)
+[src/elements/unisense.ts:20](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/unisense.ts#L20)
 
 ___
 
@@ -220,7 +220,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L58)
+[src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L58)
 
 ___
 
@@ -234,7 +234,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L61)
+[src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L61)
 
 ___
 
@@ -248,7 +248,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L64)
+[src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L64)
 
 ___
 
@@ -262,7 +262,7 @@ ___
 
 #### Defined in
 
-[src/elements/unisense.ts:15](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/unisense.ts#L15)
+[src/elements/unisense.ts:15](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/unisense.ts#L15)
 
 ___
 
@@ -276,7 +276,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L67)
+[src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L67)
 
 ___
 
@@ -286,7 +286,7 @@ ___
 
 #### Defined in
 
-[src/elements/unisense.ts:17](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/unisense.ts#L17)
+[src/elements/unisense.ts:17](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/unisense.ts#L17)
 
 ___
 
@@ -370,7 +370,7 @@ Input.\_\_@toStringTag@66
 
 #### Defined in
 
-[src/input.ts:149](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L149)
+[src/input.ts:149](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L149)
 
 ___
 
@@ -388,7 +388,7 @@ Input.active
 
 #### Defined in
 
-[src/elements/unisense.ts:41](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/unisense.ts#L41)
+[src/elements/unisense.ts:41](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/unisense.ts#L41)
 
 ## Methods
 
@@ -409,7 +409,7 @@ And decide if this is the root Input.
 
 #### Defined in
 
-[src/input.ts:168](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L168)
+[src/input.ts:168](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L168)
 
 ___
 
@@ -434,7 +434,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L190)
+[src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L190)
 
 ___
 
@@ -459,7 +459,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:194](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L194)
+[src/input.ts:194](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L194)
 
 ___
 
@@ -477,7 +477,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L186)
+[src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L186)
 
 ___
 
@@ -508,7 +508,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:199](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L199)
+[src/input.ts:199](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L199)
 
 ___
 
@@ -534,7 +534,7 @@ Update the input's state and trigger all necessary callbacks.
 
 #### Defined in
 
-[src/input.ts:215](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L215)
+[src/input.ts:215](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L215)
 
 ___
 
@@ -552,7 +552,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L139)
+[src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L139)
 
 ___
 
@@ -570,7 +570,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:131](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L131)
+[src/input.ts:131](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L131)
 
 ___
 
@@ -594,7 +594,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:143](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L143)
+[src/input.ts:143](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L143)
 
 ___
 
@@ -648,7 +648,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L44)
+[src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L44)
 
 ___
 
@@ -797,7 +797,7 @@ Resolves on the next change to this input's state.
 
 #### Defined in
 
-[src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L78)
+[src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L78)
 
 ___
 
@@ -851,7 +851,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L37)
+[src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L37)
 
 ___
 
@@ -1006,7 +1006,7 @@ Resolves on the next change to this input's state.
 
 #### Defined in
 
-[src/input.ts:91](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L91)
+[src/input.ts:91](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L91)
 
 ___
 
@@ -1250,7 +1250,7 @@ Render a convenient debugging string.
 
 #### Defined in
 
-[src/input.ts:102](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L102)
+[src/input.ts:102](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L102)
 
 ___
 

package/docs/UnisenseParams.md

@@ -26,7 +26,7 @@
 
 #### Defined in
 
-[src/elements/unisense.ts:10](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/unisense.ts#L10)
+[src/elements/unisense.ts:10](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/unisense.ts#L10)
 
 ___
 
@@ -36,7 +36,7 @@ ___
 
 #### Defined in
 
-[src/elements/unisense.ts:9](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/unisense.ts#L9)
+[src/elements/unisense.ts:9](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/unisense.ts#L9)
 
 ___
 
@@ -50,7 +50,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:6](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L6)
+[src/input.ts:6](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L6)
 
 ___
 
@@ -64,7 +64,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:5](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L5)
+[src/input.ts:5](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L5)
 
 ___
 
@@ -78,7 +78,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:8](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L8)
+[src/input.ts:8](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L8)
 
 ___
 
@@ -92,7 +92,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:7](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L7)
+[src/input.ts:7](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L7)
 
 ___
 
@@ -102,4 +102,4 @@ ___
 
 #### Defined in
 
-[src/elements/unisense.ts:8](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/unisense.ts#L8)
+[src/elements/unisense.ts:8](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/unisense.ts#L8)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dualsense-ts",
-  "version": "2.1.44",
+  "version": "2.2.0",
   "description": "A natural interface for your DualSense controller, with Typescript",
   "keywords": [
     "dualsense",

package/src/elements/analog.ts

@@ -1,8 +1,11 @@
 import { Axis } from "./axis";
 import { Momentary } from "./momentary";
 import { Input, InputParams } from "../input";
-import { Radians, Degrees, Magnitude } from "../math";
+import { Radians, Degrees, Magnitude, Force } from "../math";
 
+/**
+ * Configuration for an analog joystick and its basic inputs.
+ */
 export interface AnalogParams extends InputParams {
   button?: InputParams;
   x?: InputParams;
@@ -21,65 +24,100 @@ export interface AnalogParams extends InputParams {
 export class Analog extends Input<Analog> {
   public readonly state: Analog = this;
 
+  /**
+   * The left/right position of the input.
+   */
   public readonly x: Axis;
+  /**
+   * The up/down position of the input.
+   */
   public readonly y: Axis;
+  /**
+   * Button triggered by pressing the stick.
+   */
   public readonly button: Momentary;
 
   constructor(params?: AnalogParams) {
     super(params);
+    const { button, x, y, threshold } = params || {};
 
-    this.button = new Momentary(
-      params?.button || { icon: "3", name: "Button" }
-    );
+    this.button = new Momentary(button || { icon: "3", name: "Button" });
     this.x = new Axis(
-      params?.x || { icon: "↔", name: "X", threshold: (1 / 128) * 3 }
+      x || { icon: "↔", name: "X", threshold: threshold || (1 / 128) * 6 }
     );
     this.y = new Axis(
-      params?.y || { icon: "↕", name: "Y", threshold: (1 / 128) * 3 }
+      y || { icon: "↕", name: "Y", threshold: threshold || (1 / 128) * 6 }
     );
   }
 
-  // Returns true if the stick is away from the idle position, or the button is pressed.
+  /**
+   * Returns true if the stick is away from the idle position, or the button is pressed.
+   */
   public get active(): boolean {
-    return this.magnitude > this.threshold || this.button.active;
+    return this.x.active || this.y.active || this.button.active;
   }
 
-  // Returns a direction and magnitude representing the stick's position.
-  public get vector(): { direction: number; magnitude: number } {
+  /**
+   * Returns a direction and magnitude representing the stick's position.
+   */
+  public get vector(): { direction: Radians; magnitude: Magnitude } {
     return { direction: this.direction, magnitude: this.magnitude };
   }
 
-  // Returns the magnitude of the stick's position.
+  /**
+   * Returns an force from the stick's position.
+   */
+  public get force(): Force {
+    return this.active
+      ? Math.max(Math.min(Math.hypot(this.x.state, this.y.state), 1), -1)
+      : 0;
+  }
+
+  /**
+   * Returns a magnitude from the stick's position.
+   */
   public get magnitude(): Magnitude {
-    return Math.min(Math.abs(Math.hypot(this.x.state, this.y.state)), 1);
+    return Math.abs(this.force);
   }
 
-  // Returns the angle related to the stick's position in radians.
+  /**
+   * Returns the stick's angle in radians.
+   */
   public get direction(): Radians {
     return Math.atan2(this.y.state, this.x.state);
   }
 
-  // Alias for `.direction`
+  /**
+   * Alias for `.direction`
+   */
   public get radians(): Radians {
     return this.direction;
   }
 
-  // Alias for `.direction`
+  /**
+   * Alias for `.direction`
+   */
   public get angle(): Radians {
     return this.direction;
   }
 
-  // Alias for `.direction` converted to degrees.
+  /**
+   * Alias for `.direction` converted to degrees.
+   */
   public get directionDegrees(): Degrees {
     return (this.direction * 180) / Math.PI;
   }
 
-  // Alias for `.directionDegrees`.
+  /**
+   * Alias for `.directionDegrees`.
+   */
   public get degrees(): Degrees {
     return this.directionDegrees;
   }
 
-  // Alias for `.directionDegrees`.
+  /**
+   * Alias for `.directionDegrees`.
+   */
   public get angleDegrees(): Degrees {
     return this.directionDegrees;
   }

package/src/elements/axis.ts

@@ -5,14 +5,14 @@ export class Axis extends Input<Force> {
   public state: Force = 0;
 
   public get active(): boolean {
-    return this.magnitude > this.threshold;
+    return Math.abs(this.state) > this.threshold;
   }
 
   public get force(): Force {
-    return this.state;
+    return this.active ? this.state : 0;
   }
 
   public get magnitude(): Magnitude {
-    return Math.abs(this.state);
+    return Math.abs(this.force);
   }
 }